Skip to content

Commit 3aa258b

Browse files
authored
Merge pull request #66126 from mburke5678/main
[main][OSDOCS-3997] OCP content port to ROSA and OSD: Support
2 parents 1af2641 + 2142a2d commit 3aa258b

File tree

135 files changed

+517
-514
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

135 files changed

+517
-514
lines changed

_topic_maps/_topic_map_osd.yml

Lines changed: 81 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,6 @@ Topics:
5656
File: policy-understand-availability
5757
- Name: Update life cycle
5858
File: osd-life-cycle
59-
- Name: Support for OpenShift Dedicated
60-
File: osd-support
61-
Distros: openshift-dedicated
6259
---
6360
#Name: Tutorials
6461
#Dir: cloud_experts_tutorials
@@ -107,6 +104,87 @@ Topics:
107104
- Name: Deleting an OpenShift Dedicated cluster
108105
File: osd-deleting-a-cluster
109106
---
107+
Name: Support
108+
Dir: support
109+
Distros: openshift-dedicated
110+
Topics:
111+
- Name: Support overview
112+
File: index
113+
- Name: Managing your cluster resources
114+
File: managing-cluster-resources
115+
- Name: Getting support
116+
File: getting-support
117+
Distros: openshift-dedicated
118+
- Name: Remote health monitoring with connected clusters
119+
Dir: remote_health_monitoring
120+
Distros: openshift-dedicated
121+
Topics:
122+
- Name: About remote health monitoring
123+
File: about-remote-health-monitoring
124+
- Name: Showing data collected by remote health monitoring
125+
File: showing-data-collected-by-remote-health-monitoring
126+
# cannot get resource "secrets" in API group "" in the namespace "openshift-config"
127+
# - Name: Opting out of remote health reporting
128+
# File: opting-out-of-remote-health-reporting
129+
# cannot get resource "secrets" in API group "" in the namespace "openshift-config"
130+
# - Name: Enabling remote health reporting
131+
# File: enabling-remote-health-reporting
132+
- Name: Using Insights to identify issues with your cluster
133+
File: using-insights-to-identify-issues-with-your-cluster
134+
- Name: Using Insights Operator
135+
File: using-insights-operator
136+
# Not supported per Michael McNeill
137+
# - Name: Using remote health reporting in a restricted network
138+
# File: remote-health-reporting-from-restricted-network
139+
# cannot list resource "secrets" in API group "" in the namespace "openshift-config"
140+
# - Name: Importing simple content access entitlements with Insights Operator
141+
# File: insights-operator-simple-access
142+
# must-gather not supported for customers, per Dustin Row, cannot create resource "namespaces"
143+
# - Name: Gathering data about your cluster
144+
# File: gathering-cluster-data
145+
# Distros: openshift-dedicated
146+
- Name: Summarizing cluster specifications
147+
File: summarizing-cluster-specifications
148+
Distros: openshift-dedicated
149+
- Name: Troubleshooting
150+
Dir: troubleshooting
151+
Distros: openshift-dedicated
152+
Topics:
153+
# - Name: Troubleshooting installations
154+
# File: troubleshooting-installations
155+
- Name: Verifying node health
156+
File: verifying-node-health
157+
# cannot create resource "namespaces", cannot patch resource "nodes"
158+
# - Name: Troubleshooting CRI-O container runtime issues
159+
# File: troubleshooting-crio-issues
160+
# requires ostree, butane, and other plug-ins
161+
# - Name: Troubleshooting operating system issues
162+
# File: troubleshooting-operating-system-issues
163+
# Distros: openshift-dedicated
164+
# cannot patch resource "nodes", "nodes/proxy", "namespaces"
165+
# - Name: Troubleshooting network issues
166+
# File: troubleshooting-network-issues
167+
# Distros: openshift-dedicated
168+
- Name: Troubleshooting Operator issues
169+
File: troubleshooting-operator-issues
170+
- Name: Investigating pod issues
171+
File: investigating-pod-issues
172+
# Hiding from ROSA and OSD until it is decided who should port the Build book
173+
# - Name: Troubleshooting the Source-to-Image process
174+
# File: troubleshooting-s2i
175+
- Name: Troubleshooting storage issues
176+
File: troubleshooting-storage-issues
177+
# Not supported per WINC team
178+
# - Name: Troubleshooting Windows container workload issues
179+
# File: troubleshooting-windows-container-workload-issues
180+
- Name: Investigating monitoring issues
181+
File: investigating-monitoring-issues
182+
- Name: Diagnosing OpenShift CLI (oc) issues
183+
File: diagnosing-oc-issues
184+
- Name: OpenShift Dedicated managed resources
185+
File: osd-managed-resources
186+
Distros: openshift-dedicated
187+
---
110188
Name: CLI tools
111189
Dir: cli_reference
112190
Distros: openshift-dedicated
@@ -645,24 +723,3 @@ Topics:
645723
Topics:
646724
- Name: Serverless overview
647725
File: about-serverless
648-
---
649-
Name: Troubleshooting
650-
Dir: sd_support
651-
Distros: openshift-dedicated
652-
Topics:
653-
- Name: Remote health monitoring with connected clusters
654-
Dir: remote_health_monitoring
655-
Distros: openshift-dedicated
656-
Topics:
657-
- Name: About remote health monitoring
658-
File: about-remote-health-monitoring
659-
- Name: Showing data collected by remote health monitoring
660-
File: showing-data-collected-by-remote-health-monitoring
661-
- Name: Using Insights to identify issues with your cluster
662-
File: using-insights-to-identify-issues-with-your-cluster
663-
- Name: Summarizing cluster specifications
664-
File: osd-summarizing-cluster-specifications
665-
Distros: openshift-dedicated
666-
- Name: OpenShift Dedicated managed resources
667-
File: osd-managed-resources
668-
Distros: openshift-dedicated

