Skip to content

Commit d41dedf

Browse files
committed
OSDOCS-11831: Add Support book to ROSA HCP
1 parent a17a33d commit d41dedf

File tree

46 files changed

+339
-202
lines changed

Some content is hidden

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

46 files changed

+339
-202
lines changed

_topic_maps/_topic_map_osd.yml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -210,9 +210,8 @@ Topics:
210210
File: troubleshooting-operator-issues
211211
- Name: Investigating pod issues
212212
File: investigating-pod-issues
213-
# Hiding from ROSA and OSD until it is decided who should port the Build book
214-
# - Name: Troubleshooting the Source-to-Image process
215-
# File: troubleshooting-s2i
213+
- Name: Troubleshooting the Source-to-Image process
214+
File: troubleshooting-s2i
216215
- Name: Troubleshooting storage issues
217216
File: troubleshooting-storage-issues
218217
# Not supported per WINC team

_topic_maps/_topic_map_rosa.yml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -402,9 +402,8 @@ Topics:
402402
File: troubleshooting-operator-issues
403403
- Name: Investigating pod issues
404404
File: investigating-pod-issues
405-
# Hiding from ROSA and OSD until it is decided who should port the Build book
406-
# - Name: Troubleshooting the Source-to-Image process
407-
# File: troubleshooting-s2i
405+
- Name: Troubleshooting the Source-to-Image process
406+
File: troubleshooting-s2i
408407
- Name: Troubleshooting storage issues
409408
File: troubleshooting-storage-issues
410409
# Not supported per WINC team

_topic_maps/_topic_map_rosa_hcp.yml

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -300,6 +300,92 @@ Topics:
300300
- Name: Least privilege permissions for ROSA CLI commands
301301
File: rosa-cli-permission-examples
302302
---
303+
Name: Support
304+
Dir: support
305+
Distros: openshift-rosa-hcp
306+
Topics:
307+
- Name: Support overview
308+
File: index
309+
- Name: Managing your cluster resources
310+
File: managing-cluster-resources
311+
- Name: Approved Access
312+
File: approved-access
313+
- Name: Getting support
314+
File: getting-support
315+
- Name: Remote health monitoring with connected clusters
316+
Dir: remote_health_monitoring
317+
Topics:
318+
- Name: About remote health monitoring
319+
File: about-remote-health-monitoring
320+
- Name: Showing data collected by remote health monitoring
321+
File: showing-data-collected-by-remote-health-monitoring
322+
# cannot get resource "secrets" in API group "" in the namespace "openshift-config"
323+
# - Name: Opting out of remote health reporting
324+
# File: opting-out-of-remote-health-reporting
325+
# cannot get resource "secrets" in API group "" in the namespace "openshift-config"
326+
# - Name: Enabling remote health reporting
327+
# File: enabling-remote-health-reporting
328+
- Name: Using Insights to identify issues with your cluster
329+
File: using-insights-to-identify-issues-with-your-cluster
330+
- Name: Using Insights Operator
331+
File: using-insights-operator
332+
# Not supported per Michael McNeill
333+
# - Name: Using remote health reporting in a restricted network
334+
# File: remote-health-reporting-from-restricted-network
335+
# cannot list resource "secrets" in API group "" in the namespace "openshift-config"
336+
# - Name: Importing simple content access entitlements with Insights Operator
337+
# File: insights-operator-simple-access
338+
- Name: Gathering data about your cluster
339+
File: gathering-cluster-data
340+
- Name: Summarizing cluster specifications
341+
File: summarizing-cluster-specifications
342+
- Name: Troubleshooting
343+
Dir: troubleshooting
344+
Topics:
345+
# rosa has own troubleshooting installations
346+
# - Name: Troubleshooting installations
347+
# File: troubleshooting-installations
348+
- Name: Troubleshooting ROSA installations
349+
File: rosa-troubleshooting-installations
350+
- Name: Troubleshooting networking
351+
File: rosa-troubleshooting-networking
352+
- Name: Verifying node health
353+
File: verifying-node-health
354+
# cannot create resource "namespaces", cannot patch resource "nodes"
355+
# - Name: Troubleshooting CRI-O container runtime issues
356+
# File: troubleshooting-crio-issues
357+
# requires ostree, butane, and other plug-ins
358+
# - Name: Troubleshooting operating system issues
359+
# File: troubleshooting-operating-system-issues
360+
# Distros: openshift-rosa
361+
# cannot patch resource "nodes", "nodes/proxy", "namespaces"
362+
# - Name: Troubleshooting network issues
363+
# File: troubleshooting-network-issues
364+
# Distros: openshift-rosa
365+
- Name: Troubleshooting Operator issues
366+
File: troubleshooting-operator-issues
367+
- Name: Investigating pod issues
368+
File: investigating-pod-issues
369+
- Name: Troubleshooting the Source-to-Image process
370+
File: troubleshooting-s2i
371+
- Name: Troubleshooting storage issues
372+
File: troubleshooting-storage-issues
373+
# Not supported per WINC team
374+
# - Name: Troubleshooting Windows container workload issues
375+
# File: troubleshooting-windows-container-workload-issues
376+
- Name: Investigating monitoring issues
377+
File: investigating-monitoring-issues
378+
- Name: Diagnosing OpenShift CLI (oc) issues
379+
File: diagnosing-oc-issues
380+
- Name: Troubleshooting expired offline access tokens
381+
File: rosa-troubleshooting-expired-tokens
382+
- Name: Troubleshooting IAM roles
383+
File: rosa-troubleshooting-iam-resources
384+
- Name: Troubleshooting cluster deployments
385+
File: rosa-troubleshooting-deployments
386+
- Name: Red Hat OpenShift Service on AWS managed resources
387+
File: sd-managed-resources
388+
---
303389
Name: Cluster administration
304390
Dir: rosa_cluster_admin
305391
Distros: openshift-rosa-hcp

