Merge pull request #101819 from dfitzmau/OSDOCS-17072-batch3

OSDOCS-17072-batch3

Author: dfitzmau

modules/configuring-vsphere-host-groups.adoc

@@ -35,7 +35,6 @@ To enable host group support, you must define multiple failure domains for your
 ====
 If you specify different names for the `openshift-region` and `openshift-zone` vCenter tag categories, the installation of the {product-title} cluster fails.
 ====
-
 +
 [source,terminal]
 ----
@@ -76,7 +75,7 @@ $ govc tags.attach -c <zone_tag_category> <zone_tag_for_host_group_1> /<datacent
 ----
 
 . Change to the directory that contains the installation program and initialize the cluster deployment according to your chosen installation requirements.
-
++
 .Sample `install-config.yaml` file with multiple host groups
 
 [source,yaml]
@@ -122,4 +121,4 @@ platform:
         datastore: "/<data_center_1>/datastore/<datastore_1>"
         resourcePool: "/<data_center_1>/host/<cluster_1>/Resources/<resourcePool_1>"
         folder: "/<data_center_1>/vm/<folder_1>"
-----
+----

modules/configuring-vsphere-regions-zones.adoc

@@ -20,6 +20,7 @@ The default `install-config.yaml` file configuration from the previous release o
 ====
 You must specify at least one failure domain for your {product-title} cluster, so that you can provision data center objects for your VMware vCenter server. Consider specifying multiple failure domains if you need to provision virtual machine nodes in different data centers, clusters, datastores, and other components. To enable regions and zones, you must define multiple failure domains for your {product-title} cluster.
 ====
++
 * You have installed the `govc` command line tool.
 +
 [IMPORTANT]
@@ -75,30 +76,30 @@ $ govc tags.attach -c <zone_tag_category> <zone_tag_1> /<data_center_1>/host/<cl
 ----
 
 . Change to the directory that contains the installation program and initialize the cluster deployment according to your chosen installation requirements.
-
++
 .Sample `install-config.yaml` file with multiple data centers defined in a vSphere center
 
 [source,yaml]
 ----
----
+# ...
 compute:
 ---
   vsphere:
       zones:
         - "<machine_pool_zone_1>"
         - "<machine_pool_zone_2>"
----
+# ...
 controlPlane:
----
+# ...
 vsphere:
       zones:
         - "<machine_pool_zone_1>"
         - "<machine_pool_zone_2>"
----
+# ...
 platform:
   vsphere:
     vcenters:
----
+# ...
     datacenters:
       - <data_center_1_name>
       - <data_center_2_name>
@@ -127,5 +128,5 @@ platform:
         datastore: "/<data_center_2>/datastore/<datastore2>"
         resourcePool: "/<data_center_2>/host/<cluster2>/Resources/<resourcePool2>"
         folder: "/<data_center_2>/vm/<folder2>"
----
+# ...
 ----

modules/dynamic-plug-in-development.adoc

@@ -9,6 +9,7 @@
 You can run the plugin using a local development environment. The {product-title} web console runs in a container connected to the cluster you have logged into.
 
 .Prerequisites
+
 * You must have cloned the link:https://github.com/openshift/console-plugin-template[`console-plugin-template`] repository, which contains a template for creating plugins.
 +
 [IMPORTANT]
@@ -40,7 +41,6 @@ $ yarn install
 ----
 
 . After installing, run the following command to start yarn.
-
 +
 [source,terminal]
 ----
@@ -68,11 +68,24 @@ The `yarn run start-console` command runs an `amd64` image and might fail when r
 [source,terminal]
 ----
 $ podman machine ssh
+----
+
+[source,terminal]
+----
 $ sudo -i
+----
+
+[source,terminal]
+----
 $ rpm-ostree install qemu-user-static
+----
+
+[source,terminal]
+----
 $ systemctl reboot
 ----
 ====
 
 .Verification
-* Visit link:http://localhost:9000/example[localhost:9000] to view the running plugin. Inspect the value of `window.SERVER_FLAGS.consolePlugins` to see the list of plugins which load at runtime.
+
+* Visit link:http://localhost:9000/example[localhost:9000] to view the running plugin. Inspect the value of `window.SERVER_FLAGS.consolePlugins` to see the list of plugins which load at runtime.

modules/gitops-default-permissions-of-an-argocd-instance.adoc

@@ -9,34 +9,38 @@
 
 By default Argo CD instance has the following permissions:
 
