Merge pull request #75377 from michaelryanmcneill/OSDOCS-10406

OSDOCS-10406: updating and re-enabling the gather data support page

Author: bmcelvee

_topic_maps/_topic_map_osd.yml

@@ -158,10 +158,9 @@ Topics:
 # cannot list resource "secrets" in API group "" in the namespace "openshift-config"
 #  - Name: Importing simple content access entitlements with Insights Operator
 #    File: insights-operator-simple-access
-# must-gather not supported for customers, per Dustin Row, cannot create resource "namespaces"
-# - Name: Gathering data about your cluster
-#   File: gathering-cluster-data
-#   Distros: openshift-dedicated
+- Name: Gathering data about your cluster
+  File: gathering-cluster-data
+  Distros: openshift-dedicated
 - Name: Summarizing cluster specifications
   File: summarizing-cluster-specifications
   Distros: openshift-dedicated

_topic_maps/_topic_map_rosa.yml

@@ -328,10 +328,9 @@ Topics:
 # cannot list resource "secrets" in API group "" in the namespace "openshift-config"
 #  - Name: Importing simple content access entitlements with Insights Operator
 #    File: insights-operator-simple-access
-# must-gather not supported for customers, per Dustin Row, cannot create resource "namespaces"
-# - Name: Gathering data about your cluster
-#   File: gathering-cluster-data
-#   Distros: openshift-rosa
+- Name: Gathering data about your cluster
+  File: gathering-cluster-data
+  Distros: openshift-rosa
 - Name: Summarizing cluster specifications
   File: summarizing-cluster-specifications
   Distros: openshift-rosa

modules/about-must-gather.adoc

@@ -44,13 +44,7 @@ $ oc adm must-gather -- /usr/bin/gather_audit_logs
 Audit logs are not collected as part of the default set of information to reduce the size of the files.
 ====
 
-ifndef::openshift-rosa,openshift-dedicated[]
 When you run `oc adm must-gather`, a new pod with a random name is created in a new project on the cluster. The data is collected on that pod and saved in a new directory that starts with `must-gather.local` in the current working directory.
-endif::openshift-rosa,openshift-dedicated[]
-
-ifdef::openshift-rosa,openshift-dedicated[]
-When you run `oc adm must-gather`, the data is collected and saved in a new directory that starts with `must-gather.local` in the current working directory.
-endif::openshift-rosa,openshift-dedicated[]
 
 For example:
 

modules/gathering-data-network-logs.adoc

@@ -17,7 +17,7 @@ You can gather network logs on all nodes in a cluster.
 ----
 $ oc adm must-gather -- gather_network_logs
 ----
-
++
 [NOTE]
 ====
 By default, the `must-gather` tool collects the OVN `nbdb` and `sbdb` databases from all of the nodes in the cluster. Adding the `-- gather_network_logs` option to include additional logs that contain OVN-Kubernetes transactions for OVN `nbdb` database.

modules/gathering-data-specific-features.adoc

@@ -34,28 +34,23 @@ ifndef::openshift-origin[]
 |`registry.redhat.io/openshift-service-mesh/istio-must-gather-rhel8:<installed_version_service_mesh>`
 |Data collection for Red Hat OpenShift Service Mesh.
 
-ifndef::openshift-dedicated[]
 |`registry.redhat.io/rhmtc/openshift-migration-must-gather-rhel8:v<installed_version_migration_toolkit>`
 |Data collection for the {mtc-full}.
-endif::openshift-dedicated[]
-ifdef::openshift-dedicated[]
-|`registry.redhat.io/rhcam-1-2/openshift-migration-must-gather-rhel8`
-|Data collection for migration-related information.
-endif::openshift-dedicated[]
 
+ifndef::openshift-rosa,openshift-dedicated[]
 |`registry.redhat.io/odf4/ocs-must-gather-rhel8:v<installed_version_ODF>`
 |Data collection for {rh-storage-first}.
+endif::openshift-rosa,openshift-dedicated[]
 
 |`registry.redhat.io/openshift-logging/cluster-logging-rhel9-operator:v<installed_version_logging>`
 |Data collection for {logging}.
 
 |`registry.redhat.io/openshift4/ose-csi-driver-shared-resource-mustgather-rhel8`
 |Data collection for OpenShift Shared Resource CSI Driver.
 
-ifndef::openshift-dedicated[]
+ifndef::openshift-rosa,openshift-dedicated[]
 |`registry.redhat.io/openshift4/ose-local-storage-mustgather-rhel8:v<installed_version_LSO>`
 |Data collection for Local Storage Operator.
