Skip to content

Commit e550e94

Browse files
authored
Merge pull request #58464 from mburke5678/node-add-system-reserved-parameter
OSDOCS#5019: Add note to use kube config to add system-reserved parameter
2 parents ab91bd1 + 8e1e1ee commit e550e94

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

modules/nodes-nodes-resources-configuring-setting.adoc

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,16 @@
66
[id="nodes-nodes-resources-configuring-setting_{context}"]
77
= Manually allocating resources for nodes
88

9-
{product-title} supports the CPU and memory resource types for allocation. The `ephemeral-resource` resource type is supported as well. For the `cpu` type, the resource quantity is specified in units of cores, such as `200m`, `0.5`, or `1`. For `memory` and `ephemeral-storage`, it is specified in units of bytes, such as `200Ki`, `50Mi`, or `5Gi`. By default, the `system-reserved` CPU is `500m` and `system-reserved` memory is `1Gi`.
9+
{product-title} supports the CPU and memory resource types for allocation. The `ephemeral-resource` resource type is also supported. For the `cpu` type, you specify the resource quantity in units of cores, such as `200m`, `0.5`, or `1`. For `memory` and `ephemeral-storage`, you specify the resource quantity in units of bytes, such as `200Ki`, `50Mi`, or `5Gi`. By default, the `system-reserved` CPU is `500m` and `system-reserved` memory is `1Gi`.
1010

11-
As an administrator, you can set these using a custom resource (CR) through a set of `<resource_type>=<resource_quantity>` pairs
11+
As an administrator, you can set these values by using a kubelet config custom resource (CR) through a set of `<resource_type>=<resource_quantity>` pairs
1212
(e.g., `cpu=200m,memory=512Mi`).
1313

14+
[IMPORTANT]
15+
====
16+
You must use a kubelet config CR to manually set resource values. You cannot use a machine config CR.
17+
====
18+
1419
For details on the recommended `system-reserved` values, refer to the link:https://access.redhat.com/solutions/5843241[recommended system-reserved values].
1520

1621
.Prerequisites

nodes/nodes/nodes-nodes-resources-configuring.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ toc::[]
88

99
To provide more reliable scheduling and minimize node resource overcommitment, reserve a portion of the CPU and memory resources for use by the underlying node components, such as `kubelet` and `kube-proxy`, and the remaining system components, such as `sshd` and `NetworkManager`. By specifying the resources to reserve, you provide the scheduler with more information about the remaining CPU and memory resources that a node has available for use by pods. You can allow {product-title} to xref:../../nodes/nodes/nodes-nodes-resources-configuring.adoc#nodes-nodes-resources-configuring-auto_nodes-nodes-resources-configuring[automatically determine the optimal `system-reserved` CPU and memory resources] for your nodes or you can xref:../../nodes/nodes/nodes-nodes-resources-configuring.adoc#nodes-nodes-resources-configuring-setting_nodes-nodes-resources-configuring[manually determine and set the best resources] for your nodes.
1010

11+
[IMPORTANT]
12+
====
13+
To manually set resource values, you must use a kubelet config CR. You cannot use a machine config CR.
14+
====
15+
1116
// The following include statements pull in the module files that comprise
1217
// the assembly. Include any combination of concept, procedure, or reference
1318
// modules required to cover the user story. You can also include other

0 commit comments

Comments
 (0)