_topic_maps/_topic_map_rosa.yml

Lines changed: 93 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,6 @@ Topics:
7373
File: rosa-sts-about-iam-resources
7474
- Name: OpenID Connect Overview
7575
File: rosa-oidc-overview
76-
- Name: Support for ROSA
77-
File: rosa-getting-support
7876
# - Name: Training for ROSA
7977
# File: rosa-training
8078
---
@@ -205,6 +203,99 @@ Topics:
205203
- Name: Command quick reference for creating clusters and users
206204
File: rosa-quickstart
207205
---
206+
Name: Support
207+
Dir: support
208+
Distros: openshift-rosa
209+
Topics:
210+
- Name: Support overview
211+
File: index
212+
- Name: Managing your cluster resources
213+
File: managing-cluster-resources
214+
- Name: Getting support
215+
File: getting-support
216+
Distros: openshift-rosa
217+
- Name: Remote health monitoring with connected clusters
218+
Dir: remote_health_monitoring
219+
Distros: openshift-rosa
220+
Topics:
221+
- Name: About remote health monitoring
222+
File: about-remote-health-monitoring
223+
- Name: Showing data collected by remote health monitoring
224+
File: showing-data-collected-by-remote-health-monitoring
225+
# cannot get resource "secrets" in API group "" in the namespace "openshift-config"
226+
# - Name: Opting out of remote health reporting
227+
# File: opting-out-of-remote-health-reporting
228+
# cannot get resource "secrets" in API group "" in the namespace "openshift-config"
229+
# - Name: Enabling remote health reporting
230+
# File: enabling-remote-health-reporting
231+
- Name: Using Insights to identify issues with your cluster
232+
File: using-insights-to-identify-issues-with-your-cluster
233+
- Name: Using Insights Operator
234+
File: using-insights-operator
235+
# Not supported per Michael McNeill
236+
# - Name: Using remote health reporting in a restricted network
237+
# File: remote-health-reporting-from-restricted-network
238+
# cannot list resource "secrets" in API group "" in the namespace "openshift-config"
239+
# - Name: Importing simple content access entitlements with Insights Operator
240+
# File: insights-operator-simple-access
241+
# must-gather not supported for customers, per Dustin Row, cannot create resource "namespaces"
242+
# - Name: Gathering data about your cluster
243+
# File: gathering-cluster-data
244+
# Distros: openshift-rosa
245+
- Name: Summarizing cluster specifications
246+
File: summarizing-cluster-specifications
247+
Distros: openshift-rosa
248+
- Name: Troubleshooting
249+
Dir: troubleshooting
250+
Distros: openshift-rosa
251+
Topics:
252+
# rosa has own troubleshooting installations
253+
# - Name: Troubleshooting installations
254+
# File: troubleshooting-installations
255+
- Name: Troubleshooting ROSA installations
256+
File: rosa-troubleshooting-installations
257+
- Name: Verifying node health
258+
File: verifying-node-health
259+
# cannot create resource "namespaces", cannot patch resource "nodes"
260+
# - Name: Troubleshooting CRI-O container runtime issues
261+
# File: troubleshooting-crio-issues
262+
# requires ostree, butane, and other plug-ins
263+
# - Name: Troubleshooting operating system issues
264+
# File: troubleshooting-operating-system-issues
265+
# Distros: openshift-rosa
266+
# cannot patch resource "nodes", "nodes/proxy", "namespaces"
267+
# - Name: Troubleshooting network issues
268+
# File: troubleshooting-network-issues
269+
# Distros: openshift-rosa
270+
- Name: Troubleshooting Operator issues
271+
File: troubleshooting-operator-issues
272+
- Name: Investigating pod issues
273+
File: investigating-pod-issues
274+
# Hiding from ROSA and OSD until it is decided who should port the Build book
275+
# - Name: Troubleshooting the Source-to-Image process
276+
# File: troubleshooting-s2i
277+
- Name: Troubleshooting storage issues
278+
File: troubleshooting-storage-issues
279+
# Not supported per WINC team
280+
# - Name: Troubleshooting Windows container workload issues
281+
# File: troubleshooting-windows-container-workload-issues
282+
- Name: Investigating monitoring issues
283+
File: investigating-monitoring-issues
284+
- Name: Diagnosing OpenShift CLI (oc) issues
285+
File: diagnosing-oc-issues
286+
- Name: Troubleshooting expired offline access tokens
287+
File: rosa-troubleshooting-expired-tokens
288+
Distros: openshift-rosa
289+
- Name: Troubleshooting IAM roles
290+
File: rosa-troubleshooting-iam-resources
291+
Distros: openshift-rosa
292+
- Name: Troubleshooting cluster deployments
293+
File: rosa-troubleshooting-deployments
294+
Distros: openshift-rosa
295+
- Name: Red Hat OpenShift Service on AWS managed resources
296+
File: rosa-managed-resources
297+
Distros: openshift-rosa
298+
---
208299
Name: CLI tools
209300
Dir: cli_reference
210301
Distros: openshift-rosa
@@ -888,27 +979,3 @@ Topics:
888979
Topics:
889980
- Name: Serverless overview
890981
File: about-serverless
891-
---
892-
Name: Troubleshooting
893-
Dir: sd_support
894-
Distros: openshift-rosa
895-
Topics:
896-
- Name: Remote health monitoring with connected clusters
897-
Dir: remote_health_monitoring
898-
Topics:
899-
- Name: About remote health monitoring
900-
File: about-remote-health-monitoring
901-
- Name: Showing data collected by remote health monitoring
902-
File: showing-data-collected-by-remote-health-monitoring
903-
- Name: Using Insights to identify issues with your cluster
904-
File: using-insights-to-identify-issues-with-your-cluster
905-
- Name: Troubleshooting expired offline access tokens
906-
File: rosa-troubleshooting-expired-tokens
907-
- Name: Troubleshooting installations
908-
File: rosa-troubleshooting-installations
909-
- Name: Troubleshooting IAM roles
910-
File: rosa-troubleshooting-iam-resources
911-
- Name: Troubleshooting cluster deployments
912-
File: rosa-troubleshooting-deployments
913-
- Name: Red Hat OpenShift Service on AWS managed resources
914-
File: rosa-managed-resources

