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

(MAINT) Edit indicator descriptions for consistent style and accurate grammar #210

Merged
merged 3 commits into from
Nov 16, 2023
Merged

(MAINT) Edit indicator descriptions for consistent style and accurate grammar #210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b1142e8
Update static.yaml
J-Hunniford Nov 14, 2023
ce29c63
Update init.pp
J-Hunniford Nov 15, 2023
5c6feed
Update pe_status_check_spec.rb
J-Hunniford Nov 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 44 additions & 44 deletions data/static.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,49 +1,49 @@
pe_status_check::checks:
S0001: "Determines if Puppet agent Service is running"
S0002: "Determines if pxp-agent Service is running"
S0003: "Determines if Infrastructure components are running in NOOP"
S0004: "Determines if the status endpoint for puppet server returns all is well"
S0005: "Determines if CA expires within 90 days"
S0006: "Determines if Puppet Metrics Collector is Enabled and collecting Metrics"
S0007: "Determines if there is at least 20% disk free on postgres Data partition"
S0008: "Determines if there is at least 20% disk free on the Codedir Data Partition"
S0009: "Determines if Pe-puppetsever Service is Running and Enabled on relevant components"
S0010: "Determines if Pe-puppetdb Service is Running and Enabled on relevant components"
S0011: "Determines if Pe-postgres Service is Running and Enabled on relevant components"
S0012: "Determines if Puppet produced a report within the last run interval"
S0013: "Determines if a catalog successfully applied on Puppet Agent Last run"
S0014: "Determines if anything in the command queue is older than a Puppet Run Interval"
S0015: "Determines if the infrastructure agent host certificate is expiring within 90 days"
S0016: "Determines if there are any OutOfMemory errors in the Puppetserver JVM"
S0017: "Determines if there are any OutOfMemory errors in the Puppetdb JVM"
S0018: "Determines if there are any OutOfMemory errors in the Orchestrator JVM"
S0019: "Determines if there are sufficient jrubies available to serve agents"
S0020: "Determines if the Console status api reports all services as running"
S0021: "Determines if free memory is less than 10%"
S0022: "Determines if there is a valid Puppet Enterprise license in place at /etc/puppetlabs/license.key on your primary which is not going to expire in the next 90 days"
S0023: "Determines if the CA CRL expires within 90 days"
S0024: "Determines if there are files in the puppetdb discard directory newer than 1 week old"
S0025: "Determines if the host copy of the CRL expires within 90 days"
S0026: "Determines if the Puppet Server JVM Heap-Max is set to an inefficient volume"
S0027: "Determines if the Puppetdb JVM Heap-Max is set to an inefficient volume"
S0001: "Checks that Puppet agent service is running"
S0002: "Checks that pxp-agent service is running"
S0003: "Checks that noop mode is not enabled for infrastructure components"
S0004: "Checks that the status endpoint for Puppet Server is returning an error-free status"
S0005: "Checks whether CA expires within 90 days"
S0006: "Checks that Puppet metrics collector is enabled and collecting metrics"
S0007: "Checks that there is at least 20% disk space free on PostgreSQL data partition"
S0008: "Checks that there is at least 20% disk space free on the codedir data partition"
S0009: "Checks that pe-puppetsever service is running and enabled on relevant components"
S0010: "Checks that pe-puppetdb service is running and enabled on relevant components"
S0011: "Checks that pe-postgres service is running and enabled on relevant components"
S0012: "Checks that Puppet produced a report within the last run interval"
S0013: "Checks that a catalog was successfully applied on last Puppet agent run"
S0014: "Checks that no items in the command queue are older than a Puppet run interval"
S0015: "Checks whether the infrastructure agent host certificate expires within 90 days"
S0016: "Checks that there are no OutOfMemory errors in the Puppet Server JVM"
S0017: "Checks that there are no OutOfMemory errors in the PuppetDB JVM"
S0018: "Checks that there are no OutOfMemory errors in the Orchestrator JVM"
S0019: "Checks that there are sufficient JRubies available to serve agents"
S0020: "Checks that the console status API reports all services as running"
S0021: "Checks that free memory is more than 10%"
S0022: "Checks that there is a valid Puppet Enterprise license in place at /etc/puppetlabs/license.key on your primary which is not going to expire in the next 90 days"
S0023: "Checks whether the CA CRL expires within 90 days"
S0024: "Checks that there are no files in the PuppetDB discard directory newer than 1 week old"
S0025: "Checks whether the host copy of the CRL expires within 90 days"
S0026: "Checks that the Puppet Server JVM heap max is set to an efficient volume"
S0027: "Checks that the Puppetdb JVM heap max is set to an efficient volume"
S0028: "Determines"
S0029: "Determines if the number of current connections to Postgresql DB is approaching 90% of the max_connections defined"
S0030: "Determines when infrastructure components that run with the setting use_cached_catalog are set to true"
S0031: "Determines if old PE agent packages still exist on the Primary server"
S0029: "Checks whether the number of current connections to PostgreSQL DB is approaching 90% of the max_connections defined"
S0030: "Checks that use_cached_catalog is set to false for infrastructure nodes"
S0031: "Checks whether old PE agent packages still exist on the primary server"
S0032: "Determines"
S0033: "Determines if modern Hiera 5 is in use"
S0034: "Determines if PE installation has not been upgraded within a year"
S0035: "Determines if puppet module list is returning any warnings"
S0036: "Determines if max-queued-requests is set above 150"
S0033: "Checks that modern Hiera 5 is in use"
S0034: "Checks that the PE installation was upgraded within the past year"
S0035: "Checks that Puppet module list returns no warnings"
S0036: "Checks that max-queued-requests is set under 150"
S0037: "Determines"
S0038: "Determines whether the number of environments within $codedir/environments is less than 100"
S0039: "Determines if Puppetserver has a non zero queue-limit-hit-rate"
S0040: "Determines if the deployment is collecting system metrics"
S0041: "Determines if the pxp broker has an established connection to another pxp broker"
S0042: "Determines if the pxp-agent has an established connection to a pxp broker"
S0044: "Determines if Puppet Servers are using the the PE classifier for the node data plugin"
AS001: "Determines if the agent host certificate is expiring within 90 days"
AS002: "Determines if the pxp-agent has an established connection to a pxp broker"
AS003: "Determines the certname configuration parameter is incorrectly set outside of the [main] section of the puppet.conf file"
AS004: "Determines if the host copy of the CRL expires within 90 days"
S0038: "Checks that the number of environments within $codedir/environments is less than 100"
S0039: "Checks that Puppet Server has a non zero queue-limit-hit-rate"
S0040: "Checks that the deployment is collecting system metrics"
S0041: "Checks that the pxp broker has an established connection to another pxp broker"
S0042: "Checks that the pxp-agent has an established connection to a pxp broker"
S0044: "Checks that Puppet Servers are using the the PE classifier for the node data plugin"
AS001: "Checks whether the agent host certificate expires within 90 days"
AS002: "Checks that the pxp-agent has an established connection to a pxp broker"
AS003: "Checks that the certname configuration parameter is correctly set inside the [main] section of the puppet.conf file"
AS004: "Checks whether the host copy of the CRL expires within 90 days"

