Skip to content

Commit

Permalink
[enterprise-4.14][OSDOCS-3997] OCP content port to ROSA and OSD: Support
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Burke committed Oct 11, 2023
1 parent df892b4 commit 7cdaf95
Show file tree
Hide file tree
Showing 135 changed files with 518 additions and 515 deletions.
105 changes: 81 additions & 24 deletions _topic_maps/_topic_map_osd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
119 changes: 93 additions & 26 deletions _topic_maps/_topic_map_rosa.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
---
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
10 changes: 1 addition & 9 deletions authentication/managing-security-context-constraints.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
10 changes: 8 additions & 2 deletions modules/about-must-gather.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -65,4 +71,4 @@ For example:
----
$ oc adm must-gather --run-namespace <namespace> \
--image=registry.redhat.io/container-native-virtualization/cnv-must-gather-rhel9:v{HCOVersion}
----
----
5 changes: 5 additions & 0 deletions modules/accessing-running-pods.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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`).

Expand Down
5 changes: 5 additions & 0 deletions modules/cluster-resources.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions modules/copying-files-pods-and-containers.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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`).

Expand Down
1 change: 0 additions & 1 deletion modules/disabling-insights-advisor-recommendations.adoc
Original file line number Diff line number Diff line change
@@ -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}"]
Expand Down
7 changes: 6 additions & 1 deletion modules/disabling-insights-operator-gather.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -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}"]
Expand Down
1 change: 0 additions & 1 deletion modules/displaying-potential-issues-with-your-cluster.adoc
Original file line number Diff line number Diff line change
@@ -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}"]
Expand Down
Original file line number Diff line number Diff line change
@@ -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}"]
Expand Down
1 change: 0 additions & 1 deletion modules/enabling-insights-advisor-recommendations.adoc
Original file line number Diff line number Diff line change
@@ -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}"]
Expand Down
Loading

0 comments on commit 7cdaf95

Please sign in to comment.