Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Look up values in plan_hierarchy with bolt lookup #2815

Closed
beechtom opened this issue May 5, 2021 · 1 comment
Closed

Look up values in plan_hierarchy with bolt lookup #2815

beechtom opened this issue May 5, 2021 · 1 comment
Assignees
@lucywyman
Labels
Feature New features and improvements.

Comments

@beechtom
Copy link
Contributor

beechtom commented May 5, 2021 •
edited by lucywyman
Loading

Use Case

The bolt lookup command is helpful for looking up values using the hierarchy key. It would also be helpful to permit lookups using the plan_hierarchy key, especially for cases where there are many files in the hierarchy or a user uses interpolations (even though interpolations here are not officially supported).

Describe the Solution You Would Like

A command-line option could be specified to tell Bolt to use the plan_hierarchy when looking up values. For clarity the command-line option could be --plan-hierarchy, or for simplicity it could be --plan.

bolt lookup <key> --plan-hierarchy

It would also be helpful to provide variables for interpolation on the command-line. Syntax could be similar to providing params to tasks and plans, using VAR=VAL syntax.

bolt lookup <key> --plan-hierarchy foo=bar baz=bak

Include a note in the docs about how plan_hierarchy interpolations can be counterintuitive because they may happen in a different scope than they expect, and we may change the scope they are evaluated in further down the line. For this command the variables are being provided so the scoping / expected value won't change. Maybe a bullet list of "expectations" on the "Using Bolt with Hiera" doc.

We should also add support for passing variable values to the lookup command for the hierarchy, which should have the same precedence as plan variables with target variables for the regular hierarchy lookup.

Questions

  • What happens when the hiera config does not include a plan_hierarchy key?
    Maintain same behavior as plans: fall back to the hierarchy key. This will cause hierarchies that use fact interpolation to break.
@beechtom beechtom added the Feature New features and improvements. label May 5, 2021
@beechtom beechtom self-assigned this May 13, 2021
@beechtom beechtom removed their assignment May 19, 2021
lucywyman added a commit to lucywyman/bolt that referenced this issue Jun 1, 2021
@lucywyman
(puppetlabsGH-2815) Support plan-hierarchy lookups on the CLI
54e278d 
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.

!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`.
@lucywyman lucywyman mentioned this issue Jun 1, 2021
Merged
lucywyman added a commit to lucywyman/bolt that referenced this issue Jun 1, 2021
@lucywyman
(puppetlabsGH-2815) Support plan-hierarchy lookups on the CLI
26cea34 
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.

!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`.
lucywyman added a commit to lucywyman/bolt that referenced this issue Jun 1, 2021
@lucywyman
(puppetlabsGH-2815) Support plan-hierarchy lookups on the CLI
48dad4e 
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.

!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`.
lucywyman added a commit to lucywyman/bolt that referenced this issue Jun 2, 2021
@lucywyman
(puppetlabsGH-2815) Support plan-hierarchy lookups on the CLI
e527377 
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`.
lucywyman added a commit to lucywyman/bolt that referenced this issue Jun 3, 2021
@lucywyman
(puppetlabsGH-2815) Support plan-hierarchy lookups on the CLI
173aa69 
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`.
lucywyman added a commit to lucywyman/bolt that referenced this issue Jun 3, 2021
@lucywyman
(puppetlabsGH-2815) Support plan-hierarchy lookups on the CLI
1be1de6 
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`.
lucywyman added a commit to lucywyman/bolt that referenced this issue Jun 3, 2021
@lucywyman
(puppetlabsGH-2815) Support plan-hierarchy lookups on the CLI
b504387 
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`.
lucywyman added a commit to lucywyman/bolt that referenced this issue Jun 3, 2021
@lucywyman
(puppetlabsGH-2815) Support plan-hierarchy lookups on the CLI
f87a231 
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`.
lucywyman added a commit to lucywyman/bolt that referenced this issue Jun 7, 2021
@lucywyman
(puppetlabsGH-2815) Support plan-hierarchy lookups on the CLI
11431e6 
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`.
lucywyman added a commit to lucywyman/bolt that referenced this issue Jun 8, 2021
@lucywyman
(puppetlabsGH-2815) Support plan-hierarchy lookups on the CLI
7464c98 
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`.
lucywyman added a commit to lucywyman/bolt that referenced this issue Jun 8, 2021
@lucywyman
(puppetlabsGH-2815) Support plan-hierarchy lookups on the CLI
861d120 
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`.
beechtom added a commit that referenced this issue Jun 10, 2021
@beechtom
Merge pull request #2859 from lucywyman/GH-2815
c3299e3 
(GH-2815) Support plan-hierarchy lookups on the CLI
@beechtom
Copy link
Contributor Author

Closed by #2589

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lucywyman lucywyman

Labels
Feature New features and improvements.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@lucywyman @beechtom