2 changes: 1 addition & 1 deletion manifests/init.pp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
$negatives.each |$indicator, $_v| {
$msg = $checks[$indicator]
notify { "pe_status_check ${indicator}":
message => "${indicator} is at fault. The indicator ${indicator} ${msg}, refer to documentation for required action",
message => "${indicator} is at fault. The indicator ${indicator} ${msg}. Refer to documentation for required action.",
}
}
}
2 changes: 1 addition & 1 deletion spec/acceptance/pe_status_check_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
end
# Test Confirms all facts are false which is another indicator the class is performing correctly
describe 'check no pe_status_check fact is false' do
it 'if idempotent all facts should be true' do

Check failure on line 20 in spec/acceptance/pe_status_check_spec.rb

View workflow job for this annotation

GitHub Actions / PE latest Testing / RedHat-8, 2023.4.0 

pe_status_check class activates module default parameters check no pe_status_check fact is false if idempotent all facts should be true

On host `34.168.253.41'
Failure/Error: expect(host_inventory['facter']['pe_status_check'].filter { |_k, v| !v }).to be_empty
  expected `{"S0019"=>false}.empty?` to be truthy, got false
expect(host_inventory['facter']['pe_status_check'].size).to eq(41)
expect(host_inventory['facter']['pe_status_check'].filter { |_k, v| !v }).to be_empty
end
Expand All @@ -34,7 +34,7 @@
run_shell('puppet resource service puppet ensure=stopped')
result = run_shell('facter -p pe_status_check.S0001')
output = apply_manifest(pp).stdout
expect(output).to match('S0001 is at fault. The indicator S0001 Determines if Puppet agent Service is running, refer to documentation for required action')
expect(output).to match('S0001 is at fault. The indicator S0001 Checks that Puppet agent service is running. Refer to documentation for required action.')
expect(result.stdout).to match(%r{false})
end
it 'if in the exclude list a parameter should not notify' do
Expand Down
Loading