authentication/managing-security-context-constraints.adoc

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,4 @@ include::modules/security-context-constraints-command-reference.adoc[leveloffset
4747
[id="additional-resources_configuring-internal-oauth"]
4848
== Additional resources
4949

50-
ifndef::openshift-dedicated,openshift-rosa[]
51-
* xref:../support/getting-support.adoc#getting-support[Getting support]
52-
endif::[]
53-
ifdef::openshift-dedicated[]
54-
* xref:../osd_architecture/osd-support.adoc#osd-getting-support[Getting support]
55-
endif::[]
56-
ifdef::openshift-rosa[]
57-
* xref:../rosa_architecture/rosa-getting-support.adoc#rosa-getting-support[Getting support]
58-
endif::[]
50+
* xref:../support/getting-support.adoc#getting-support[Getting support]

modules/about-must-gather.adoc

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,13 @@ $ oc adm must-gather -- /usr/bin/gather_audit_logs
4444
Audit logs are not collected as part of the default set of information to reduce the size of the files.
4545
====
4646
47-
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.
47+
ifndef::openshift-rosa,openshift-dedicated[]
48+
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.
49+
endif::openshift-rosa,openshift-dedicated[]
50+
51+
ifdef::openshift-rosa,openshift-dedicated[]
52+
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.
53+
endif::openshift-rosa,openshift-dedicated[]
4854

4955
For example:
5056

@@ -65,4 +71,4 @@ For example:
6571
----
6672
$ oc adm must-gather --run-namespace <namespace> \
6773
--image=registry.redhat.io/container-native-virtualization/cnv-must-gather-rhel9:v{HCOVersion}
68-
----
74+
----

modules/accessing-running-pods.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,12 @@ You can review running pods dynamically by opening a shell inside a pod or by ga
1010

1111
.Prerequisites
1212

13+
ifndef::openshift-rosa,openshift-dedicated[]
1314
* You have access to the cluster as a user with the `cluster-admin` role.
15+
endif::openshift-rosa,openshift-dedicated[]
16+
ifdef::openshift-rosa,openshift-dedicated[]
17+
* You have access to the cluster as a user with the `dedicated-admin` role.
18+
endif::openshift-rosa,openshift-dedicated[]
1419
* Your API service is still functional.
1520
* You have installed the OpenShift CLI (`oc`).
1621

modules/cluster-resources.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,12 @@ You can interact with cluster resources by using the OpenShift CLI (`oc`) tool i
66

77
.Prerequisites
88

9+
ifndef::openshift-rosa,openshift-dedicated[]
910
* You have access to the cluster as a user with the `cluster-admin` role.
11+
endif::openshift-rosa,openshift-dedicated[]
12+
ifdef::openshift-rosa,openshift-dedicated[]
13+
* You have access to the cluster as a user with the `dedicated-admin` role.
14+
endif::openshift-rosa,openshift-dedicated[]
1015
* You have access to the web console or you have installed the `oc` CLI tool.
1116

1217
.Procedure

modules/copying-files-pods-and-containers.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,12 @@ You can copy files to and from a pod to test configuration changes or gather dia
1010

1111
.Prerequisites
1212

13+
ifndef::openshift-rosa,openshift-dedicated[]
1314
* You have access to the cluster as a user with the `cluster-admin` role.
15+
endif::openshift-rosa,openshift-dedicated[]
16+
ifdef::openshift-rosa,openshift-dedicated[]
17+
* You have access to the cluster as a user with the `dedicated-admin` role.
18+
endif::openshift-rosa,openshift-dedicated[]
1419
* Your API service is still functional.
1520
* You have installed the OpenShift CLI (`oc`).
1621

modules/disabling-insights-advisor-recommendations.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
// Module included in the following assemblies:
22
//
33
// * support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc
4-
// * sd_support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc
54

65
:_content-type: PROCEDURE
76
[id="disabling-insights-advisor-recommendations_{context}"]

modules/disabling-insights-operator-gather.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,12 @@ If you enable Technology Preview in your cluster, the Insights Operator runs gat
1919

2020
.Prerequisites
2121

22-
* You are logged in to the {product-title} web console as a user with `cluster-admin` role.
22+
ifndef::openshift-rosa,openshift-dedicated[]
23+
* You are logged in to the {product-title} web console as a user with the `cluster-admin` role.
24+
endif::openshift-rosa,openshift-dedicated[]
25+
ifdef::openshift-rosa,openshift-dedicated[]
26+
* You are logged in to the {product-title} web console as a user with the `dedicated-admin` role.
27+
endif::openshift-rosa,openshift-dedicated[]
2328

2429
.Procedure
2530

modules/displaying-all-insights-advisor-recommendations.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
// Module included in the following assemblies:
22
//
33
// * support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc
4-
// * sd_support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc
54

65
:_content-type: PROCEDURE
76
[id="displaying-all-insights-advisor-recommendations_{context}"]

0 commit comments

Comments
 (0)