modules/accessing-running-pods.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +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[]
13+
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
1414
* 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[]
15+
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
16+
ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
1717
* You have access to the cluster as a user with the `dedicated-admin` role.
18-
endif::openshift-rosa,openshift-dedicated[]
18+
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
1919
* Your API service is still functional.
2020
* You have installed the OpenShift CLI (`oc`).
2121

modules/cluster-resources.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +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[]
9+
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
1010
* 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[]
11+
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
12+
ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
1313
* You have access to the cluster as a user with the `dedicated-admin` role.
14-
endif::openshift-rosa,openshift-dedicated[]
14+
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
1515
* You have access to the web console or you have installed the `oc` CLI tool.
1616

1717
.Procedure

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +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[]
13+
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
1414
* 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[]
15+
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
16+
ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
1717
* You have access to the cluster as a user with the `dedicated-admin` role.
18-
endif::openshift-rosa,openshift-dedicated[]
18+
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
1919
* Your API service is still functional.
2020
* You have installed the OpenShift CLI (`oc`).
2121

modules/inspecting-pod-and-container-logs.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ You can inspect pod and container logs for warnings and error messages related t
1010

1111
.Prerequisites
1212

13-
ifndef::openshift-rosa,openshift-dedicated[]
13+
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
1414
* 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[]
15+
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
16+
ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
1717
* You have access to the cluster as a user with the `dedicated-admin` role.
18-
endif::openshift-rosa,openshift-dedicated[]
18+
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
1919
* Your API service is still functional.
2020
* You have installed the OpenShift CLI (`oc`).
2121

modules/monitoring-determining-why-prometheus-is-consuming-disk-space.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,12 @@ Using attributes that are bound to a limited set of possible values reduces the
2828
2929
.Prerequisites
3030

