(SUP-3709) - Indicator Exclusion using code manager and Hiera lookup #205

Aaronoftheages · 2023-10-16T18:11:13Z

Work done and tested within PE_Status_Check, lookup added to pe_status_check::infra_summary and pe_status_check::agent_summary plans and tested within PE_Console

MartyEwings

the readme needs some work

MartyEwings · 2023-10-18T09:08:18Z

plans/agent_summary.pp

@@ -6,8 +6,9 @@
 #   Defaults to using a PuppetDB query to identify nodes
 # @param indicator_exclusions
 #   List of disabled indicators, place any indicator ids you do not wish to report on in this list
+#   Can be used with a code manager/control repo to exclude test by ID using a static.yaml file


The Phrasing here is not quite right.

You would need something along the lines of "Static Hiera data can be used to set indicator_exclusions see https://www.puppet.com/docs/pe/latest/writing_plans_in_puppet_language_pe.html#using_hiera_with_plans"

MartyEwings · 2023-10-18T09:08:30Z

plans/infra_summary.pp

@@ -6,8 +6,9 @@
 #   Defaults to using a PuppetDB query to identify nodes
 # @param indicator_exclusions
 #   List of disabled indicators, place any indicator ids you do not wish to report on in this list
+#   Can be used with a code manager/control repo to exclude test by ID using a static.yaml file


same here

The Phrasing here is not quite right.

You would need something along the lines of "Static Hiera data can be used to set indicator_exclusions see https://www.puppet.com/docs/pe/latest/writing_plans_in_puppet_language_pe.html#using_hiera_with_plans"

MartyEwings · 2023-10-18T09:10:51Z

