Merge pull request #62484 from mburke5678/nodes-scheduler-fix-errors

NodesScheduler docs fixes during ROSA review

Author: mburke5678

modules/nodes-cluster-overcommit-configure-nodes.adoc

@@ -32,7 +32,9 @@ $ sysctl -a |grep commit
 .Example output
 [source,terminal]
 ----
-vm.overcommit_memory = 1
+#...
+vm.overcommit_memory = 0
+#...
 ----
 
 [source,terminal]
@@ -43,7 +45,9 @@ $ sysctl -a |grep panic
 .Example output
 [source,terminal]
 ----
+#...
 vm.panic_on_oom = 0
+#...
 ----
 
 [NOTE]

modules/nodes-scheduler-node-affinity-about.adoc

@@ -44,6 +44,7 @@ spec:
   containers:
   - name: with-node-affinity
     image: docker.io/ocpqe/hello-pod
+#...
 ----
 
 <1> The stanza to configure node affinity.
@@ -75,6 +76,7 @@ spec:
   containers:
   - name: with-node-affinity
     image: docker.io/ocpqe/hello-pod
+#...
 ----
 
 <1> The stanza to configure node affinity.

modules/nodes-scheduler-node-affinity-configuring-preferred.adoc

@@ -19,32 +19,43 @@ The following steps demonstrate a simple configuration that creates a node and a
 $ oc label node node1 e2e-az-name=e2e-az3
 ----
 
-. In the `Pod` spec, use the `nodeAffinity` stanza to configure the `preferredDuringSchedulingIgnoredDuringExecution` parameter:
+. Create a pod with a specific label:
 +
-.. Specify a weight for the node, as a number 1-100. The node with highest weight is preferred.
+.. Create a YAML file with the following content:
 +
-.. Specify the key and values that must be met. If you want the new pod to be scheduled on the node you edited, use the same `key` and `value` parameters as the label in the node:
+[NOTE]
+====
+You cannot add an affinity directly to a scheduled pod.
+====
 +
 [source,yaml]
 ----
+apiVersion: v1
+kind: Pod
+metadata:
+  name: s1
 spec:
-  affinity:
+  affinity: <1>
     nodeAffinity:
-      preferredDuringSchedulingIgnoredDuringExecution:
-      - weight: 1
+      preferredDuringSchedulingIgnoredDuringExecution: <2>
+      - weight: <3>
         preference:
           matchExpressions:
-          - key: e2e-az-name
-            operator: In
+          - key: e2e-az-name <4>
             values:
             - e2e-az3
+            operator: In <5>
+#...
 ----
-+
-.. Specify an `operator`. The operator can be `In`, `NotIn`, `Exists`, `DoesNotExist`, `Lt`, or `Gt`. For example, use the Operator `In` to require the label to be in the node.
+<1> Adds a pod affinity.
+<2> Configures the `preferredDuringSchedulingIgnoredDuringExecution` parameter.
+<3> Specifies a weight for the node, as a number 1-100. The node with highest weight is preferred.
+<4> Specifies the `key` and `values` that must be met. If you want the new pod to be scheduled on the node you edited, use the same `key` and `values` parameters as the label in the node.
+<5> Specifies an `operator`. The operator can be `In`, `NotIn`, `Exists`, or `DoesNotExist`. For example, use the operator `In` to require the label to be in the node.
 
-. Create the pod.
+.. Create the pod.
 +
 [source,terminal]
 ----
-$ oc create -f e2e-az3.yaml
+$ oc create -f <file-name>.yaml
 ----

modules/nodes-scheduler-node-affinity-configuring-required.adoc

@@ -31,34 +31,47 @@ metadata:
   name: <node_name>
   labels:
     e2e-az-name: e2e-az1
+#...
 ----
 ====
 
-. In the `Pod` spec, use the `nodeAffinity` stanza to configure the `requiredDuringSchedulingIgnoredDuringExecution` parameter:
+. Create a pod with a specific label in the pod spec:
 +
-.. Specify the key and values that must be met. If you want the new pod to be scheduled on the node you edited, use the same `key` and `value` parameters as the label in the node.
+.. Create a YAML file with the following content:
 +
-.. Specify an `operator`. The operator can be `In`, `NotIn`, `Exists`, `DoesNotExist`, `Lt`, or `Gt`. For example, use the operator `In` to require the label to be in the node:
+[NOTE]
+====
+You cannot add an affinity directly to a scheduled pod.
+====
 +
 .Example output
 [source,yaml]
 ----
+apiVersion: v1
+kind: Pod
+metadata:
+  name: s1
 spec:
-  affinity:
+  affinity: <1>
     nodeAffinity:
-      requiredDuringSchedulingIgnoredDuringExecution:
+      requiredDuringSchedulingIgnoredDuringExecution: <2>
         nodeSelectorTerms:
         - matchExpressions:
-          - key: e2e-az-name
-            operator: In
+          - key: e2e-az-name <3>
             values:
             - e2e-az1
             - e2e-az2
+            operator: In <4>
+#...
 ----