-* Argo CD instance has the `admin` privileges to manage resources only in the namespace where it is deployed. For instance, an Argo CD instance deployed in the **foo** namespace has the `admin` privileges to manage resources only for that namespace.
+* Argo CD instance has the `admin` privileges to manage resources only in the namespace where it is deployed. For instance, an Argo CD instance deployed in the *foo* namespace has the `admin` privileges to manage resources only for that namespace.
 
 * Argo CD has the following cluster-scoped permissions because Argo CD requires cluster-wide `read` privileges on resources to function appropriately:
 +
-[source,yaml]
+[source,yaml,subs="attributes+"]
 ----
 - verbs:
     - get
     - list
     - watch
    apiGroups:
-    - '*'
+    - /'*'
    resources:
-    - '*'
+    - /'*'
  - verbs:
     - get
     - list
    nonResourceURLs:
-    - '*'
+    - /'*'
 ----
 
 [NOTE]
 ====
 * You can edit the cluster roles used by the `argocd-server` and `argocd-application-controller` components where Argo CD is running such that the `write` privileges are limited to only the namespaces and resources that you wish Argo CD to manage.
-+
+
 [source,terminal]
 ----
 $ oc edit clusterrole argocd-server
+----
+
+[source,terminal]
+----
 $ oc edit clusterrole argocd-application-controller
 ----
 ====

modules/hosted-cluster-etcd-backup-restore-on-premise.adoc

@@ -18,7 +18,7 @@ include::snippets/technology-preview.adoc[]
 .Procedure
 
 . First, set up your environment variables:
-
++
 .. Set up environment variables for your hosted cluster by entering the following commands, replacing values as necessary:
 +
 [source,terminal]
@@ -35,7 +35,7 @@ $ HOSTED_CLUSTER_NAMESPACE=clusters
 ----
 $ CONTROL_PLANE_NAMESPACE="${HOSTED_CLUSTER_NAMESPACE}-${CLUSTER_NAME}"
 ----
-
++
 .. Pause reconciliation of the hosted cluster by entering the following command, replacing values as necessary:
 +
 [source,terminal]
@@ -45,17 +45,18 @@ $ oc patch -n ${HOSTED_CLUSTER_NAMESPACE} hostedclusters/${CLUSTER_NAME} \
 ----
 
 . Next, take a snapshot of etcd by using one of the following methods:
-
++
 .. Use a previously backed-up snapshot of etcd.
++
 .. If you have an available etcd pod, take a snapshot from the active etcd pod by completing the following steps:
-
++
 ... List etcd pods by entering the following command:
 +
 [source,terminal]
 ----
 $ oc get -n ${CONTROL_PLANE_NAMESPACE} pods -l app=etcd
 ----
-
++
 ... Take a snapshot of the pod database and save it locally to your machine by entering the following commands:
 +
 [source,terminal]
@@ -73,7 +74,7 @@ $ oc exec -n ${CONTROL_PLANE_NAMESPACE} -c etcd -t ${ETCD_POD} -- \
   --endpoints=https://localhost:2379 \
   snapshot save /var/lib/snapshot.db
 ----
-
++
 ... Verify that the snapshot is successful by entering the following command:
 +
 [source,terminal]
@@ -82,15 +83,15 @@ $ oc exec -n ${CONTROL_PLANE_NAMESPACE} -c etcd -t ${ETCD_POD} -- \
   env ETCDCTL_API=3 /usr/bin/etcdctl -w table snapshot status \
   /var/lib/snapshot.db
 ----
-
++
 .. Make a local copy of the snapshot by entering the following command:
 +
 [source,terminal]
 ----
 $ oc cp -c etcd ${CONTROL_PLANE_NAMESPACE}/${ETCD_POD}:/var/lib/snapshot.db \
   /tmp/etcd.snapshot.db
 ----
-
++
 ... Make a copy of the snapshot database from etcd persistent storage:
 +
 .... List etcd pods by entering the following command:
@@ -99,7 +100,7 @@ $ oc cp -c etcd ${CONTROL_PLANE_NAMESPACE}/${ETCD_POD}:/var/lib/snapshot.db \
 ----
 $ oc get -n ${CONTROL_PLANE_NAMESPACE} pods -l app=etcd
 ----
-
++
 .... Find a pod that is running and set its name as the value of `ETCD_POD: ETCD_POD=etcd-0`, and then copy its snapshot database by entering the following command:
 +
 [source,terminal]