31-
ifndef::openshift-dedicated,openshift-rosa[]
31+
ifndef::openshift-dedicated,openshift-rosa-hcp,openshift-rosa[]
3232
* You have access to the cluster as a user with the `cluster-admin` cluster role.
33-
endif::openshift-dedicated,openshift-rosa[]
34-
ifdef::openshift-dedicated,openshift-rosa[]
33+
endif::openshift-dedicated,openshift-rosa-hcp,openshift-rosa[]
34+
ifdef::openshift-dedicated,openshift-rosa-hcp,openshift-rosa[]
3535
* You have access to the cluster as a user with the `dedicated-admin` role.
36-
endif::openshift-dedicated,openshift-rosa[]
36+
endif::openshift-dedicated,openshift-rosa-hcp,openshift-rosa[]
3737
* You have installed the OpenShift CLI (`oc`).
3838

3939
.Procedure
@@ -64,12 +64,12 @@ topk(10, sum by(namespace, job) (sum_over_time(scrape_series_added[1h])))
6464
* *If the metrics relate to a core {product-title} project*, create a Red Hat support case on the link:https://access.redhat.com/[Red Hat Customer Portal].
6565
6666
. Review the TSDB status using the Prometheus HTTP API by following these steps when logged in as a
67-
ifndef::openshift-dedicated,openshift-rosa[]
67+
ifndef::openshift-dedicated,openshift-rosa-hcp,openshift-rosa[]
6868
cluster administrator:
69-
endif::openshift-dedicated,openshift-rosa[]
70-
ifdef::openshift-dedicated,openshift-rosa[]
69+
endif::openshift-dedicated,openshift-rosa-hcp,openshift-rosa[]
70+
ifdef::openshift-dedicated,openshift-rosa-hcp,openshift-rosa[]
7171
`dedicated-admin`:
72-
endif::openshift-dedicated,openshift-rosa[]
72+
endif::openshift-dedicated,openshift-rosa-hcp,openshift-rosa[]
7373
+
7474
.. Get the Prometheus API route URL by running the following command:
7575
+

modules/monitoring-investigating-why-user-defined-metrics-are-unavailable.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@
1111

1212
.Prerequisites
1313

14-
ifndef::openshift-rosa,openshift-dedicated[]
14+
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
1515
* You have access to the cluster as a user with the `cluster-admin` role.
16-
endif::openshift-rosa,openshift-dedicated[]
17-
ifdef::openshift-rosa,openshift-dedicated[]
16+
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
17+
ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
1818
* You have access to the cluster as a user with the `dedicated-admin` role.
19-
endif::openshift-rosa,openshift-dedicated[]
19+
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
2020
* You have installed the OpenShift CLI (`oc`).
2121
* You have enabled and configured monitoring for user-defined projects.
2222
* You have created a `ServiceMonitor` resource.

modules/monitoring-resolving-the-kubepersistentvolumefillingup-alert-firing-for-prometheus.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@ To address this issue, you can remove Prometheus time-series database (TSDB) blo
2323

2424
.Prerequisites
2525

26-
ifndef::openshift-dedicated,openshift-rosa[]
26+
ifndef::openshift-dedicated,openshift-rosa-hcp,openshift-rosa[]
2727
* You have access to the cluster as a user with the `cluster-admin` cluster role.
28-
endif::openshift-dedicated,openshift-rosa[]
29-
ifdef::openshift-dedicated,openshift-rosa[]
28+
endif::openshift-dedicated,openshift-rosa-hcp,openshift-rosa[]
29+
ifdef::openshift-dedicated,openshift-rosa-hcp,openshift-rosa[]
3030
* You have access to the cluster as a user with the `dedicated-admin` role.
31-
endif::openshift-dedicated,openshift-rosa[]
31+
endif::openshift-dedicated,openshift-rosa-hcp,openshift-rosa[]
3232
* You have installed the OpenShift CLI (`oc`).
3333

3434
.Procedure

0 commit comments

Comments
 (0)