Skip to content

OSDOCS#15587: CQA updates #96824

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 5, 2025
Merged

OSDOCS#15587: CQA updates #96824

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions modules/cli-logging-in-kubeadmin.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
----
Expand All @@ -99,7 +99,7 @@ $ export KUBECONFIG=<installation_directory>/auth/kubeconfig <1>
<1> For `<installation_directory>`, 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]
----
Expand Down
2 changes: 1 addition & 1 deletion modules/cluster-entitlements.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
21 changes: 11 additions & 10 deletions modules/configuring-vsphere-regions-zones.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,23 @@ 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.
+
[IMPORTANT]
====
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]
====
Expand All @@ -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 <region_tag_category> <region_tag>
----

. 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 <zone_tag_category> <zone_tag>
----

. 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 <region_tag_category> <region_tag_1> /<data_center_1>
----

. 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]
----
Expand Down
1 change: 1 addition & 0 deletions modules/installation-installer-provisioned-vsphere-config-yaml.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions modules/installation-launching-installer.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
====
Expand Down Expand Up @@ -325,10 +325,10 @@ ifdef::ibm-cloud-restricted[]
$ export OPENSHIFT_INSTALL_OS_IMAGE_OVERRIDE="<path_to_image>/rhcos-<image_version>-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]
Expand Down
2 changes: 1 addition & 1 deletion modules/installation-registry-storage-block-recreate-rollout.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion modules/ipi-install-modifying-install-config-for-dual-stack-network.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
12 changes: 6 additions & 6 deletions modules/registry-configuring-storage-vsphere.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
----
Expand All @@ -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]
----
Expand All @@ -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:
Copy link
Contributor

@dfitzmau dfitzmau Aug 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be out of scope, but I see a big spacial divide in the output between the VERSION column and the AVAILABLE column:

Screenshot From 2025-08-05 17-14-29

Copy link
Contributor Author

@skopacz1 skopacz1 Aug 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is a big gap, let me try and delete that

+
[source,terminal]
----
Expand All @@ -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
----

//+
Expand Down