diff --git a/_topic_maps/_topic_map_osd.yml b/_topic_maps/_topic_map_osd.yml index 1b4314a364..ba0c89064a 100644 --- a/_topic_maps/_topic_map_osd.yml +++ b/_topic_maps/_topic_map_osd.yml @@ -56,9 +56,6 @@ Topics: File: policy-understand-availability - Name: Update life cycle File: osd-life-cycle -- Name: Support for OpenShift Dedicated - File: osd-support - Distros: openshift-dedicated --- #Name: Tutorials #Dir: cloud_experts_tutorials @@ -107,6 +104,87 @@ Topics: - Name: Deleting an OpenShift Dedicated cluster File: osd-deleting-a-cluster --- +Name: Support +Dir: support +Distros: openshift-dedicated +Topics: +- Name: Support overview + File: index +- Name: Managing your cluster resources + File: managing-cluster-resources +- Name: Getting support + File: getting-support + Distros: openshift-dedicated +- Name: Remote health monitoring with connected clusters + Dir: remote_health_monitoring + Distros: openshift-dedicated + Topics: + - Name: About remote health monitoring + File: about-remote-health-monitoring + - Name: Showing data collected by remote health monitoring + File: showing-data-collected-by-remote-health-monitoring +# cannot get resource "secrets" in API group "" in the namespace "openshift-config" +# - Name: Opting out of remote health reporting +# File: opting-out-of-remote-health-reporting +# cannot get resource "secrets" in API group "" in the namespace "openshift-config" +# - Name: Enabling remote health reporting +# File: enabling-remote-health-reporting + - Name: Using Insights to identify issues with your cluster + File: using-insights-to-identify-issues-with-your-cluster + - Name: Using Insights Operator + File: using-insights-operator +# Not supported per Michael McNeill +# - Name: Using remote health reporting in a restricted network +# File: remote-health-reporting-from-restricted-network +# 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: Summarizing cluster specifications + File: summarizing-cluster-specifications + Distros: openshift-dedicated +- Name: Troubleshooting + Dir: troubleshooting + Distros: openshift-dedicated + Topics: +# - Name: Troubleshooting installations +# File: troubleshooting-installations + - Name: Verifying node health + File: verifying-node-health +# cannot create resource "namespaces", cannot patch resource "nodes" +# - Name: Troubleshooting CRI-O container runtime issues +# File: troubleshooting-crio-issues +# requires ostree, butane, and other plug-ins +# - Name: Troubleshooting operating system issues +# File: troubleshooting-operating-system-issues +# Distros: openshift-dedicated +# cannot patch resource "nodes", "nodes/proxy", "namespaces" +# - Name: Troubleshooting network issues +# File: troubleshooting-network-issues +# Distros: openshift-dedicated + - Name: Troubleshooting Operator issues + File: troubleshooting-operator-issues + - Name: Investigating pod issues + File: investigating-pod-issues +# Hiding from ROSA and OSD until it is decided who should port the Build book +# - Name: Troubleshooting the Source-to-Image process +# File: troubleshooting-s2i + - Name: Troubleshooting storage issues + File: troubleshooting-storage-issues +# Not supported per WINC team +# - Name: Troubleshooting Windows container workload issues +# File: troubleshooting-windows-container-workload-issues + - Name: Investigating monitoring issues + File: investigating-monitoring-issues + - Name: Diagnosing OpenShift CLI (oc) issues + File: diagnosing-oc-issues + - Name: OpenShift Dedicated managed resources + File: osd-managed-resources + Distros: openshift-dedicated +--- Name: CLI tools Dir: cli_reference Distros: openshift-dedicated @@ -645,24 +723,3 @@ Topics: Topics: - Name: Serverless overview File: about-serverless ---- -Name: Troubleshooting -Dir: sd_support -Distros: openshift-dedicated -Topics: -- Name: Remote health monitoring with connected clusters - Dir: remote_health_monitoring - Distros: openshift-dedicated - Topics: - - Name: About remote health monitoring - File: about-remote-health-monitoring - - Name: Showing data collected by remote health monitoring - File: showing-data-collected-by-remote-health-monitoring - - Name: Using Insights to identify issues with your cluster - File: using-insights-to-identify-issues-with-your-cluster -- Name: Summarizing cluster specifications - File: osd-summarizing-cluster-specifications - Distros: openshift-dedicated -- Name: OpenShift Dedicated managed resources - File: osd-managed-resources - Distros: openshift-dedicated diff --git a/_topic_maps/_topic_map_rosa.yml b/_topic_maps/_topic_map_rosa.yml index 55b3b0fc67..3e803a1e1d 100644 --- a/_topic_maps/_topic_map_rosa.yml +++ b/_topic_maps/_topic_map_rosa.yml @@ -73,8 +73,6 @@ Topics: File: rosa-sts-about-iam-resources - Name: OpenID Connect Overview File: rosa-oidc-overview -- Name: Support for ROSA - File: rosa-getting-support # - Name: Training for ROSA # File: rosa-training --- @@ -205,6 +203,99 @@ Topics: - Name: Command quick reference for creating clusters and users File: rosa-quickstart --- +Name: Support +Dir: support +Distros: openshift-rosa +Topics: +- Name: Support overview + File: index +- Name: Managing your cluster resources + File: managing-cluster-resources +- Name: Getting support + File: getting-support + Distros: openshift-rosa +- Name: Remote health monitoring with connected clusters + Dir: remote_health_monitoring + Distros: openshift-rosa + Topics: + - Name: About remote health monitoring + File: about-remote-health-monitoring + - Name: Showing data collected by remote health monitoring + File: showing-data-collected-by-remote-health-monitoring +# cannot get resource "secrets" in API group "" in the namespace "openshift-config" +# - Name: Opting out of remote health reporting +# File: opting-out-of-remote-health-reporting +# cannot get resource "secrets" in API group "" in the namespace "openshift-config" +# - Name: Enabling remote health reporting +# File: enabling-remote-health-reporting + - Name: Using Insights to identify issues with your cluster + File: using-insights-to-identify-issues-with-your-cluster + - Name: Using Insights Operator + File: using-insights-operator +# Not supported per Michael McNeill +# - Name: Using remote health reporting in a restricted network +# File: remote-health-reporting-from-restricted-network +# 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: Summarizing cluster specifications + File: summarizing-cluster-specifications + Distros: openshift-rosa +- Name: Troubleshooting + Dir: troubleshooting + Distros: openshift-rosa + Topics: +# rosa has own troubleshooting installations +# - Name: Troubleshooting installations +# File: troubleshooting-installations + - Name: Troubleshooting ROSA installations + File: rosa-troubleshooting-installations + - Name: Verifying node health + File: verifying-node-health +# cannot create resource "namespaces", cannot patch resource "nodes" +# - Name: Troubleshooting CRI-O container runtime issues +# File: troubleshooting-crio-issues +# requires ostree, butane, and other plug-ins +# - Name: Troubleshooting operating system issues +# File: troubleshooting-operating-system-issues +# Distros: openshift-rosa +# cannot patch resource "nodes", "nodes/proxy", "namespaces" +# - Name: Troubleshooting network issues +# File: troubleshooting-network-issues +# Distros: openshift-rosa + - Name: Troubleshooting Operator issues + File: troubleshooting-operator-issues + - Name: Investigating pod issues + File: investigating-pod-issues +# Hiding from ROSA and OSD until it is decided who should port the Build book +# - Name: Troubleshooting the Source-to-Image process +# File: troubleshooting-s2i + - Name: Troubleshooting storage issues + File: troubleshooting-storage-issues +# Not supported per WINC team +# - Name: Troubleshooting Windows container workload issues +# File: troubleshooting-windows-container-workload-issues + - Name: Investigating monitoring issues + File: investigating-monitoring-issues + - Name: Diagnosing OpenShift CLI (oc) issues + File: diagnosing-oc-issues + - Name: Troubleshooting expired offline access tokens + File: rosa-troubleshooting-expired-tokens + Distros: openshift-rosa + - Name: Troubleshooting IAM roles + File: rosa-troubleshooting-iam-resources + Distros: openshift-rosa + - Name: Troubleshooting cluster deployments + File: rosa-troubleshooting-deployments + Distros: openshift-rosa + - Name: Red Hat OpenShift Service on AWS managed resources + File: rosa-managed-resources + Distros: openshift-rosa +--- Name: CLI tools Dir: cli_reference Distros: openshift-rosa @@ -888,27 +979,3 @@ Topics: Topics: - Name: Serverless overview File: about-serverless ---- -Name: Troubleshooting -Dir: sd_support -Distros: openshift-rosa -Topics: -- Name: Remote health monitoring with connected clusters - Dir: remote_health_monitoring - Topics: - - Name: About remote health monitoring - File: about-remote-health-monitoring - - Name: Showing data collected by remote health monitoring - File: showing-data-collected-by-remote-health-monitoring - - Name: Using Insights to identify issues with your cluster - File: using-insights-to-identify-issues-with-your-cluster -- Name: Troubleshooting expired offline access tokens - File: rosa-troubleshooting-expired-tokens -- Name: Troubleshooting installations - File: rosa-troubleshooting-installations -- Name: Troubleshooting IAM roles - File: rosa-troubleshooting-iam-resources -- Name: Troubleshooting cluster deployments - File: rosa-troubleshooting-deployments -- Name: Red Hat OpenShift Service on AWS managed resources - File: rosa-managed-resources diff --git a/authentication/managing-security-context-constraints.adoc b/authentication/managing-security-context-constraints.adoc index 3e95b0558f..c0a97773bd 100644 --- a/authentication/managing-security-context-constraints.adoc +++ b/authentication/managing-security-context-constraints.adoc @@ -47,12 +47,4 @@ include::modules/security-context-constraints-command-reference.adoc[leveloffset [id="additional-resources_configuring-internal-oauth"] == Additional resources -ifndef::openshift-dedicated,openshift-rosa[] -* xref:../support/getting-support.adoc#getting-support[Getting support] -endif::[] -ifdef::openshift-dedicated[] -* xref:../osd_architecture/osd-support.adoc#osd-getting-support[Getting support] -endif::[] -ifdef::openshift-rosa[] -* xref:../rosa_architecture/rosa-getting-support.adoc#rosa-getting-support[Getting support] -endif::[] +* xref:../support/getting-support.adoc#getting-support[Getting support] \ No newline at end of file diff --git a/modules/about-must-gather.adoc b/modules/about-must-gather.adoc index c6e31b347f..258e329d21 100644 --- a/modules/about-must-gather.adoc +++ b/modules/about-must-gather.adoc @@ -44,7 +44,13 @@ $ 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. ==== -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`. This directory is created in the current working directory. +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: @@ -65,4 +71,4 @@ For example: ---- $ oc adm must-gather --run-namespace \ --image=registry.redhat.io/container-native-virtualization/cnv-must-gather-rhel9:v{HCOVersion} ----- \ No newline at end of file +---- diff --git a/modules/accessing-running-pods.adoc b/modules/accessing-running-pods.adoc index 5513024f44..f0fdfe65a4 100644 --- a/modules/accessing-running-pods.adoc +++ b/modules/accessing-running-pods.adoc @@ -10,7 +10,12 @@ You can review running pods dynamically by opening a shell inside a pod or by ga .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. * You have installed the OpenShift CLI (`oc`). diff --git a/modules/cluster-resources.adoc b/modules/cluster-resources.adoc index 1efb54bcb6..a013cfb44c 100644 --- a/modules/cluster-resources.adoc +++ b/modules/cluster-resources.adoc @@ -6,7 +6,12 @@ You can interact with cluster resources by using the OpenShift CLI (`oc`) tool i .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[] * You have access to the web console or you have installed the `oc` CLI tool. .Procedure diff --git a/modules/copying-files-pods-and-containers.adoc b/modules/copying-files-pods-and-containers.adoc index 42c8553049..15d7e9364b 100644 --- a/modules/copying-files-pods-and-containers.adoc +++ b/modules/copying-files-pods-and-containers.adoc @@ -10,7 +10,12 @@ You can copy files to and from a pod to test configuration changes or gather dia .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. * You have installed the OpenShift CLI (`oc`). diff --git a/modules/disabling-insights-advisor-recommendations.adoc b/modules/disabling-insights-advisor-recommendations.adoc index 2b0d256497..4a380cdba4 100644 --- a/modules/disabling-insights-advisor-recommendations.adoc +++ b/modules/disabling-insights-advisor-recommendations.adoc @@ -1,7 +1,6 @@ // Module included in the following assemblies: // // * support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc -// * sd_support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc :_content-type: PROCEDURE [id="disabling-insights-advisor-recommendations_{context}"] diff --git a/modules/disabling-insights-operator-gather.adoc b/modules/disabling-insights-operator-gather.adoc index 3ecc9b4773..51ebd14e67 100644 --- a/modules/disabling-insights-operator-gather.adoc +++ b/modules/disabling-insights-operator-gather.adoc @@ -19,7 +19,12 @@ If you enable Technology Preview in your cluster, the Insights Operator runs gat .Prerequisites -* You are logged in to the {product-title} web console as a user with `cluster-admin` role. +ifndef::openshift-rosa,openshift-dedicated[] +* You are logged in to the {product-title} web console as a user with the `cluster-admin` role. +endif::openshift-rosa,openshift-dedicated[] +ifdef::openshift-rosa,openshift-dedicated[] +* You are logged in to the {product-title} web console as a user with the `dedicated-admin` role. +endif::openshift-rosa,openshift-dedicated[] .Procedure diff --git a/modules/displaying-all-insights-advisor-recommendations.adoc b/modules/displaying-all-insights-advisor-recommendations.adoc index 770fef46d2..815b27868f 100644 --- a/modules/displaying-all-insights-advisor-recommendations.adoc +++ b/modules/displaying-all-insights-advisor-recommendations.adoc @@ -1,7 +1,6 @@ // Module included in the following assemblies: // // * support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc -// * sd_support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc :_content-type: PROCEDURE [id="displaying-all-insights-advisor-recommendations_{context}"] diff --git a/modules/displaying-potential-issues-with-your-cluster.adoc b/modules/displaying-potential-issues-with-your-cluster.adoc index 2d441f83da..ebe0e61f82 100644 --- a/modules/displaying-potential-issues-with-your-cluster.adoc +++ b/modules/displaying-potential-issues-with-your-cluster.adoc @@ -1,7 +1,6 @@ // Module included in the following assemblies: // // * support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc -// * sd_support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc :_content-type: PROCEDURE [id="displaying-potential-issues-with-your-cluster_{context}"] diff --git a/modules/displaying-the-insights-status-in-the-web-console.adoc b/modules/displaying-the-insights-status-in-the-web-console.adoc index dfbd2add1e..77ce8e86a3 100644 --- a/modules/displaying-the-insights-status-in-the-web-console.adoc +++ b/modules/displaying-the-insights-status-in-the-web-console.adoc @@ -1,7 +1,6 @@ // Module included in the following assemblies: // // * support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc -// * sd_support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc :_content-type: PROCEDURE [id="displaying-the-insights-status-in-the-web-console_{context}"] diff --git a/modules/enabling-insights-advisor-recommendations.adoc b/modules/enabling-insights-advisor-recommendations.adoc index f11d3363ba..28ed7a3d12 100644 --- a/modules/enabling-insights-advisor-recommendations.adoc +++ b/modules/enabling-insights-advisor-recommendations.adoc @@ -1,7 +1,6 @@ // Module included in the following assemblies: // // * support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc -// * sd_support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc :_content-type: PROCEDURE [id="enabling-insights-advisor-recommendations_{context}"] diff --git a/modules/gathering-application-diagnostic-data.adoc b/modules/gathering-application-diagnostic-data.adoc index 71e47442a9..0b80ac8612 100644 --- a/modules/gathering-application-diagnostic-data.adoc +++ b/modules/gathering-application-diagnostic-data.adoc @@ -14,7 +14,12 @@ Application failures can occur within running application pods. In these situati .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[] * You have installed the OpenShift CLI (`oc`). .Procedure @@ -71,6 +76,8 @@ $ oc exec -it my-app-1-akdlg /bin/bash Root privileges are required to run some diagnostic binaries. In these situations you can start a debug pod with root access, based on a problematic pod's `DeploymentConfig` object, by running `oc debug dc/ --as-root`. Then, you can run diagnostic binaries as root from within the debug pod. ==== +// cannot create resource "namespaces" in API group +ifndef::openshift-rosa,openshift-dedicated[] . If diagnostic binaries are not available within a container, you can run a host's diagnostic binaries within a container's namespace by using `nsenter`. The following example runs `ip ad` within a container's namespace, using the host`s `ip` binary. .. Enter into a debug session on the target node. This step instantiates a debug pod called `-debug`: + @@ -116,3 +123,4 @@ $ oc debug node/my-cluster-node ==== Running a host's diagnostic binaries within a container's namespace is only possible if you are using a privileged container such as a debug node. ==== +endif::openshift-rosa,openshift-dedicated[] diff --git a/modules/gathering-crio-logs.adoc b/modules/gathering-crio-logs.adoc index a6939d6d5d..c3b2e263af 100644 --- a/modules/gathering-crio-logs.adoc +++ b/modules/gathering-crio-logs.adoc @@ -10,7 +10,12 @@ If you experience CRI-O issues, you can obtain CRI-O journald unit logs from a n .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. * You have installed the OpenShift CLI (`oc`). * You have the fully qualified domain names of the control plane or control plane machines. diff --git a/modules/gathering-data-specific-features.adoc b/modules/gathering-data-specific-features.adoc index bd755a4e40..33dfdf6286 100644 --- a/modules/gathering-data-specific-features.adoc +++ b/modules/gathering-data-specific-features.adoc @@ -121,12 +121,17 @@ endif::from-main-support-section[] .Prerequisites -* Access to the cluster as a user with the `cluster-admin` role. +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[] ifndef::openshift-dedicated[] -* The {product-title} CLI (`oc`) installed. +* The {product-title} CLI (`oc`) is installed. endif::openshift-dedicated[] ifdef::openshift-dedicated[] -* The OpenShift CLI (`oc`) installed. +* The OpenShift CLI (`oc`) is installed. endif::openshift-dedicated[] .Procedure diff --git a/modules/gathering-operator-logs.adoc b/modules/gathering-operator-logs.adoc index db808849d4..b792aadd90 100644 --- a/modules/gathering-operator-logs.adoc +++ b/modules/gathering-operator-logs.adoc @@ -10,7 +10,12 @@ If you experience Operator issues, you can gather detailed diagnostic informatio .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. * You have installed the OpenShift CLI (`oc`). * You have the fully qualified domain names of the control plane or control plane machines. diff --git a/modules/gathering-s2i-diagnostic-data.adoc b/modules/gathering-s2i-diagnostic-data.adoc index 2a9dcaf183..3c84ebb63a 100644 --- a/modules/gathering-s2i-diagnostic-data.adoc +++ b/modules/gathering-s2i-diagnostic-data.adoc @@ -10,7 +10,12 @@ The S2I tool runs a build pod and a deployment pod in sequence. The deployment p .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. * You have installed the OpenShift CLI (`oc`). diff --git a/modules/images-update-global-pull-secret.adoc b/modules/images-update-global-pull-secret.adoc index a704667324..a4e59caa1c 100644 --- a/modules/images-update-global-pull-secret.adoc +++ b/modules/images-update-global-pull-secret.adoc @@ -3,7 +3,6 @@ // * post_installation_configuration/cluster-tasks.adoc // * updating/updating_a_cluster/updating_disconnected_cluster/disconnected-update-osus.adoc // * support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc -// * sd_support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc // // Not included, but linked to from: // * operators/admin/olm-managing-custom-catalogs.adoc diff --git a/modules/insights-operator-about.adoc b/modules/insights-operator-about.adoc index c98ba34c3b..28365c226f 100644 --- a/modules/insights-operator-about.adoc +++ b/modules/insights-operator-about.adoc @@ -1,7 +1,6 @@ // Module included in the following assemblies: // // * support/remote_health_monitoring/about-remote-health-monitoring.adoc -// * sd_support/remote_health_monitoring/about-remote-health-monitoring.adoc :_content-type: CONCEPT [id="insights-operator-about_{context}"] diff --git a/modules/insights-operator-advisor-overview.adoc b/modules/insights-operator-advisor-overview.adoc index 30fec85226..ec4cde615b 100644 --- a/modules/insights-operator-advisor-overview.adoc +++ b/modules/insights-operator-advisor-overview.adoc @@ -1,7 +1,6 @@ // Module included in the following assemblies: // // * support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc -// * sd_support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc :_content-type: CONCEPT [id="insights-operator-advisor-overview_{context}"] diff --git a/modules/insights-operator-advisor-recommendations.adoc b/modules/insights-operator-advisor-recommendations.adoc index 1c2f1a6088..bafb4dfa0f 100644 --- a/modules/insights-operator-advisor-recommendations.adoc +++ b/modules/insights-operator-advisor-recommendations.adoc @@ -1,7 +1,6 @@ // Module included in the following assemblies: // // * support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc -// * sd_support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc :_content-type: CONCEPT [id="insights-operator-advisor-recommendations_{context}"] diff --git a/modules/insights-operator-configuring-sca.adoc b/modules/insights-operator-configuring-sca.adoc index 66dc1f5f16..bb19fb492a 100644 --- a/modules/insights-operator-configuring-sca.adoc +++ b/modules/insights-operator-configuring-sca.adoc @@ -1,7 +1,6 @@ // Module included in the following assemblies: // // * support/remote_health_monitoring/insights-operator-simple-access.adoc -// * sd_support/remote_health_monitoring/insights-operator-simple-access.adoc :_content-type: PROCEDURE @@ -14,7 +13,12 @@ This procedure describes how to update the import interval to one hour. .Prerequisites -* You are logged in to the {product-title} web console as `cluster-admin`. +ifndef::openshift-rosa,openshift-dedicated[] +* You are logged in to the {product-title} web console as a user with the `cluster-admin` role. +endif::openshift-rosa,openshift-dedicated[] +ifdef::openshift-rosa,openshift-dedicated[] +* You are logged in to the {product-title} web console as a user with the `dedicated-admin` role. +endif::openshift-rosa,openshift-dedicated[] .Procedure diff --git a/modules/insights-operator-disabling-sca.adoc b/modules/insights-operator-disabling-sca.adoc index 8f6a91e2df..008317988a 100644 --- a/modules/insights-operator-disabling-sca.adoc +++ b/modules/insights-operator-disabling-sca.adoc @@ -1,7 +1,6 @@ // Module included in the following assemblies: // // * support/remote_health_monitoring/insights-operator-simple-access.adoc -// * sd_support/remote_health_monitoring/insights-operator-simple-access.adoc :_content-type: PROCEDURE diff --git a/modules/insights-operator-downloading-archive.adoc b/modules/insights-operator-downloading-archive.adoc index 81df8ba614..fec34fdc29 100644 --- a/modules/insights-operator-downloading-archive.adoc +++ b/modules/insights-operator-downloading-archive.adoc @@ -10,7 +10,12 @@ Insights Operator stores gathered data in an archive located in the `openshift-i .Prerequisites -* Access to the cluster as a user with the `cluster-admin` role. +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[] .Procedure diff --git a/modules/insights-operator-enable-obfuscation.adoc b/modules/insights-operator-enable-obfuscation.adoc index b095cb44ae..200ca9530c 100644 --- a/modules/insights-operator-enable-obfuscation.adoc +++ b/modules/insights-operator-enable-obfuscation.adoc @@ -1,7 +1,6 @@ // Module included in the following assemblies: // // * support/remote_health_monitoring/remote-health-reporting-from-restricted-network.adoc -// * sd_support/remote_health_monitoring/remote-health-reporting-from-restricted-network.adoc diff --git a/modules/insights-operator-manual-upload.adoc b/modules/insights-operator-manual-upload.adoc index b705a2c1b2..ce34e697b4 100644 --- a/modules/insights-operator-manual-upload.adoc +++ b/modules/insights-operator-manual-upload.adoc @@ -1,7 +1,6 @@ // Module included in the following assemblies: // // * support/remote_health_monitoring/remote-health-reporting-from-restricted-network.adoc -// * sd_support/remote_health_monitoring/remote-health-reporting-from-restricted-network.adoc diff --git a/modules/insights-operator-new-pull-secret-disabled.adoc b/modules/insights-operator-new-pull-secret-disabled.adoc index f1078cb7a4..5e4563811a 100644 --- a/modules/insights-operator-new-pull-secret-disabled.adoc +++ b/modules/insights-operator-new-pull-secret-disabled.adoc @@ -1,7 +1,6 @@ // Module included in the following assemblies: // // * support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc -// * sd_support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc :_content-type: PROCEDURE [id="insights-operator-new-pull-secret_{context}"] @@ -11,7 +10,12 @@ You can modify your existing global cluster pull secret to disable remote health .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[] .Procedure diff --git a/modules/insights-operator-new-pull-secret-enable.adoc b/modules/insights-operator-new-pull-secret-enable.adoc index 6a5f787863..511460a227 100644 --- a/modules/insights-operator-new-pull-secret-enable.adoc +++ b/modules/insights-operator-new-pull-secret-enable.adoc @@ -1,7 +1,6 @@ // Module included in the following assemblies: // // * support/remote_health_monitoring/enabling-remote-health-reporting.adoc -// * sd_support/remote_health_monitoring/enabling-remote-health-reporting.adoc :_content-type: PROCEDURE [id="insights-operator-new-pull-secret-enable_{context}"] diff --git a/modules/insights-operator-one-time-gather.adoc b/modules/insights-operator-one-time-gather.adoc index 0e3119e292..d9f7c7b11a 100644 --- a/modules/insights-operator-one-time-gather.adoc +++ b/modules/insights-operator-one-time-gather.adoc @@ -1,7 +1,6 @@ // Module included in the following assemblies: // // * support/remote_health_monitoring/remote-health-reporting-from-restricted-network.adoc -// * sd_support/remote_health_monitoring/remote-health-reporting-from-restricted-network.adoc diff --git a/modules/insights-operator-register-disconnected-cluster.adoc b/modules/insights-operator-register-disconnected-cluster.adoc index 420467e0bf..784abeaa14 100644 --- a/modules/insights-operator-register-disconnected-cluster.adoc +++ b/modules/insights-operator-register-disconnected-cluster.adoc @@ -1,7 +1,6 @@ // Module included in the following assemblies: // // * support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc -// * sd_support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc :_content-type: PROCEDURE diff --git a/modules/insights-operator-showing-data-collected-from-the-cluster.adoc b/modules/insights-operator-showing-data-collected-from-the-cluster.adoc index 64dbaf590e..d9f185995f 100644 --- a/modules/insights-operator-showing-data-collected-from-the-cluster.adoc +++ b/modules/insights-operator-showing-data-collected-from-the-cluster.adoc @@ -1,8 +1,6 @@ // Module included in the following assemblies: // -// * rosa_support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc // * support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc -// * sd_support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc :_content-type: PROCEDURE [id="insights-operator-showing-data-collected-from-the-cluster_{context}"] diff --git a/modules/insights-operator-what-information-is-collected.adoc b/modules/insights-operator-what-information-is-collected.adoc index 72e0cbcbf9..79a9c099f3 100644 --- a/modules/insights-operator-what-information-is-collected.adoc +++ b/modules/insights-operator-what-information-is-collected.adoc @@ -1,7 +1,6 @@ // Module included in the following assemblies: // // * support/remote_health_monitoring/about-remote-health-monitoring.adoc -// * sd_support/remote_health_monitoring/about-remote-health-monitoring.adoc [id="insights-operator-what-information-is-collected_{context}"] = Information collected by the Insights Operator diff --git a/modules/inspecting-pod-and-container-logs.adoc b/modules/inspecting-pod-and-container-logs.adoc index 011170bf8e..bc8b72eeaa 100644 --- a/modules/inspecting-pod-and-container-logs.adoc +++ b/modules/inspecting-pod-and-container-logs.adoc @@ -10,7 +10,12 @@ You can inspect pod and container logs for warnings and error messages related t .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. * You have installed the OpenShift CLI (`oc`). diff --git a/modules/investigating-etcd-installation-issues.adoc b/modules/investigating-etcd-installation-issues.adoc index 36fef08315..3c426c09eb 100644 --- a/modules/investigating-etcd-installation-issues.adoc +++ b/modules/investigating-etcd-installation-issues.adoc @@ -10,7 +10,12 @@ If you experience etcd issues during installation, you can check etcd pod status .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[] * You have installed the OpenShift CLI (`oc`). * You have SSH access to your hosts. * You have the fully qualified domain names of the control plane nodes. diff --git a/modules/investigating-kubelet-api-installation-issues.adoc b/modules/investigating-kubelet-api-installation-issues.adoc index 318b634d65..8e11084baa 100644 --- a/modules/investigating-kubelet-api-installation-issues.adoc +++ b/modules/investigating-kubelet-api-installation-issues.adoc @@ -10,7 +10,12 @@ To investigate control plane node kubelet and API server issues during installat .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[] * You have installed the OpenShift CLI (`oc`). * You have SSH access to your hosts. * You have the fully qualified domain names of the control plane nodes. diff --git a/modules/investigating-master-node-installation-issues.adoc b/modules/investigating-master-node-installation-issues.adoc index 39f69cc8cd..7af7f0c6d7 100644 --- a/modules/investigating-master-node-installation-issues.adoc +++ b/modules/investigating-master-node-installation-issues.adoc @@ -10,7 +10,12 @@ If you experience control plane node installation issues, determine the control .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[] * You have installed the OpenShift CLI (`oc`). * You have SSH access to your hosts. * You have the fully qualified domain names of the bootstrap and control plane nodes. diff --git a/modules/investigating-worker-node-installation-issues.adoc b/modules/investigating-worker-node-installation-issues.adoc index 0050ee3a55..6f3fa95b01 100644 --- a/modules/investigating-worker-node-installation-issues.adoc +++ b/modules/investigating-worker-node-installation-issues.adoc @@ -10,7 +10,12 @@ If you experience worker node installation issues, you can review the worker nod .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[] * You have installed the OpenShift CLI (`oc`). * You have SSH access to your hosts. * You have the fully qualified domain names of the bootstrap and worker nodes. diff --git a/modules/monitoring-investigating-why-user-defined-metrics-are-unavailable.adoc b/modules/monitoring-investigating-why-user-defined-metrics-are-unavailable.adoc index c3bbfb3c95..9d3c3672c8 100644 --- a/modules/monitoring-investigating-why-user-defined-metrics-are-unavailable.adoc +++ b/modules/monitoring-investigating-why-user-defined-metrics-are-unavailable.adoc @@ -11,7 +11,12 @@ .Prerequisites -* You have access to the cluster as a user with the `cluster-admin` cluster role. +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[] * You have installed the OpenShift CLI (`oc`). * You have enabled and configured monitoring for user-defined workloads. * You have created the `user-workload-monitoring-config` `ConfigMap` object. diff --git a/modules/olm-cs-status-cli.adoc b/modules/olm-cs-status-cli.adoc index 4bb4d37cb2..d036d313e0 100644 --- a/modules/olm-cs-status-cli.adoc +++ b/modules/olm-cs-status-cli.adoc @@ -18,12 +18,12 @@ You can view the status of an Operator catalog source by using the CLI. .Prerequisites -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-rosa,openshift-dedicated[] * You have access to the cluster as a user with the `cluster-admin` role. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +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-dedicated,openshift-rosa[] +endif::openshift-rosa,openshift-dedicated[] * You have installed the OpenShift CLI (`oc`). .Procedure diff --git a/modules/olm-status-viewing-cli.adoc b/modules/olm-status-viewing-cli.adoc index 46935111be..5bc9e4f50f 100644 --- a/modules/olm-status-viewing-cli.adoc +++ b/modules/olm-status-viewing-cli.adoc @@ -11,12 +11,12 @@ You can view Operator subscription status by using the CLI. .Prerequisites -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-rosa,openshift-dedicated[] * You have access to the cluster as a user with the `cluster-admin` role. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +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-dedicated,openshift-rosa[] +endif::openshift-rosa,openshift-dedicated[] * You have installed the OpenShift CLI (`oc`). .Procedure diff --git a/modules/querying-cluster-node-journal-logs.adoc b/modules/querying-cluster-node-journal-logs.adoc index e800795fa2..f805df32c9 100644 --- a/modules/querying-cluster-node-journal-logs.adoc +++ b/modules/querying-cluster-node-journal-logs.adoc @@ -11,7 +11,12 @@ 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. * You have installed the OpenShift CLI (`oc`). * You have SSH access to your hosts. diff --git a/modules/querying-kubelet-status-on-a-node.adoc b/modules/querying-kubelet-status-on-a-node.adoc index 8feedcf6f1..79caed1cb3 100644 --- a/modules/querying-kubelet-status-on-a-node.adoc +++ b/modules/querying-kubelet-status-on-a-node.adoc @@ -10,7 +10,12 @@ You can review cluster node health status, resource consumption statistics, and .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. * You have installed the OpenShift CLI (`oc`). diff --git a/modules/querying-operator-pod-status.adoc b/modules/querying-operator-pod-status.adoc index 0219491bb3..b5b4ace8ff 100644 --- a/modules/querying-operator-pod-status.adoc +++ b/modules/querying-operator-pod-status.adoc @@ -10,7 +10,12 @@ You can list Operator pods within a cluster and their status. You can also colle .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. * You have installed the OpenShift CLI (`oc`). @@ -37,6 +42,7 @@ $ oc get pod -n $ oc describe pod -n ---- +ifndef::openshift-rosa,openshift-dedicated[] . If an Operator issue is node-specific, query Operator container status on that node. .. Start a debug pod for the node: + @@ -72,3 +78,4 @@ $ oc debug node/my-node ---- + .. Exit from the debug shell. +endif::openshift-rosa,openshift-dedicated[] diff --git a/modules/querying-operator-status-after-installation.adoc b/modules/querying-operator-status-after-installation.adoc index 1b7800e011..d1770fdbe5 100644 --- a/modules/querying-operator-status-after-installation.adoc +++ b/modules/querying-operator-status-after-installation.adoc @@ -10,7 +10,12 @@ You can check Operator status at the end of an installation. Retrieve diagnostic .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[] * You have installed the OpenShift CLI (`oc`). .Procedure diff --git a/modules/reviewing-node-status-usage-and-configuration.adoc b/modules/reviewing-node-status-usage-and-configuration.adoc index cd23ca0ea2..78f7e6373b 100644 --- a/modules/reviewing-node-status-usage-and-configuration.adoc +++ b/modules/reviewing-node-status-usage-and-configuration.adoc @@ -10,7 +10,12 @@ Review cluster node health status, resource consumption statistics, and node log .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[] * You have installed the OpenShift CLI (`oc`). .Procedure diff --git a/modules/reviewing-pod-status.adoc b/modules/reviewing-pod-status.adoc index a01bffd600..0c996c5225 100644 --- a/modules/reviewing-pod-status.adoc +++ b/modules/reviewing-pod-status.adoc @@ -10,7 +10,12 @@ You can query pod status and error states. You can also query a pod's associated .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[] * You have installed the OpenShift CLI (`oc`). * `skopeo` is installed. diff --git a/modules/rosa-deleting-cluster.adoc b/modules/rosa-deleting-cluster.adoc index 6ceef7607a..df33d5944b 100644 --- a/modules/rosa-deleting-cluster.adoc +++ b/modules/rosa-deleting-cluster.adoc @@ -145,7 +145,7 @@ $ rosa delete operator-roles -c --mode auto <1> endif::sts[] .Troubleshooting -* If the cluster cannot be deleted because of missing IAM roles, see xref:../sd_support/rosa-troubleshooting-deployments.adoc#rosa-troubleshooting-cluster-deletion_rosa-troubleshooting-cluster-deployments[Repairing a cluster that cannot be deleted]. +* If the cluster cannot be deleted because of missing IAM roles, see xref:../support/troubleshooting/rosa-troubleshooting-deployments.adoc#rosa-troubleshooting-cluster-deletion_rosa-troubleshooting-cluster-deployments[Repairing a cluster that cannot be deleted]. * If the cluster cannot be deleted for other reasons: ** Check that there are no Add-ons for your cluster pending in the link:https://console.redhat.com/openshift[Hybrid Cloud Console]. ** Check that all AWS resources and dependencies have been deleted in the Amazon Web Console. \ No newline at end of file diff --git a/modules/rosa-sts-aws-requirements-creating-association.adoc b/modules/rosa-sts-aws-requirements-creating-association.adoc index b17f9b6ed5..a868233dbe 100644 --- a/modules/rosa-sts-aws-requirements-creating-association.adoc +++ b/modules/rosa-sts-aws-requirements-creating-association.adoc @@ -1,6 +1,5 @@ // Module included in the following assemblies: // -// * sd_support/rosa-troubleshooting-iam-resources.adoc // * rosa_planning/rosa-sts-ocm-role.adoc // * rosa_planning/rosa-sts-aws-prereqs.adoc :_content-type: PROCEDURE diff --git a/modules/rosa-sts-aws-requirements-creating-multi-association.adoc b/modules/rosa-sts-aws-requirements-creating-multi-association.adoc index 68633776ff..93b4106849 100644 --- a/modules/rosa-sts-aws-requirements-creating-multi-association.adoc +++ b/modules/rosa-sts-aws-requirements-creating-multi-association.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * sd_support/rosa-troubleshooting-iam-resources.adoc +// * support/rosa-troubleshooting-iam-resources.adoc // * rosa_planning/rosa-sts-ocm-role.adoc // * rosa_planning/rosa-sts-aws-prereqs.adoc :_content-type: PROCEDURE diff --git a/modules/rosa-sts-ocm-and-user-role-troubleshooting.adoc b/modules/rosa-sts-ocm-and-user-role-troubleshooting.adoc index ec029367d2..c90d69def4 100644 --- a/modules/rosa-sts-ocm-and-user-role-troubleshooting.adoc +++ b/modules/rosa-sts-ocm-and-user-role-troubleshooting.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * sd_support/rosa-troubleshooting-iam-resources.adoc +// * support/rosa-troubleshooting-iam-resources.adoc :_content-type: PROCEDURE [id="rosa-sts-ocm-roles-and-permissions-troubleshooting_{context}"] diff --git a/modules/rosa-sts-ocm-role-creation.adoc b/modules/rosa-sts-ocm-role-creation.adoc index a8563913c3..e91177d4ba 100644 --- a/modules/rosa-sts-ocm-role-creation.adoc +++ b/modules/rosa-sts-ocm-role-creation.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: //* rosa_architecture/rosa-sts-about-iam-resources.adoc -// * sd_support/rosa-troubleshooting-iam-resources.adoc +// * support/rosa-troubleshooting-iam-resources.adoc // * rosa_planning/rosa-sts-ocm-role.adoc :_content-type: PROCEDURE [id="rosa-sts-ocm-roles-and-permissions-iam-basic-role_{context}"] diff --git a/modules/rosa-sts-user-role-creation.adoc b/modules/rosa-sts-user-role-creation.adoc index bcc54ff9e6..404259f9d1 100644 --- a/modules/rosa-sts-user-role-creation.adoc +++ b/modules/rosa-sts-user-role-creation.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * sd_support/rosa-troubleshooting-iam-resources.adoc +// * support/rosa-troubleshooting-iam-resources.adoc // * rosa_planning/rosa-sts-ocm-role.adoc :_content-type: PROCEDURE [id="rosa-sts-user-role-iam-basic-role_{context}"] diff --git a/modules/rosa-troubleshooting-cluster-deletion.adoc b/modules/rosa-troubleshooting-cluster-deletion.adoc index be0f806554..73cd2403d5 100644 --- a/modules/rosa-troubleshooting-cluster-deletion.adoc +++ b/modules/rosa-troubleshooting-cluster-deletion.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * sd_support/rosa-troubleshooting-deployments.adoc +// * support/rosa-troubleshooting-deployments.adoc :_content-type: PROCEDURE [id="rosa-troubleshooting-cluster-deletion_{context}"] = Repairing a cluster that cannot be deleted diff --git a/modules/rosa-troubleshooting-elb-service-role.adoc b/modules/rosa-troubleshooting-elb-service-role.adoc index cb20682a95..02ebc0ebfd 100644 --- a/modules/rosa-troubleshooting-elb-service-role.adoc +++ b/modules/rosa-troubleshooting-elb-service-role.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * sd_support/rosa-troubleshooting-deployments.adoc +// * support/rosa-troubleshooting-deployments.adoc :_content-type: PROCEDURE [id="rosa-troubleshooting-elb-service-role_{context}"] = Creating the Elastic Load Balancing (ELB) service-linked role diff --git a/modules/rosa-troubleshooting-expired-token.adoc b/modules/rosa-troubleshooting-expired-token.adoc index d0bf91b2ac..0112e38fde 100644 --- a/modules/rosa-troubleshooting-expired-token.adoc +++ b/modules/rosa-troubleshooting-expired-token.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // -// * sd_support/rosa-troubleshooting-expired-tokens.adoc +// * support/rosa-troubleshooting-expired-tokens.adoc :_content-type: PROCEDURE diff --git a/modules/rosa-troubleshooting-general-deployment.adoc b/modules/rosa-troubleshooting-general-deployment.adoc index a107fc691b..e25656d879 100644 --- a/modules/rosa-troubleshooting-general-deployment.adoc +++ b/modules/rosa-troubleshooting-general-deployment.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * sd_support/rosa-troubleshooting-deployments.adoc +// * support/rosa-troubleshooting-deployments.adoc :_content-type: PROCEDURE [id="rosa-troubleshooting-general-deployment-failure_{context}"] = Obtaining information on a failed cluster diff --git a/modules/rosa-troubleshooting-installing.adoc b/modules/rosa-troubleshooting-installing.adoc index d2fc6240fe..78bd21481a 100644 --- a/modules/rosa-troubleshooting-installing.adoc +++ b/modules/rosa-troubleshooting-installing.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * sd_support/rosa-troubleshooting-installations.adoc +// * support/rosa-troubleshooting-installations.adoc [id="rosa-troubleshooting-installing_{context}"] = Installation troubleshooting diff --git a/modules/rosa-troubleshooting-osdccsadmin-deployment.adoc b/modules/rosa-troubleshooting-osdccsadmin-deployment.adoc index 6c556cf50a..fbd3c52637 100644 --- a/modules/rosa-troubleshooting-osdccsadmin-deployment.adoc +++ b/modules/rosa-troubleshooting-osdccsadmin-deployment.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * sd_support/rosa-troubleshooting-deployments.adoc +// * support/rosa-troubleshooting-deployments.adoc :_content-type: PROCEDURE [id="rosa-troubleshooting-deployment-failure-osdccsadmin_{context}"] = Failing to create a cluster with an `osdCcsAdmin` error diff --git a/modules/security-audit-log-filtering.adoc b/modules/security-audit-log-filtering.adoc index 0333612374..9977a23d80 100644 --- a/modules/security-audit-log-filtering.adoc +++ b/modules/security-audit-log-filtering.adoc @@ -17,7 +17,12 @@ The following procedure provides examples of using `jq` to filter audit logs on .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[] * You have installed `jq`. .Procedure diff --git a/modules/starting-debug-pods-with-root-access.adoc b/modules/starting-debug-pods-with-root-access.adoc index e9815b4b06..917e4b977e 100644 --- a/modules/starting-debug-pods-with-root-access.adoc +++ b/modules/starting-debug-pods-with-root-access.adoc @@ -10,7 +10,12 @@ You can start a debug pod with root access, based on a problematic pod's deploym .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. * You have installed the OpenShift CLI (`oc`). diff --git a/modules/summarizing-cluster-specifications-through-clusterversion.adoc b/modules/summarizing-cluster-specifications-through-clusterversion.adoc index 594215cfaf..811dfb5b37 100644 --- a/modules/summarizing-cluster-specifications-through-clusterversion.adoc +++ b/modules/summarizing-cluster-specifications-through-clusterversion.adoc @@ -1,7 +1,6 @@ // Module included in the following assemblies: // // * support/summarizing-cluster-specifications.adoc -// * sd_support/osd-summarizing-cluster-specifications.adoc :_content-type: PROCEDURE [id="summarizing-cluster-specifications-through-clusterversion_{context}"] @@ -11,7 +10,12 @@ You can obtain a summary of {product-title} cluster specifications by querying t .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[] * You have installed the OpenShift CLI (`oc`). .Procedure diff --git a/modules/support-collecting-host-network-trace.adoc b/modules/support-collecting-host-network-trace.adoc index 2a057f1ba2..37f8523eb2 100644 --- a/modules/support-collecting-host-network-trace.adoc +++ b/modules/support-collecting-host-network-trace.adoc @@ -30,7 +30,12 @@ However, you can run any command in the container image that is specified in the .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[] * You have installed the OpenShift CLI (`oc`). diff --git a/modules/support-collecting-network-trace.adoc b/modules/support-collecting-network-trace.adoc index 5191d7820a..5f6803b984 100644 --- a/modules/support-collecting-network-trace.adoc +++ b/modules/support-collecting-network-trace.adoc @@ -10,7 +10,12 @@ 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[] * You have installed the OpenShift CLI (`oc`). * You have a Red Hat standard or premium Subscription. * You have a Red Hat Customer Portal account. diff --git a/modules/support-gather-data.adoc b/modules/support-gather-data.adoc index 0712e1909b..c0b3eee1a4 100644 --- a/modules/support-gather-data.adoc +++ b/modules/support-gather-data.adoc @@ -10,8 +10,13 @@ You can gather debugging information about your cluster by using the `oc adm mus .Prerequisites -* Access to the cluster as a user with the `cluster-admin` role. -* The {product-title} CLI (`oc`) installed. +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[] +* The {product-title} CLI (`oc`) is installed. .Procedure diff --git a/modules/support-generating-a-sosreport-archive.adoc b/modules/support-generating-a-sosreport-archive.adoc index f9207687fd..ec2bd66671 100644 --- a/modules/support-generating-a-sosreport-archive.adoc +++ b/modules/support-generating-a-sosreport-archive.adoc @@ -10,7 +10,12 @@ The recommended way to generate a `sosreport` for an {product-title} {product-ve .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[] * You have SSH access to your hosts. * You have installed the OpenShift CLI (`oc`). * You have a Red Hat standard or premium Subscription. diff --git a/modules/support-get-cluster-id.adoc b/modules/support-get-cluster-id.adoc index 2dd32b856f..f1f5f78b77 100644 --- a/modules/support-get-cluster-id.adoc +++ b/modules/support-get-cluster-id.adoc @@ -10,8 +10,13 @@ When providing information to Red Hat Support, it is helpful to provide the uniq .Prerequisites -* Access to the cluster as a user with the `cluster-admin` role. -* Access to the web console or the OpenShift CLI (`oc`) installed. +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[] +* You have access to the web console or the OpenShift CLI (`oc`) installed. .Procedure ifdef::openshift-enterprise,openshift-webscale,openshift-dedicated[] diff --git a/modules/support-providing-diagnostic-data-to-red-hat.adoc b/modules/support-providing-diagnostic-data-to-red-hat.adoc index 56c7130b64..a29a502789 100644 --- a/modules/support-providing-diagnostic-data-to-red-hat.adoc +++ b/modules/support-providing-diagnostic-data-to-red-hat.adoc @@ -10,7 +10,12 @@ When investigating {product-title} issues, Red Hat Support might ask you to uplo .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[] * You have SSH access to your hosts. * You have installed the OpenShift CLI (`oc`). * You have a Red Hat standard or premium Subscription. diff --git a/modules/support-submitting-a-case.adoc b/modules/support-submitting-a-case.adoc index 6fd04be8ec..9ccf753135 100644 --- a/modules/support-submitting-a-case.adoc +++ b/modules/support-submitting-a-case.adoc @@ -13,8 +13,11 @@ ifndef::openshift-dedicated[] * You have access to the cluster as a user with the `cluster-admin` role. -* You have installed the OpenShift CLI (`oc`). endif::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[] +* You have installed the OpenShift CLI (`oc`). ifdef::openshift-dedicated[] * You have access to the {cluster-manager-first}. endif::openshift-dedicated[] diff --git a/modules/telemetry-about-telemetry.adoc b/modules/telemetry-about-telemetry.adoc index b5e8c6797b..598000ef44 100644 --- a/modules/telemetry-about-telemetry.adoc +++ b/modules/telemetry-about-telemetry.adoc @@ -1,7 +1,6 @@ // Module included in the following assemblies: // // * support/remote_health_monitoring/about-remote-health-monitoring.adoc -// * sd_support/remote_health_monitoring/about-remote-health-monitoring.adoc :_content-type: CONCEPT [id="telemetry-about-telemetry_{context}"] diff --git a/modules/telemetry-consequences-of-disabling-telemetry.adoc b/modules/telemetry-consequences-of-disabling-telemetry.adoc index f3d0336ffb..89af41b617 100644 --- a/modules/telemetry-consequences-of-disabling-telemetry.adoc +++ b/modules/telemetry-consequences-of-disabling-telemetry.adoc @@ -1,7 +1,6 @@ // Module included in the following assemblies: // // * support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc -// * sd_support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc [id="telemetry-consequences-of-disabling-telemetry_{context}"] = Consequences of disabling remote health reporting diff --git a/modules/telemetry-showing-data-collected-from-the-cluster.adoc b/modules/telemetry-showing-data-collected-from-the-cluster.adoc index 379ee05d23..0ce2c50534 100644 --- a/modules/telemetry-showing-data-collected-from-the-cluster.adoc +++ b/modules/telemetry-showing-data-collected-from-the-cluster.adoc @@ -1,8 +1,6 @@ // Module included in the following assemblies: // -// * rosa_support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc // * support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc -// * sd_support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc :_content-type: PROCEDURE [id="showing-data-collected-from-the-cluster_{context}"] @@ -20,7 +18,12 @@ ifndef::openshift-enterprise,openshift-webscale,openshift-origin[] OpenShift Container Platform endif::openshift-enterprise,openshift-webscale,openshift-origin[] CLI (`oc`). +ifndef::openshift-rosa,openshift-dedicated[] * You have access to the cluster as a user with the `cluster-admin` role or the `cluster-monitoring-view` 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[] .Procedure diff --git a/modules/telemetry-user-telemetry.adoc b/modules/telemetry-user-telemetry.adoc index 4c1c54e690..f3d60e3d21 100644 --- a/modules/telemetry-user-telemetry.adoc +++ b/modules/telemetry-user-telemetry.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * sd_support/remote_health_monitoring/about-remote-health-monitoring.adoc +// * support/remote_health_monitoring/about-remote-health-monitoring.adoc :_content-type: CONCEPT [id="telemetry-user-telemetry_{context}"] diff --git a/modules/telemetry-what-information-is-collected.adoc b/modules/telemetry-what-information-is-collected.adoc index 705bab2596..813a09818d 100644 --- a/modules/telemetry-what-information-is-collected.adoc +++ b/modules/telemetry-what-information-is-collected.adoc @@ -1,7 +1,6 @@ // Module included in the following assemblies: // // * support/remote_health_monitoring/about-remote-health-monitoring.adoc -// * sd_support/remote_health_monitoring/about-remote-health-monitoring.adoc :_content-type: REFERENCE [id="what-information-is-collected_{context}"] diff --git a/modules/troubleshooting-disabling-autoreboot-mco-cli.adoc b/modules/troubleshooting-disabling-autoreboot-mco-cli.adoc index cce4621ba6..f4773f1083 100644 --- a/modules/troubleshooting-disabling-autoreboot-mco-cli.adoc +++ b/modules/troubleshooting-disabling-autoreboot-mco-cli.adoc @@ -15,7 +15,12 @@ See second `NOTE` in xref:../../support/troubleshooting/troubleshooting-operator .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[] * You have installed the OpenShift CLI (`oc`). .Procedure diff --git a/modules/troubleshooting-disabling-autoreboot-mco-console.adoc b/modules/troubleshooting-disabling-autoreboot-mco-console.adoc index 8381d8d1ae..684c7538a2 100644 --- a/modules/troubleshooting-disabling-autoreboot-mco-console.adoc +++ b/modules/troubleshooting-disabling-autoreboot-mco-console.adoc @@ -15,7 +15,12 @@ See second `NOTE` in xref:../../support/troubleshooting/troubleshooting-operator .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[] .Procedure diff --git a/modules/understanding-telemetry-and-insights-operator-data-flow.adoc b/modules/understanding-telemetry-and-insights-operator-data-flow.adoc index 2a3920ebd2..b686ae9a07 100644 --- a/modules/understanding-telemetry-and-insights-operator-data-flow.adoc +++ b/modules/understanding-telemetry-and-insights-operator-data-flow.adoc @@ -1,7 +1,6 @@ // Module included in the following assemblies: // // * support/remote_health_monitoring/about-remote-health-monitoring.adoc -// * sd_support/remote_health_monitoring/about-remote-health-monitoring.adoc :_content-type: CONCEPT [id="understanding-telemetry-and-insights-operator-data-flow_{context}"] diff --git a/modules/verifying-crio-status.adoc b/modules/verifying-crio-status.adoc index 4c79d405b5..f77c5e2fa2 100644 --- a/modules/verifying-crio-status.adoc +++ b/modules/verifying-crio-status.adoc @@ -10,7 +10,12 @@ You can verify CRI-O container runtime engine status on each cluster node. .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[] * You have installed the OpenShift CLI (`oc`). .Procedure diff --git a/monitoring/troubleshooting-monitoring-issues.adoc b/monitoring/troubleshooting-monitoring-issues.adoc index 4845e906bc..4b411f6e98 100644 --- a/monitoring/troubleshooting-monitoring-issues.adoc +++ b/monitoring/troubleshooting-monitoring-issues.adoc @@ -37,12 +37,4 @@ include::modules/monitoring-determining-why-prometheus-is-consuming-disk-space.a .Additional resources * See xref:../monitoring/configuring-the-monitoring-stack.adoc#setting-scrape-sample-and-label-limits-for-user-defined-projects_configuring-the-monitoring-stack[Setting a scrape sample limit for user-defined projects] for details on how to set a scrape sample limit and create related alerting rules -ifndef::openshift-dedicated,openshift-rosa[] * xref:../support/getting-support.adoc#support-submitting-a-case_getting-support[Submitting a support case] -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-rosa[] -* xref:../rosa_architecture/rosa-getting-support.adoc#rosa-getting-support_rosa-getting-support[Submitting a support case] -endif::openshift-rosa[] -ifdef::openshift-dedicated[] -* xref:../osd_architecture/osd-support.adoc#support_osd-getting-support[Submitting a support case] -endif::openshift-dedicated[] diff --git a/osd_architecture/osd-support.adoc b/osd_architecture/osd-support.adoc deleted file mode 100644 index 04dcb81125..0000000000 --- a/osd_architecture/osd-support.adoc +++ /dev/null @@ -1,23 +0,0 @@ -:_content-type: ASSEMBLY -[id="osd-getting-support"] -= Getting support -include::_attributes/common-attributes.adoc[] -ifdef::openshift-dedicated[] -include::_attributes/attributes-openshift-dedicated.adoc[] -endif::[] -:context: osd-getting-support - -toc::[] - -Get support for {product-title}. - -include::modules/support.adoc[leveloffset=+1] -include::modules/support-knowledgebase-about.adoc[leveloffset=+1] -include::modules/support-knowledgebase-search.adoc[leveloffset=+1] -include::modules/support-submitting-a-case.adoc[leveloffset=+1] - -[id="osd-getting-support-additional-resources"] -[role="_additional-resources"] -== Additional resources - -* For details about identifying issues with your cluster, see xref:../sd_support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc#using-insights-to-identify-issues-with-your-cluster[Using Insights to identify issues with your cluster]. diff --git a/osd_architecture/osd-understanding.adoc b/osd_architecture/osd-understanding.adoc index 02736de519..42a83b8457 100644 --- a/osd_architecture/osd-understanding.adoc +++ b/osd_architecture/osd-understanding.adoc @@ -13,4 +13,4 @@ include::modules/osd-intro.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* For more information about Telemetry and remote health monitoring for {product-title} clusters, see xref:../sd_support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring] +* For more information about Telemetry and remote health monitoring for {product-title} clusters, see xref:../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring] diff --git a/rosa_architecture/rosa-getting-support.adoc b/rosa_architecture/rosa-getting-support.adoc deleted file mode 100644 index 91c34dc5fe..0000000000 --- a/rosa_architecture/rosa-getting-support.adoc +++ /dev/null @@ -1,10 +0,0 @@ -:_content-type: ASSEMBLY -[id="rosa-getting-support"] -= Getting support for {product-title} -include::_attributes/attributes-openshift-dedicated.adoc[] -:context: rosa-getting-support -toc::[] - -Get support for {product-title} (ROSA). - -include::modules/rosa-getting-support.adoc[leveloffset=+1] diff --git a/rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc b/rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc index ab82c90bad..30ba56ad74 100644 --- a/rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc +++ b/rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc @@ -130,5 +130,5 @@ include::modules/rosa-hcp-sts-creating-a-cluster-cli.adoc[leveloffset=+1] * For information about the prerequisites to installing ROSA with STS, see xref:../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-sts-aws-prereqs[AWS prerequisites for ROSA with STS]. * For details about using the `auto` and `manual` modes to create the required STS resources, see xref:../rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-with-customizations.adoc#rosa-understanding-deployment-modes_rosa-sts-creating-a-cluster-with-customizations[Understanding the auto and manual deployment modes]. * For more information about using OpenID Connect (OIDC) identity providers in AWS IAM, see link:https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html[Creating OpenID Connect (OIDC) identity providers] in the AWS documentation. -* For more information about troubleshooting ROSA cluster installations, see xref:../sd_support/rosa-troubleshooting-installations.adoc#rosa-troubleshooting-installations[Troubleshooting installations]. -* For steps to contact Red Hat Support for assistance, see xref:../rosa_architecture/rosa-getting-support.adoc#rosa-getting-support[Getting support for Red Hat OpenShift Service on AWS]. +* For more information about troubleshooting ROSA cluster installations, see xref:../support/troubleshooting/rosa-troubleshooting-installations.adoc#rosa-troubleshooting-installations[Troubleshooting installations]. +* For steps to contact Red Hat Support for assistance, see xref:../support/getting-support.adoc#getting-support[Getting support for Red Hat OpenShift Service on AWS]. diff --git a/rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-quickly.adoc b/rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-quickly.adoc index 55d0f3047c..054aa747ca 100644 --- a/rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-quickly.adoc +++ b/rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-quickly.adoc @@ -60,5 +60,5 @@ include::modules/rosa-sts-creating-a-cluster-quickly-cli.adoc[leveloffset=+1] * For information about the prerequisites to installing ROSA with STS, see xref:../rosa_planning/rosa-sts-aws-prereqs.adoc#rosa-sts-aws-prereqs[AWS prerequisites for ROSA with STS]. * For details about using the `auto` and `manual` modes to create the required STS resources, see xref:../rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-with-customizations.adoc#rosa-understanding-deployment-modes_rosa-sts-creating-a-cluster-with-customizations[Understanding the auto and manual deployment modes]. * For more information about using OpenID Connect (OIDC) identity providers in AWS IAM, see link:https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html[Creating OpenID Connect (OIDC) identity providers] in the AWS documentation. -* For more information about troubleshooting ROSA cluster installations, see xref:../sd_support/rosa-troubleshooting-installations.adoc#rosa-troubleshooting-installations[Troubleshooting installations]. -* For steps to contact Red Hat Support for assistance, see xref:../rosa_architecture/rosa-getting-support.adoc#rosa-getting-support[Getting support for Red Hat OpenShift Service on AWS]. \ No newline at end of file +* For more information about troubleshooting ROSA cluster installations, see xref:../support/troubleshooting/rosa-troubleshooting-installations.adoc#rosa-troubleshooting-installations[Troubleshooting installations]. +* For steps to contact Red Hat Support for assistance, see xref:../support/getting-support.adoc#getting-support[Getting support for Red Hat OpenShift Service on AWS]. \ No newline at end of file diff --git a/rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-with-customizations.adoc b/rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-with-customizations.adoc index c973851110..273e0f0370 100644 --- a/rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-with-customizations.adoc +++ b/rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-with-customizations.adoc @@ -63,5 +63,5 @@ include::modules/rosa-sts-creating-a-cluster-with-customizations-cli.adoc[levelo * For more information about using OpenID Connect (OIDC) identity providers in AWS IAM, see link:https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html[Creating OpenID Connect (OIDC) identity providers] in the AWS documentation. * For more information about etcd encryption, see the xref:../rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc#rosa-sdpolicy-etcd-encryption_rosa-service-definition[etcd encryption service definition]. * For information about configuring a proxy with ROSA, see xref:../networking/configuring-cluster-wide-proxy.adoc#configuring-a-cluster-wide-proxy[Configuring a cluster-wide proxy]. -* For more information about troubleshooting ROSA cluster installations, see xref:../sd_support/rosa-troubleshooting-deployments.adoc#rosa-troubleshooting-cluster-deployments[Troubleshooting cluster deployments]. -* For steps to contact Red Hat Support for assistance, see xref:../rosa_architecture/rosa-getting-support.adoc#rosa-getting-support[Getting support for Red Hat OpenShift Service on AWS]. +* For more information about troubleshooting ROSA cluster installations, see xref:../support/troubleshooting/rosa-troubleshooting-deployments.adoc#rosa-troubleshooting-cluster-deployments[Troubleshooting cluster deployments]. +* For steps to contact Red Hat Support for assistance, see xref:../support/getting-support.adoc#getting-support[Getting support for Red Hat OpenShift Service on AWS]. diff --git a/rosa_install_access_delete_clusters/rosa-sts-deleting-cluster.adoc b/rosa_install_access_delete_clusters/rosa-sts-deleting-cluster.adoc index cd0b0d12a6..e31703d41c 100644 --- a/rosa_install_access_delete_clusters/rosa-sts-deleting-cluster.adoc +++ b/rosa_install_access_delete_clusters/rosa-sts-deleting-cluster.adoc @@ -35,4 +35,4 @@ include::modules/rosa-unlinking-and-deleting-ocm-and-user-iam-roles.adoc[levelof == Additional resources * For information about the AWS IAM resources for ROSA clusters that use STS, see xref:../rosa_architecture/rosa-sts-about-iam-resources.adoc#rosa-sts-about-iam-resources[About IAM resources for ROSA clusters that use STS]. -* For information on cluster errors that are due to missing IAM roles, see xref:../sd_support/rosa-troubleshooting-deployments.adoc#rosa-troubleshooting-cluster-deletion_rosa-troubleshooting-cluster-deployments[Repairing a cluster that cannot be deleted]. +* For information on cluster errors that are due to missing IAM roles, see xref:../support/troubleshooting/rosa-troubleshooting-deployments.adoc#rosa-troubleshooting-cluster-deletion_rosa-troubleshooting-cluster-deployments[Repairing a cluster that cannot be deleted]. diff --git a/rosa_planning/rosa-hcp-prereqs.adoc b/rosa_planning/rosa-hcp-prereqs.adoc index 7dcdbaa318..2ea37d2410 100644 --- a/rosa_planning/rosa-hcp-prereqs.adoc +++ b/rosa_planning/rosa-hcp-prereqs.adoc @@ -25,7 +25,7 @@ include::modules/rosa-sts-aws-requirements-account.adoc[leveloffset=+2] [id="additional-resources_aws-account-requirements_{context}"] .Additional resources * xref:../rosa_planning/rosa-limits-scalability.adoc#rosa-limits-scalability[Limits and scalability] -* xref:../sd_support/rosa-troubleshooting-deployments.adoc#rosa-troubleshooting-elb-service-role_rosa-troubleshooting-cluster-deployments[Creating the Elastic Load Balancing (ELB) service-linked role] +* xref:../support/troubleshooting/rosa-troubleshooting-deployments.adoc#rosa-troubleshooting-elb-service-role_rosa-troubleshooting-cluster-deployments[Creating the Elastic Load Balancing (ELB) service-linked role] include::modules/rosa-sts-aws-requirements-access-req.adoc[leveloffset=+2] diff --git a/rosa_planning/rosa-sts-aws-prereqs.adoc b/rosa_planning/rosa-sts-aws-prereqs.adoc index 8bd6b730c0..75d26d8d12 100644 --- a/rosa_planning/rosa-sts-aws-prereqs.adoc +++ b/rosa_planning/rosa-sts-aws-prereqs.adoc @@ -27,7 +27,7 @@ include::modules/rosa-sts-aws-requirements-account.adoc[leveloffset=+2] [id="additional-resources_aws-account-requirements_{context}"] .Additional resources * xref:../rosa_planning/rosa-limits-scalability.adoc#rosa-limits-scalability[Limits and scalability] -* xref:../sd_support/rosa-troubleshooting-deployments.adoc#rosa-troubleshooting-elb-service-role_rosa-troubleshooting-cluster-deployments[Creating the Elastic Load Balancing (ELB) service-linked role] +* xref:../support/troubleshooting/rosa-troubleshooting-deployments.adoc#rosa-troubleshooting-elb-service-role_rosa-troubleshooting-cluster-deployments[Creating the Elastic Load Balancing (ELB) service-linked role] include::modules/rosa-sts-aws-requirements-access-req.adoc[leveloffset=+2] diff --git a/rosa_planning/rosa-sts-ocm-role.adoc b/rosa_planning/rosa-sts-ocm-role.adoc index ff87137b56..e76acd4ec1 100644 --- a/rosa_planning/rosa-sts-ocm-role.adoc +++ b/rosa_planning/rosa-sts-ocm-role.adoc @@ -54,7 +54,7 @@ include::modules/rosa-sts-user-role-creation.adoc[leveloffset=+2] [IMPORTANT] ==== -If you unlink or delete your `user-role` IAM role prior to deleting your cluster, an error prevents you from deleting your cluster. You must create or relink this role to proceed with the deletion process. See xref:../sd_support/rosa-troubleshooting-deployments.adoc#rosa-troubleshooting-cluster-deletion_rosa-troubleshooting-cluster-deployments[Repairing a cluster that cannot be deleted] for more information. +If you unlink or delete your `user-role` IAM role prior to deleting your cluster, an error prevents you from deleting your cluster. You must create or relink this role to proceed with the deletion process. See xref:../support/troubleshooting/rosa-troubleshooting-deployments.adoc#rosa-troubleshooting-cluster-deletion_rosa-troubleshooting-cluster-deployments[Repairing a cluster that cannot be deleted] for more information. ==== include::modules/rosa-sts-aws-requirements-association-concept.adoc[leveloffset=+1] @@ -63,5 +63,5 @@ include::modules/rosa-sts-aws-requirements-creating-multi-association.adoc[level [role="_additional-resources"] == Additional resources -* See xref:../sd_support/rosa-troubleshooting-iam-resources.adoc#rosa-sts-ocm-roles-and-permissions-troubleshooting[Troubleshooting IAM roles] +* See xref:../support/troubleshooting/rosa-troubleshooting-iam-resources.adoc#rosa-sts-ocm-roles-and-permissions-troubleshooting[Troubleshooting IAM roles] * See xref:../rosa_architecture/rosa-sts-about-iam-resources.adoc#rosa-sts-account-wide-roles-and-policies[Account-wide IAM role and policy reference] for a list of IAM roles needed for cluster creation. \ No newline at end of file diff --git a/rosa_support/_attributes b/rosa_support/_attributes deleted file mode 120000 index f27fd275ea..0000000000 --- a/rosa_support/_attributes +++ /dev/null @@ -1 +0,0 @@ -../_attributes/ \ No newline at end of file diff --git a/rosa_support/images b/rosa_support/images deleted file mode 120000 index 5e67573196..0000000000 --- a/rosa_support/images +++ /dev/null @@ -1 +0,0 @@ -../images \ No newline at end of file diff --git a/rosa_support/modules b/rosa_support/modules deleted file mode 120000 index 464b823aca..0000000000 --- a/rosa_support/modules +++ /dev/null @@ -1 +0,0 @@ -../modules \ No newline at end of file diff --git a/rosa_support/remote_health_monitoring/_attributes b/rosa_support/remote_health_monitoring/_attributes deleted file mode 120000 index 20cc1dcb77..0000000000 --- a/rosa_support/remote_health_monitoring/_attributes +++ /dev/null @@ -1 +0,0 @@ -../../_attributes/ \ No newline at end of file diff --git a/rosa_support/remote_health_monitoring/images b/rosa_support/remote_health_monitoring/images deleted file mode 120000 index 847b03ed05..0000000000 --- a/rosa_support/remote_health_monitoring/images +++ /dev/null @@ -1 +0,0 @@ -../../images/ \ No newline at end of file diff --git a/rosa_support/remote_health_monitoring/modules b/rosa_support/remote_health_monitoring/modules deleted file mode 120000 index 36719b9de7..0000000000 --- a/rosa_support/remote_health_monitoring/modules +++ /dev/null @@ -1 +0,0 @@ -../../modules/ \ No newline at end of file diff --git a/rosa_support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc b/rosa_support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc deleted file mode 100644 index d4ac74ca6e..0000000000 --- a/rosa_support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc +++ /dev/null @@ -1,16 +0,0 @@ -:_content-type: ASSEMBLY -[id="showing-data-collected-by-remote-health-monitoring"] -= Showing data collected by remote health monitoring -include::_attributes/common-attributes.adoc[] -ifdef::openshift-dedicated[] -include::_attributes/attributes-openshift-dedicated.adoc[] -endif::[] -:context: showing-data-collected-by-remote-health-monitoring - -toc::[] - -As an administrator, you can review the metrics collected by Telemetry and the Insights Operator. - -include::modules/telemetry-showing-data-collected-from-the-cluster.adoc[leveloffset=+1] - -include::modules/insights-operator-showing-data-collected-from-the-cluster.adoc[leveloffset=+1] diff --git a/rosa_support/remote_health_monitoring/snippets b/rosa_support/remote_health_monitoring/snippets deleted file mode 120000 index 5a3f5add14..0000000000 --- a/rosa_support/remote_health_monitoring/snippets +++ /dev/null @@ -1 +0,0 @@ -../../snippets/ \ No newline at end of file diff --git a/rosa_support/snippets b/rosa_support/snippets deleted file mode 120000 index 9f5bc7e4dd..0000000000 --- a/rosa_support/snippets +++ /dev/null @@ -1 +0,0 @@ -../snippets \ No newline at end of file diff --git a/sd_support/_attributes b/sd_support/_attributes deleted file mode 120000 index f27fd275ea..0000000000 --- a/sd_support/_attributes +++ /dev/null @@ -1 +0,0 @@ -../_attributes/ \ No newline at end of file diff --git a/sd_support/images b/sd_support/images deleted file mode 120000 index 5e67573196..0000000000 --- a/sd_support/images +++ /dev/null @@ -1 +0,0 @@ -../images \ No newline at end of file diff --git a/sd_support/modules b/sd_support/modules deleted file mode 120000 index 464b823aca..0000000000 --- a/sd_support/modules +++ /dev/null @@ -1 +0,0 @@ -../modules \ No newline at end of file diff --git a/sd_support/osd-summarizing-cluster-specifications.adoc b/sd_support/osd-summarizing-cluster-specifications.adoc deleted file mode 100644 index 5c7495db81..0000000000 --- a/sd_support/osd-summarizing-cluster-specifications.adoc +++ /dev/null @@ -1,13 +0,0 @@ -:_content-type: ASSEMBLY -[id="summarizing-cluster-specifications"] -= Summarizing cluster specifications -include::_attributes/common-attributes.adoc[] -ifdef::openshift-dedicated[] -include::_attributes/attributes-openshift-dedicated.adoc[] -endif::[] -:context: summarizing-cluster-specifications - -toc::[] - -// Summarizing cluster specifications through `clusterversion` -include::modules/summarizing-cluster-specifications-through-clusterversion.adoc[leveloffset=+1] diff --git a/sd_support/remote_health_monitoring/_attributes b/sd_support/remote_health_monitoring/_attributes deleted file mode 120000 index 20cc1dcb77..0000000000 --- a/sd_support/remote_health_monitoring/_attributes +++ /dev/null @@ -1 +0,0 @@ -../../_attributes/ \ No newline at end of file diff --git a/sd_support/remote_health_monitoring/about-remote-health-monitoring.adoc b/sd_support/remote_health_monitoring/about-remote-health-monitoring.adoc deleted file mode 100644 index 14dee6a40e..0000000000 --- a/sd_support/remote_health_monitoring/about-remote-health-monitoring.adoc +++ /dev/null @@ -1,113 +0,0 @@ -:_content-type: ASSEMBLY -[id="about-remote-health-monitoring"] -= About remote health monitoring -include::_attributes/common-attributes.adoc[] -ifdef::openshift-dedicated[] -include::_attributes/attributes-openshift-dedicated.adoc[] -endif::[] -:context: about-remote-health-monitoring - -toc::[] - -{product-title} collects telemetry and configuration data about your cluster and reports it to Red Hat by using the Telemeter Client and the Insights Operator. The data that is provided to Red Hat enables the benefits outlined in this document. - -A cluster that reports data to Red Hat through Telemetry and the Insights Operator is considered a _connected cluster_. - -*Telemetry* is the term that Red Hat uses to describe the information being sent to Red Hat by the {product-title} Telemeter Client. Lightweight attributes are sent from connected clusters to Red Hat to enable subscription management automation, monitor the health of clusters, assist with support, and improve customer experience. - -The *Insights Operator* gathers {product-title} configuration data and sends it to Red Hat. The data is used to produce insights about potential issues that a cluster might be exposed to. These insights are communicated to cluster administrators on {cluster-manager-url}. - -More information is provided in this document about these two processes. - -.Telemetry and Insights Operator benefits - -Telemetry and the Insights Operator enable the following benefits for end-users: - -* *Enhanced identification and resolution of issues*. Events that might seem normal to an end-user can be observed by Red Hat from a broader perspective across a fleet of clusters. Some issues can be more rapidly identified from this point of view and resolved without an end-user needing to open a support case or file a https://issues.redhat.com/secure/CreateIssueDetails!init.jspa?pid=12332330&summary=Summary&issuetype=1&priority=10200&versions=12391126[Jira issue]. - -* *Advanced release management*. {product-title} offers the `candidate`, `fast`, and `stable` release channels, which enable you to choose an update strategy. The graduation of a release from `fast` to `stable` is dependent on the success rate of updates and on the events seen during upgrades. With the information provided by connected clusters, Red Hat can improve the quality of releases to `stable` channels and react more rapidly to issues found in the `fast` channels. - -* *Targeted prioritization of new features and functionality*. The data collected provides insights about which areas of {product-title} are used most. With this information, Red Hat can focus on developing the new features and functionality that have the greatest impact for our customers. - -* *A streamlined support experience*. You can provide a cluster ID for a connected cluster when creating a support ticket on the link:https://access.redhat.com/support/[Red Hat Customer Portal]. This enables Red Hat to deliver a streamlined support experience that is specific to your cluster, by using the connected information. This document provides more information about that enhanced support experience. - -* *Predictive analytics*. The insights displayed for your cluster on {cluster-manager-url} are enabled by the information collected from connected clusters. Red Hat is investing in applying deep learning, machine learning, and artificial intelligence automation to help identify issues that {product-title} clusters are exposed to. - -ifdef::openshift-origin[] -{product-title} may be installed without a pull secret received at console.redhat.com. In this case default imagestreams will not be imported and telemetry data will not be sent. -endif::[] - -include::modules/telemetry-about-telemetry.adoc[leveloffset=+1] - -ifndef::openshift-dedicated,openshift-rosa[] - -[role="_additional-resources"] -.Additional resources - -* See the xref:../../updating/updating_a_cluster/updating-cluster-web-console.adoc#updating-cluster-web-console[{product-title} update documentation] for more information about updating or upgrading a cluster. -endif::[] - -include::modules/telemetry-what-information-is-collected.adoc[leveloffset=+2] - -include::modules/telemetry-user-telemetry.adoc[leveloffset=+2] - -ifndef::openshift-dedicated,openshift-rosa[] - -[role="_additional-resources"] -.Additional resources - -* See xref:../../sd_support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc#showing-data-collected-from-the-cluster_showing-data-collected-by-remote-health-monitoring[Showing data collected by Telemetry] for details about how to list the attributes that Telemetry gathers from Prometheus in {product-title}. - -* See the link:https://github.com/openshift/cluster-monitoring-operator/blob/master/manifests/0000_50_cluster-monitoring-operator_04-config.yaml[upstream cluster-monitoring-operator source code] for a list of the attributes that Telemetry gathers from Prometheus. - -* Telemetry is installed and enabled by default. -endif::[] - -include::modules/insights-operator-about.adoc[leveloffset=+1] - -[role="_additional-resources"] -.Additional resources - -* The Insights Operator is installed and enabled by default. - -include::modules/insights-operator-what-information-is-collected.adoc[leveloffset=+2] - -[role="_additional-resources"] -.Additional resources - -ifndef::openshift-dedicated,openshift-rosa[] -* See xref:../../sd_support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc#insights-operator-showing-data-collected-from-the-cluster_showing-data-collected-by-remote-health-monitoring[Showing data collected by the Insights Operator] for details about how to review the data that is collected by the Insights Operator. -endif::[] - -* The Insights Operator source code is available for review and contribution. See the link:https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md[Insights Operator upstream project] for a list of the items collected by the Insights Operator. - -include::modules/understanding-telemetry-and-insights-operator-data-flow.adoc[leveloffset=+1] - -ifndef::openshift-dedicated,openshift-rosa[] - -[role="_additional-resources"] -.Additional resources - -* See xref:../../monitoring/monitoring-overview.adoc#monitoring-overview_monitoring-overview[Monitoring overview] for more information about the {product-title} monitoring stack. - -* See xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[Configuring your firewall] for details about configuring a firewall and enabling endpoints for Telemetry and Insights -endif::[] - -[id="additional-details-about-how-remote-health-monitoring-data-is-used"] -== Additional details about how remote health monitoring data is used - -The information collected to enable remote health monitoring is detailed in xref:../../sd_support/remote_health_monitoring/about-remote-health-monitoring.adoc#what-information-is-collected_about-remote-health-monitoring[Information collected by Telemetry] and xref:../../sd_support/remote_health_monitoring/about-remote-health-monitoring.adoc#insights-operator-what-information-is-collected_about-remote-health-monitoring[Information collected by the Insights Operator]. - -As further described in the preceding sections of this document, Red Hat collects data about your use of the Red Hat Product(s) for purposes such as providing support and upgrades, optimizing performance or configuration, minimizing service impacts, identifying and remediating threats, troubleshooting, improving the offerings and user experience, responding to issues, and for billing purposes if applicable. - -.Collection safeguards - -Red Hat employs technical and organizational measures designed to protect the telemetry and configuration data. - -.Sharing - -Red Hat may share the data collected through Telemetry and the Insights Operator internally within Red Hat to improve your user experience. Red Hat may share telemetry and configuration data with its business partners in an aggregated form that does not identify customers to help the partners better understand their markets and their customers’ use of Red Hat offerings or to ensure the successful integration of products jointly supported by those partners. - -.Third parties - -Red Hat may engage certain third parties to assist in the collection, analysis, and storage of the Telemetry and configuration data. \ No newline at end of file diff --git a/sd_support/remote_health_monitoring/enabling-remote-health-reporting.adoc b/sd_support/remote_health_monitoring/enabling-remote-health-reporting.adoc deleted file mode 100644 index 3addca1d15..0000000000 --- a/sd_support/remote_health_monitoring/enabling-remote-health-reporting.adoc +++ /dev/null @@ -1,20 +0,0 @@ -:_content-type: ASSEMBLY -[id="enabling-remote-health-reporting"] -= Enabling remote health reporting -include::_attributes/common-attributes.adoc[] - -:context: enabling-remote-health-reporting - -toc::[] - - -If you or your organization have disabled remote health reporting, you can enable this feature again. You can see that remote health reporting is disabled from the message "Insights not available" in the *Status* tile on the {product-title} Web Console Overview page. - -To enable remote health reporting, you must xref:../../support/remote_health_monitoring/enabling-remote-health-reporting.adoc#insights-operator-new-pull-secret-enable_enabling-remote-health-reporting[Modify the global cluster pull secret] with a new authorization token. - -[NOTE] -==== -Enabling remote health reporting enables both Insights Operator and Telemetry. -==== - -include::modules/insights-operator-new-pull-secret-enable.adoc[leveloffset=+1] diff --git a/sd_support/remote_health_monitoring/images b/sd_support/remote_health_monitoring/images deleted file mode 120000 index 5fa6987088..0000000000 --- a/sd_support/remote_health_monitoring/images +++ /dev/null @@ -1 +0,0 @@ -../../images \ No newline at end of file diff --git a/sd_support/remote_health_monitoring/insights-operator-simple-access.adoc b/sd_support/remote_health_monitoring/insights-operator-simple-access.adoc deleted file mode 100644 index 39fd51c636..0000000000 --- a/sd_support/remote_health_monitoring/insights-operator-simple-access.adoc +++ /dev/null @@ -1,23 +0,0 @@ -:_content-type: ASSEMBLY -[id="insights-operator-simple-access"] -= Importing simple content access certificates with Insights Operator -include::_attributes/common-attributes.adoc[] -:context: remote-health-reporting-from-restricted-network -:FeatureName: `InsightsOperatorPullingSCA` - -toc::[] - -Insights Operator periodically imports your simple content access certificates from {cluster-manager-url} and stores them in the `etc-pki-entitlement` secret in the `openshift-config-managed` namespace. Simple content access is a capability in Red Hat subscription tools which simplifies the behavior of the entitlement tooling. This feature makes it easier to consume the content provided by your Red Hat subscriptions without the complexity of configuring subscription tooling. - -Insights Operator imports simple content access certificates every 8 hours by default, but can be configured or disabled using the `support` secret in the `openshift-config` namespace. - -[role="_additional-resources"] -.Additional resources - -* See link:https://access.redhat.com/documentation/en-us/subscription_central/2021/html-single/getting_started_with_simple_content_access/index#assembly-about-simplecontent[About simple content access] in the Red Hat Subscription Central documentation, for more information about simple content access. - -* See xref:../../cicd/builds/running-entitled-builds.adoc[Using Red Hat subscriptions in builds], for more information about using simple content access certificates in {product-title} entitled builds. - -include::modules/insights-operator-configuring-sca.adoc[leveloffset=+1] - -include::modules/insights-operator-disabling-sca.adoc[leveloffset=+1] diff --git a/sd_support/remote_health_monitoring/modules b/sd_support/remote_health_monitoring/modules deleted file mode 120000 index 8b0e854007..0000000000 --- a/sd_support/remote_health_monitoring/modules +++ /dev/null @@ -1 +0,0 @@ -../../modules \ No newline at end of file diff --git a/sd_support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc b/sd_support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc deleted file mode 100644 index f9e5dd9a27..0000000000 --- a/sd_support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc +++ /dev/null @@ -1,35 +0,0 @@ -:_content-type: ASSEMBLY -[id="opting-out-remote-health-reporting"] -= Opting out of remote health reporting -include::_attributes/common-attributes.adoc[] -ifdef::openshift-dedicated[] -include::_attributes/attributes-openshift-dedicated.adoc[] -endif::[] -:context: opting-out-remote-health-reporting - -toc::[] - -ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] -You may choose to opt out of reporting health and usage data for your cluster. -endif::[] - -ifdef::openshift-dedicated[] -On {product-title}, remote health reporting is always enabled. You cannot opt out. - -// TODO: Is there even a reason to include this assembly for OSD? Could you remove it, and just mention in the other assemblies that you can't opt out? -endif::[] - -ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] - -To opt out of remote health reporting, you must: - -. xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#insights-operator-new-pull-secret_opting-out-remote-health-reporting[Modify the global cluster pull secret] to disable remote health reporting. -. xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#images-update-global-pull-secret_opting-out-remote-health-reporting[Update the cluster] to use this modified pull secret. - -include::modules/telemetry-consequences-of-disabling-telemetry.adoc[leveloffset=+1] - -include::modules/insights-operator-new-pull-secret-disabled.adoc[leveloffset=+1] - -include::modules/images-update-global-pull-secret.adoc[leveloffset=+1] - -endif::[] diff --git a/sd_support/remote_health_monitoring/remote-health-reporting-from-restricted-network.adoc b/sd_support/remote_health_monitoring/remote-health-reporting-from-restricted-network.adoc deleted file mode 100644 index 64d76d1d4c..0000000000 --- a/sd_support/remote_health_monitoring/remote-health-reporting-from-restricted-network.adoc +++ /dev/null @@ -1,28 +0,0 @@ -:_content-type: ASSEMBLY -[id="remote-health-reporting-from-restricted-network"] -= Using remote health reporting in a restricted network -include::_attributes/common-attributes.adoc[] -:context: remote-health-reporting-from-restricted-network - -toc::[] - -You can manually gather and upload Insights Operator archives to diagnose issues from a restricted network. - -To use the Insights Operator in a restricted network, you must: - -* Create a copy of your Insights Operator archive. -* Upload the Insights Operator archive to link:https://console.redhat.com[console.redhat.com]. - -Additionally, you can choose to xref:../../support/remote_health_monitoring/remote-health-reporting-from-restricted-network.adoc#insights-operator-enable-obfuscation_remote-health-reporting-from-restricted-network[obfuscate] the Insights Operator data before upload. - - -include::modules/insights-operator-one-time-gather.adoc[leveloffset=+1] - -include::modules/insights-operator-manual-upload.adoc[leveloffset=+1] - -include::modules/insights-operator-enable-obfuscation.adoc[leveloffset=+1] - -[role="_additional-resources"] -.Additional resources - -* For more information on how to download your Insights Operator archive, see xref:../../support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc#insights-operator-showing-data-collected-from-the-cluster_showing-data-collected-by-remote-health-monitoring[Showing data collected by the Insights Operator]. diff --git a/sd_support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc b/sd_support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc deleted file mode 100644 index d4ac74ca6e..0000000000 --- a/sd_support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc +++ /dev/null @@ -1,16 +0,0 @@ -:_content-type: ASSEMBLY -[id="showing-data-collected-by-remote-health-monitoring"] -= Showing data collected by remote health monitoring -include::_attributes/common-attributes.adoc[] -ifdef::openshift-dedicated[] -include::_attributes/attributes-openshift-dedicated.adoc[] -endif::[] -:context: showing-data-collected-by-remote-health-monitoring - -toc::[] - -As an administrator, you can review the metrics collected by Telemetry and the Insights Operator. - -include::modules/telemetry-showing-data-collected-from-the-cluster.adoc[leveloffset=+1] - -include::modules/insights-operator-showing-data-collected-from-the-cluster.adoc[leveloffset=+1] diff --git a/sd_support/remote_health_monitoring/snippets b/sd_support/remote_health_monitoring/snippets deleted file mode 120000 index 7bf6da9a51..0000000000 --- a/sd_support/remote_health_monitoring/snippets +++ /dev/null @@ -1 +0,0 @@ -../../snippets \ No newline at end of file diff --git a/sd_support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc b/sd_support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc deleted file mode 100644 index b4380a8969..0000000000 --- a/sd_support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc +++ /dev/null @@ -1,20 +0,0 @@ -:_content-type: ASSEMBLY -[id="using-insights-to-identify-issues-with-your-cluster"] -= Using Insights to identify issues with your cluster -include::_attributes/common-attributes.adoc[] -ifdef::openshift-dedicated[] -include::_attributes/attributes-openshift-dedicated.adoc[] -endif::[] -:context: using-insights-to-identify-issues-with-your-cluster - -toc::[] - -Insights repeatedly analyzes the data Insights Operator sends. Users of {product-title} can display the report in the *Insights* tab of each cluster on {cluster-manager-url}. - -include::modules/insights-operator-advisor-overview.adoc[leveloffset=+1] -include::modules/insights-operator-advisor-recommendations.adoc[leveloffset=+1] -include::modules/displaying-potential-issues-with-your-cluster.adoc[leveloffset=+1] -include::modules/displaying-all-insights-advisor-recommendations.adoc[leveloffset=+1] -include::modules/disabling-insights-advisor-recommendations.adoc[leveloffset=+1] -include::modules/enabling-insights-advisor-recommendations.adoc[leveloffset=+1] -include::modules/displaying-the-insights-status-in-the-web-console.adoc[leveloffset=+1] diff --git a/sd_support/rosa-getting-support.adoc b/sd_support/rosa-getting-support.adoc deleted file mode 100644 index 91c34dc5fe..0000000000 --- a/sd_support/rosa-getting-support.adoc +++ /dev/null @@ -1,10 +0,0 @@ -:_content-type: ASSEMBLY -[id="rosa-getting-support"] -= Getting support for {product-title} -include::_attributes/attributes-openshift-dedicated.adoc[] -:context: rosa-getting-support -toc::[] - -Get support for {product-title} (ROSA). - -include::modules/rosa-getting-support.adoc[leveloffset=+1] diff --git a/sd_support/snippets b/sd_support/snippets deleted file mode 120000 index 9f5bc7e4dd..0000000000 --- a/sd_support/snippets +++ /dev/null @@ -1 +0,0 @@ -../snippets \ No newline at end of file diff --git a/support/gathering-cluster-data.adoc b/support/gathering-cluster-data.adoc index 66c0aad49e..73a1f64e4e 100644 --- a/support/gathering-cluster-data.adoc +++ b/support/gathering-cluster-data.adoc @@ -36,7 +36,9 @@ include::modules/gathering-data-specific-features.adoc[leveloffset=+2] == Additional resources +ifndef::openshift-rosa,openshift-dedicated[] * xref:../nodes/cma/nodes-cma-autoscaling-custom.adoc#nodes-cma-autoscaling-custom-gather[Gathering debugging data] for the Custom Metrics Autoscaler. +endif::openshift-rosa,openshift-dedicated[] * link:https://access.redhat.com/support/policy/updates/openshift[Red Hat {product-title} Life Cycle Policy] diff --git a/support/getting-support.adoc b/support/getting-support.adoc index b34337338f..ffe54f11a8 100644 --- a/support/getting-support.adoc +++ b/support/getting-support.adoc @@ -10,15 +10,12 @@ endif::[] toc::[] // Getting support -ifdef::openshift-enterprise,openshift-webscale,openshift-dedicated,openshift-origin[] include::modules/support.adoc[leveloffset=+1] include::modules/support-knowledgebase-about.adoc[leveloffset=+1] include::modules/support-knowledgebase-search.adoc[leveloffset=+1] include::modules/support-submitting-a-case.adoc[leveloffset=+1] -endif::openshift-enterprise,openshift-webscale,openshift-dedicated,openshift-origin[] - [id="getting-support-additional-resources"] [role="_additional-resources"] == Additional resources diff --git a/support/index.adoc b/support/index.adoc index dbe7a1d110..ff377f7c83 100644 --- a/support/index.adoc +++ b/support/index.adoc @@ -12,10 +12,20 @@ Red Hat offers cluster administrators tools for gathering data for your cluster, == Get support xref:../support/getting-support.adoc#getting-support[Get support]: Visit the Red Hat Customer Portal to review knowledge base articles, submit a support case, and review additional product documentation and resources. +ifndef::openshift-rosa,openshift-dedicated[] [id='support-overview-remote-health-monitoring'] == Remote health monitoring issues xref:../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[Remote health monitoring issues]: {product-title} collects telemetry and configuration data about your cluster and reports it to Red Hat by using the Telemeter Client and the Insights Operator. Red Hat uses this data to understand and resolve issues in _connected cluster_. Similar to connected clusters, you can xref:../support/remote_health_monitoring/remote-health-reporting-from-restricted-network.adoc#remote-health-reporting-from-restricted-network[Use remote health monitoring in a restricted network]. {product-title} collects data and monitors health using the following: +endif::openshift-rosa,openshift-dedicated[] + +// Removed sentence on restricted networks, not supported in ROSA/OSD +ifdef::openshift-rosa,openshift-dedicated[] +[id='support-overview-remote-health-monitoring'] +== Remote health monitoring issues +xref:../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[Remote health monitoring issues]: +{product-title} collects telemetry and configuration data about your cluster and reports it to Red Hat by using the Telemeter Client and the Insights Operator. Red Hat uses this data to understand and resolve issues in _connected cluster_. {product-title} collects data and monitors health using the following: +endif::openshift-rosa,openshift-dedicated[] * *Telemetry*: The Telemetry Client gathers and uploads the metrics values to Red Hat every four minutes and thirty seconds. Red Hat uses this data to: @@ -28,10 +38,12 @@ xref:../support/remote_health_monitoring/about-remote-health-monitoring.adoc#abo ** Identify potential cluster issues proactively. ** Provide a solution and preventive action in {cluster-manager-first}. -You can xref:../support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc#showing-data-collected-by-remote-health-monitoring[Review telemetry information]. +You can xref:../support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc#showing-data-collected-by-remote-health-monitoring[review telemetry information]. If you have enabled remote health reporting, xref:../support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc#using-insights-to-identify-issues-with-your-cluster[Use Insights to identify issues]. You can optionally disable remote health reporting. +// must-gather not supported for customers, per Dustin Row, cannot create resource "namespaces" +ifndef::openshift-rosa,openshift-dedicated[] [id='support-overview-gather-data-cluster'] == Gather data about your cluster xref:../support/gathering-cluster-data.adoc#gathering-cluster-data[Gather data about your cluster]: Red Hat recommends gathering your debugging information when opening a support case. This helps Red Hat Support to perform a root cause analysis. A cluster administrator can use the following to gather data about your cluster: @@ -43,24 +55,28 @@ xref:../support/gathering-cluster-data.adoc#gathering-cluster-data[Gather data a * *Cluster node journal logs*: Gather `journald` unit logs and logs within `/var/log` on individual cluster nodes to troubleshoot node-related issues. * *A network trace*: Provide a network packet trace from a specific {product-title} cluster node or a container to Red Hat Support to help troubleshoot network-related issues. * *Diagnostic data*: Use the `redhat-support-tool` command to gather(?) diagnostic data about your cluster. +endif::openshift-rosa,openshift-dedicated[] [id='support-overview-troubleshooting-issues'] == Troubleshooting issues A cluster administrator can monitor and troubleshoot the following {product-title} component issues: +ifndef::openshift-rosa,openshift-dedicated[] * xref:../support/troubleshooting/troubleshooting-installations.adoc#troubleshooting-installations[Installation issues]: {product-title} installation proceeds through various stages. You can perform the following: ** Monitor the installation stages. ** Determine at which stage installation issues occur. ** Investigate multiple installation issues. ** Gather logs from a failed installation. +endif::openshift-rosa,openshift-dedicated[] * xref:../support/troubleshooting/verifying-node-health.adoc#verifying-node-health[Node issues]: A cluster administrator can verify and troubleshoot node-related issues by reviewing the status, resource usage, and configuration of a node. You can query the following: ** Kubelet’s status on a node. ** Cluster node journal logs. +ifndef::openshift-rosa,openshift-dedicated[] * xref:../support/troubleshooting/troubleshooting-crio-issues.adoc#troubleshooting-crio-issues[Crio issues]: A cluster administrator can verify CRI-O container runtime engine status on each cluster node. If you experience container runtime issues, perform the following: ** Gather CRI-O journald unit logs. @@ -71,12 +87,15 @@ A cluster administrator can monitor and troubleshoot the following {product-titl ** Enable kdump. ** Test the kdump configuration. ** Analyze a core dump. +endif::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-dedicated[] * xref:../support/troubleshooting/troubleshooting-network-issues.adoc#troubleshooting-network-issues[Network issues]: To troubleshoot Open vSwitch issues, a cluster administrator can perform the following: ** Configure the Open vSwitch log level temporarily. ** Configure the Open vSwitch log level permanently. ** Display Open vSwitch logs. +endif::openshift-rosa,openshift-dedicated[] * xref:../support/troubleshooting/troubleshooting-operator-issues.adoc#troubleshooting-operator-issues[Operator issues]: A cluster administrator can do the following to resolve Operator issues: @@ -89,10 +108,12 @@ A cluster administrator can monitor and troubleshoot the following {product-titl ** Review pod and container logs. ** Start debug pods with root access. +ifndef::openshift-rosa,openshift-dedicated[] * xref:../support/troubleshooting/troubleshooting-s2i.adoc#troubleshooting-s2i[Source-to-image issues]: A cluster administrator can observe the S2I stages to determine where in the S2I process a failure occurred. Gather the following to resolve Source-to-Image (S2I) issues: ** Source-to-Image diagnostic data. ** Application diagnostic data to investigate application failure. +endif::openshift-rosa,openshift-dedicated[] * xref:../support/troubleshooting/troubleshooting-storage-issues.adoc#troubleshooting-storage-issues[Storage issues]: A multi-attach storage error occurs when the mounting volume on a new node is not possible because the failed node cannot unmount the attached volume. A cluster administrator can do the following to resolve multi-attach storage issues: diff --git a/support/remote_health_monitoring/about-remote-health-monitoring.adoc b/support/remote_health_monitoring/about-remote-health-monitoring.adoc index 178ba36f1b..8580f7eea7 100644 --- a/support/remote_health_monitoring/about-remote-health-monitoring.adoc +++ b/support/remote_health_monitoring/about-remote-health-monitoring.adoc @@ -23,7 +23,7 @@ More information is provided in this document about these two processes. Telemetry and the Insights Operator enable the following benefits for end-users: -* *Enhanced identification and resolution of issues*. Events that might seem normal to an end-user can be observed by Red Hat from a broader perspective across a fleet of clusters. Some issues can be more rapidly identified from this point of view and resolved without an end-user needing to open a support case or file a link:https://issues.redhat.com/secure/CreateIssueDetails!init.jspa?pid=12332330&summary=Summary&issuetype=1&priority=10200&versions=12391126[Jira issue]. +* *Enhanced identification and resolution of issues*. Events that might seem normal to an end-user can be observed by Red Hat from a broader perspective across a fleet of clusters. Some issues can be more rapidly identified from this point of view and resolved without an end-user needing to open a support case or file a link:https://issues.redhat.com/secure/CreateIssueDetails!init.jspa?pid=12332330&summary=Summary&issuetype=1&priority=10200&versions=12385624[Jira issue]. * *Advanced release management*. {product-title} offers the `candidate`, `fast`, and `stable` release channels, which enable you to choose an update strategy. The graduation of a release from `fast` to `stable` is dependent on the success rate of updates and on the events seen during upgrades. With the information provided by connected clusters, Red Hat can improve the quality of releases to `stable` channels and react more rapidly to issues found in the `fast` channels. @@ -33,23 +33,29 @@ Telemetry and the Insights Operator enable the following benefits for end-users: * *Predictive analytics*. The insights displayed for your cluster on {cluster-manager-url} are enabled by the information collected from connected clusters. Red Hat is investing in applying deep learning, machine learning, and artificial intelligence automation to help identify issues that {product-title} clusters are exposed to. +ifdef::openshift-rosa,openshift-dedicated[] +On {product-title}, remote health reporting is always enabled. You cannot opt out of it. +endif::openshift-rosa,openshift-dedicated[] + ifdef::openshift-origin[] {product-title} may be installed without a pull secret received at console.redhat.com. In this case default imagestreams will not be imported and telemetry data will not be sent. endif::[] include::modules/telemetry-about-telemetry.adoc[leveloffset=+1] -ifndef::openshift-dedicated[] +ifndef::openshift-rosa,openshift-dedicated[] [role="_additional-resources"] .Additional resources * See the xref:../../updating/updating_a_cluster/updating-cluster-web-console.adoc#updating-cluster-web-console[{product-title} update documentation] for more information about updating or upgrading a cluster. -endif::[] +endif::openshift-rosa,openshift-dedicated[] include::modules/telemetry-what-information-is-collected.adoc[leveloffset=+2] - -ifndef::openshift-dedicated[] +// Module is not in OCP +ifdef::openshift-rosa,openshift-dedicated[] +include::modules/telemetry-user-telemetry.adoc[leveloffset=+2] +endif::openshift-rosa,openshift-dedicated[] [role="_additional-resources"] .Additional resources @@ -58,42 +64,40 @@ ifndef::openshift-dedicated[] * See the link:https://github.com/openshift/cluster-monitoring-operator/blob/master/manifests/0000_50_cluster-monitoring-operator_04-config.yaml[upstream cluster-monitoring-operator source code] for a list of the attributes that Telemetry gathers from Prometheus. +ifndef::openshift-rosa,openshift-dedicated[] * Telemetry is installed and enabled by default. If you need to opt out of remote health reporting, see xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting[Opting out of remote health reporting]. -endif::[] +endif::openshift-rosa,openshift-dedicated[] include::modules/insights-operator-about.adoc[leveloffset=+1] +ifndef::openshift-rosa,openshift-dedicated[] [role="_additional-resources"] .Additional resources * The Insights Operator is installed and enabled by default. If you need to opt out of remote health reporting, see xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting[Opting out of remote health reporting]. - -ifdef::openshift-dedicated[] -// TODO: When you click on that link, you actually can't opt out. Should this additional resources link be removed? -endif::[] +endif::openshift-rosa,openshift-dedicated[] include::modules/insights-operator-what-information-is-collected.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -ifndef::openshift-dedicated[] +ifndef::openshift-rosa,openshift-dedicated[] * See xref:../../support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc#insights-operator-showing-data-collected-from-the-cluster_showing-data-collected-by-remote-health-monitoring[Showing data collected by the Insights Operator] for details about how to review the data that is collected by the Insights Operator. -endif::[] +endif::openshift-rosa,openshift-dedicated[] * The Insights Operator source code is available for review and contribution. See the link:https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md[Insights Operator upstream project] for a list of the items collected by the Insights Operator. include::modules/understanding-telemetry-and-insights-operator-data-flow.adoc[leveloffset=+1] -ifndef::openshift-dedicated[] - [role="_additional-resources"] .Additional resources * See xref:../../monitoring/monitoring-overview.adoc#monitoring-overview_monitoring-overview[Monitoring overview] for more information about the {product-title} monitoring stack. +ifndef::openshift-rosa,openshift-dedicated[] * See xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[Configuring your firewall] for details about configuring a firewall and enabling endpoints for Telemetry and Insights -endif::[] +endif::openshift-rosa,openshift-dedicated[] [id="additional-details-about-how-remote-health-monitoring-data-is-used"] == Additional details about how remote health monitoring data is used @@ -116,8 +120,6 @@ Red Hat may engage certain third parties to assist in the collection, analysis, .User control / enabling and disabling telemetry and configuration data collection +ifndef::openshift-rosa,openshift-dedicated[] You may disable {product-title} Telemetry and the Insights Operator by following the instructions in xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting[Opting out of remote health reporting]. - -ifdef::openshift-dedicated[] -// TODO: Same question about should this be removed or updated, since you can't actually opt out for dedicated? -endif::[] +endif::openshift-rosa,openshift-dedicated[] diff --git a/support/remote_health_monitoring/insights-operator-simple-access.adoc b/support/remote_health_monitoring/insights-operator-simple-access.adoc index 7b8f8574d6..254178877c 100644 --- a/support/remote_health_monitoring/insights-operator-simple-access.adoc +++ b/support/remote_health_monitoring/insights-operator-simple-access.adoc @@ -21,7 +21,9 @@ Simple content access must be enabled in Red Hat Subscription Management for the * See link:https://access.redhat.com/documentation/en-us/subscription_central/2021/html-single/getting_started_with_simple_content_access/index#assembly-about-simplecontent[About simple content access] in the Red Hat Subscription Central documentation, for more information about simple content access. +ifndef::openshift-rosa,openshift-dedicated[] * See xref:../../cicd/builds/running-entitled-builds.adoc[Using Red Hat subscriptions in builds] for more information about using simple content access entitlements in {product-title} builds. +endif::openshift-rosa,openshift-dedicated[] include::modules/insights-operator-configuring-sca.adoc[leveloffset=+1] diff --git a/support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc b/support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc index d104a05cbf..3998eb9679 100644 --- a/support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc +++ b/support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc @@ -13,11 +13,7 @@ ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] You may choose to opt out of reporting health and usage data for your cluster. endif::[] -ifdef::openshift-dedicated[] -On {product-title}, remote health reporting is always enabled. You cannot opt out. - -// TODO: Is there even a reason to include this assembly for OSD? Could you remove it, and just mention in the other assemblies that you can't opt out? -endif::[] +// moved OSD note on not able to opt out to about telemetery ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] diff --git a/support/remote_health_monitoring/remote-health-reporting-from-restricted-network.adoc b/support/remote_health_monitoring/remote-health-reporting-from-restricted-network.adoc index 64d76d1d4c..18b25632d5 100644 --- a/support/remote_health_monitoring/remote-health-reporting-from-restricted-network.adoc +++ b/support/remote_health_monitoring/remote-health-reporting-from-restricted-network.adoc @@ -15,7 +15,6 @@ To use the Insights Operator in a restricted network, you must: Additionally, you can choose to xref:../../support/remote_health_monitoring/remote-health-reporting-from-restricted-network.adoc#insights-operator-enable-obfuscation_remote-health-reporting-from-restricted-network[obfuscate] the Insights Operator data before upload. - include::modules/insights-operator-one-time-gather.adoc[leveloffset=+1] include::modules/insights-operator-manual-upload.adoc[leveloffset=+1] diff --git a/support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc b/support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc index d4ac74ca6e..a6ac503fd1 100644 --- a/support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc +++ b/support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc @@ -13,4 +13,7 @@ As an administrator, you can review the metrics collected by Telemetry and the I include::modules/telemetry-showing-data-collected-from-the-cluster.adoc[leveloffset=+1] +// cannot create resource "pods/exec" in API group "" in the namespace "openshift-insights" +ifndef::openshift-rosa,openshift-dedicated[] include::modules/insights-operator-showing-data-collected-from-the-cluster.adoc[leveloffset=+1] +endif::openshift-rosa,openshift-dedicated[] diff --git a/support/remote_health_monitoring/using-insights-operator.adoc b/support/remote_health_monitoring/using-insights-operator.adoc index b7fe861f42..7e96150866 100644 --- a/support/remote_health_monitoring/using-insights-operator.adoc +++ b/support/remote_health_monitoring/using-insights-operator.adoc @@ -14,15 +14,28 @@ The Insights Operator periodically gathers configuration and component failure s [role="_additional-resources"] .Additional resources +ifndef::openshift-rosa,openshift-dedicated[] * The Insights Operator is installed and enabled by default. If you need to opt out of remote health reporting, see xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting[Opting out of remote health reporting]. +endif::openshift-rosa,openshift-dedicated[] * For more information on using Insights Advisor to identify issues with your cluster, see xref:../../support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc#using-insights-to-identify-issues-with-your-cluster[Using Insights to identify issues with your cluster]. include::modules/understanding-insights-operator-alerts.adoc[leveloffset=+1] +ifndef::openshift-rosa,openshift-dedicated[] include::modules/disabling-insights-operator-alerts.adoc[leveloffset=+1] +endif::openshift-rosa,openshift-dedicated[] +// cannot create resource "pods/exec" in API group "" in the namespace "openshift-insights" +ifndef::openshift-rosa,openshift-dedicated[] include::modules/insights-operator-downloading-archive.adoc[leveloffset=+1] +// cannot download archive using previous module include::modules/insights-operator-gather-duration.adoc[leveloffset=+1] +endif::openshift-rosa,openshift-dedicated[] +// InsightsDataGather is a Tech Preview feature. When the feature goes GA, verify if it can be added to ROSA/OSD. +ifndef::openshift-rosa,openshift-dedicated[] include::modules/disabling-insights-operator-gather.adoc[leveloffset=+1] +endif::openshift-rosa,openshift-dedicated[] +// tech preview feature +ifndef::openshift-rosa,openshift-dedicated[] [id="running-insights-operator-gather_using-insights-operator"] == Running an Insights Operator gather operation @@ -37,4 +50,9 @@ If you enable Technology Preview in your cluster, the Insights Operator runs gat ==== include::modules/running-insights-operator-gather-web-console.adoc[leveloffset=+2] include::modules/running-insights-operator-gather-cli.adoc[leveloffset=+2] +endif::openshift-rosa,openshift-dedicated[] +// cannot list resource "secrets" in API group "" in the namespace "openshift-config" +ifndef::openshift-rosa,openshift-dedicated[] include::modules/insights-operator-configuring.adoc[leveloffset=+1] +endif::openshift-rosa,openshift-dedicated[] + diff --git a/sd_support/osd-managed-resources.adoc b/support/troubleshooting/osd-managed-resources.adoc similarity index 100% rename from sd_support/osd-managed-resources.adoc rename to support/troubleshooting/osd-managed-resources.adoc diff --git a/sd_support/rosa-managed-resources.adoc b/support/troubleshooting/rosa-managed-resources.adoc similarity index 100% rename from sd_support/rosa-managed-resources.adoc rename to support/troubleshooting/rosa-managed-resources.adoc diff --git a/sd_support/rosa-troubleshooting-deployments.adoc b/support/troubleshooting/rosa-troubleshooting-deployments.adoc similarity index 100% rename from sd_support/rosa-troubleshooting-deployments.adoc rename to support/troubleshooting/rosa-troubleshooting-deployments.adoc diff --git a/sd_support/rosa-troubleshooting-expired-tokens.adoc b/support/troubleshooting/rosa-troubleshooting-expired-tokens.adoc similarity index 100% rename from sd_support/rosa-troubleshooting-expired-tokens.adoc rename to support/troubleshooting/rosa-troubleshooting-expired-tokens.adoc diff --git a/sd_support/rosa-troubleshooting-iam-resources.adoc b/support/troubleshooting/rosa-troubleshooting-iam-resources.adoc similarity index 100% rename from sd_support/rosa-troubleshooting-iam-resources.adoc rename to support/troubleshooting/rosa-troubleshooting-iam-resources.adoc diff --git a/sd_support/rosa-troubleshooting-installations.adoc b/support/troubleshooting/rosa-troubleshooting-installations.adoc similarity index 83% rename from sd_support/rosa-troubleshooting-installations.adoc rename to support/troubleshooting/rosa-troubleshooting-installations.adoc index d1d39b5b6a..4245ce4830 100644 --- a/sd_support/rosa-troubleshooting-installations.adoc +++ b/support/troubleshooting/rosa-troubleshooting-installations.adoc @@ -1,7 +1,7 @@ :_content-type: ASSEMBLY include::_attributes/attributes-openshift-dedicated.adoc[] [id="rosa-troubleshooting-installations"] -= Troubleshooting installations += Troubleshooting {product-title} installations :context: rosa-troubleshooting-installations toc::[] diff --git a/support/troubleshooting/troubleshooting-crio-issues.adoc b/support/troubleshooting/troubleshooting-crio-issues.adoc index 3529e8aa2b..19bafd350a 100644 --- a/support/troubleshooting/troubleshooting-crio-issues.adoc +++ b/support/troubleshooting/troubleshooting-crio-issues.adoc @@ -12,8 +12,11 @@ include::modules/about-crio.adoc[leveloffset=+1] // Verifying CRI-O runtime engine status include::modules/verifying-crio-status.adoc[leveloffset=+1] +// Prevented from accessing Red Hat managed resources +ifndef::openshift-rosa,openshift-dedicated[] // Gathering CRI-O journald unit logs include::modules/gathering-crio-logs.adoc[leveloffset=+1] +endif::openshift-rosa,openshift-dedicated[] // Cleaning CRI-O storage include::modules/cleaning-crio-storage.adoc[leveloffset=+1] diff --git a/support/troubleshooting/troubleshooting-installations.adoc b/support/troubleshooting/troubleshooting-installations.adoc index 960c954954..087288a63c 100644 --- a/support/troubleshooting/troubleshooting-installations.adoc +++ b/support/troubleshooting/troubleshooting-installations.adoc @@ -45,9 +45,11 @@ include::modules/querying-operator-status-after-installation.adoc[leveloffset=+1 // Gathering logs from a failed installation include::modules/installation-bootstrap-gather.adoc[leveloffset=+1] +ifndef::openshift-rosa,openshift-dedicated[] [role="_additional-resources"] == Additional resources * See xref:../../architecture/architecture-installation.adoc#installation-process_architecture-installation[Installation process] for more details on {product-title} installation types and process. +endif::openshift-rosa,openshift-dedicated[] // TODO: xref to UPI recommendations for respective versions, with ifdefs. diff --git a/support/troubleshooting/troubleshooting-operator-issues.adoc b/support/troubleshooting/troubleshooting-operator-issues.adoc index 89dc5f4267..2ecbcaecbb 100644 --- a/support/troubleshooting/troubleshooting-operator-issues.adoc +++ b/support/troubleshooting/troubleshooting-operator-issues.adoc @@ -30,9 +30,13 @@ include::modules/olm-cs-status-cli.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources +ifndef::openshift-rosa,openshift-dedicated[] * xref:../../operators/understanding/olm/olm-understanding-olm.adoc#olm-catalogsource_olm-understanding-olm[Operator Lifecycle Manager concepts and resources -> Catalog source] +endif::openshift-rosa,openshift-dedicated[] * gRPC documentation: link:https://grpc.github.io/grpc/core/md_doc_connectivity-semantics-and-api.html[States of Connectivity] +ifndef::openshift-rosa,openshift-dedicated[] * xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-accessing-images-private-registries_olm-managing-custom-catalogs[Accessing images for Operators from private registries] +endif::openshift-rosa,openshift-dedicated[] // Querying Operator Pod status include::modules/querying-operator-pod-status.adoc[leveloffset=+1] @@ -40,21 +44,32 @@ include::modules/querying-operator-pod-status.adoc[leveloffset=+1] // Gathering Operator logs include::modules/gathering-operator-logs.adoc[leveloffset=+1] +// cannot patch resource "machineconfigpools" +ifndef::openshift-rosa,openshift-dedicated[] // Disabling Machine Config Operator from autorebooting include::modules/troubleshooting-disabling-autoreboot-mco.adoc[leveloffset=+1] include::modules/troubleshooting-disabling-autoreboot-mco-console.adoc[leveloffset=+2] include::modules/troubleshooting-disabling-autoreboot-mco-cli.adoc[leveloffset=+2] +endif::openshift-rosa,openshift-dedicated[] // Refreshing failing subscriptions +// cannot delete resource "clusterserviceversions", "jobs" in API group "operators.coreos.com" in the namespace "openshift-apiserver" +ifndef::openshift-rosa,openshift-dedicated[] include::modules/olm-refresh-subs.adoc[leveloffset=+1] +endif::openshift-rosa,openshift-dedicated[] // Reinstalling Operators after failed uninstallation +// cannot delete resource "customresourcedefinitions" +ifndef::openshift-rosa,openshift-dedicated[] include::modules/olm-reinstall.adoc[leveloffset=+1] +endif::openshift-rosa,openshift-dedicated[] + +ifndef::openshift-rosa,openshift-dedicated[] [role="_additional-resources"] .Additional resources * xref:../../operators/admin/olm-deleting-operators-from-cluster.adoc#olm-deleting-operators-from-a-cluster[Deleting Operators from a cluster] * xref:../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-adding-operators-to-a-cluster[Adding Operators to a cluster] - +endif::openshift-rosa,openshift-dedicated[] diff --git a/support/troubleshooting/troubleshooting-s2i.adoc b/support/troubleshooting/troubleshooting-s2i.adoc index fc4c273ad7..ec5ff44258 100644 --- a/support/troubleshooting/troubleshooting-s2i.adoc +++ b/support/troubleshooting/troubleshooting-s2i.adoc @@ -15,7 +15,9 @@ include::modules/gathering-s2i-diagnostic-data.adoc[leveloffset=+1] // Gathering application diagnostic data to investigate application failures include::modules/gathering-application-diagnostic-data.adoc[leveloffset=+1] +ifndef::openshift-rosa,openshift-dedicated[] [role="_additional-resources"] == Additional resources * See xref:../../cicd/builds/build-strategies.adoc#build-strategy-s2i_build-strategies[Source-to-Image (S2I) build] for more details about the S2I build strategy. +endif::openshift-rosa,openshift-dedicated[] diff --git a/support/troubleshooting/verifying-node-health.adoc b/support/troubleshooting/verifying-node-health.adoc index 707df7a06d..2054805ee2 100644 --- a/support/troubleshooting/verifying-node-health.adoc +++ b/support/troubleshooting/verifying-node-health.adoc @@ -9,8 +9,13 @@ toc::[] // Reviewing node status, resource usage, and configuration include::modules/reviewing-node-status-usage-and-configuration.adoc[leveloffset=+1] +// cannot create resource "namespaces" +ifndef::openshift-rosa,openshift-dedicated[] // Querying the kubelet's status on a node include::modules/querying-kubelet-status-on-a-node.adoc[leveloffset=+1] +// cannot get resource "nodes/proxy" // Querying node journal logs include::modules/querying-cluster-node-journal-logs.adoc[leveloffset=+1] +endif::openshift-rosa,openshift-dedicated[] +