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.

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

(SUP-4585) Update Readme for missing description of S0020 #207

Merged

Conversation

Aaronoftheages
Copy link
Contributor

Quick update to the readme, with s0020 marked out and self service steps marked out by @jordi-garcia.

@Aaronoftheages Aaronoftheages added the documentation Improvements or additions to documentation label Oct 24, 2023
@Aaronoftheages Aaronoftheages requested a review from a team as a code owner October 24, 2023 14:54
Copy link
Collaborator

@MartyEwings MartyEwings left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in line changes requested

README.md Outdated Show resolved Hide resolved
README.md Outdated
@@ -260,6 +260,7 @@ Refer below for next steps when any indicator reports a `false`.
| S0017 | Determines if there are any `OutOfMemory` errors in the `puppetdb` log. | [Increase the Java heap size for that service.](https://support.puppet.com/hc/en-us/articles/360015511413) | Open a Support ticket referencing S0017 and provide [puppet metrics](https://support.puppet.com/hc/en-us/articles/231751308), `/var/log/puppetlabs/puppetdb/puppetdb.log`, and the output of `puppet infra tune`.|
| S0018 | Determines if there are any `OutOfMemory` errors in the `orchestrator` log. | [Increase the Java heap size for that service.](https://support.puppet.com/hc/en-us/articles/360015511413) | Open a Support ticket referencing S0018 and provide [puppet metrics](https://support.puppet.com/hc/en-us/articles/231751308), `/var/log/puppetlabs/orchestration-services/orchestration-services.log`, and output of `puppet infra tune`.|
|S0019|Determines if there are sufficent jRubies available to serve agents.| Insufficient jRuby availability results in queued puppet agents and overall poor system performance. There can be many causes: [Insufficient server tuning for load](https://support.puppet.com/hc/en-us/articles/360013148854), [a thundering herd](https://support.puppet.com/hc/en-us/articles/215729277), and [insufficient system resources for scale.](https://puppet.com/docs/pe/latest/hardware_requirements.html#hardware_requirements) | If self-sevice fails to resolve the issue, open a ticket referencing S0019 and provide a description of actions so far and the output of the [support script.](https://puppet.com/docs/pe/latest/getting_support_for_pe.html#pe_support_script)
| S0020 | Determines if the Console status api reports all services as running | Checks Infrastracture services API for classifier information - Distinct to S0004. Which ever service returns in a state that is not running, examine the logging for that service to indicate the fault. | Open a Support ticket referencing S0020 and provide [Support Script](https://www.puppet.com/docs/pe/2023.4/getting_support_for_pe.html#pe_support_script-running-support-script) from your primary |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Checks Infrastracture services API for classifier information - Distinct to S0004. Which ever service returns in a state that is not running, examine the logging for that service to indicate the fault.

This section is still an incorrect description with no steps for the customer to execute, please change this to steps showing them how to identify which service is not running and links to the docs page for where logs reside with instructions to examine

Open a Support ticket referencing S0020 and provide Support Script from your primary

For this one i would state something like "please provide the name of the service that failed the approximate time it failed, and any error messages from the logging you examine" as well as the support script part you have here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's fine, I'll rewrite it as you've recommended it.

Self Service Steps added

Exclusion Work for indicator_exclusions using hiera

Release prep v4.0.0

Section on what to include for support desk

S0020 self service steps updated, similar process as S0004
@MartyEwings MartyEwings added bug Something isn't working and removed documentation Improvements or additions to documentation labels Oct 26, 2023
@MartyEwings MartyEwings merged commit 18b142f into puppetlabs:main Oct 26, 2023
1 check passed
@MartyEwings MartyEwings changed the title Sup 4585 readme update s0020 (SUP-4585) Update Readme for missing description of S0020 Oct 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants