Skip to content

Commit 839beb3

Browse files
authored
Merge pull request #222 from Aaronoftheages/S0024_S0041_S0042_README_Update
(SUP-4724/SUP-4728/SUP-4729) Updating S0024, S0041 and S0042 KB links in README
2 parents 3e12ebf + 165c7c6 commit 839beb3

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,25 @@
11
# puppetlabs-pe_status_check
22

3-
- [puppetlabs-pe_status_check](#puppetlabs-pe_status_check)
3+
- [puppetlabs-pe\_status\_check](#puppetlabs-pe_status_check)
44
- [Description](#description)
55
- [Setup](#setup)
6-
- [What pe_status_check affects](#what-pe_status_check-affects)
6+
- [What pe\_status\_check affects](#what-pe_status_check-affects)
77
- [Setup requirements](#setup-requirements)
8-
- [Beginning with pe_status_check](#beginning-with-pe_status_check)
8+
- [Beginning with pe\_status\_check](#beginning-with-pe_status_check)
99
- [Usage](#usage)
10-
- [Enabling agent_status_check](#enabling-agent_status_check)
11-
- [Disabling agent_status_check](#disabling-agent_status_check)
10+
- [Enabling agent\_status\_check](#enabling-agent_status_check)
11+
- [Disabling agent\_status\_check](#disabling-agent_status_check)
1212
- [Reporting Options](#reporting-options)
13-
- [Class declaration pe_status_check (optional)](#class-declaration-pe_status_check-optional)
13+
- [Class declaration pe\_status\_check (optional)](#class-declaration-pe_status_check-optional)
1414
- [Ad-hoc Report (Plans)](#ad-hoc-report-plans)
1515
- [Using a Puppet Query to report status.](#using-a-puppet-query-to-report-status)
1616
- [Setup Requirements](#setup-requirements-1)
17+
- [Using Static Hiera data to populate indicator\_exclusions when executing plans](#using-static-hiera-data-to-populate-indicator_exclusions-when-executing-plans)
1718
- [Running the plans](#running-the-plans)
1819
- [Reference](#reference)
19-
- [Fact: pe_status_check_role](#fact-pe_status_check_role)
20-
- [Fact: pe_status_check](#fact-pe_status_check)
21-
- [Fact: agent_status_check](#fact-agent_status_check)
20+
- [Fact: pe\_status\_check\_role](#fact-pe_status_check_role)
21+
- [Fact: pe\_status\_check](#fact-pe_status_check)
22+
- [Fact: agent\_status\_check](#fact-agent_status_check)
2223
- [How to report an issue or contribute to the module](#how-to-report-an-issue-or-contribute-to-the-module)
2324
- [Supporting Content](#supporting-content)
2425
- [Articles](#articles)
@@ -264,7 +265,7 @@ Refer below for next steps when any indicator reports a `false`.
264265
|S0021|Determines if free memory is less than 10%.| Ensure your system hardware availability matches the [recommended configuration](https://puppet.com/docs/pe/latest/hardware_requirements.html#hardware_requirements), note this assumes no third-party software using significant resources, adapt requirements accordingly for third-party requirements. Examine metrics from the server and determine if the memory issue is persistent | If you have issues with memory utilization in Puppet Enterprise that can not be explained, open a Support ticket, referencing S0021 and provide the output of the [support script](https://puppet.com/docs/pe/latest/getting_support_for_pe.html#pe_support_script)
265266
| S0022 | Determines if there is a valid Puppet Enterprise license in place at `/etc/puppetlabs/license.key` on the primary server which is not expiring in the next 90 days. | [Get help with Puppet Enterprise license issues](https://support.puppet.com/hc/en-us/articles/360017933313)| Open a Support ticket referencing S0022 and provide the output of the following commands `ls -la /etc/puppetlabs/license.key` and `cat /etc/puppetlabs/license.key`. |
266267
| S0023 | Determines if certificate authority CRL expires in the next 90 days. | The solution is to reissue a new CRL from the Puppet CA, note this will also remove any revoked certificates. To do this follow the instructions in [this module](https://forge.puppet.com/modules/m0dular/crl_truncate) | Open a Support ticket referencing S0023 and provide [support script](https://puppet.com/docs/pe/latest/getting_support_for_pe.html#pe_support_script) output from the primary server, and errors or output collected from the resolution steps |
267-
| S0024 | Determines if there are files in the puppetdb discard directory newer than 1 week old | Recent files indicate an issue that causes PuppetDB to reject incoming data. Investigate Puppetdb logs at the time the data was rejected to find a cause, | If you are unable to determine a reason for the rejections from logging, Open a Support ticket referencing S0024 and provide a copy of the PuppetDB log for the time in question, along with a sample of the most recent file in the following directory `/opt/puppetlabs/server/data/puppetdb/stockpile/discard/`|
268+
| S0024 | Determines if there are files in the puppetdb discard directory newer than 1 week old | see [documentation]() | If you are unable to determine a reason for the rejections from logging, Open a Support ticket referencing S0024 and provide a copy of the PuppetDB log for the time in question, along with a sample of the most recent file in the following directory `/opt/puppetlabs/server/data/puppetdb/stockpile/discard/`|
268269
| S0025 | Determines if the host copy of the CRL expires in the next 90 days. | If the Output of S0023 on the primary server is also false use the resolution steps in S0023. If S0023 on the Primary is True, follow [this article](https://support.puppet.com/hc/en-us/articles/7631166251415) | Open a Support ticket referencing S0025 and provide any errors you received in following the resolution steps | |
269270
| S0026 | Determines if pe-puppetserver JVM Heap-Memory is set to an inefficient value. | Due to an odditity in how JVM memory is utilised, most applications are unable to consume heap memory between ~31GB and ~48GB as such is if you have heap memory set within this value, you should reduce it to more efficiently allocate server resources. To set heap refer to [Increase the Java heap size for this service.](https://support.puppet.com/hc/en-us/articles/360015511413) | |
270271
| S0027 | Determines if if pe-puppetdb JVM Heap-Memory is set to an inefficient value. | Due to an odditity in how JVM memory is utilised, most applications are unable to consume heap memory between ~31GB and ~48GB as such is if you have heap memory set within this value, you should reduce it to more efficiently allocate server resources. To set heap refer to [Increase the Java heap size for this service.](https://support.puppet.com/hc/en-us/articles/360015511413) | |
@@ -278,8 +279,8 @@ Refer below for next steps when any indicator reports a `false`.
278279
| S0038 | Determines whether the number of environments within `$codedir/environments` is less than 100 | Having a large number of code environments can negatively affect Puppet Server performance. [See the Configuring Puppet Server documentation for more information.](https://puppet.com/docs/pe/latest/config_puppetserver.html#configuring_and_tuning_puppet_server) You should examine if you need them all, any unused environments should be removed. If all are required you can ignore this warning. |
279280
| S0039 | Determines if Puppets Server has reached its `queue-limit-hit-rate`,and is sending messages to agents. | [Check the max-queued-requests article for more information.](https://support.puppet.com/hc/en-us/articles/115003769433) | If the article is unable to solve your issue, open a Support ticket referencing S0039, indicating the investigation so far, and any issues you encountered, then provide the [support script](https://puppet.com/docs/pe/latest/getting_support_for_pe.html#pe_support_script) output from the primary server.
280281
| S0040 | Determines if PE is collecting system metrics. | If system metrics are not collected by default, the sysstat package is not installed on the impacted PE infrastructure component. Install the package and set the parameter `puppet_enterprise::enable_system_metrics_collection` to true. [See the documentation.](https://puppet.com/docs/pe/latest/getting_support_for_pe.html#puppet_metrics_collector) | After system metrics are configured, you do not see any files in `/var/log/sa` or if the `/var/log/sa` directory does not exist, open a Support ticket. |
281-
| S0041 | Determines if the pxp broker on a compiler has an established connection to another pxp broker | To resolve a connection issue from a compiler to a pcp broker examine the following log `/var/log/puppetlabs/puppetserver/pcp-broker.log` for an explanation, Compilers should be attempting to make a connection to port 8143 on the primary server, ssl can not be terminated on a network appliance and must passthrough directly to the primary server. Ensure the connnection attempt is not to another compiler in the pool | If unable to make a connection to a broker, raise a ticket with the support team quoting S0041 and attaching the file `/var/log/puppetlabs/puppetserver/pcp-broker.log` along with the conclusions of your investigation so far |
282-
| S0042 | Determines if the pxp-agent has an established connection to a pxp broker | Ensure the pxp-agent service is running. Check S0002 can make that determination. if running check `/var/log/puppetlabs/pxp-agent/pxp-agent.log` (on *nix) or `C:/ProgramData/PuppetLabs/pxp-agent/var/log/pxp-agent.log` (on Windows), for connection issues, first ensuring the agent is connecting to the proper endpoint, for example, a compiler and not the primary. This fact can also be used as a target filter for running tasks, ensuring time is not wasted sending instructions to agents not connected to a broker | If unable to make a connection to a broker, raise a ticket with the support team quoting S0042 and attaching the file `/var/log/puppetlabs/pxp-agent/pxp-agent.log` (on *nix) or `C:/ProgramData/PuppetLabs/pxp-agent/var/log/pxp-agent.log` (on Windows), along with the conclusions of your investigation so far |
282+
| S0041 | Determines if the pxp broker on a compiler has an established connection to another pxp broker | See [documenation](https://portal.perforce.com/s/article/pxp-broker-cannot-connect-to-other-broker?name=000007253) | If unable to make a connection to a broker, raise a ticket with the support team quoting S0041 and attaching the file `/var/log/puppetlabs/puppetserver/pcp-broker.log` along with the conclusions of your investigation so far |
283+
| S0042 | Determines if the pxp-agent has an established connection to a pxp broker | See [documenation](https://portal.perforce.com/s/article/pxp-agent-cannot-connect-to-pxp-broker) | If unable to make a connection to a broker, raise a ticket with the support team quoting S0042 and attaching the file `/var/log/puppetlabs/pxp-agent/pxp-agent.log` (on *nix) or `C:/ProgramData/PuppetLabs/pxp-agent/var/log/pxp-agent.log` (on Windows), along with the conclusions of your investigation so far |
283284
| S0043 | Determines if there are nodes with Puppet agent versions ahead of the primary server | Agent nodes should not be running Puppet agent versions ahead of infrastructure nodes. Instead consider upgrading PE so that PE package management contains the desired Puppet agent version. See the [upgrading PE](https://puppet.com/docs/pe/latest/upgrading_pe.html) and [upgrading agents](https://puppet.com/docs/latest/upgrading_agents.html) documentation for more information. | If you are unable to determine why the indicator is evaluating to `false` or have questions about Puppet agent versions, open a support ticket and reference S0043. |
284285
| S0044 | Determines if Puppet Servers are using the the PE classifier for the node data plugin (node terminus) | Due to performance optimizations, it is recommended to use the PE classifier plugin instead of external node classifier (ENC) scripts or applications. See the [node_terminus configuration setting documentation](https://www.puppet.com/docs/puppet/7/configuration.html#node-terminus) for more information. | If you have additional questions about the node_terminus configuration setting, open a support ticket and reference S0044. |
285286
| S0045 | Determines if Puppet Servers are configured with an excessive number of JRubies. | Because each JRuby instance consumes additional memory, having too many can reduce the amount of heap space available to Puppet server and cause excessive garbage collections. While it is possible to increase the heap along with the number of JRubies, we have observered diminishing returns with more than 12 JRubies and therefore recommend an upper limit of 12. We also recommend allocating between 1 - 2gb of heap memory for each JRuby. | If you would like to measure the effects of changing JRubies and heap settings, use the [Puppet Operational Dashboards module](https://forge.puppet.com/modules/puppetlabs/puppet_operational_dashboards/readme) to configure a metrics stack and Grafana dashboards for viewing the metrics. If you still have performance issues or further questions, open a support ticket and reference S0045. |

0 commit comments

Comments
 (0)