Merge pull request #113598 from dfitzmau/OSDOCS-16988-4-CQA-1

dfitzmau · web-flow · commit 707e9f397458 · 2026-06-18T15:59:45.000+01:00
OSDOCS-16988-4-CQA-1:CQA PR 4.1 for INSTALL-1: Core Installation Conc…
diff --git a/installing/validation_and_troubleshooting/validating-an-installation.adoc b/installing/validation_and_troubleshooting/validating-an-installation.adoc
@@ -6,7 +6,10 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
-You can check the status of an {product-title} cluster after an installation or validate boot artifacts before an installation by following the procedures in this document.
+[role="_abstract"]
+You can check the status of an {product-title} cluster after an installation or validate boot artifacts before an installation.
+
+After you complete the procedures, you can move onto postinstallation cluster tasks. If you experience installation issues, see "Troubleshooting installations" in the _Additional resources_" section.
 
 //Validating RHCOS live media
 include::modules/rhcos-validate-live-media.adoc[leveloffset=+1]
@@ -23,13 +26,13 @@ include::modules/getting-cluster-version-status-and-update-details.adoc[leveloff
 [role="_additional-resources"]
 .Additional resources
 
-* See xref:../../support/troubleshooting/troubleshooting-installations.adoc#querying-operator-status-after-installation_troubleshooting-installations[Querying Operator status after installation] for more information about querying Operator status if your installation is still progressing.
+* xref:../../support/troubleshooting/troubleshooting-installations.adoc#querying-operator-status-after-installation_troubleshooting-installations[Querying Operator status after installation]
 
-* See xref:../../support/troubleshooting/troubleshooting-operator-issues.adoc#troubleshooting-operator-issues[Troubleshooting Operator issues] for information about investigating issues with Operators.
+* xref:../../support/troubleshooting/troubleshooting-operator-issues.adoc#troubleshooting-operator-issues[Troubleshooting Operator issues]
 
-* See xref:../../updating/updating_a_cluster/updating-cluster-web-console.adoc#updating-cluster-web-console[Updating a cluster using the web console] for more information on updating your cluster.
+* xref:../../updating/updating_a_cluster/updating-cluster-web-console.adoc#updating-cluster-web-console[Updating a cluster using the web console]
 
-* See xref:../../updating/understanding_updates/understanding-update-channels-release.adoc#understanding-update-channels-releases[Understanding update channels and releases] for an overview about update release channels.
+* xref:../../updating/understanding_updates/understanding-update-channels-release.adoc#understanding-update-channels-releases[Understanding update channels and releases]
 
 // Verification steps for the Cloud Credential Operator utility (`ccoctl`)
 include::modules/cco-ccoctl-install-verifying.adoc[leveloffset=+1]
@@ -40,7 +43,7 @@ include::modules/querying-the-status-of-cluster-nodes-using-the-cli.adoc[levelof
 [role="_additional-resources"]
 .Additional resources
 
-* See xref:../../support/troubleshooting/verifying-node-health.adoc#verifying-node-health[Verifying node health] for more details about reviewing node health and investigating node issues.
+* xref:../../support/troubleshooting/verifying-node-health.adoc#verifying-node-health[Verifying node health]
 
 //Reviewing the cluster status from the OpenShift Container Platform web console
 include::modules/reviewing-cluster-status-from-the-openshift-web-console.adoc[leveloffset=+1]
@@ -51,27 +54,22 @@ include::modules/reviewing-cluster-status-from-the-openshift-cluster-manager.ado
 [role="_additional-resources"]
 .Additional resources
 
-* See xref:../../support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc#using-insights-to-identify-issues-with-your-cluster[Using {red-hat-lightspeed} to identify issues with your cluster] for more information about reviewing potential issues with your cluster.
+* xref:../../support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc#using-insights-to-identify-issues-with-your-cluster[Using {red-hat-lightspeed} to identify issues with your cluster]
 
 //Checking cluster resource availability and utilization
 include::modules/checking-cluster-resource-availability-and-utilization.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
 .Additional resources
 
-* See link:https://docs.redhat.com/en/documentation/monitoring_stack_for_red_hat_openshift/latest/html/about_monitoring/about-ocp-monitoring[About {product-title} monitoring] for more information about the {product-title} monitoring stack.
+* link:https://docs.redhat.com/en/documentation/monitoring_stack_for_red_hat_openshift/latest/html/about_monitoring/about-ocp-monitoring[About {product-title} monitoring]
 
 //Listing alerts that are firing
 include::modules/listing-alerts-that-are-firing.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
 .Additional resources
 
-* See link:https://docs.redhat.com/en/documentation/monitoring_stack_for_red_hat_openshift/latest/html/managing_alerts/managing-alerts-as-an-administrator[Managing alerts as an Administrator] for further details about alerting in {product-title}.
-
-[id="validating-an-installation-next-steps"]
-== Next steps
-
-* See xref:../../support/troubleshooting/troubleshooting-installations.adoc#troubleshooting-installations[Troubleshooting installations] if you experience issues when installing your cluster.
-
-* After installing {product-title}, you can xref:../../post_installation_configuration/cluster-tasks.adoc#post-install-cluster-tasks[further expand and customize your cluster].
+* link:https://docs.redhat.com/en/documentation/monitoring_stack_for_red_hat_openshift/latest/html/managing_alerts/managing-alerts-as-an-administrator[Managing alerts as an Administrator]
+* xref:../../support/troubleshooting/troubleshooting-installations.adoc#troubleshooting-installations[Troubleshooting installations]
+* xref:../../post_installation_configuration/cluster-tasks.adoc#post-install-cluster-tasks[Postinstallation cluster tasks]
diff --git a/modules/cco-ccoctl-install-verifying.adoc b/modules/cco-ccoctl-install-verifying.adoc
@@ -7,6 +7,7 @@
 [id="cco-ccoctl-install-verifying_{context}"]
 = Verifying that a cluster uses short-term credentials
 
+[role="_abstract"]
 You can verify that a cluster uses short-term security credentials for individual components by checking the Cloud Credential Operator (CCO) configuration and other values in the cluster.
 
 .Prerequisites
@@ -90,7 +91,7 @@ $ oc get secrets \
   -o jsonpath='{.data}'
 ----
 +
-An output that contains the `azure_client_id` and `azure_federated_token_file` felids confirms that the components are assuming the {azure-short} client ID.
+An output that contains the `azure_client_id` and `azure_federated_token_file` fields confirms that the components are assuming the {azure-short} client ID.
 
 * {azure-short} clusters: Verify that the pod identity webhook is running by running the following command:
 +
diff --git a/modules/checking-cluster-resource-availability-and-utilization.adoc b/modules/checking-cluster-resource-availability-and-utilization.adoc
@@ -6,7 +6,8 @@
 [id="checking-cluster-resource-availability-and-utilization_{context}"]
 = Checking cluster resource availability and utilization
 
-{product-title} provides a comprehensive set of monitoring dashboards that help you understand the state of cluster components.
+[role="_abstract"]
+{product-title} provides a comprehensive set of monitoring dashboards that you can analyze to better understand the state of cluster components.
 
 As an administrator, you can access dashboards for core {product-title} components, including:
 
@@ -21,15 +22,15 @@ As an administrator, you can access dashboards for core {product-title} componen
 * Dashboards relating to cluster and node performance
 
 .Example compute resources dashboard
-image::monitoring-dashboard-compute-resources.png[]
+image::monitoring-dashboard-compute-resources.png[Screenshot of the {product-title} monitoring dashboard showing compute resources including CPU usage, memory consumption, and pod metrics with time-series graphs]
 
 .Prerequisites
 
 * You have access to the cluster as a user with the `cluster-admin` role.
 
 .Procedure
 
-. As a cluster administrator in the {product-title} web console, navigate to *Observe* -> *Dashboards*.
+. In the {product-title} web console, navigate to *Observe* -> *Dashboards*.
 
 . Choose a dashboard in the *Dashboard* list. Some dashboards, such as the *etcd* dashboard, produce additional sub-menus when selected.
 
diff --git a/modules/getting-cluster-version-status-and-update-details.adoc b/modules/getting-cluster-version-status-and-update-details.adoc
@@ -6,14 +6,15 @@
 [id="getting-cluster-version-and-update-details_{context}"]
 = Getting cluster version, status, and update details
 
+[role="_abstract"]
 You can view the cluster version and status by running the `oc get clusterversion` command. If the status shows that the installation is still progressing, you can review the status of the Operators for more information.
 
 You can also list the current update channel and review the available cluster updates.
 
 .Prerequisites
 
 * You have access to the cluster as a user with the `cluster-admin` role.
-* You have installed the OpenShift CLI (`oc`).
+* You have installed the {oc-first}.
 
 .Procedure
 
diff --git a/modules/listing-alerts-that-are-firing.adoc b/modules/listing-alerts-that-are-firing.adoc
@@ -6,16 +6,18 @@
 [id="listing-alerts-that-are-firing_{context}"]
 = Listing alerts that are firing
 
-Alerts provide notifications when a set of defined conditions are true in an {product-title} cluster. You can review the alerts that are firing in your cluster by using the Alerting UI in the {product-title} web console.
+[role="_abstract"]
+Alerts provide notifications when a set of defined conditions are true in an {product-title} cluster. The Alerting UI in the {product-title} web console displays alerts that are firing and provides detailed information about each alert.
 
 .Prerequisites
 
+* You have access to the {product-title} web console.
 * You have access to the cluster as a user with the `cluster-admin` role.
 
 .Procedure
 
 . In the *Administrator* perspective, navigate to the *Observe* -> *Alerting* -> *Alerts* page.
 
-. Review the alerts that are firing, including their *Severity*, *State*, and *Source*.
+. Review the alerts that are firing, including their *Severity*, *State*, and *Source*. Use this information to identify which alerts require immediate attention.
 
 . Select an alert to view more detailed information in the *Alert Details* page.
diff --git a/modules/querying-the-status-of-cluster-nodes-using-the-cli.adoc b/modules/querying-the-status-of-cluster-nodes-using-the-cli.adoc
@@ -6,21 +6,24 @@
 [id="querying-the-status-of-cluster-nodes-using-the-cli_{context}"]
 = Querying the status of the cluster nodes by using the CLI
 
+[role="_abstract"]
 You can verify the status of the cluster nodes after an installation.
 
 .Prerequisites
 
 * You have access to the cluster as a user with the `cluster-admin` role.
-* You have installed the OpenShift CLI (`oc`).
+* You have installed the {oc-first}.
 
 .Procedure
 
-. List the status of the cluster nodes. Verify that the output lists all of the expected control plane and compute nodes and that each node has a `Ready` status:
+. List the status of the cluster nodes by entering the following command:
 +
 [source,terminal]
 ----
 $ oc get nodes
 ----
+
+. Verify that the output lists all of the expected control plane and compute nodes and that each node has a `Ready` status:
 +
 .Example output
 [source,terminal]
diff --git a/modules/reviewing-cluster-status-from-the-openshift-cluster-manager.adoc b/modules/reviewing-cluster-status-from-the-openshift-cluster-manager.adoc
@@ -6,15 +6,19 @@
 [id="reviewing-cluster-status-from-the-openshift-cluster-manager_{context}"]
 = Reviewing the cluster status from {cluster-manager-first}
 
+[role="_abstract"]
 From the {product-title} web console, you can review detailed information about the status of your cluster on {cluster-manager}.
 
 .Prerequisites
-* You are logged in to {cluster-manager-url}.
+* You have logged in to {cluster-manager-url}.
 * You have access to the cluster as a user with the `cluster-admin` role.
 
 .Procedure
-. Go to the *Cluster List* list in {cluster-manager-url} and locate your {product-title} cluster.
+
+. Go to the *Cluster List* in {cluster-manager-url} and locate your {product-title} cluster.
+
 . Click the *Overview* tab for your cluster.
+
 . Review the following information about your cluster:
 +
 * vCPU and memory availability and resource usage
@@ -34,7 +38,8 @@ From the {product-title} web console, you can review detailed information about
 To view the history for your cluster, click the *Cluster history* tab.
 ====
 
-. Navigate to the *Monitoring* page to review the following information:
+. Go to the *Monitoring* page to review the following information:
++
 * A list of any issues that have been detected
 +
 * A list of alerts that are firing
@@ -43,7 +48,8 @@ To view the history for your cluster, click the *Cluster history* tab.
 +
 * The cluster's resource usage
 
-. Optional: You can view information about your cluster that {red-hat-lightspeed} collects by navigating to the *Overview* menu. From this menu you can view the following information:
+. Optional: Go to the *Overview* menu to view information that {red-hat-lightspeed} collects about your cluster:
++
 * Potential issues that your cluster might be exposed to, categorized by risk level
 +
 * Health-check status by category
diff --git a/modules/reviewing-cluster-status-from-the-openshift-web-console.adoc b/modules/reviewing-cluster-status-from-the-openshift-web-console.adoc
@@ -6,7 +6,10 @@
 [id="reviewing-cluster-status-from-the-openshift-web-console_{context}"]
 = Reviewing the cluster status from the {product-title} web console
 
-You can review the following information in the *Overview* page in the {product-title} web console:
+[role="_abstract"]
+You can view specific information in the *Overview* page in the {product-title} web console.
+
+The *Overview* page displays the following information:
 
 * The general status of your cluster
 
@@ -32,4 +35,3 @@ You can review the following information in the *Overview* page in the {product-
 
 * Navigate to *Home* -> *Overview*.
 
-
diff --git a/modules/reviewing-the-installation-log.adoc b/modules/reviewing-the-installation-log.adoc
@@ -6,7 +6,8 @@
 [id="reviewing-the-installation-log_{context}"]
 = Reviewing the installation log
 
-You can review a summary of an installation in the {product-title} installation log. If an installation succeeds, the information required to access the cluster is included in the log.
+[role="_abstract"]
+The {product-title} installation log contains a summary of the installation, including the information required to access the cluster after installation.
 
 .Prerequisites
 
@@ -21,8 +22,6 @@ You can review a summary of an installation in the {product-title} installation
 $ cat <install_dir>/.openshift_install.log
 ----
 +
-.Example output
-+
 Cluster credentials are included at the end of the log if the installation is successful, as outlined in the following example:
 +
 [source,terminal]
diff --git a/modules/rhcos-validate-live-media.adoc b/modules/rhcos-validate-live-media.adoc
@@ -4,22 +4,25 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="rhcos-validate-live-media_{context}"]
-
 = Validating {op-system} live media
 
-The {product-title} installation program contains pinned versions of {op-system} bootimages. Fully automated installations use these pinned artifacts by default. The mirror registry where you downloaded the installation program contains a `sha256sum` encrypted with the Red{nbsp}Hat product key.
-
+[role="_abstract"]
 For user-provisioned infrastructure installations, you can access information and use the {product-title} installer to indirectly validate {op-system} bootimage artifacts using their SHA-256 checksums.
 
+The {product-title} installation program contains pinned versions of {op-system} bootimages. Fully automated installations use these pinned artifacts by default. The mirror registry where you downloaded the installation program contains a `sha256sum` encrypted with the Red{nbsp}Hat product key.
+
 .Procedure
 
 * Run the following command to print the metadata for any bootimage artifact:
 +
 [source,terminal]
 ----
-$ openshift-install coreos print-stream-json | jq <bootimage> <1>
+$ openshift-install coreos print-stream-json | jq <bootimage>
 ----
-<1> The query for the bootimage you want to obtain information on. For validation purposes, the bootimage artifact must have a generated `sha256sum`. This can include OVA, VHD, QCOW2 and others. For example, to get information on an `x86_64` architecture `iso` file for bare metal platforms, this value would be `.architectures.x86_64.artifacts.metal.formats.iso`.
++
+where:
++
+`<bootimage>`: Specifies the query for the bootimage you want to obtain information on. For validation purposes, the bootimage artifact must have a generated `sha256sum`. This can include OVA, VHD, QCOW2, and others. For example, to get information on an `x86_64` architecture `iso` file for bare metal platforms, use `.architectures.x86_64.artifacts.metal.formats.iso`.
 +
 .Example output
 [source,text]
diff --git a/modules/viewing-the-image-pull-source.adoc b/modules/viewing-the-image-pull-source.adoc
@@ -6,6 +6,7 @@
 [id="viewing-the-image-pull-source_{context}"]
 = Viewing the image pull source
 
+[role="_abstract"]
 For clusters with unrestricted network connectivity, you can view the source of your pulled images by using a command on a node, such as `crictl images`.
 
 However, for disconnected installations, to view the source of pulled images, you must review the CRI-O logs to locate the `Trying to access` log entry, as shown in the following procedure. Other methods to view the image pull source, such as the `crictl images` command, show the non-mirrored image name, even though the image is pulled from the mirrored location.
@@ -20,13 +21,10 @@ However, for disconnected installations, to view the source of pulled images, yo
 +
 [source,terminal]
 ----
-$  oc adm node-logs <node_name> -u crio
+$ oc adm node-logs <node_name> -u crio
 ----
 +
 .Example output
-+
-The `Trying to access` log entry indicates where the image is being pulled from.
-+
 [source,terminal]
 ----
 ...
@@ -36,6 +34,8 @@ Mar 17 02:52:50 ip-10-0-138-140.ec2.internal crio[1484]: time="2021-03-17 02:52:
 ...
 ----
 +
+The `Trying to access` log entry indicates where the image is being pulled from.
++
 The log might show the image pull source twice, as shown in the preceding example.
 +
 If your `ImageContentSourcePolicy` object lists multiple mirrors, {product-title} attempts to pull the images in the order listed in the configuration, for example:

Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@`
`7`	`7`	`[id="cco-ccoctl-install-verifying_{context}"]`
`8`	`8`	`= Verifying that a cluster uses short-term credentials`
`9`	`9`
	`10`	`+[role="_abstract"]`
`10`	`11`	`You can verify that a cluster uses short-term security credentials for individual components by checking the Cloud Credential Operator (CCO) configuration and other values in the cluster.`
`11`	`12`
`12`	`13`	`.Prerequisites`
`@@ -90,7 +91,7 @@ $ oc get secrets \`
`90`	`91`	`-o jsonpath='{.data}'`
`91`	`92`	`----`
`92`	`93`	`+`
`93`		-An output that contains the `azure_client_id` and `azure_federated_token_file` felids confirms that the components are assuming the {azure-short} client ID.
	`94`	+An output that contains the `azure_client_id` and `azure_federated_token_file` fields confirms that the components are assuming the {azure-short} client ID.
`94`	`95`
`95`	`96`	`* {azure-short} clusters: Verify that the pod identity webhook is running by running the following command:`
`96`	`97`	`+`