@@ -115,16 +116,16 @@ $ oc cp -c etcd \
 ----
 $ oc scale -n ${CONTROL_PLANE_NAMESPACE} statefulset/etcd --replicas=0
 ----
-
++
 .. Delete volumes for second and third members by entering the following command:
 +
 [source,terminal]
 ----
 $ oc delete -n ${CONTROL_PLANE_NAMESPACE} pvc/data-etcd-1 pvc/data-etcd-2
 ----
-
++
 .. Create a pod to access the first etcd member's data:
-
++
 ... Get the etcd image by entering the following command:
 +
 [source,terminal]
@@ -135,7 +136,7 @@ $ ETCD_IMAGE=$(oc get -n ${CONTROL_PLANE_NAMESPACE} statefulset/etcd \
 +
 ... Create a pod that allows access to etcd data:
 +
-[source,yaml]
+[source,yaml,subs="attributes+"]
 ----
 $ cat << EOF | oc apply -n ${CONTROL_PLANE_NAMESPACE} -f -
 apiVersion: apps/v1
@@ -170,32 +171,32 @@ spec:
       - name: data
         persistentVolumeClaim:
           claimName: data-etcd-0
-EOF
+    EOF
 ----
-
++
 ... Check the status of the `etcd-data` pod and wait for it to be running by entering the following command:
 +
 [source,terminal]
 ----
 $ oc get -n ${CONTROL_PLANE_NAMESPACE} pods -l app=etcd-data
 ----
-
++
 ... Get the name of the `etcd-data` pod by entering the following command:
 +
 [source,terminal]
 ----
 $ DATA_POD=$(oc get -n ${CONTROL_PLANE_NAMESPACE} pods --no-headers \
   -l app=etcd-data -o name | cut -d/ -f2)
 ----
-
++
 .. Copy an etcd snapshot into the pod by entering the following command:
 +
 [source,terminal]
 ----
 $ oc cp /tmp/etcd.snapshot.db \
   ${CONTROL_PLANE_NAMESPACE}/${DATA_POD}:/var/lib/restored.snap.db
 ----
-
++
 .. Remove old data from the `etcd-data` pod by entering the following commands:
 +
 [source,terminal]
@@ -207,7 +208,7 @@ $ oc exec -n ${CONTROL_PLANE_NAMESPACE} ${DATA_POD} -- rm -rf /var/lib/data
 ----
 $ oc exec -n ${CONTROL_PLANE_NAMESPACE} ${DATA_POD} -- mkdir -p /var/lib/data
 ----
-
++
 .. Restore the etcd snapshot by entering the following command:
 +
 [source,terminal]
@@ -220,29 +221,29 @@ $ oc exec -n ${CONTROL_PLANE_NAMESPACE} ${DATA_POD} -- \
      --initial-cluster etcd-0=https://etcd-0.etcd-discovery.${CONTROL_PLANE_NAMESPACE}.svc:2380,etcd-1=https://etcd-1.etcd-discovery.${CONTROL_PLANE_NAMESPACE}.svc:2380,etcd-2=https://etcd-2.etcd-discovery.${CONTROL_PLANE_NAMESPACE}.svc:2380 \
      --initial-advertise-peer-urls https://etcd-0.etcd-discovery.${CONTROL_PLANE_NAMESPACE}.svc:2380
 ----
-
++
 .. Remove the temporary etcd snapshot from the pod by entering the following command:
 +
 [source,terminal]
 ----
 $ oc exec -n ${CONTROL_PLANE_NAMESPACE} ${DATA_POD} -- \
   rm /var/lib/restored.snap.db
 ----
-
++
 .. Delete data access deployment by entering the following command:
 +
 [source,terminal]
 ----
 $ oc delete -n ${CONTROL_PLANE_NAMESPACE} deployment/etcd-data
 ----
-
++
 .. Scale up the etcd cluster by entering the following command:
 +
 [source,terminal]
 ----
 $ oc scale -n ${CONTROL_PLANE_NAMESPACE} statefulset/etcd --replicas=3
 ----
-
++
 .. Wait for the etcd member pods to return and report as available by entering the following command:
 +
 [source,terminal]
@@ -291,4 +292,4 @@ $ oc annotate hostedcluster -n \
   --overwrite
 ----
 +
-After a few minutes, the control plane pods start running.
+After a few minutes, the control plane pods start running.