Skip to content

Commit 2f3cfb6

Browse files
authored
Merge pull request #97179 from openshift-cherrypick-robot/cherry-pick-96824-to-enterprise-4.20
[enterprise-4.20] OSDOCS#15587: CQA updates
2 parents 1ad0b2c + b574488 commit 2f3cfb6

8 files changed

+27
-25
lines changed

modules/cli-logging-in-kubeadmin.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,14 +82,14 @@ The file is specific to a cluster and is created during {product-title} installa
8282
ifndef::gcp[]
8383
* You deployed an {product-title} cluster.
8484
endif::gcp[]
85-
* You installed the `oc` CLI.
85+
* You installed the {oc-first}.
8686
ifdef::gcp[]
8787
* Ensure the bootstrap process completed successfully.
8888
endif::gcp[]
8989

9090
.Procedure
9191

92-
. Export the `kubeadmin` credentials:
92+
. Export the `kubeadmin` credentials by running the following command:
9393
+
9494
[source,terminal]
9595
----
@@ -98,7 +98,7 @@ $ export KUBECONFIG=<installation_directory>/auth/kubeconfig <1>
9898
<1> For `<installation_directory>`, specify the path to the directory that you stored
9999
the installation files in.
100100

101-
. Verify you can run `oc` commands successfully using the exported configuration:
101+
. Verify you can run `oc` commands successfully using the exported configuration by running the following command:
102102
+
103103
[source,terminal]
104104
----

modules/cluster-entitlements.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ obtain the images that are necessary to install
120120
endif::restricted[]
121121
your cluster.
122122

123-
You must have internet access to:
123+
You must have internet access to perform the following actions:
124124

125125
* 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.
126126
* Access link:http://quay.io[Quay.io] to obtain the packages that are required to install your cluster.

modules/configuring-vsphere-regions-zones.adoc

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,22 +13,23 @@ You can modify the default installation configuration file, so that you can depl
1313

1414
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.
1515

16-
[IMPORTANT]
17-
====
18-
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
19-
====
20-
2116
.Prerequisites
2217
* You have an existing `install-config.yaml` installation configuration file.
2318
+
2419
[IMPORTANT]
2520
====
2621
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.
2722
====
23+
* You have installed the `govc` command line tool.
24+
+
25+
[IMPORTANT]
26+
====
27+
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.
28+
====
2829
2930
.Procedure
3031

31-
. Enter the following `govc` command-line tool commands to create the `openshift-region` and `openshift-zone` vCenter tag categories:
32+
. Create the `openshift-region` and `openshift-zone` vCenter tag categories by running the following commands:
3233
+
3334
[IMPORTANT]
3435
====
@@ -45,28 +46,28 @@ $ govc tags.category.create -d "OpenShift region" openshift-region
4546
$ govc tags.category.create -d "OpenShift zone" openshift-zone
4647
----
4748

48-
. 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:
49+
. For each region where you want to deploy your cluster, create a region tag by running the following command:
4950
+
5051
[source,terminal]
5152
----
5253
$ govc tags.create -c <region_tag_category> <region_tag>
5354
----
5455

55-
. To create a zone tag for each vSphere cluster where you want to deploy your cluster, enter the following command:
56+
. For each zone where you want to deploy your cluster, create a zone tag by running the following command:
5657
+
5758
[source,terminal]
5859
----
5960
$ govc tags.create -c <zone_tag_category> <zone_tag>
6061
----
6162

62-
. Attach region tags to each vCenter data center object by entering the following command:
63+
. Attach region tags to each vCenter data center object by running the following command:
6364
+
6465
[source,terminal]
6566
----
6667
$ govc tags.attach -c <region_tag_category> <region_tag_1> /<data_center_1>
6768
----
6869

69-
. Attach the zone tags to each vCenter cluster object by entering the following command:
70+
. Attach the zone tags to each vCenter cluster object by running the following command:
7071
+
7172
[source,terminal]
7273
----

