(GH-2815) Support plan-hierarchy lookups on the CLI #2859

lucywyman · 2021-06-01T21:43:53Z

This adds a new flag --plan-hierarchy to the bolt lookup CLI
command, which will perform a lookup as if in a plan outside an apply
block rather than in an apply block. The command optionally accepts
variable definitions for plan variable interpolation in hiera config.
The flag is mutually exclusive with targetting options, and either a
targetting option or --plan-hierarchy are required. The command
returns the bare value of the lookup, rather than a Result object.

This also updates the parallelize test to verify that return
statements return to only run on SSH infrastructure, since it keeps
falsely failing on Windows.

!feature

Lookup hiera plan_hierarchy values from the CLI (#2815)

The bolt lookup command now has a --plan-hierarchy flag that will
lookup values from Hiera's plan_hierarchy.

lib/bolt/cli.rb

lib/bolt/pal.rb

spec/bolt/cli_spec.rb

hestonhoffman · 2021-06-04T15:56:58Z

documentation/hiera.md

-> **Note:** The `bolt lookup` and `Invoke-BoltLookup` commands only look up data
-> using the `hierarchy` key in the Hiera configuration file. `plan_hierarchy`
-> is not supported from the command line.
+### Lookup up data from hierarchy key


Suggested change

### Lookup up data from hierarchy key

We don't mention the hierarchy key in this section outside of the section title. We've told the reader to learn more about Hiera and linked off to the Hiera docs, but I think we should add some references to where the hierarchy key is. I'll look for some opportunities do that below.

This command line section is a little difficult to parse right now because we've added a section on the plan_hierarchy key, but that key is only explained later in the plans section. The plan_hierarchy key was mentioned in a note that we're removing here, and I think I just missed this last time I reviewed. I think we should:

Move the plan_hierarchy lookup section under "Look up data in plans" (It can probably just go right at the end).

Add a sentence to the end of the "Look up data from the command line" section that says something like: "To look up data outside an apply block in a Bolt plan, see..."

Remove this section title (I added a piece that should send users in the right direction if they're
looking for info on lookups outside apply blocks

Mmk, I really don't like the titles I gave the subheadings of Look up data on the command line, but I'm not sure if it's better to continue the theme of 'inside apply blocks / outside apply blocks' or to use more correct language around target context vs. plan context (or to even just say "from hierarchy" and "from plan_hierarchy")

documentation/hiera.md

beechtom

Trying to set a reserved variable results in a stacktrace:

$ bolt lookup foo -t nix facts='{"os":{"name":"Windows"}}'                                                                                     1 ✘  9s   2.6.3 
Starting: install puppet and gather facts on ubuntu
Finished: install puppet and gather facts with 0 failures in 4.91 sec
Attempt to assign to a reserved variable name: 'facts' on node thomass-macbook-pro.local
Traceback (most recent call last):
	43: from /Users/tom/.rvm/gems/ruby-2.6.3/bin/ruby_executable_hooks:24:in `<main>'
	42: from /Users/tom/.rvm/gems/ruby-2.6.3/bin/ruby_executable_hooks:24:in `eval'
	41: from /Users/tom/git/bolt/vendor/bundle/ruby/2.6.0/bin/bolt:23:in `<main>'
	40: from /Users/tom/git/bolt/vendor/bundle/ruby/2.6.0/bin/bolt:23:in `load'
	39: from /Users/tom/git/bolt/exe/bolt:11:in `<top (required)>'
	38: from /Users/tom/git/bolt/lib/bolt/cli.rb:529:in `execute'
	37: from /Users/tom/git/bolt/lib/bolt/cli.rb:735:in `lookup'
	36: from /Users/tom/git/bolt/lib/bolt/outputter.rb:46:in `spin'
        ...

lib/bolt/pal.rb

beechtom

Looks up values using the plan_hierarchy key
Interpolates variables passed on the CLI
Falls back to hierarchy if plan_hierarchy is not defined
Gracefully errors when interpolating variables that are not defined
Gracefully errors when using targeting options with --plan-hierarchy
Gracefully errors when defining reserved variables
Note: Error is printed twice.
Sets variables in an 'apply' lookup
Shadows variables correctly in an 'apply' lookup

documentation/hiera.md

This adds a new flag `--plan-hierarchy` to the `bolt lookup` CLI command, which will perform a lookup as if in a plan outside an apply block rather than in an apply block. The command optionally accepts variable definitions for plan variable interpolation in hiera config. The flag is mutually exclusive with targetting options, and either a targetting option or `--plan-hierarchy` are required. The command returns the bare value of the lookup, rather than a Result object. This also updates the parallelize test to verify that `return` statements return to only run on SSH infrastructure, since it keeps falsely failing on Windows. !feature * **Lookup hiera plan_hierarchy values from the CLI** ([puppetlabs#2815](puppetlabs#2815)) The `bolt lookup` command now has a `--plan-hierarchy` flag that will lookup values from Hiera's `plan_hierarchy`.

hestonhoffman · 2021-06-09T16:55:49Z

I wanted to make some edits outside of the changed lines, so I opened a PR here lucywyman#13

Summary of changes

Good instincts on moving the entire CLI section down in the page, I think it's a lot easier to follow now.

Moved the link to apply blocks up to the "Before you start" paragraph. Users who want to use Hiera with Bolt should probably already be fairly familiar with how Puppet and Bolt work together, so they're better educated about which context they need to use (inside/outside apply blocks).

For headings, let's just keep it consistent and go with inside / outside apply blocks. I know it feels a little weird cos it's the command line, but we've already established these contexts, so I think it makes it a bit easier for the user if we stay consistent and then go into more detail in the sections.

Updated the opening paragraph of CLI lookups to summarize both options.

Updates to hiera.md

lucywyman · 2021-06-09T21:31:14Z

Docs updates look great, merged

lucywyman force-pushed the GH-2815 branch 3 times, most recently from 48dad4e to e527377 Compare June 2, 2021 00:57

lucywyman marked this pull request as ready for review June 2, 2021 16:50

lucywyman requested review from hestonhoffman and a team as code owners June 2, 2021 16:50

beechtom suggested changes Jun 2, 2021

View reviewed changes

lucywyman force-pushed the GH-2815 branch 4 times, most recently from b504387 to f87a231 Compare June 3, 2021 16:53

lucywyman requested a review from beechtom June 3, 2021 19:04

hestonhoffman reviewed Jun 4, 2021

View reviewed changes

lucywyman force-pushed the GH-2815 branch from f87a231 to 11431e6 Compare June 7, 2021 17:56

beechtom suggested changes Jun 7, 2021

View reviewed changes

lib/bolt/pal.rb Show resolved Hide resolved

lib/bolt/pal.rb Outdated Show resolved Hide resolved

lucywyman force-pushed the GH-2815 branch from 11431e6 to 7464c98 Compare June 8, 2021 14:40

lucywyman requested a review from beechtom June 8, 2021 21:20

beechtom approved these changes Jun 8, 2021

View reviewed changes

documentation/hiera.md Outdated Show resolved Hide resolved

lucywyman mentioned this pull request Jun 8, 2021

Native SSH transport cannot connect with just a password #2875

Closed

lucywyman force-pushed the GH-2815 branch from 7464c98 to 861d120 Compare June 8, 2021 22:50

beechtom requested a review from hestonhoffman June 9, 2021 16:37

Updates to hiera.md

38a9eec

Merge pull request #13 from hestonhoffman/hiera-updates

9dabe63

Updates to hiera.md

hestonhoffman approved these changes Jun 10, 2021

View reviewed changes

beechtom merged commit c3299e3 into puppetlabs:main Jun 10, 2021

beechtom mentioned this pull request Jun 14, 2021

(hack) Bash tab completion for Bolt commands #2869

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

(GH-2815) Support plan-hierarchy lookups on the CLI #2859

(GH-2815) Support plan-hierarchy lookups on the CLI #2859

lucywyman commented Jun 1, 2021 •

edited

Loading

hestonhoffman Jun 4, 2021

hestonhoffman Jun 4, 2021 •

edited

Loading

lucywyman Jun 7, 2021

beechtom left a comment

beechtom left a comment •

edited

Loading

hestonhoffman commented Jun 9, 2021 •

edited

Loading

lucywyman commented Jun 9, 2021

(GH-2815) Support plan-hierarchy lookups on the CLI #2859

(GH-2815) Support plan-hierarchy lookups on the CLI #2859

Conversation

lucywyman commented Jun 1, 2021 • edited Loading

hestonhoffman Jun 4, 2021

Choose a reason for hiding this comment

hestonhoffman Jun 4, 2021 • edited Loading

Choose a reason for hiding this comment

lucywyman Jun 7, 2021

Choose a reason for hiding this comment

beechtom left a comment

Choose a reason for hiding this comment

beechtom left a comment • edited Loading

Choose a reason for hiding this comment

hestonhoffman commented Jun 9, 2021 • edited Loading

Summary of changes

lucywyman commented Jun 9, 2021

lucywyman commented Jun 1, 2021 •

edited

Loading

hestonhoffman Jun 4, 2021 •

edited

Loading

beechtom left a comment •

edited

Loading

hestonhoffman commented Jun 9, 2021 •

edited

Loading