-endif::openshift-dedicated[]
 
 |`registry.redhat.io/openshift-sandboxed-containers/osc-must-gather-rhel8:v<installed_version_sandboxed_containers>`
 |Data collection for {sandboxed-containers-first}.
@@ -71,15 +66,18 @@ endif::openshift-dedicated[]
 
 |`registry.redhat.io/workload-availability/node-maintenance-must-gather-rhel8:v<installed-version-NMO>`
 |Data collection for the Node Maintenance Operator (NMO).
+endif::openshift-rosa,openshift-dedicated[]
 
 |`registry.redhat.io/openshift-gitops-1/must-gather-rhel8:v<installed_version_GitOps>`
 |Data collection for {gitops-title}.
 
 |`registry.redhat.io/openshift4/ose-secrets-store-csi-mustgather-rhel8:v<installed_version_secret_store>`
 |Data collection for the {secrets-store-operator}.
 
+ifndef::openshift-rosa,openshift-dedicated[]
 |`registry.redhat.io/lvms4/lvms-must-gather-rhel9:v<installed_version_LVMS>`
 |Data collection for the LVM Operator.
+endif::openshift-rosa,openshift-dedicated[]
 
 |`registry.redhat.io/rhacm2/acm-must-gather-rhel9:v<ACM_version>`
 |Data collection for {rh-rhacm-first} 2.10 and later.
@@ -97,7 +95,7 @@ endif::openshift-dedicated[]
 
 [NOTE]
 ====
-To determine the latest version for an {product-title} component's image, see the link:https://access.redhat.com/support/policy/updates/openshift[Red Hat {product-title} Life Cycle Policy] web page on the Red Hat Customer Portal.
+To determine the latest version for an {product-title} component's image, see the link:https://access.redhat.com/support/policy/updates/openshift_operators[OpenShift Operator Life Cycles] web page on the Red Hat Customer Portal.
 ====
 
 endif::openshift-origin[]
@@ -143,18 +141,13 @@ endif::from-main-support-section[]
 
 .Prerequisites
 
-ifndef::openshift-rosa,openshift-dedicated[]
 * You have access to the cluster as a user with the `cluster-admin` role.
+ifndef::openshift-rosa,openshift-dedicated[]
+* The {product-title} CLI (`oc`) is installed.
 endif::openshift-rosa,openshift-dedicated[]
 ifdef::openshift-rosa,openshift-dedicated[]
-* You have access to the cluster as a user with the `dedicated-admin` role.
-endif::openshift-rosa,openshift-dedicated[]
-ifndef::openshift-dedicated[]
-* The {product-title} CLI (`oc`) is installed.
-endif::openshift-dedicated[]
-ifdef::openshift-dedicated[]
 * The OpenShift CLI (`oc`) is installed.
-endif::openshift-dedicated[]
+endif::openshift-rosa,openshift-dedicated[]
 
 .Procedure
 
@@ -167,8 +160,9 @@ ifndef::openshift-origin[]
 [NOTE]
 ====
 * To collect the default `must-gather` data in addition to specific feature data, add the `--image-stream=openshift/must-gather` argument.
-
+ifndef::openshift-rosa,openshift-dedicated[]
 * For information on gathering data about the Custom Metrics Autoscaler, see the Additional resources section that follows.
+endif::openshift-rosa,openshift-dedicated[]
 ====
 +
 For example, the following command gathers both the default cluster data and information specific to {VirtProductName}:

modules/querying-cluster-node-journal-logs.adoc

@@ -11,15 +11,20 @@ You can gather `journald` unit logs and other logs within `/var/log` on individu
 
 .Prerequisites
 
-ifndef::openshift-rosa,openshift-dedicated[]
 * You have access to the cluster as a user with the `cluster-admin` role.
-endif::openshift-rosa,openshift-dedicated[]
-ifdef::openshift-rosa,openshift-dedicated[]
-* You have access to the cluster as a user with the `dedicated-admin` role.
-endif::openshift-rosa,openshift-dedicated[]
-* Your API service is still functional.
+ifdef::openshift-dedicated[]
++
+[NOTE]
+====
+In {product-title} deployments, customers who are not using the Customer Cloud Subscription (CCS) model cannot use the `oc adm node-logs` command as it requires `cluster-admin` privileges.
+====
++
+endif::openshift-dedicated[]
 * You have installed the OpenShift CLI (`oc`).
