mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
OSDOCS-11831: Add Support book to ROSA HCP
This commit is contained in:
Ben Hardesty
committed by
openshift-cherrypick-robot
openshift-cherrypick-robot
parent
9caa5f2849
commit
61924a1882
@@ -210,9 +210,8 @@ Topics:
|
||||
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 the Source-to-Image process
|
||||
File: troubleshooting-s2i
|
||||
- Name: Troubleshooting storage issues
|
||||
File: troubleshooting-storage-issues
|
||||
# Not supported per WINC team
|
||||
|
||||
@@ -402,9 +402,8 @@ Topics:
|
||||
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 the Source-to-Image process
|
||||
File: troubleshooting-s2i
|
||||
- Name: Troubleshooting storage issues
|
||||
File: troubleshooting-storage-issues
|
||||
# Not supported per WINC team
|
||||
|
||||
@@ -300,6 +300,92 @@ Topics:
|
||||
- Name: Least privilege permissions for ROSA CLI commands
|
||||
File: rosa-cli-permission-examples
|
||||
---
|
||||
Name: Support
|
||||
Dir: support
|
||||
Distros: openshift-rosa-hcp
|
||||
Topics:
|
||||
- Name: Support overview
|
||||
File: index
|
||||
- Name: Managing your cluster resources
|
||||
File: managing-cluster-resources
|
||||
- Name: Approved Access
|
||||
File: approved-access
|
||||
- Name: Getting support
|
||||
File: getting-support
|
||||
- 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
|
||||
# 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
|
||||
- Name: Gathering data about your cluster
|
||||
File: gathering-cluster-data
|
||||
- Name: Summarizing cluster specifications
|
||||
File: summarizing-cluster-specifications
|
||||
- Name: Troubleshooting
|
||||
Dir: troubleshooting
|
||||
Topics:
|
||||
# rosa has own troubleshooting installations
|
||||
# - Name: Troubleshooting installations
|
||||
# File: troubleshooting-installations
|
||||
- Name: Troubleshooting ROSA installations
|
||||
File: rosa-troubleshooting-installations
|
||||
- Name: Troubleshooting networking
|
||||
File: rosa-troubleshooting-networking
|
||||
- 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
|
||||
- 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
|
||||
- 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: sd-managed-resources
|
||||
---
|
||||
Name: Cluster administration
|
||||
Dir: rosa_cluster_admin
|
||||
Distros: openshift-rosa-hcp
|
||||
|
||||
@@ -10,12 +10,12 @@ You can review running pods dynamically by opening a shell inside a pod or by ga
|
||||
|
||||
.Prerequisites
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,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[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* You have access to the cluster as a user with the `dedicated-admin` role.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* Your API service is still functional.
|
||||
* You have installed the OpenShift CLI (`oc`).
|
||||
|
||||
|
||||
@@ -6,12 +6,12 @@ You can interact with cluster resources by using the OpenShift CLI (`oc`) tool i
|
||||
|
||||
.Prerequisites
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,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[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* You have access to the cluster as a user with the `dedicated-admin` role.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* You have access to the web console or you have installed the `oc` CLI tool.
|
||||
|
||||
.Procedure
|
||||
|
||||
@@ -10,12 +10,12 @@ You can copy files to and from a pod to test configuration changes or gather dia
|
||||
|
||||
.Prerequisites
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,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[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* You have access to the cluster as a user with the `dedicated-admin` role.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* Your API service is still functional.
|
||||
* You have installed the OpenShift CLI (`oc`).
|
||||
|
||||
|
||||
@@ -10,12 +10,12 @@ You can inspect pod and container logs for warnings and error messages related t
|
||||
|
||||
.Prerequisites
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,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[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* You have access to the cluster as a user with the `dedicated-admin` role.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* Your API service is still functional.
|
||||
* You have installed the OpenShift CLI (`oc`).
|
||||
|
||||
|
||||
@@ -28,12 +28,12 @@ Using attributes that are bound to a limited set of possible values reduces the
|
||||
|
||||
.Prerequisites
|
||||
|
||||
ifndef::openshift-dedicated,openshift-rosa[]
|
||||
ifndef::openshift-dedicated,openshift-rosa-hcp,openshift-rosa[]
|
||||
* You have access to the cluster as a user with the `cluster-admin` cluster role.
|
||||
endif::openshift-dedicated,openshift-rosa[]
|
||||
ifdef::openshift-dedicated,openshift-rosa[]
|
||||
endif::openshift-dedicated,openshift-rosa-hcp,openshift-rosa[]
|
||||
ifdef::openshift-dedicated,openshift-rosa-hcp,openshift-rosa[]
|
||||
* You have access to the cluster as a user with the `dedicated-admin` role.
|
||||
endif::openshift-dedicated,openshift-rosa[]
|
||||
endif::openshift-dedicated,openshift-rosa-hcp,openshift-rosa[]
|
||||
* You have installed the OpenShift CLI (`oc`).
|
||||
|
||||
.Procedure
|
||||
@@ -64,12 +64,12 @@ topk(10, sum by(namespace, job) (sum_over_time(scrape_series_added[1h])))
|
||||
* *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].
|
||||
|
||||
. Review the TSDB status using the Prometheus HTTP API by following these steps when logged in as a
|
||||
ifndef::openshift-dedicated,openshift-rosa[]
|
||||
ifndef::openshift-dedicated,openshift-rosa-hcp,openshift-rosa[]
|
||||
cluster administrator:
|
||||
endif::openshift-dedicated,openshift-rosa[]
|
||||
ifdef::openshift-dedicated,openshift-rosa[]
|
||||
endif::openshift-dedicated,openshift-rosa-hcp,openshift-rosa[]
|
||||
ifdef::openshift-dedicated,openshift-rosa-hcp,openshift-rosa[]
|
||||
`dedicated-admin`:
|
||||
endif::openshift-dedicated,openshift-rosa[]
|
||||
endif::openshift-dedicated,openshift-rosa-hcp,openshift-rosa[]
|
||||
+
|
||||
.. Get the Prometheus API route URL by running the following command:
|
||||
+
|
||||
|
||||
@@ -11,12 +11,12 @@
|
||||
|
||||
.Prerequisites
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,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[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* You have access to the cluster as a user with the `dedicated-admin` role.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* You have installed the OpenShift CLI (`oc`).
|
||||
* You have enabled and configured monitoring for user-defined projects.
|
||||
* You have created a `ServiceMonitor` resource.
|
||||
|
||||
@@ -23,12 +23,12 @@ To address this issue, you can remove Prometheus time-series database (TSDB) blo
|
||||
|
||||
.Prerequisites
|
||||
|
||||
ifndef::openshift-dedicated,openshift-rosa[]
|
||||
ifndef::openshift-dedicated,openshift-rosa-hcp,openshift-rosa[]
|
||||
* You have access to the cluster as a user with the `cluster-admin` cluster role.
|
||||
endif::openshift-dedicated,openshift-rosa[]
|
||||
ifdef::openshift-dedicated,openshift-rosa[]
|
||||
endif::openshift-dedicated,openshift-rosa-hcp,openshift-rosa[]
|
||||
ifdef::openshift-dedicated,openshift-rosa-hcp,openshift-rosa[]
|
||||
* You have access to the cluster as a user with the `dedicated-admin` role.
|
||||
endif::openshift-dedicated,openshift-rosa[]
|
||||
endif::openshift-dedicated,openshift-rosa-hcp,openshift-rosa[]
|
||||
* You have installed the OpenShift CLI (`oc`).
|
||||
|
||||
.Procedure
|
||||
|
||||
@@ -18,12 +18,12 @@ You can view the status of an Operator catalog source by using the CLI.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,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[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* You have access to the cluster as a user with the `dedicated-admin` role.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* You have installed the OpenShift CLI (`oc`).
|
||||
|
||||
.Procedure
|
||||
|
||||
@@ -11,12 +11,12 @@ You can view Operator subscription status by using the CLI.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,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[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* You have access to the cluster as a user with the `dedicated-admin` role.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* You have installed the OpenShift CLI (`oc`).
|
||||
|
||||
.Procedure
|
||||
|
||||
@@ -21,21 +21,32 @@ In {product-title} deployments, customers who are not using the Customer Cloud S
|
||||
+
|
||||
endif::openshift-dedicated[]
|
||||
* You have installed the OpenShift CLI (`oc`).
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* Your API service is still functional.
|
||||
* You have SSH access to your hosts.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
.Procedure
|
||||
|
||||
ifndef::openshift-rosa-hcp[]
|
||||
. Query `kubelet` `journald` unit logs from {product-title} cluster nodes. The following example queries control plane nodes only:
|
||||
endif::openshift-rosa-hcp[]
|
||||
ifdef::openshift-rosa-hcp[]
|
||||
* Query `kubelet` `journald` unit logs from {product-title} cluster nodes. The following example queries worker nodes only:
|
||||
endif::openshift-rosa-hcp[]
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
ifndef::openshift-rosa-hcp[]
|
||||
$ oc adm node-logs --role=master -u kubelet <1>
|
||||
endif::openshift-rosa-hcp[]
|
||||
ifdef::openshift-rosa-hcp[]
|
||||
$ oc adm node-logs --role=worker -u kubelet <1>
|
||||
endif::openshift-rosa-hcp[]
|
||||
----
|
||||
<1> Replace `kubelet` as appropriate to query other unit logs.
|
||||
|
||||
ifndef::openshift-rosa-hcp[]
|
||||
. Collect logs from specific subdirectories under `/var/log/` on cluster nodes.
|
||||
.. Retrieve a list of logs contained within a `/var/log/` subdirectory. The following example lists files in `/var/log/openshift-apiserver/` on all control plane nodes:
|
||||
+
|
||||
@@ -50,8 +61,9 @@ $ oc adm node-logs --role=master --path=openshift-apiserver
|
||||
----
|
||||
$ oc adm node-logs --role=master --path=openshift-apiserver/audit.log
|
||||
----
|
||||
endif::openshift-rosa-hcp[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
+
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
.. If the API is not functional, review the logs on each node using SSH instead. The following example tails `/var/log/openshift-apiserver/audit.log`:
|
||||
+
|
||||
[source,terminal]
|
||||
@@ -63,4 +75,4 @@ $ ssh core@<master-node>.<cluster_name>.<base_domain> sudo tail -f /var/log/open
|
||||
====
|
||||
{product-title} {product-version} cluster nodes running {op-system-first} are immutable and rely on Operators to apply cluster changes. Accessing cluster nodes by using SSH is not recommended. Before attempting to collect diagnostic data over SSH, review whether the data collected by running `oc adm must gather` and other `oc` commands is sufficient instead. However, if the {product-title} API is not available, or the kubelet is not properly functioning on the target node, `oc` operations will be impacted. In such situations, it is possible to access nodes using `ssh core@<node>.<cluster_name>.<base_domain>`.
|
||||
====
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
@@ -10,12 +10,12 @@ You can list Operator pods within a cluster and their status. You can also colle
|
||||
|
||||
.Prerequisites
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,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[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* You have access to the cluster as a user with the `dedicated-admin` role.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* Your API service is still functional.
|
||||
* You have installed the OpenShift CLI (`oc`).
|
||||
|
||||
@@ -42,7 +42,7 @@ $ oc get pod -n <operator_namespace>
|
||||
$ oc describe pod <operator_pod_name> -n <operator_namespace>
|
||||
----
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
. If an Operator issue is node-specific, query Operator container status on that node.
|
||||
.. Start a debug pod for the node:
|
||||
+
|
||||
@@ -78,4 +78,4 @@ $ oc debug node/my-node
|
||||
----
|
||||
+
|
||||
.. Exit from the debug shell.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
@@ -10,12 +10,12 @@ Review cluster node health status, resource consumption statistics, and node log
|
||||
|
||||
.Prerequisites
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,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[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* You have access to the cluster as a user with the `dedicated-admin` role.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* You have installed the OpenShift CLI (`oc`).
|
||||
|
||||
.Procedure
|
||||
|
||||
@@ -10,12 +10,12 @@ You can query pod status and error states. You can also query a pod's associated
|
||||
|
||||
.Prerequisites
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,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[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* You have access to the cluster as a user with the `dedicated-admin` role.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* You have installed the OpenShift CLI (`oc`).
|
||||
* `skopeo` is installed.
|
||||
|
||||
|
||||
@@ -2,6 +2,8 @@
|
||||
//
|
||||
// * rosa_planning/rosa-sts-ocm-role.adoc
|
||||
// * rosa_planning/rosa-sts-aws-prereqs.adoc
|
||||
// * support/troubleshooting/rosa-troubleshooting-iam-resources.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="rosa-associating-account_{context}"]
|
||||
= Associating your AWS account with IAM roles
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * support/rosa-troubleshooting-iam-resources.adoc
|
||||
// * support/troubleshooting/rosa-troubleshooting-iam-resources.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
[id="rosa-sts-ocm-roles-and-permissions-troubleshooting_{context}"]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//* rosa_architecture/rosa-sts-about-iam-resources.adoc
|
||||
// * support/rosa-troubleshooting-iam-resources.adoc
|
||||
// * rosa_architecture/rosa-sts-about-iam-resources.adoc
|
||||
// * support/troubleshooting/rosa-troubleshooting-iam-resources.adoc
|
||||
// * rosa_planning/rosa-sts-ocm-role.adoc
|
||||
// * rosa_planning/rosa-hcp-prepare-iam-resources.adoc
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * support/rosa-troubleshooting-iam-resources.adoc
|
||||
// * support/troubleshooting/rosa-troubleshooting-iam-resources.adoc
|
||||
// * rosa_planning/rosa-sts-ocm-role.adoc
|
||||
// * rosa_planning/rosa-hcp-prepare-iam-resources.adoc
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
|
||||
@@ -38,4 +38,4 @@ $ rosa create user-role
|
||||
[source,terminal]
|
||||
----
|
||||
I: Successfully linked role ARN <user role ARN> with account <account ID>
|
||||
----
|
||||
----
|
||||
|
||||
@@ -14,13 +14,13 @@ Error: Error creating network Load Balancer: AccessDenied: User: arn:aws:sts::xx
|
||||
|
||||
.Procedure
|
||||
|
||||
To resolve this issue, ensure that the role exists on your AWS account. If not, create this role with the following command:
|
||||
|
||||
* To resolve this issue, ensure that the role exists on your AWS account. If not, create this role with the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
aws iam get-role --role-name "AWSServiceRoleForElasticLoadBalancing" || aws iam create-service-linked-role --aws-service-name "elasticloadbalancing.amazonaws.com"
|
||||
----
|
||||
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
This command only needs to be executed once per account.
|
||||
|
||||
@@ -8,8 +8,9 @@
|
||||
If a cluster deployment fails, the cluster is put into an "error" state.
|
||||
|
||||
.Procedure
|
||||
Run the following command to get more information:
|
||||
|
||||
* Run the following command to get more information:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ rosa describe cluster -c <my_cluster_name> --debug
|
||||
|
||||
@@ -39,6 +39,7 @@ $ rosa logs uninstall --cluster=<cluster_name>
|
||||
$ rosa logs uninstall --cluster=<cluster_name> --watch
|
||||
----
|
||||
|
||||
ifndef::openshift-rosa-hcp[]
|
||||
[id="rosa-faq-verify-permissions-for-clusters-without-sts_{context}"]
|
||||
== Verify your AWS account permissions for clusters without STS
|
||||
|
||||
@@ -50,6 +51,7 @@ $ rosa verify permissions
|
||||
----
|
||||
|
||||
If you receive any errors, double check to ensure than an link:https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_type-auth.html#orgs_manage_policies_scp[SCP] is not applied to your AWS account. If you are required to use an SCP, see link:https://www.openshift.com/dedicated/ccs#scp[Red{nbsp}Hat Requirements for Customer Cloud Subscriptions] for details on the minimum required SCP.
|
||||
endif::openshift-rosa-hcp[]
|
||||
|
||||
[id="rosa-faq-verify-aws-quota_{context}"]
|
||||
== Verify your AWS account and quota
|
||||
|
||||
@@ -5,6 +5,6 @@
|
||||
[id="rosa-troubleshooting-general-deployment-failure_{context}"]
|
||||
= Connectivity issues on clusters with private Network Load Balancers
|
||||
|
||||
{product-title} and {hcp-title} clusters created with version {product-version} deploy AWS Network Load Balancers (NLB) by default for the `default` ingress controller. In the case of a private NLB, the NLB's client IP address preservation might cause connections to be dropped where the source and destination are the same host. See the AWS's documentation about how to link:https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-troubleshooting.html#loopback-timeout[Troubleshoot your Network Load Balancer]. This IP address preservation has the implication that any customer workloads cohabitating on the same node with the router pods, may not be able send traffic to the private NLB fronting the ingress controller router.
|
||||
{product-title} clusters created with version {product-version} deploy AWS Network Load Balancers (NLB) by default for the `default` ingress controller. In the case of a private NLB, the NLB's client IP address preservation might cause connections to be dropped where the source and destination are the same host. See the AWS's documentation about how to link:https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-troubleshooting.html#loopback-timeout[Troubleshoot your Network Load Balancer]. This IP address preservation has the implication that any customer workloads cohabitating on the same node with the router pods, may not be able send traffic to the private NLB fronting the ingress controller router.
|
||||
|
||||
To mitigate this impact, customer's should reschedule their workloads onto nodes separate from those where the router pods are scheduled. Alternatively, customers should rely on the internal pod and service networks for accessing other workloads co-located within the same cluster.
|
||||
To mitigate this impact, customers should reschedule their workloads onto nodes separate from those where the router pods are scheduled. Alternatively, customers should rely on the internal pod and service networks for accessing other workloads co-located within the same cluster.
|
||||
|
||||
@@ -10,12 +10,12 @@ You can start a debug pod with root access, based on a problematic pod's deploym
|
||||
|
||||
.Prerequisites
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,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[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* You have access to the cluster as a user with the `dedicated-admin` role.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* Your API service is still functional.
|
||||
* You have installed the OpenShift CLI (`oc`).
|
||||
|
||||
|
||||
@@ -10,12 +10,12 @@ You can obtain a summary of {product-title} cluster specifications by querying t
|
||||
|
||||
.Prerequisites
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,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[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* You have access to the cluster as a user with the `dedicated-admin` role.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* You have installed the OpenShift CLI (`oc`).
|
||||
|
||||
.Procedure
|
||||
|
||||
@@ -49,14 +49,14 @@ ifndef::openshift-origin[]
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc adm must-gather \
|
||||
--dest-dir /tmp/captures \ <.>
|
||||
--source-dir '/tmp/tcpdump/' \ <.>
|
||||
--image registry.redhat.io/openshift4/network-tools-rhel8:latest \ <.>
|
||||
--node-selector 'node-role.kubernetes.io/worker' \ <.>
|
||||
--host-network=true \ <.>
|
||||
--timeout 30s \ <.>
|
||||
--dest-dir /tmp/captures \// <.>
|
||||
--source-dir '/tmp/tcpdump/' \// <.>
|
||||
--image registry.redhat.io/openshift4/network-tools-rhel8:latest \// <.>
|
||||
--node-selector 'node-role.kubernetes.io/worker' \// <.>
|
||||
--host-network=true \// <.>
|
||||
--timeout 30s \// <.>
|
||||
-- \
|
||||
tcpdump -i any \ <.>
|
||||
tcpdump -i any \// <.>
|
||||
-w /tmp/tcpdump/%Y-%m-%dT%H:%M:%S.pcap -W 1 -G 300
|
||||
----
|
||||
<.> The `--dest-dir` argument specifies that `oc adm must-gather` stores the packet captures in directories that are relative to `/tmp/captures` on the client machine. You can specify any writable directory.
|
||||
|
||||
@@ -21,11 +21,11 @@ endif::openshift-dedicated[]
|
||||
+
|
||||
* You have installed the OpenShift CLI (`oc`).
|
||||
* You have an existing Red Hat Support case ID.
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* You have a Red Hat standard or premium Subscription.
|
||||
* You have a Red Hat Customer Portal account.
|
||||
* You have SSH access to your hosts.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
.Procedure
|
||||
|
||||
@@ -49,14 +49,14 @@ $ oc debug node/my-cluster-node
|
||||
----
|
||||
# chroot /host
|
||||
----
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
+
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
[NOTE]
|
||||
====
|
||||
{product-title} {product-version} cluster nodes running {op-system-first} are immutable and rely on Operators to apply cluster changes. Accessing cluster nodes by using SSH is not recommended. However, if the {product-title} API is not available, or the kubelet is not properly functioning on the target node, `oc` operations will be impacted. In such situations, it is possible to access nodes using `ssh core@<node>.<cluster_name>.<base_domain>` instead.
|
||||
====
|
||||
+
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
. From within the `chroot` environment console, obtain the node's interface names:
|
||||
+
|
||||
[source,terminal]
|
||||
@@ -75,7 +75,7 @@ endif::openshift-rosa,openshift-dedicated[]
|
||||
====
|
||||
If an existing `toolbox` pod is already running, the `toolbox` command outputs `'toolbox-' already exists. Trying to start...`. To avoid `tcpdump` issues, remove the running toolbox container with `podman rm toolbox-` and spawn a new toolbox container.
|
||||
====
|
||||
+
|
||||
|
||||
. Initiate a `tcpdump` session on the cluster node and redirect output to a capture file. This example uses `ens5` as the interface name:
|
||||
+
|
||||
[source,terminal]
|
||||
@@ -119,6 +119,7 @@ $ tcpdump -nn -s 0 -i ens5 -w /host/var/tmp/my-cluster-node_$(date +%d_%m_%Y-%H_
|
||||
<1> The toolbox container mounts the host's root directory at `/host`. Reference the absolute path from the toolbox container's root directory, including `/host/`, when specifying files to upload through the `redhat-support-tool` command.
|
||||
+
|
||||
* Upload the file to an existing Red Hat support case.
|
||||
|
||||
.. Concatenate the `sosreport` archive by running the `oc debug node/<node_name>` command and redirect the output to a file. This command assumes you have exited the previous `oc debug` session:
|
||||
+
|
||||
[source,terminal]
|
||||
@@ -126,16 +127,16 @@ $ tcpdump -nn -s 0 -i ens5 -w /host/var/tmp/my-cluster-node_$(date +%d_%m_%Y-%H_
|
||||
$ oc debug node/my-cluster-node -- bash -c 'cat /host/var/tmp/my-tcpdump-capture-file.pcap' > /tmp/my-tcpdump-capture-file.pcap <1>
|
||||
----
|
||||
<1> The debug container mounts the host's root directory at `/host`. Reference the absolute path from the debug container's root directory, including `/host`, when specifying target files for concatenation.
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
+
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
[NOTE]
|
||||
====
|
||||
{product-title} {product-version} cluster nodes running {op-system-first} are immutable and rely on Operators to apply cluster changes. Transferring a `tcpdump` capture file from a cluster node by using `scp` is not recommended. However, if the {product-title} API is not available, or the kubelet is not properly functioning on the target node, `oc` operations will be impacted. In such situations, it is possible to copy a `tcpdump` capture file from a node by running `scp core@<node>.<cluster_name>.<base_domain>:<file_path> <local_path>`.
|
||||
====
|
||||
+
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
.. Navigate to an existing support case within link:https://access.redhat.com/support/cases/#/case/list[the *Customer Support* page] of the Red Hat Customer Portal.
|
||||
+
|
||||
|
||||
.. Select *Attach files* and follow the prompts to upload the file.
|
||||
|
||||
// TODO - Add details relating to https://github.com/openshift/must-gather/pull/156 within the procedure.
|
||||
|
||||
@@ -20,32 +20,31 @@ In {product-title} deployments, customers who are not using the Customer Cloud S
|
||||
endif::openshift-dedicated[]
|
||||
+
|
||||
* You have installed the OpenShift CLI (`oc`).
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* You have SSH access to your hosts.
|
||||
* You have a Red Hat standard or premium Subscription.
|
||||
* You have a Red Hat Customer Portal account.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* You have an existing Red Hat Support case ID.
|
||||
|
||||
.Procedure
|
||||
|
||||
* Upload diagnostic data to an existing Red Hat support case through the Red Hat Customer Portal.
|
||||
. Concatenate a diagnostic file contained on an {product-title} node by using the `oc debug node/<node_name>` command and redirect the output to a file. The following example copies `/host/var/tmp/my-diagnostic-data.tar.gz` from a debug container to `/var/tmp/my-diagnostic-data.tar.gz`:
|
||||
.. Concatenate a diagnostic file contained on an {product-title} node by using the `oc debug node/<node_name>` command and redirect the output to a file. The following example copies `/host/var/tmp/my-diagnostic-data.tar.gz` from a debug container to `/var/tmp/my-diagnostic-data.tar.gz`:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc debug node/my-cluster-node -- bash -c 'cat /host/var/tmp/my-diagnostic-data.tar.gz' > /var/tmp/my-diagnostic-data.tar.gz <1>
|
||||
----
|
||||
<1> The debug container mounts the host's root directory at `/host`. Reference the absolute path from the debug container's root directory, including `/host`, when specifying target files for concatenation.
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
+
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
[NOTE]
|
||||
====
|
||||
{product-title} {product-version} cluster nodes running {op-system-first} are immutable and rely on Operators to apply cluster changes. Transferring files from a cluster node by using `scp` is not recommended. However, if the {product-title} API is not available, or the kubelet is not properly functioning on the target node, `oc` operations will be impacted. In such situations, it is possible to copy diagnostic files from a node by running `scp core@<node>.<cluster_name>.<base_domain>:<file_path> <local_path>`.
|
||||
====
|
||||
+
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
. Navigate to an existing support case within link:https://access.redhat.com/support/cases/#/case/list[the *Customer Support* page] of the Red Hat Customer Portal.
|
||||
+
|
||||
. Select *Attach files* and follow the prompts to upload the file.
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
.. Navigate to an existing support case within link:https://access.redhat.com/support/cases/#/case/list[the *Customer Support* page] of the Red Hat Customer Portal.
|
||||
|
||||
.. Select *Attach files* and follow the prompts to upload the file.
|
||||
|
||||
@@ -11,10 +11,10 @@
|
||||
|
||||
Cluster owners will receive an email notification when Red{nbsp}Hat Site Reliability Engineering (SRE) request access to their cluster with a link to review the request in the {hybrid-console-second}.
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
.Prerequisites
|
||||
* You have access to the cluster as a user with the `cluster-admin` role.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
|
||||
.Procedure
|
||||
|
||||
@@ -9,10 +9,10 @@
|
||||
|
||||
Review access requests for your {product-rosa} clusters from the {hybrid-console-second}.
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
.Prerequisites
|
||||
* You have access to the cluster as a user with the `Cluster Owner` role.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
|
||||
.Procedure
|
||||
|
||||
@@ -23,7 +23,12 @@
|
||||
|
||||
. Enter the following information:
|
||||
|
||||
.. In the *Product* field, select *{product-title}* or *{product-title} {hcp-capital}*.
|
||||
ifdef::openshift-rosa[]
|
||||
.. In the *Product* field, select *{product-title}*.
|
||||
endif::openshift-rosa[]
|
||||
ifdef::openshift-rosa-hcp[]
|
||||
.. In the *Product* field, select *{product-title} {hcp-capital}*.
|
||||
endif::openshift-rosa-hcp[]
|
||||
.. In the *Problem statement* field, enter *Enable ROSA Access Protection*.
|
||||
.. Click *See more options*.
|
||||
|
||||
@@ -41,4 +46,3 @@
|
||||
. Select *Severity* as *4(Low)* and click *Continue*.
|
||||
|
||||
. Preview the case details and click *Submit*.
|
||||
|
||||
|
||||
@@ -18,12 +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[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,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[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* You have access to the cluster as a user with the `dedicated-admin` role.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
.Procedure
|
||||
|
||||
|
||||
@@ -40,4 +40,3 @@ endif::openshift-dedicated[]
|
||||
* Usage details about Technology Previews and unsupported configurations
|
||||
|
||||
Telemetry does not collect identifying information such as usernames or passwords. Red Hat does not intend to collect personal information. If Red Hat discovers that personal information has been inadvertently received, Red Hat will delete such information. To the extent that any telemetry data constitutes personal data, please refer to the link:https://www.redhat.com/en/about/privacy-policy[Red Hat Privacy Statement] for more information about Red Hat's privacy practices.
|
||||
|
||||
|
||||
@@ -17,7 +17,7 @@ Elevated access requests to clusters on {product-rosa} clusters and the correspo
|
||||
|
||||
When _Approved Access_ is enabled and an SRE creates an access request, _cluster owners_ receive an email notification informing them of a new access request. The email notification contains a link allowing the cluster owner to quickly approve or deny the access request. You must respond in a timely manner otherwise there is a risk to your SLA for {product-rosa}.
|
||||
|
||||
* If customers require additional users that are not the cluster owner to receive the email, they can link:https://docs.openshift.com/rosa/rosa_cluster_admin/rosa-cluster-notifications.html#add-notification-contact_rosa-cluster-notifications[add notification cluster contacts].
|
||||
* If customers require additional users that are not the cluster owner to receive the email, they can xref:../rosa_cluster_admin/rosa-cluster-notifications.adoc#add-notification-contact_rosa-cluster-notifications[add notification cluster contacts].
|
||||
* Pending access requests are available in the {hybrid-console-second} on the clusters list or *Access Requests* tab on the cluster overview for the specific cluster.
|
||||
|
||||
[NOTE]
|
||||
@@ -28,5 +28,3 @@ Denying an access request requires you to complete the *Justification* field. In
|
||||
include::modules/support-submitting-a-case-enable-approved-access.adoc[leveloffset=+1]
|
||||
include::modules/support-reviewing-an-access-request-from-an-email-notification.adoc[leveloffset=+1]
|
||||
include::modules/support-reviewing-an-access-request-from-the-hybrid-console.adoc[leveloffset=+1]
|
||||
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ endif::[]
|
||||
|
||||
toc::[]
|
||||
|
||||
ifndef::openshift-origin,openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-origin[]
|
||||
When opening a support case, it is helpful to provide debugging
|
||||
information about your cluster to Red Hat Support.
|
||||
|
||||
@@ -17,11 +17,11 @@ It is recommended to provide:
|
||||
|
||||
* xref:../support/gathering-cluster-data.adoc#support_gathering_data_gathering-cluster-data[Data gathered using the `oc adm must-gather` command]
|
||||
* The xref:../support/gathering-cluster-data.adoc#support-get-cluster-id_gathering-cluster-data[unique cluster ID]
|
||||
endif::openshift-origin,openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-origin[]
|
||||
|
||||
ifdef::openshift-origin,openshift-rosa,openshift-dedicated[]
|
||||
ifdef::openshift-origin[]
|
||||
You can use the following tools to get debugging information about your {product-title} cluster.
|
||||
endif::openshift-origin,openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-origin[]
|
||||
|
||||
// About the must-gather tool
|
||||
include::modules/about-must-gather.adoc[leveloffset=+1]
|
||||
@@ -39,17 +39,22 @@ endif::openshift-origin[]
|
||||
// Gathering data about specific features
|
||||
include::modules/gathering-data-specific-features.adoc[leveloffset=+2]
|
||||
|
||||
== Additional resources
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* xref:../nodes/cma/nodes-cma-autoscaling-custom.adoc#nodes-cma-autoscaling-custom-gather[Gathering debugging data] for the Custom Metrics Autoscaler.
|
||||
* link:https://access.redhat.com/support/policy/updates/openshift[Red Hat {product-title} Life Cycle Policy]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
ifdef::openshift-rosa[]
|
||||
* xref:../rosa_architecture/rosa_policy_service_definition/rosa-life-cycle.html[{product-title} update life cycle]
|
||||
endif::openshift-rosa[]
|
||||
|
||||
ifdef::openshift-rosa-hcp[]
|
||||
* xref:../rosa_architecture/rosa_policy_service_definition/rosa-hcp-life-cycle.html[{product-title} update life cycle]
|
||||
endif::openshift-rosa-hcp[]
|
||||
|
||||
ifdef::openshift-dedicated[]
|
||||
* xref:../osd_architecture/osd_policy/osd-life-cycle.html[{product-title} update life cycle]
|
||||
endif::openshift-dedicated[]
|
||||
@@ -65,18 +70,18 @@ ifndef::openshift-origin[]
|
||||
include::modules/support-get-cluster-id.adoc[leveloffset=+1]
|
||||
endif::openshift-origin[]
|
||||
|
||||
ifndef::openshift-origin,openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-origin,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
// About `sosreport`
|
||||
include::modules/about-sosreport.adoc[leveloffset=+1]
|
||||
|
||||
// Generating a `sosreport` archive for an {product-title} cluster node
|
||||
include::modules/support-generating-a-sosreport-archive.adoc[leveloffset=+1]
|
||||
endif::openshift-origin,openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-origin,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
// Querying bootstrap node journal logs
|
||||
include::modules/querying-bootstrap-node-journal-logs.adoc[leveloffset=+1]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
// Querying cluster node journal logs
|
||||
include::modules/querying-cluster-node-journal-logs.adoc[leveloffset=+1]
|
||||
|
||||
@@ -12,20 +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[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,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[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
// Removed sentence on restricted networks, not supported in ROSA/OSD
|
||||
ifdef::openshift-rosa,openshift-dedicated[]
|
||||
ifdef::openshift-rosa,openshift-rosa-hcp,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[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,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:
|
||||
|
||||
@@ -42,8 +42,6 @@ You can xref:../support/remote_health_monitoring/showing-data-collected-by-remot
|
||||
|
||||
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:
|
||||
@@ -51,32 +49,33 @@ xref:../support/gathering-cluster-data.adoc#gathering-cluster-data[Gather data a
|
||||
* *The must-gather tool*: Use the `must-gather` tool to collect information about your cluster and to debug the issues.
|
||||
* *sosreport*: Use the `sosreport` tool to collect configuration details, system information, and diagnostic data for debugging purposes.
|
||||
* *Cluster ID*: Obtain the unique identifier for your cluster, when providing information to Red Hat Support.
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* *Bootstrap node journal logs*: Gather `bootkube.service` `journald` unit logs and container logs from the bootstrap node to troubleshoot bootstrap-related issues.
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* *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[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,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[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,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.
|
||||
** Kubelet's status on a node.
|
||||
** Cluster node journal logs.
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,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.
|
||||
@@ -87,15 +86,15 @@ ifndef::openshift-rosa,openshift-dedicated[]
|
||||
** Enable kdump.
|
||||
** Test the kdump configuration.
|
||||
** Analyze a core dump.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,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[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,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:
|
||||
|
||||
@@ -108,12 +107,10 @@ endif::openshift-rosa,openshift-dedicated[]
|
||||
** 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:
|
||||
|
||||
@@ -125,11 +122,14 @@ endif::openshift-rosa,openshift-dedicated[]
|
||||
** Investigate why user-defined metrics are unavailable.
|
||||
** Determine why Prometheus is consuming a lot of disk space.
|
||||
|
||||
// TODO: Include this in ROSA HCP when the Logging book is migrated.
|
||||
ifndef::openshift-rosa-hcp[]
|
||||
* xref:../observability/logging/cluster-logging.adoc#cluster-logging[Logging issues]: A cluster administrator can follow the procedures in the "Support" and "Troubleshooting logging" sections to resolve logging issues:
|
||||
|
||||
** xref:../observability/logging/troubleshooting/cluster-logging-cluster-status.adoc#cluster-logging-clo-status_cluster-logging-cluster-status[Viewing the status of the {clo}]
|
||||
** xref:../observability/logging/troubleshooting/cluster-logging-cluster-status.adoc#cluster-logging-clo-status-comp_cluster-logging-cluster-status[Viewing the status of {logging} components]
|
||||
** xref:../observability/logging/troubleshooting/troubleshooting-logging-alerts.adoc#troubleshooting-logging-alerts[Troubleshooting logging alerts]
|
||||
** xref:../observability/logging/cluster-logging-support.adoc#cluster-logging-must-gather-collecting_cluster-logging-support[Collecting information about your logging environment by using the `oc adm must-gather` command]
|
||||
endif::openshift-rosa-hcp[]
|
||||
|
||||
* xref:../support/troubleshooting/diagnosing-oc-issues.adoc#diagnosing-oc-issues[{oc-first} issues]: Investigate {oc-first} issues by increasing the log level.
|
||||
|
||||
@@ -33,9 +33,9 @@ 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[]
|
||||
ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
On {product-title}, remote health reporting is always enabled. You cannot opt out of it.
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,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.
|
||||
@@ -43,19 +43,28 @@ endif::[]
|
||||
|
||||
include::modules/telemetry-about-telemetry.adoc[leveloffset=+1]
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* 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::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
ifdef::openshift-rosa[]
|
||||
* See the xref:../../upgrading/rosa-upgrading-sts.adoc#rosa-upgrading-sts[{product-title} upgrade documentation] for more information about upgrading a cluster.
|
||||
endif::openshift-rosa[]
|
||||
ifdef::openshift-rosa-hcp[]
|
||||
* See the xref:../../upgrading/rosa-hcp-upgrading.adoc#rosa-hcp-upgrading[{product-title} upgrade documentation] for more information about upgrading a cluster.
|
||||
endif::openshift-rosa-hcp[]
|
||||
ifdef::openshift-dedicated[]
|
||||
* See the xref:../../upgrading/osd-upgrades.adoc#osd-upgrades[{product-title} upgrade documentation] for more information about upgrading a cluster.
|
||||
endif::openshift-dedicated[]
|
||||
|
||||
include::modules/telemetry-what-information-is-collected.adoc[leveloffset=+2]
|
||||
|
||||
// Module is not in OCP
|
||||
ifdef::openshift-rosa,openshift-dedicated[]
|
||||
ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
include::modules/telemetry-user-telemetry.adoc[leveloffset=+2]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
@@ -64,46 +73,49 @@ endif::openshift-rosa,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[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,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::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
include::modules/insights-operator-about.adoc[leveloffset=+1]
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,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].
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
include::modules/insights-operator-what-information-is-collected.adoc[leveloffset=+2]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,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::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
* link:https://access.redhat.com/solutions/7066188[What data is being collected by the Insights Operator in OpenShift?]
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
* xref:../../nodes/clusters/nodes-cluster-enabling-features.adoc#nodes-cluster-enabling[Enabling features using feature gates]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,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]
|
||||
|
||||
// TODO: Add the first xref to ROSA HCP when the monitoring book is migrated.
|
||||
ifndef::openshift-rosa-hcp[]
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* See xref:../../observability/monitoring/monitoring-overview.adoc#monitoring-overview_monitoring-overview[Monitoring overview] for more information about the {product-title} monitoring stack.
|
||||
endif::openshift-rosa-hcp[]
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,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::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
[id="additional-details-about-how-remote-health-monitoring-data-is-used"]
|
||||
== Additional details about how remote health monitoring data is used
|
||||
@@ -118,7 +130,7 @@ Red Hat employs technical and organizational measures designed to protect the te
|
||||
|
||||
.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.
|
||||
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
|
||||
|
||||
@@ -126,6 +138,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[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,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].
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
@@ -14,6 +14,6 @@ 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[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
include::modules/insights-operator-showing-data-collected-from-the-cluster.adoc[leveloffset=+1]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
@@ -14,32 +14,32 @@ The Insights Operator periodically gathers configuration and component failure s
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,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[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,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].
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
include::modules/insights-operator-configuring.adoc[leveloffset=+1]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
include::modules/understanding-insights-operator-alerts.adoc[leveloffset=+1]
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
include::modules/disabling-insights-operator-alerts.adoc[leveloffset=+2]
|
||||
include::modules/enabling-insights-operator-alerts.adoc[leveloffset=+2]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
// cannot create resource "pods/exec" in API group "" in the namespace "openshift-insights"
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
include::modules/insights-operator-downloading-archive.adoc[leveloffset=+1]
|
||||
// cannot download archive using previous module
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
// InsightsDataGather is a Tech Preview feature. When the feature goes GA, verify if it can be added to ROSA/OSD.
|
||||
|
||||
// tech preview feature
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
[id="running-insights-operator-gather_using-insights-operator"]
|
||||
== Running an Insights Operator gather operation
|
||||
|
||||
@@ -61,11 +61,11 @@ include::modules/running-insights-operator-gather-cli.adoc[leveloffset=+2]
|
||||
.Additional resources
|
||||
* link:https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md[Insights Operator Gathered Data GitHub repository]
|
||||
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
// cannot list resource "secrets" in API group "" in the namespace "openshift-config"
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
include::modules/disabling-insights-operator-gather.adoc[leveloffset=+2]
|
||||
include::modules/enabling-insights-operator-gather.adoc[leveloffset=+2]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
include::modules/obfuscating-dvo-data.adoc[leveloffset=+1]
|
||||
|
||||
@@ -18,20 +18,28 @@ Use these procedures if the following issues occur:
|
||||
// Investigating why user-defined metrics are unavailable
|
||||
include::modules/monitoring-investigating-why-user-defined-metrics-are-unavailable.adoc[leveloffset=+1]
|
||||
|
||||
// TODO: Add the additional resources for ROSA HCP when the Observability book is added.
|
||||
ifndef::openshift-rosa-hcp[]
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* xref:../../observability/monitoring/configuring-the-monitoring-stack.adoc#creating-user-defined-workload-monitoring-configmap_configuring-the-monitoring-stack[Creating a user-defined workload monitoring config map]
|
||||
* See xref:../../observability/monitoring/managing-metrics.adoc#specifying-how-a-service-is-monitored_managing-metrics[Specifying how a service is monitored] for details on how to create a service monitor or pod monitor
|
||||
* See xref:../../observability/monitoring/managing-metrics.adoc#getting-detailed-information-about-a-target_managing-metrics[Getting detailed information about a metrics target]
|
||||
endif::openshift-rosa-hcp[]
|
||||
|
||||
// Determining why Prometheus is consuming a lot of disk space
|
||||
include::modules/monitoring-determining-why-prometheus-is-consuming-disk-space.adoc[leveloffset=+1]
|
||||
|
||||
// TODO: Add the additional resources for ROSA HCP when the Observability book is added.
|
||||
ifndef::openshift-rosa-hcp[]
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* xref:../../observability/monitoring/configuring-the-monitoring-stack.adoc#setting-scrape-and-evaluation-intervals-limits-for-user-defined-projects_configuring-the-monitoring-stack[Setting scrape and evaluation intervals and enforced limits for user-defined projects]
|
||||
endif::openshift-rosa-hcp[]
|
||||
|
||||
// Resolving the KubePersistentVolumeFillingUp alert firing for Prometheus
|
||||
include::modules/monitoring-resolving-the-kubepersistentvolumefillingup-alert-firing-for-prometheus.adoc[leveloffset=+1]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
include::modules/monitoring-resolving-the-kubepersistentvolumefillingup-alert-firing-for-prometheus.adoc[leveloffset=+1]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
@@ -8,7 +8,7 @@ toc::[]
|
||||
|
||||
{product-title} leverages the Kubernetes concept of a pod, which is one or more containers deployed together on one host. A pod is the smallest compute unit that can be defined, deployed, and managed on {product-title} {product-version}.
|
||||
|
||||
After a pod is defined, it is assigned to run on a node until its containers exit, or until it is removed. Depending on policy and exit code, Pods are either removed after exiting or retained so that their logs can be accessed.
|
||||
After a pod is defined, it is assigned to run on a node until its containers exit, or until it is removed. Depending on policy and exit code, pods are either removed after exiting or retained so that their logs can be accessed.
|
||||
|
||||
The first thing to check when pod issues arise is the pod's status. If an explicit pod failure has occurred, observe the pod's error state to identify specific image, container, or pod network issues. Focus diagnostic data collection according to the error state. Review pod event messages, as well as pod and container log information. Diagnose issues dynamically by accessing running Pods on the command line, or start a debug pod with root access based on a problematic pod's deployment configuration.
|
||||
|
||||
|
||||
@@ -23,3 +23,10 @@ include::modules/rosa-sts-user-role-creation.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/rosa-sts-aws-requirements-creating-association.adoc[leveloffset=+2]
|
||||
include::modules/rosa-sts-aws-requirements-creating-multi-association.adoc[leveloffset=+2]
|
||||
|
||||
// TODO: Add the additional resource to ROSA HCP when the Architecture book is added.
|
||||
ifndef::openshift-rosa-hcp[]
|
||||
[role="_additional-resources"]
|
||||
== Additional resources
|
||||
* 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.
|
||||
endif::openshift-rosa-hcp[]
|
||||
|
||||
@@ -18,10 +18,14 @@ If you experience Operator issues, verify Operator subscription status. Check Op
|
||||
|
||||
// Operator subscription condition types
|
||||
include::modules/olm-status-conditions.adoc[leveloffset=+1]
|
||||
|
||||
// TODO: Add this xref when the Operators book is added to ROSA HCP.
|
||||
ifndef::openshift-rosa-hcp[]
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* xref:../../operators/understanding/olm/olm-understanding-olm.adoc#olm-cs-health_olm-understanding-olm[Catalog health requirements]
|
||||
endif::openshift-rosa-hcp[]
|
||||
|
||||
// Viewing Operator subscription status by using the CLI
|
||||
include::modules/olm-status-viewing-cli.adoc[leveloffset=+1]
|
||||
@@ -32,46 +36,45 @@ include::modules/olm-cs-status-cli.adoc[leveloffset=+1]
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
// TODO: Add this xref when the Operators book is added to ROSA HCP.
|
||||
ifndef::openshift-rosa-hcp[]
|
||||
* 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[]
|
||||
endif::openshift-rosa-hcp[]
|
||||
* gRPC documentation: link:https://grpc.github.io/grpc/core/md_doc_connectivity-semantics-and-api.html[States of Connectivity]
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,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[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
// Querying Operator Pod status
|
||||
include::modules/querying-operator-pod-status.adoc[leveloffset=+1]
|
||||
|
||||
// Gathering Operator logs
|
||||
ifndef::openshift-rosa-hcp[]
|
||||
include::modules/gathering-operator-logs.adoc[leveloffset=+1]
|
||||
endif::openshift-rosa-hcp[]
|
||||
|
||||
// cannot patch resource "machineconfigpools"
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,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[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,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[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
include::modules/olm-refresh-subs.adoc[leveloffset=+1]
|
||||
endif::openshift-rosa,openshift-dedicated[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
// Reinstalling Operators after failed uninstallation
|
||||
// cannot delete resource "customresourcedefinitions"
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,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[]
|
||||
|
||||
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
@@ -10,12 +10,12 @@ toc::[]
|
||||
include::modules/reviewing-node-status-usage-and-configuration.adoc[leveloffset=+1]
|
||||
|
||||
// cannot create resource "namespaces"
|
||||
ifndef::openshift-rosa,openshift-dedicated[]
|
||||
ifndef::openshift-rosa,openshift-rosa-hcp,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[]
|
||||
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
||||
|
||||
|
||||
Reference in New Issue
Block a user