Merge pull request #71924 from mburke5678/pod-per-core-max-pods-snippet

Add Snippet for maxPods and podsPerCore

Author: mburke5678

modules/recommended-node-host-practices.adoc

@@ -9,50 +9,4 @@ The {product-title} node configuration file contains important options. For
 example, two parameters control the maximum number of pods that can be scheduled
 to a node: `podsPerCore` and `maxPods`.
 
-When both options are in use, the lower of the two values limits the number of
-pods on a node. Exceeding these values can result in:
-
-* Increased CPU utilization.
-* Slow pod scheduling.
-* Potential out-of-memory scenarios, depending on the amount of memory in the node.
-* Exhausting the pool of IP addresses.
-* Resource overcommitting, leading to poor user application performance.
-
-[IMPORTANT]
-====
-In Kubernetes, a pod that is holding a single container actually uses two
-containers. The second container is used to set up networking prior to the
-actual container starting. Therefore, a system running 10 pods will actually
-have 20 containers running.
-====
-
-[NOTE]
-====
-Disk IOPS throttling from the cloud provider might have an impact on CRI-O and kubelet.
-They might get overloaded when there are large number of I/O intensive pods running on
-the nodes. It is recommended that you monitor the disk I/O on the nodes and use volumes
-with sufficient throughput for the workload.
-====
-
-`podsPerCore` sets the number of pods the node can run based on the number of
-processor cores on the node. For example, if `podsPerCore` is set to `10` on a
-node with 4 processor cores, the maximum number of pods allowed on the node will
-be `40`.
-
-[source,yaml]
-----
-kubeletConfig:
-  podsPerCore: 10
-----
-
-Setting `podsPerCore` to `0` disables this limit. The default is `0`.
-`podsPerCore` cannot exceed `maxPods`.
-
-`maxPods` sets the number of pods the node can run to a fixed value, regardless
-of the properties of the node.
-
-[source,yaml]
-----
- kubeletConfig:
-    maxPods: 250
-----
+include::snippets/nodes-pods-core-max-pods.adoc[]

nodes/nodes/nodes-nodes-managing-max-pods.adoc

@@ -10,28 +10,7 @@ In {product-title}, you can configure the number of pods that can run on a node
 processor cores on the node, a hard limit or both. If you use both options,
 the lower of the two limits the number of pods on a node.
 
-Exceeding these values can result in:
-
-* Increased CPU utilization by {product-title}.
-* Slow pod scheduling.
-* Potential out-of-memory scenarios, depending on the amount of memory in the node.
-* Exhausting the IP address pool.
-* Resource overcommitting, leading to poor user application performance.
-
-[NOTE]
-====
-A pod that is holding a single container actually uses two
-containers. The second container sets up networking prior to the
-actual container starting. As a result, a node running 10 pods actually
-has 20 containers running.
-====
-
-The `podsPerCore` parameter limits the number of pods the node can run based on the number of
-processor cores on the node. For example, if `podsPerCore` is set to `10` on
-a node with 4 processor cores, the maximum number of pods allowed on the node is 40.
-
-The `maxPods` parameter limits the number of pods the node can run to a fixed value, regardless
-of the properties of the node.
+include::snippets/nodes-pods-core-max-pods.adoc[]
 
 // The following include statements pull in the module files that comprise
 // the assembly. Include any combination of concept, procedure, or reference

snippets/nodes-pods-core-max-pods.adoc

@@ -0,0 +1,54 @@
+// Text snippet included in the following modules:
+//
+// * nodes/nodes/nodes-nodes-managing-max-pods.adoc
+// * modules/recommended-node-host-practices.adoc
+
+:_mod-docs-content-type: SNIPPET
+
+When both options are in use, the lower of the two values limits the number of
+pods on a node. Exceeding these values can result in:
+
+* Increased CPU utilization.
+* Slow pod scheduling.
+* Potential out-of-memory scenarios, depending on the amount of memory in the node.
+* Exhausting the pool of IP addresses.
+* Resource overcommitting, leading to poor user application performance.
+
+[IMPORTANT]
+====
+In Kubernetes, a pod that is holding a single container actually uses two
+containers. The second container is used to set up networking prior to the
+actual container starting. Therefore, a system running 10 pods will actually
+have 20 containers running.
+====
+
+[NOTE]
+====
+Disk IOPS throttling from the cloud provider might have an impact on CRI-O and kubelet.
+They might get overloaded when there are large number of I/O intensive pods running on
+the nodes. It is recommended that you monitor the disk I/O on the nodes and use volumes
+with sufficient throughput for the workload.
+====
+
+The `podsPerCore` parameter sets the number of pods the node can run based on the number of
+processor cores on the node. For example, if `podsPerCore` is set to `10` on a
+node with 4 processor cores, the maximum number of pods allowed on the node will
+be `40`.
+
+[source,yaml]
+----
+kubeletConfig:
+  podsPerCore: 10
+----
+
+Setting `podsPerCore` to `0` disables this limit. The default is `0`.
+The value of the `podsPerCore` parameter cannot exceed the value of the `maxPods` parameter.
+
+The `maxPods` parameter sets the number of pods the node can run to a fixed value, regardless
+of the properties of the node.
+
+[source,yaml]
+----
+ kubeletConfig:
+    maxPods: 250
+----