+ifndef::openshift-rosa,openshift-dedicated[]
+* Your API service is still functional.
 * You have SSH access to your hosts.
+endif::openshift-rosa,openshift-dedicated[]
 
 .Procedure
 
@@ -46,6 +51,7 @@ $ oc adm node-logs --role=master --path=openshift-apiserver
 $ oc adm node-logs --role=master --path=openshift-apiserver/audit.log
 ----
 +
+ifndef::openshift-rosa,openshift-dedicated[]
 .. If the API is not functional, review the logs on each node using SSH instead. The following example tails `/var/log/openshift-apiserver/audit.log`:
 +
 [source,terminal]
@@ -57,3 +63,4 @@ $ ssh core@<master-node>.<cluster_name>.<base_domain> sudo tail -f /var/log/open
 ====
 {product-title} {product-version} cluster nodes running {op-system-first} are immutable and rely on Operators to apply cluster changes. Accessing cluster nodes by using SSH is not recommended. Before attempting to collect diagnostic data over SSH, review whether the data collected by running `oc adm must gather` and other `oc` commands is sufficient instead. However, if the {product-title} API is not available, or the kubelet is not properly functioning on the target node, `oc` operations will be impacted. In such situations, it is possible to access nodes using `ssh core@<node>.<cluster_name>.<base_domain>`.
 ====
+endif::openshift-rosa,openshift-dedicated[]

modules/support-collecting-host-network-trace.adoc

@@ -30,13 +30,15 @@ However, you can run any command in the container image that is specified in the
 
 .Prerequisites
 
-ifndef::openshift-rosa,openshift-dedicated[]
 * You are logged in to {product-title} as a user with the `cluster-admin` role.
-endif::openshift-rosa,openshift-dedicated[]
-ifdef::openshift-rosa,openshift-dedicated[]
-* You are logged in to {product-title} as a user with the `dedicated-admin` role.
-endif::openshift-rosa,openshift-dedicated[]
-
++
+ifdef::openshift-dedicated[]
+[NOTE]
+====
+In {product-title} deployments, customers who are not using the Customer Cloud Subscription (CCS) model cannot use the `oc adm must-gather` command as it requires `cluster-admin` privileges.
+====
+endif::openshift-dedicated[]
++
 * You have installed the OpenShift CLI (`oc`).
 
 .Procedure

modules/support-collecting-network-trace.adoc

@@ -10,17 +10,22 @@ When investigating potential network-related {product-title} issues, Red Hat Sup
 
 .Prerequisites
 
-ifndef::openshift-rosa,openshift-dedicated[]
 * You have access to the cluster as a user with the `cluster-admin` role.
-endif::openshift-rosa,openshift-dedicated[]
-ifdef::openshift-rosa,openshift-dedicated[]
-* You have access to the cluster as a user with the `dedicated-admin` role.
-endif::openshift-rosa,openshift-dedicated[]
++
+ifdef::openshift-dedicated[]
+[NOTE]
+====
+In {product-title} deployments, customers who are not using the Customer Cloud Subscription (CCS) model cannot use the `oc debug` command as it requires `cluster-admin` privileges.
+====
+endif::openshift-dedicated[]
++
 * You have installed the OpenShift CLI (`oc`).
+* You have an existing Red Hat Support case ID.
+ifndef::openshift-rosa,openshift-dedicated[]
 * You have a Red Hat standard or premium Subscription.
 * You have a Red Hat Customer Portal account.
-* You have an existing Red Hat Support case ID.
 * You have SSH access to your hosts.
+endif::openshift-rosa,openshift-dedicated[]
 
 .Procedure
 
@@ -45,11 +50,13 @@ $ oc debug node/my-cluster-node
 # chroot /host
 ----
 +
+ifndef::openshift-rosa,openshift-dedicated[]
 [NOTE]
 ====
 {product-title} {product-version} cluster nodes running {op-system-first} are immutable and rely on Operators to apply cluster changes. Accessing cluster nodes by using SSH is not recommended. However, if the {product-title} API is not available, or the kubelet is not properly functioning on the target node, `oc` operations will be impacted. In such situations, it is possible to access nodes using `ssh core@<node>.<cluster_name>.<base_domain>` instead.
 ====
 +
+endif::openshift-rosa,openshift-dedicated[]
 . From within the `chroot` environment console, obtain the node's interface names:
 +
 [source,terminal]
