-
Notifications
You must be signed in to change notification settings - Fork 1.9k
OCPDOCS 17899 Document Kernel PSI Enablement in OpenShift 4.21 #104869
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
Open
mburke5678
wants to merge
1
commit into
openshift:main
Choose a base branch
from
mburke5678:node-document-kernel-psi
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+77
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * nodes/nodes/nodes-nodes-managing.adoc | ||
|
|
||
| :_mod-docs-content-type: PROCEDURE | ||
| [id="nodes-nodes-psi-enable_{context}"] | ||
| = Enabling Pressure Stall Information (PSI) monitoring | ||
|
|
||
| [role="_abstract"] | ||
| You can enable Linux Pressure Stall Information monitoring by using a `MachineConfig` object. Enabling PSI monitoring makes PSI metrics (pressure stall information) for CPU, memory, and IO available for your cluster. | ||
|
|
||
| [NOTE] | ||
| ==== | ||
| The performance impact of enabling PSI is negligible with the benefit of gaining critical resource pressure visibility for better scheduling and eviction decisions. This was tested on worker nodes (m5.2xl) on the AWS platform. For latency sensitive environments, we suggest testing it before enabling it on production. Enable it on 1 worker first, monitor for the performance impact, and gradually roll out to more workers. | ||
| ==== | ||
|
|
||
| .Prerequisites | ||
|
|
||
| . Obtain the label associated with the static `MachineConfigPool` CR for the type of node you want to configure. | ||
| Perform one of the following steps: | ||
|
|
||
| .. View the machine config pool: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ oc describe machineconfigpool <name> | ||
| ---- | ||
| + | ||
| For example: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ oc describe machineconfigpool worker | ||
| ---- | ||
| + | ||
| .Example output | ||
| [source,yaml] | ||
| ---- | ||
| apiVersion: machineconfiguration.openshift.io/v1 | ||
| kind: MachineConfigPool | ||
| metadata: | ||
| creationTimestamp: 2019-02-08T14:52:39Z | ||
| generation: 1 | ||
| labels: | ||
| custom-kubelet: set-kubelet-config <1> | ||
| ---- | ||
| <1> If a label has been added it appears under `labels`. | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤖 [error] AsciiDocDITA.CalloutList: Callouts are not supported in DITA. |
||
|
|
||
| .. If the label is not present, add a key/value pair: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ oc label machineconfigpool worker custom-kubelet=set-kubelet-config | ||
| ---- | ||
|
|
||
| .Procedure | ||
|
|
||
| . Create a YAML file similar to the following that contains the machine configuration: | ||
| + | ||
| [source,yaml] | ||
| ---- | ||
| apiVersion: machineconfiguration.openshift.io/v1 | ||
| kind: MachineConfig | ||
| metadata: | ||
| labels: | ||
| machineconfiguration.openshift.io/role: <label> | ||
| name: 99-openshift-machineconfig-<label>-kargs | ||
| spec: | ||
| kernelArguments: | ||
| - psi=1 | ||
| ---- | ||
| where: | ||
| + | ||
| `spec.kernelArguments.psi=1` Specifies that Pressure Stall Information (PSI) monitoring is enabled. | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The performance impact to of enabling PSI is negligible with the benefit of gaining critical resource pressure visibility for better scheduling and eviction decisions. This was tested on worker nodes (m5.2xl) on the AWS platform. For latency sensitive environments, we suggest testing it before enabling it on production. Enable it on 1 worker first, monitor for the performance impact, and gradually roll out to more workers. Enabling PSI introduces new metrics per container that can increase the RSS memory usage of prometheus-k8s pods. On a cluster with a big number of containers, monitor the memory usage of prometheus-k8s pods and adjust the resource if needed.