modules/installation-installer-provisioned-vsphere-config-yaml.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ ifeval::["{context}" == "installing-restricted-networks-installer-provisioned-vs
1010
:restricted:
1111
endif::[]
1212

13+
:_mod-docs-content-type: CONCEPT
1314
[id="installation-installer-provisioned-vsphere-config-yaml_{context}"]
1415
= Sample install-config.yaml file for an installer-provisioned VMware vSphere cluster
1516

modules/installation-launching-installer.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@ ifndef::azure[]
281281
* 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.
282282
endif::azure[]
283283
ifdef::vsphere[]
284-
* Optional: Before you create the cluster, configure an external load balancer in place of the default load balancer.
284+
* Optional: Before you create the cluster, you configured an external load balancer in place of the default load balancer.
285285
+
286286
[IMPORTANT]
287287
====
@@ -319,10 +319,10 @@ ifdef::ibm-cloud-restricted[]
319319
$ export OPENSHIFT_INSTALL_OS_IMAGE_OVERRIDE="<path_to_image>/rhcos-<image_version>-ibmcloud.x86_64.qcow2.gz"
320320
----
321321
endif::ibm-cloud-restricted[]
322-
. Change to the directory that contains the installation program and initialize the cluster deployment:
322+
. In the directory that contains the installation program, initialize the cluster deployment by running the following command:
323323
endif::aws,azure-gov,azure-private,gcp,ibm-cloud-restricted,no-config[]
324324
ifdef::single-step,azure-restricted[]
325-
* Change to the directory that contains the installation program and initialize the cluster deployment:
325+
* In the directory that contains the installation program, initialize the cluster deployment by running the following command:
326326
endif::single-step,azure-restricted[]
327327
+
328328
[source,terminal]

modules/installation-registry-storage-block-recreate-rollout.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ have more than one replica.
3131
$ oc patch config.imageregistry.operator.openshift.io/cluster --type=merge -p '{"spec":{"rolloutStrategy":"Recreate","replicas":1}}'
3232
----
3333
+
34-
. 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.
34+
. 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.
3535
.. Create a `pvc.yaml` file with the following contents to define a VMware vSphere `PersistentVolumeClaim` object:
3636
+
3737
[source,yaml]

modules/ipi-install-modifying-install-config-for-dual-stack-network.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ifeval::["{context}" == "installing-vsphere-installer-provisioned-network-custom
77
:vsphere:
88
endif::[]
99

10-
:_mod-docs-content-type: PROCEDURE
10+
:_mod-docs-content-type: CONCEPT
1111
[id='modifying-install-config-for-dual-stack-network_{context}']
1212
= Deploying with dual-stack networking
1313

modules/registry-configuring-storage-vsphere.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,14 @@ components.
4141

4242
.Procedure
4343

44-
. To configure your registry to use storage, change the `spec.storage.pvc` in the `configs.imageregistry/cluster` resource.
44+
. Change the `spec.storage.pvc` field in the `configs.imageregistry/cluster` resource.
4545
+
4646
[NOTE]
4747
====
4848
When you use shared storage, review your security settings to prevent outside access.
4949
====
5050

51-
. Verify that you do not have a registry pod:
51+
. Verify that you do not have a registry pod by running the following command:
5252
+
5353
[source,terminal]
5454
----
@@ -65,7 +65,7 @@ No resourses found in openshift-image-registry namespace
6565
=====
6666
If you do have a registry pod in your output, you do not need to continue with this procedure.
6767
=====
68-
. Check the registry configuration:
68+
. Check the registry configuration by running the following command:
6969
+
7070
[source,terminal]
7171
----
@@ -82,7 +82,7 @@ storage:
8282
+
8383
<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.
8484

85-
. Check the `clusteroperator` status:
85+
. Check the `clusteroperator` status by running the following command:
8686
+
8787
[source,terminal]
8888
----
@@ -92,8 +92,8 @@ $ oc get clusteroperator image-registry
9292
.Example output
9393
[source,terminal]
9494
----
95-
NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE MESSAGE
96-
image-registry 4.7 True False False 6h50m
95+
NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE MESSAGE
96+
image-registry 4.7 True False False 6h50m
9797
----
9898

9999
//+

0 commit comments

Comments
 (0)