@@ -120,11 +127,13 @@ $ oc debug node/my-cluster-node -- bash -c 'cat /host/var/tmp/my-tcpdump-capture
 ----
 <1> The debug container mounts the host's root directory at `/host`. Reference the absolute path from the debug container's root directory, including `/host`, when specifying target files for concatenation.
 +
+ifndef::openshift-rosa,openshift-dedicated[]
 [NOTE]
 ====
 {product-title} {product-version} cluster nodes running {op-system-first} are immutable and rely on Operators to apply cluster changes. Transferring a `tcpdump` capture file from a cluster node by using `scp` is not recommended. However, if the {product-title} API is not available, or the kubelet is not properly functioning on the target node, `oc` operations will be impacted. In such situations, it is possible to copy a `tcpdump` capture file from a node by running `scp core@<node>.<cluster_name>.<base_domain>:<file_path> <local_path>`.
 ====
 +
+endif::openshift-rosa,openshift-dedicated[]
 .. Navigate to an existing support case within link:https://access.redhat.com/support/cases/#/case/list[the *Customer Support* page] of the Red Hat Customer Portal.
 +
 .. Select *Attach files* and follow the prompts to upload the file.

modules/support-gather-data.adoc

@@ -10,19 +10,29 @@ You can gather debugging information about your cluster by using the `oc adm mus
 
 .Prerequisites
 
-ifndef::openshift-rosa,openshift-dedicated[]
 * You have access to the cluster as a user with the `cluster-admin` role.
++
+ifdef::openshift-dedicated[]
+[NOTE]
+====
+In {product-title} deployments, customers who are not using the Customer Cloud Subscription (CCS) model cannot use the `oc adm must-gather` command as it requires `cluster-admin` privileges.
+====
+endif::openshift-dedicated[]
++
+ifndef::openshift-rosa,openshift-dedicated[]
+* The {product-title} CLI (`oc`) is installed.
 endif::openshift-rosa,openshift-dedicated[]
 ifdef::openshift-rosa,openshift-dedicated[]
-* You have access to the cluster as a user with the `dedicated-admin` role.
+* The OpenShift CLI (`oc`) is installed.
 endif::openshift-rosa,openshift-dedicated[]
-* The {product-title} CLI (`oc`) is installed.
+
 
 .Procedure
 
 . Navigate to the directory where you want to store the `must-gather` data.
 +
 
+ifndef::openshift-rosa,openshift-dedicated[]
 [NOTE]
 ====
 If your cluster is in a disconnected environment, you must take additional steps. If your mirror registry has a trusted CA, you must first add the trusted CA to the cluster. For all clusters in disconnected environments, you must import the default `must-gather` image as an image stream.
@@ -32,6 +42,7 @@ If your cluster is in a disconnected environment, you must take additional steps
 $ oc import-image is/must-gather -n openshift
 ----
 ====
+endif::openshift-rosa,openshift-dedicated[]
 
 . Run the `oc adm must-gather` command:
 +
@@ -41,11 +52,13 @@ $ oc import-image is/must-gather -n openshift
 $ oc adm must-gather
 ----
 +
+ifndef::openshift-rosa,openshift-dedicated[]
 [IMPORTANT]
 ====
 If you are in a disconnected environment, use the `--image` flag as part of must-gather and point to the payload image.
 ====
 +
+endif::openshift-rosa,openshift-dedicated[]
 [NOTE]
 ====
 Because this command picks a random control plane node by default, the pod might be scheduled to a control plane node that is in the `NotReady` and `SchedulingDisabled` state.

modules/support-get-cluster-id.adoc

@@ -19,7 +19,13 @@ endif::openshift-rosa,openshift-dedicated[]
 * You have access to the web console or the OpenShift CLI (`oc`) installed.
 
 .Procedure
-ifdef::openshift-enterprise,openshift-webscale,openshift-dedicated[]
+ifdef::openshift-rosa,openshift-dedicated[]
+* To manually obtain your cluster ID using {cluster-manager-url}:
+.. Navigate to *Clusters*.
+.. Click on the name of the cluster you need to open a support case for.
+.. Find the value in the *Cluster ID* field of the *Details* section of the *Overview* tab.
+endif::[]
+ifdef::openshift-enterprise,openshift-webscale,openshift-dedicated,openshift-rosa[]
 * To open a support case and have your cluster ID autofilled using the web console:
 .. From the toolbar, navigate to *(?) Help* and select *Share Feedback* from the list.
 .. Click *Open a support case* from the *Tell us about your experience* window.