Merge pull request #37886 from jboxman-rh/fix-yaml-errors

Fix YAML validation errors

Author: jboxman

modules/builds-docker-credentials-private-registries.adoc

@@ -24,11 +24,11 @@ auths:
     auth: "YWRfbGzhcGU6R2labnRib21ifTE=" <2>
     email: "[email protected]" <3>
   https://docker.io/my-namespace/my-user/my-image: <4>
-      auth: "GzhYWRGU6R2fbclabnRgbkSp=""
-      email: "[email protected]"
+    auth: "GzhYWRGU6R2fbclabnRgbkSp=""
+    email: "[email protected]"
   https://docker.io/my-namespace: <5>
-      auth: "GzhYWRGU6R2deesfrRgbkSp=""
-      email: "[email protected]"
+    auth: "GzhYWRGU6R2deesfrRgbkSp=""
+    email: "[email protected]"
 ----
 <1> URL of the registry.
 <2> Encrypted password.

modules/cnf-adjusting-nic-queues-with-the-performance-profile.adoc

@@ -26,7 +26,6 @@ Unsupported network devices:
 * Access to the cluster as a user with the `cluster-admin` role.
 * Install the OpenShift CLI (`oc`).
 
-
 .Procedure
 
 . Log in to the {product-title} cluster running the Performance Addon Operator as a user with `cluster-admin` privileges.
@@ -37,7 +36,7 @@ Unsupported network devices:
 +
 [source,terminal]
 ----
-$  oc edit -f <your_profile_name>.yaml
+$ oc edit -f <your_profile_name>.yaml
 ----
 
 . Populate the `spec` field with the `net` object. The object list can contain two fields:
@@ -94,7 +93,7 @@ spec:
     - interfaceName: “eth1”
     - vendorID: “0x1af4”
     deviceID: “0x1000”
-   nodeSelector:
+  nodeSelector:
     node-role.kubernetes.io/worker-cnf: ""
 ----
 
@@ -164,5 +163,5 @@ spec:
 +
 [source,terminal]
 ----
-$  oc apply -f <your_profile_name>.yaml
+$ oc apply -f <your_profile_name>.yaml
 ----

modules/cnf-deploying-the-du-infrastructure-profile.adoc

@@ -11,7 +11,7 @@
 
 . Create and apply the performance profile, for example:
 +
-[source,yaml]
+[source,terminal]
 ----
 cat <<EOF |  oc apply -f -
 apiVersion: performance.openshift.io/v1
@@ -60,9 +60,9 @@ $ oc wait mcp/worker-cnf --for condition="updated"
 
 . Apply the PTP configuration, for example:
 +
-[source,yaml]
+[source,terminal]
 ----
-cat <<EOF |  oc apply -f -
+cat <<EOF | oc apply -f -
 apiVersion: ptp.openshift.io/v1
 kind: PtpConfig
 metadata:
@@ -196,7 +196,7 @@ This is currently set to match `logSyncInterval -4`.
 
 . Apply the SR-IOV network node policy, for example:
 +
-[source,yaml]
+[source,terminal]
 ----
 cat <<EOF |  oc apply -f -
 apiVersion: sriovnetwork.openshift.io/v1
@@ -229,7 +229,7 @@ _SR-IOV configuration notes_.
 
 . Create the SR-IOV network, for example:
 +
-[source,yaml]
+[source,terminal]
 ----
 cat <<EOF | oc apply -f -
 apiVersion: sriovnetwork.openshift.io/v1

modules/cnf-installing-the-operators.adoc

@@ -15,7 +15,7 @@ Install the Performance Addon Operator using the {product-title} CLI.
 
 . Create the Performance Addon Operator namespace:
 +
-[source,yaml]
+[source,terminal]
 ----
 cat <<EOF | oc apply -f -
 apiVersion: v1
@@ -33,7 +33,7 @@ EOF
 
 . Apply the Operator group:
 +
-[source,yaml]
+[source,terminal]
 ----
 cat <<EOF | oc apply -f -
 apiVersion: operators.coreos.com/v1
@@ -60,7 +60,7 @@ $ oc get packagemanifest performance-addon-operator -n openshift-marketplace -o
 . Apply the Subscription CR:
 +
 .Example subscription
-[source,yaml]
+[source,terminal]
 ----
 cat <<EOF | oc apply -f -
 apiVersion: operators.coreos.com/v1alpha1
@@ -73,7 +73,6 @@ spec:
   name: performance-addon-operator
   source: redhat-operators <2>
   sourceNamespace: openshift-marketplace
-
 EOF
 ----
 <1> Specify the value you obtained in the previous step for the `status.defaultChannel` parameter.
@@ -88,7 +87,7 @@ Install the PTP Operator using the {product-title} CLI or the web console.
 
 . Apply the Operator namespace:
 +
-[source,yaml]
+[source,terminal]
 ----
 cat <<EOF | oc apply -f -
 apiVersion: v1
@@ -99,13 +98,12 @@ metadata:
     workload.openshift.io/allowed: management
   labels:
     openshift.io/cluster-monitoring: "true"
-
 EOF
 ----
 
 . Apply the Operator group:
 +
-[source,yaml]
+[source,terminal]
 ----
 cat <<EOF | oc apply -f -
 apiVersion: operators.coreos.com/v1
@@ -122,7 +120,7 @@ EOF
 
 . Apply the subscription:
 +
-[source,yaml]
+[source,terminal]
 ----
 cat <<EOF | oc apply -f -
 apiVersion: operators.coreos.com/v1alpha1
