From 4226a319b11c8f9d43fefe9ce62edf5a1d64cdb3 Mon Sep 17 00:00:00 2001 From: Sebastian Kopacz Date: Tue, 29 Jul 2025 15:58:29 -0400 Subject: [PATCH] OSDOCS-15587: CQA updates --- modules/cli-logging-in-kubeadmin.adoc | 6 +++--- modules/cluster-entitlements.adoc | 2 +- .../configuring-vsphere-regions-zones.adoc | 21 ++++++++++--------- ...aller-provisioned-vsphere-config-yaml.adoc | 1 + modules/installation-launching-installer.adoc | 6 +++--- ...gistry-storage-block-recreate-rollout.adoc | 2 +- ...install-config-for-dual-stack-network.adoc | 2 +- .../registry-configuring-storage-vsphere.adoc | 12 +++++------ 8 files changed, 27 insertions(+), 25 deletions(-) diff --git a/modules/cli-logging-in-kubeadmin.adoc b/modules/cli-logging-in-kubeadmin.adoc index 8e1c69350b9a..769eed2f41ab 100644 --- a/modules/cli-logging-in-kubeadmin.adoc +++ b/modules/cli-logging-in-kubeadmin.adoc @@ -83,14 +83,14 @@ The file is specific to a cluster and is created during {product-title} installa ifndef::gcp[] * You deployed an {product-title} cluster. endif::gcp[] -* You installed the `oc` CLI. +* You installed the {oc-first}. ifdef::gcp[] * Ensure the bootstrap process completed successfully. endif::gcp[] .Procedure -. Export the `kubeadmin` credentials: +. Export the `kubeadmin` credentials by running the following command: + [source,terminal] ---- @@ -99,7 +99,7 @@ $ export KUBECONFIG=/auth/kubeconfig <1> <1> For ``, specify the path to the directory that you stored the installation files in. -. Verify you can run `oc` commands successfully using the exported configuration: +. Verify you can run `oc` commands successfully using the exported configuration by running the following command: + [source,terminal] ---- diff --git a/modules/cluster-entitlements.adoc b/modules/cluster-entitlements.adoc index 1f5e2a631b74..1bff5220dac8 100644 --- a/modules/cluster-entitlements.adoc +++ b/modules/cluster-entitlements.adoc @@ -121,7 +121,7 @@ obtain the images that are necessary to install endif::restricted[] your cluster. -You must have internet access to: +You must have internet access to perform the following actions: * Access {cluster-manager-url} to download the installation program and perform subscription management. If the cluster has internet access and you do not disable Telemetry, that service automatically entitles your cluster. * Access link:http://quay.io[Quay.io] to obtain the packages that are required to install your cluster. diff --git a/modules/configuring-vsphere-regions-zones.adoc b/modules/configuring-vsphere-regions-zones.adoc index 3a07866e7980..32c3d00d31aa 100644 --- a/modules/configuring-vsphere-regions-zones.adoc +++ b/modules/configuring-vsphere-regions-zones.adoc @@ -14,11 +14,6 @@ You can modify the default installation configuration file, so that you can depl The default `install-config.yaml` file configuration from the previous release of {product-title} is deprecated. You can continue to use the deprecated default configuration, but the `openshift-installer` will prompt you with a warning message that indicates the use of deprecated fields in the configuration file. -[IMPORTANT] -==== -The example uses the `govc` command. The `govc` command is an open source command available from VMware; it is not available from Red Hat. The Red Hat support team does not maintain the `govc` command. Instructions for downloading and installing `govc` are found on the VMware documentation website -==== - .Prerequisites * You have an existing `install-config.yaml` installation configuration file. + @@ -26,10 +21,16 @@ The example uses the `govc` command. The `govc` command is an open source comman ==== 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] +==== +The example uses the `govc` command. The `govc` command is an open source command available from VMware; it is not available from Red{nbsp}Hat. The Red{nbsp}Hat support team does not maintain the `govc` command. Instructions for downloading and installing `govc` are found on the VMware documentation website. +==== .Procedure -. Enter the following `govc` command-line tool commands to create the `openshift-region` and `openshift-zone` vCenter tag categories: +. Create the `openshift-region` and `openshift-zone` vCenter tag categories by running the following commands: + [IMPORTANT] ==== @@ -46,28 +47,28 @@ $ govc tags.category.create -d "OpenShift region" openshift-region $ govc tags.category.create -d "OpenShift zone" openshift-zone ---- -. To create a region tag for each region vSphere data center where you want to deploy your cluster, enter the following command in your terminal: +. For each region where you want to deploy your cluster, create a region tag by running the following command: + [source,terminal] ---- $ govc tags.create -c ---- -. To create a zone tag for each vSphere cluster where you want to deploy your cluster, enter the following command: +. For each zone where you want to deploy your cluster, create a zone tag by running the following command: + [source,terminal] ---- $ govc tags.create -c ---- -. Attach region tags to each vCenter data center object by entering the following command: +. Attach region tags to each vCenter data center object by running the following command: + [source,terminal] ---- $ govc tags.attach -c / ---- -. Attach the zone tags to each vCenter cluster object by entering the following command: +. Attach the zone tags to each vCenter cluster object by running the following command: + [source,terminal] ---- diff --git a/modules/installation-installer-provisioned-vsphere-config-yaml.adoc b/modules/installation-installer-provisioned-vsphere-config-yaml.adoc index 6634ac05444c..65ba9fe20d4e 100644 --- a/modules/installation-installer-provisioned-vsphere-config-yaml.adoc +++ b/modules/installation-installer-provisioned-vsphere-config-yaml.adoc @@ -11,6 +11,7 @@ ifeval::["{context}" == "installing-restricted-networks-installer-provisioned-vs :restricted: endif::[] +:_mod-docs-content-type: CONCEPT [id="installation-installer-provisioned-vsphere-config-yaml_{context}"] = Sample install-config.yaml file for an installer-provisioned VMware vSphere cluster diff --git a/modules/installation-launching-installer.adoc b/modules/installation-launching-installer.adoc index 0edf31731283..3dc7c59eee3c 100644 --- a/modules/installation-launching-installer.adoc +++ b/modules/installation-launching-installer.adoc @@ -287,7 +287,7 @@ ifndef::azure[] * You have verified that the cloud provider account on your host has the correct permissions to deploy the cluster. An account with incorrect permissions causes the installation process to fail with an error message that displays the missing permissions. endif::azure[] ifdef::vsphere[] -* Optional: Before you create the cluster, configure an external load balancer in place of the default load balancer. +* Optional: Before you create the cluster, you configured an external load balancer in place of the default load balancer. + [IMPORTANT] ==== @@ -325,10 +325,10 @@ ifdef::ibm-cloud-restricted[] $ export OPENSHIFT_INSTALL_OS_IMAGE_OVERRIDE="/rhcos--ibmcloud.x86_64.qcow2.gz" ---- endif::ibm-cloud-restricted[] -. Change to the directory that contains the installation program and initialize the cluster deployment: +. In the directory that contains the installation program, initialize the cluster deployment by running the following command: endif::aws,azure-gov,azure-private,gcp,ibm-cloud-restricted,no-config[] ifdef::single-step,azure-restricted[] -* Change to the directory that contains the installation program and initialize the cluster deployment: +* In the directory that contains the installation program, initialize the cluster deployment by running the following command: endif::single-step,azure-restricted[] + [source,terminal] diff --git a/modules/installation-registry-storage-block-recreate-rollout.adoc b/modules/installation-registry-storage-block-recreate-rollout.adoc index 5fd6de615cc4..b44272923097 100644 --- a/modules/installation-registry-storage-block-recreate-rollout.adoc +++ b/modules/installation-registry-storage-block-recreate-rollout.adoc @@ -31,7 +31,7 @@ have more than one replica. $ oc patch config.imageregistry.operator.openshift.io/cluster --type=merge -p '{"spec":{"rolloutStrategy":"Recreate","replicas":1}}' ---- + -. Provision the PV for the block storage device, and create a PVC for that volume. The requested block volume uses the ReadWriteOnce (RWO) access mode. +. Provision the persistent volume (PV) for the block storage device, and create a persistent volume claim (PVC) for that volume. The requested block volume uses the ReadWriteOnce (RWO) access mode. .. Create a `pvc.yaml` file with the following contents to define a VMware vSphere `PersistentVolumeClaim` object: + [source,yaml] diff --git a/modules/ipi-install-modifying-install-config-for-dual-stack-network.adoc b/modules/ipi-install-modifying-install-config-for-dual-stack-network.adoc index 14dee38bbbf1..9f3cbbbe4c0b 100644 --- a/modules/ipi-install-modifying-install-config-for-dual-stack-network.adoc +++ b/modules/ipi-install-modifying-install-config-for-dual-stack-network.adoc @@ -7,7 +7,7 @@ ifeval::["{context}" == "installing-vsphere-installer-provisioned-network-custom :vsphere: endif::[] -:_mod-docs-content-type: PROCEDURE +:_mod-docs-content-type: CONCEPT [id='modifying-install-config-for-dual-stack-network_{context}'] = Deploying with dual-stack networking diff --git a/modules/registry-configuring-storage-vsphere.adoc b/modules/registry-configuring-storage-vsphere.adoc index a3b91a204ff3..a498ad9d001e 100644 --- a/modules/registry-configuring-storage-vsphere.adoc +++ b/modules/registry-configuring-storage-vsphere.adoc @@ -42,14 +42,14 @@ components. .Procedure -. To configure your registry to use storage, change the `spec.storage.pvc` in the `configs.imageregistry/cluster` resource. +. Change the `spec.storage.pvc` field in the `configs.imageregistry/cluster` resource. + [NOTE] ==== When you use shared storage, review your security settings to prevent outside access. ==== -. Verify that you do not have a registry pod: +. Verify that you do not have a registry pod by running the following command: + [source,terminal] ---- @@ -66,7 +66,7 @@ No resourses found in openshift-image-registry namespace ===== If you do have a registry pod in your output, you do not need to continue with this procedure. ===== -. Check the registry configuration: +. Check the registry configuration by running the following command: + [source,terminal] ---- @@ -83,7 +83,7 @@ storage: + <1> Leave the `claim` field blank to allow the automatic creation of an `image-registry-storage` persistent volume claim (PVC). The PVC is generated based on the default storage class. However, be aware that the default storage class might provide ReadWriteOnce (RWO) volumes, such as a RADOS Block Device (RBD), which can cause issues when you replicate to more than one replica. -. Check the `clusteroperator` status: +. Check the `clusteroperator` status by running the following command: + [source,terminal] ---- @@ -93,8 +93,8 @@ $ oc get clusteroperator image-registry .Example output [source,terminal] ---- -NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE MESSAGE -image-registry 4.7 True False False 6h50m +NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE MESSAGE +image-registry 4.7 True False False 6h50m ---- //+