Skip to content

Commit 51d9014

Browse files
skopacz1openshift-cherrypick-robot
authored andcommitted
OSDOCS-15587: CQA updates
1 parent 3726ef9 commit 51d9014

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
@@ -83,14 +83,14 @@ The file is specific to a cluster and is created during {product-title} installa
8383
ifndef::gcp[]
8484
* You deployed an {product-title} cluster.
8585
endif::gcp[]
86-
* You installed the `oc` CLI.
86+
* You installed the {oc-first}.
8787
ifdef::gcp[]
8888
* Ensure the bootstrap process completed successfully.
8989
endif::gcp[]
9090

9191
.Procedure
9292

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

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

modules/cluster-entitlements.adoc

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

124-
You must have internet access to:
124+
You must have internet access to perform the following actions:
125125

126126
* 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.
127127
* 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
@@ -14,22 +14,23 @@ You can modify the default installation configuration file, so that you can depl
1414

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

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

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

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

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

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

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

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

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

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

modules/installation-launching-installer.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,7 @@ ifndef::azure[]
287287
* 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.
288288
endif::azure[]
289289
ifdef::vsphere[]
290-
* Optional: Before you create the cluster, configure an external load balancer in place of the default load balancer.
290+
* Optional: Before you create the cluster, you configured an external load balancer in place of the default load balancer.
291291
+
292292
[IMPORTANT]
293293
====
@@ -325,10 +325,10 @@ ifdef::ibm-cloud-restricted[]
325325
$ export OPENSHIFT_INSTALL_OS_IMAGE_OVERRIDE="<path_to_image>/rhcos-<image_version>-ibmcloud.x86_64.qcow2.gz"
326326
----
327327
endif::ibm-cloud-restricted[]
328-
. Change to the directory that contains the installation program and initialize the cluster deployment:
328+
. In the directory that contains the installation program, initialize the cluster deployment by running the following command:
329329
endif::aws,azure-gov,azure-private,gcp,ibm-cloud-restricted,no-config[]
330330
ifdef::single-step,azure-restricted[]
331-
* Change to the directory that contains the installation program and initialize the cluster deployment:
331+
* In the directory that contains the installation program, initialize the cluster deployment by running the following command:
332332
endif::single-step,azure-restricted[]
333333
+
334334
[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
@@ -42,14 +42,14 @@ components.
4242

4343
.Procedure
4444

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

52-
. Verify that you do not have a registry pod:
52+
. Verify that you do not have a registry pod by running the following command:
5353
+
5454
[source,terminal]
5555
----
@@ -66,7 +66,7 @@ No resourses found in openshift-image-registry namespace
6666
=====
6767
If you do have a registry pod in your output, you do not need to continue with this procedure.
6868
=====
69-
. Check the registry configuration:
69+
. Check the registry configuration by running the following command:
7070
+
7171
[source,terminal]
7272
----
@@ -83,7 +83,7 @@ storage:
8383
+
8484
<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.
8585

86-
. Check the `clusteroperator` status:
86+
. Check the `clusteroperator` status by running the following command:
8787
+
8888
[source,terminal]
8989
----
@@ -93,8 +93,8 @@ $ oc get clusteroperator image-registry
9393
.Example output
9494
[source,terminal]
9595
----
96-
NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE MESSAGE
97-
image-registry 4.7 True False False 6h50m
96+
NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE MESSAGE
97+
image-registry 4.7 True False False 6h50m
9898
----
9999

100100
//+

0 commit comments

Comments
 (0)