@@ -135,7 +133,6 @@ spec:
   name: ptp-operator
   source: "redhat-operators"
   sourceNamespace: openshift-marketplace
-
 EOF
 ----
 
@@ -148,7 +145,7 @@ Load and enable the SCTP kernel module on worker nodes in your cluster.
 
 . Apply the SCTP machine config patch:
 +
-[source,yaml]
+[source,terminal]
 ----
 cat <<EOF | oc apply -f -
 apiVersion: machineconfiguration.openshift.io/v1
@@ -183,7 +180,7 @@ Install the SR-IOV Network Operator by using the {product-title} CLI or the web
 
 . Apply the SR-IOV Operator namespace:
 +
-[source,yaml]
+[source,terminal]
 ----
 cat <<EOF | oc apply -f -
 apiVersion: v1
@@ -192,13 +189,12 @@ metadata:
   name: openshift-sriov-network-operator
   annotations:
     workload.openshift.io/allowed: management
-
 EOF
 ----
 
 . Apply the SR-IOV Operator group:
 +
-[source,yaml]
+[source,terminal]
 ----
 cat <<EOF | oc apply -f -
 apiVersion: operators.coreos.com/v1
@@ -209,13 +205,12 @@ metadata:
 spec:
   targetNamespaces:
   - openshift-sriov-network-operator
-
 EOF
 ----
 
 . Apply the SR-IOV Operator subscription:
 +
-[source,yaml]
+[source,terminal]
 ----
 cat <<EOF | oc apply -f -
 apiVersion: operators.coreos.com/v1alpha1
@@ -228,7 +223,6 @@ spec:
   name: sriov-network-operator
   source: redhat-operators
   sourceNamespace: openshift-marketplace
-
 EOF
 ----
 

modules/cnf-provisioning-deploying-a-distributed-unit-manually.adoc

@@ -56,7 +56,7 @@ Before installing the Operators and deploying the DU, perform the following step
 
 . Create a machine config pool for the RAN worker nodes. For example:
 +
-[source,yaml]
+[source,terminal]
 ----
 cat <<EOF | oc apply -f -
 apiVersion: machineconfiguration.openshift.io/v1

modules/cnf-provisioning-real-time-and-low-latency-workloads.adoc

@@ -223,9 +223,9 @@ kind: Pod
 metadata:
   name: example
 spec:
-  [...]
+  # ...
   nodeSelector:
-     node-role.kubernetes.io/worker-rt: ""
+    node-role.kubernetes.io/worker-rt: ""
 ----
 
 For more information, see link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.5/html-single/nodes/index#nodes-scheduler-node-selectors[Placing pods on specific nodes using node selectors].

modules/cnf-verifying-queue-status.adoc

@@ -23,10 +23,10 @@ spec:
   spec:
     cpu:
       reserved: 0-1  #total = 2
-      Isolated: 2-8
+      isolated: 2-8
     net:
       userLevelNetworking: true
-...
+# ...
 ----
 
 * Display the status of the queues associated with a device using the following command:
@@ -102,15 +102,15 @@ metadata:
   name: performance
 spec:
   kind: PerformanceProfile
-    spec:
-     cpu:
+  spec:
+    cpu:
       reserved: 0-1  #total = 2
-      Isolated: 2-8
-     net:
+      isolated: 2-8
+    net:
       userLevelNetworking: true
       devices:
       - vendorID = 0x1af4
-...
+# ...
 ----
 
 * Display the status of the queues associated with a device using the following command:
@@ -164,7 +164,7 @@ The command `udevadm info` provides a detailed report on a device. In this examp
 E: ID_MODEL_ID=0x1000
 E: ID_VENDOR_ID=0x1af4
 E: INTERFACE=ens4
-…
+...
 ----
 
 [source,terminal]
@@ -187,14 +187,14 @@ metadata:
 spec:
   kind: PerformanceProfile
     spec:
-     cpu:
-      reserved: 0-1  #total = 2
-      Isolated: 2-8
-     net:
-      userLevelNetworking: true
-      devices:
-      - interfaceName = eth0
-      - vendorID = 0x1af4
+      cpu:
+        reserved: 0-1  #total = 2
+        isolated: 2-8
+      net:
+        userLevelNetworking: true
+        devices:
+        - interfaceName = eth0
+        - vendorID = 0x1af4
 ...
 ----
 

modules/eco-configuring-machine-health-check-with-poison-pill.adoc

@@ -53,7 +53,7 @@ spec:
     matchLabels:
       machine.openshift.io/cluster-api-machine-role: "worker"
       machine.openshift.io/cluster-api-machine-type: "worker"
-   unhealthyConditions:
+  unhealthyConditions:
   - type:    "Ready"
     timeout: "300s" 
     status: "False"

modules/ibm-z-ensure-high-disk-performance-hyperpav.adoc

@@ -18,7 +18,7 @@ For z/VM-based {product-title} setups that use full-pack minidisks, you can leve
 
 . Copy the following MCO sample profile into a YAML file for the control plane node. For example, `05-master-kernelarg-hpav.yaml`:
 +
-[source,yaml]
+[source,terminal]
 ----
 $ cat 05-master-kernelarg-hpav.yaml
 apiVersion: machineconfiguration.openshift.io/v1
@@ -37,7 +37,7 @@ spec:
 
 . Copy the following MCO sample profile into a YAML file for the compute node. For example, `05-worker-kernelarg-hpav.yaml`:
 +
-[source,yaml]
+[source,terminal]
 ----
 $ cat 05-worker-kernelarg-hpav.yaml
 apiVersion: machineconfiguration.openshift.io/v1