README.md

 See the following [documentation](https://puppet.com/docs/bolt/latest/hiera.html#outside-apply-blocks) for further explanation.

+#### Using indictor_exclusion with a code manager and hiera.yaml


Using Static Hiera data to populate indictor_exclusions when executing the plans

Replacing the title now

MartyEwings · 2023-10-18T09:13:05Z

README.md

 See the following [documentation](https://puppet.com/docs/bolt/latest/hiera.html#outside-apply-blocks) for further explanation.

+#### Using indictor_exclusion with a code manager and hiera.yaml
+
+To utilize the indicator_exclusions with a code manager, place the plan_hierarchy listed in the step above, placing it in the root level [hiera.yaml](https://puppet.com/docs/puppet/latest/hiera_config_yaml_5.html) file.


Phrasing change needed
You are not using it with code manager you are using hiera within the plan, its the environment layer of hiera not root, and you should link to https://www.puppet.com/docs/pe/2023.4/writing_plans_in_puppet_language_pe.html#using_hiera_with_plans

MartyEwings · 2023-10-18T09:13:55Z

README.md

+
+To utilize the indicator_exclusions with a code manager, place the plan_hierarchy listed in the step above, placing it in the root level [hiera.yaml](https://puppet.com/docs/puppet/latest/hiera_config_yaml_5.html) file.
+
+Following this create a [static.yaml] file within the code manager data folder `CODE_MANAGER/data/static.yaml`


dont specify the folder, people can place their data structures anywhere

MartyEwings · 2023-10-18T09:14:53Z

README.md

+  - '<TEST ID>'                                                                
+``` 
+
+This will allow you to exclude tests from `pe_status_check::infra_summary` and `pe_status_check::agent_summary` within the PE Console planning


This sentence needs some work,

indicator ids in this array will be excluded when running the plans pe_status_check::infra_summary and pe_status_check::agent_summary

something like that

README.md

MartyEwings · 2023-10-18T10:46:10Z

README.md

 See the following [documentation](https://puppet.com/docs/bolt/latest/hiera.html#outside-apply-blocks) for further explanation.

+#### Using Static Hiera data to populate indicator_exclusions when executing plans
+
+To utilize the indicator_exclusions using hiera within the plan, place the plan_hierarchy listed in the step above the environment layer (https://www.puppet.com/docs/pe/2023.4/writing_plans_in_puppet_language_pe.html#using_hiera_with_plans)


Suggested change

To utilize the indicator_exclusions using hiera within the plan, place the plan_hierarchy listed in the step above the environment layer (https://www.puppet.com/docs/pe/2023.4/writing_plans_in_puppet_language_pe.html#using_hiera_with_plans)

Place the plan_hierarchy listed in the step above, in the environment layer (https://www.puppet.com/docs/pe/latest/writing_plans_in_puppet_language_pe.html#using_hiera_with_plans)

MartyEwings · 2023-10-18T10:47:19Z

README.md

+
+To utilize the indicator_exclusions using hiera within the plan, place the plan_hierarchy listed in the step above the environment layer (https://www.puppet.com/docs/pe/2023.4/writing_plans_in_puppet_language_pe.html#using_hiera_with_plans)
+
+Following this create a [static.yaml] file within the code manager


Suggested change

Following this create a [static.yaml] file within the code manager

Create a [static.yaml] file in the environment layer hiera data directory```

MartyEwings · 2023-10-18T10:47:52Z

README.md

+  - '<TEST ID>'                                                                
+``` 
+
+Following this, Indicator ID's within lookup array will be excluded when `running pe_status_check::infra_summary` and `pe_status_check::agent_summary` p


Suggested change

Following this, Indicator ID's within lookup array will be excluded when `running pe_status_check::infra_summary` and `pe_status_check::agent_summary` p

Indicator ID's within array will be excluded when `running pe_status_check::infra_summary` and `pe_status_check::agent_summary` p

MartyEwings · 2023-10-18T11:03:05Z

Ok looks good @Aaronoftheages can you rebase down to one commit and ill merge

Aaronoftheages · 2023-10-18T11:04:43Z

Ok looks good @Aaronoftheages can you rebase down to one commit and ill merge

Will do!

Aaronoftheages added the do not merge label Oct 16, 2023

Aaronoftheages requested a review from a team as a code owner October 16, 2023 18:11

MartyEwings linked an issue Oct 17, 2023 that may be closed by this pull request

lookup indicator_exclusions from hiera #127

Closed

MartyEwings changed the title ~~SUP-3709 - W.I.P Initial test of lookup functionality~~ (SUP-3709) - W.I.P Initial test of lookup functionality Oct 17, 2023

Aaronoftheages changed the title ~~(SUP-3709) - W.I.P Initial test of lookup functionality~~ (SUP-3709) - Indicator Exclusion using code manager and Hiera lookup Oct 17, 2023

Aaronoftheages added enhancement New feature or request and removed do not merge labels Oct 17, 2023

MartyEwings requested changes Oct 18, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

MartyEwings requested changes Oct 18, 2023

View reviewed changes

Exclusion Work for indicator_exclusions using hiera

c5a77d5

Aaronoftheages force-pushed the SUP_3709_Indicator_Exclusions_from_Hiera_pe_status_check branch from 33a3361 to c5a77d5 Compare October 18, 2023 13:55

MartyEwings approved these changes Oct 18, 2023

View reviewed changes

MartyEwings merged commit d787913 into puppetlabs:main Oct 18, 2023
24 of 31 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

(SUP-3709) - Indicator Exclusion using code manager and Hiera lookup #205

(SUP-3709) - Indicator Exclusion using code manager and Hiera lookup #205

Aaronoftheages commented Oct 16, 2023 •

edited

MartyEwings left a comment

MartyEwings Oct 18, 2023

MartyEwings Oct 18, 2023

MartyEwings Oct 18, 2023

Aaronoftheages Oct 18, 2023

MartyEwings Oct 18, 2023

MartyEwings Oct 18, 2023

MartyEwings Oct 18, 2023

MartyEwings Oct 18, 2023

MartyEwings Oct 18, 2023

MartyEwings Oct 18, 2023

MartyEwings commented Oct 18, 2023

Aaronoftheages commented Oct 18, 2023

		See the following [documentation](https://puppet.com/docs/bolt/latest/hiera.html#outside-apply-blocks) for further explanation.

		#### Using indictor_exclusion with a code manager and hiera.yaml


		To utilize the indicator_exclusions with a code manager, place the plan_hierarchy listed in the step above, placing it in the root level [hiera.yaml](https://puppet.com/docs/puppet/latest/hiera_config_yaml_5.html) file.

		Following this create a [static.yaml] file within the code manager data folder `CODE_MANAGER/data/static.yaml`

	To utilize the indicator_exclusions using hiera within the plan, place the plan_hierarchy listed in the step above the environment layer (https://www.puppet.com/docs/pe/2023.4/writing_plans_in_puppet_language_pe.html#using_hiera_with_plans)
	Place the plan_hierarchy listed in the step above, in the environment layer (https://www.puppet.com/docs/pe/latest/writing_plans_in_puppet_language_pe.html#using_hiera_with_plans)

	Following this create a [static.yaml] file within the code manager
	Create a [static.yaml] file in the environment layer hiera data directory```

	Following this, Indicator ID's within lookup array will be excluded when `running pe_status_check::infra_summary` and `pe_status_check::agent_summary` p
	Indicator ID's within array will be excluded when `running pe_status_check::infra_summary` and `pe_status_check::agent_summary` p

(SUP-3709) - Indicator Exclusion using code manager and Hiera lookup #205

(SUP-3709) - Indicator Exclusion using code manager and Hiera lookup #205

Conversation

Aaronoftheages commented Oct 16, 2023 • edited

MartyEwings left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MartyEwings commented Oct 18, 2023

Aaronoftheages commented Oct 18, 2023

Aaronoftheages commented Oct 16, 2023 •

edited