+<1> Adds a pod affinity.
+<2> Configures the `requiredDuringSchedulingIgnoredDuringExecution` parameter.
+<3> Specifies the `key` and `values` that must be met. If you want the new pod to be scheduled on the node you edited, use the same `key` and `values` parameters as the label in the node.
+<4> Specifies an `operator`. The operator can be `In`, `NotIn`, `Exists`, or `DoesNotExist`. For example, use the operator `In` to require the label to be in the node.
 
-. Create the pod:
+.. Create the pod:
 +
 [source,terminal]
 ----
-$ oc create -f e2e-az2.yaml
+$ oc create -f <file-name>.yaml
 ----

modules/nodes-scheduler-node-affinity-example.adoc

@@ -2,7 +2,7 @@
 //
 // * nodes/nodes-scheduler-node-affinity.adoc
 
-[id="nodes-scheduler-node-affinity-examples_{context}"]
+[id="nodes-scheduler-node-affinity-example_{context}"]
 = Sample node affinity rules
 
 The following examples demonstrate node affinity.
@@ -31,6 +31,7 @@ metadata:
   name: <node_name>
   labels:
     zone: us
+#...
 ----
 ====
 
@@ -61,6 +62,7 @@ spec:
               operator: In
               values:
               - us
+#...
 ----
 
 * The pod-s1 pod can be scheduled on Node1:
@@ -101,6 +103,7 @@ metadata:
   name: <node_name>
   labels:
     zone: emea
+#...
 ----
 ====
 
@@ -131,6 +134,7 @@ spec:
               operator: In
               values:
               - us
+#...
 ----
 
 * The pod-s1 pod cannot be scheduled on Node1:

modules/nodes-scheduler-node-selectors-about.adoc

@@ -62,6 +62,7 @@ metadata:
     kubernetes.io/arch: amd64
     region: east <1>
     type: user-node
+#...
 ----
 <1> Labels to match the pod node selector.
 endif::openshift-origin[]
@@ -72,7 +73,7 @@ ifdef::openshift-origin[]
 kind: Node
 apiVersion: v1
 metadata:
-  name: ip-10-0-131-14.ec2.internal
+  name: s1
   selfLink: /api/v1/nodes/ip-10-0-131-14.ec2.internal
   uid: 7bc2580a-8b8e-11e9-8e01-021ab4174c74
   resourceVersion: '478704'
@@ -89,6 +90,7 @@ metadata:
     kubernetes.io/arch: amd64
     region: east <1>
     type: user-node
+#...
 ----
 <1> Labels to match the pod node selector.
 endif::openshift-origin[]
@@ -100,13 +102,14 @@ A pod has the `type: user-node,region: east` node selector:
 ----
 apiVersion: v1
 kind: Pod
-
-....
-
+metadata:
+  name: s1
+#...
 spec:
   nodeSelector: <1>
     region: east
     type: user-node
+#...
 ----
 <1> Node selectors to match the node label. The node must have a label for each node selector.
 +
@@ -126,11 +129,10 @@ apiVersion: config.openshift.io/v1
 kind: Scheduler
 metadata:
   name: cluster
-...
-
+#...
 spec:
   defaultNodeSelector: type=user-node,region=east
-...
+#...
 ----
 +
 A node in that cluster has the `type=user-node,region=east` labels:
@@ -142,24 +144,25 @@ apiVersion: v1
 kind: Node
 metadata:
   name: ci-ln-qg1il3k-f76d1-hlmhl-worker-b-df2s4
-...
+#...
   labels:
     region: east
     type: user-node
-...
+#...
 ----
 +
 .Example `Pod` object with a node selector
 [source,terminal]
 ----
 apiVersion: v1
 kind: Pod
-...
-
+metadata:
+  name: s1
+#...
 spec:
   nodeSelector:
     region: east
-...
+#...
 ----
 +
 When you create the pod using the example pod spec in the example cluster, the pod is created with the cluster-wide node selector and is scheduled on the labeled node:
@@ -192,7 +195,7 @@ metadata:
   name: east-region
   annotations:
     openshift.io/node-selector: "region=east"
-...
+#...
 ----
 +
 The following node has the `type=user-node,region=east` labels:
@@ -204,11 +207,11 @@ apiVersion: v1
 kind: Node
 metadata:
   name: ci-ln-qg1il3k-f76d1-hlmhl-worker-b-df2s4
-...
+#...
   labels:
     region: east
     type: user-node
-...
+#...
 ----
 +
 When you create the pod using the example pod spec in this example project, the pod is created with the project node selectors and is scheduled on the labeled node:
@@ -220,12 +223,12 @@ apiVersion: v1
 kind: Pod
 metadata:
   namespace: east-region
-...
+#...
 spec:
   nodeSelector:
     region: east
     type: user-node
-...
+#...
 ----
 +
 [source,terminal]
@@ -242,11 +245,11 @@ A pod in the project is not created or scheduled if the pod contains different n
 ----
 apiVersion: v1
 kind: Pod
-...
-
+metadata:
+  name: west-region
+#...
 spec:
   nodeSelector:
     region: west
-
-....
+#...
 ----