Support
Getting support for OpenShift Container Platform 4.1
Abstract
Chapter 1. Getting support
1.1. Getting support
If you experience difficulty with a procedure described in this documentation, visit the Red Hat Customer Portal. Through the Customer Portal, you can:
- Search or browse through the Red Hat Knowledgebase of technical support articles about Red Hat products.
Submit a support case to Red Hat Support.
NoteWhen submitting a support case, it is recommended to provide the following information about your cluster to Red Hat Support to aid in troubleshooting:
-
Data gathered using the
oc adm must-gathercommand - The unique cluster ID
-
Data gathered using the
- Access other product documentation.
If you have a suggestion for improving this documentation or have found an error, please submit a Bugzilla report at http://bugzilla.redhat.com against the OpenShift Container Platform product for the Documentation component. Please provide specific details, such as the section name and OpenShift Container Platform version.
Chapter 2. Gathering data about your cluster
When opening a support case, it is often helpful to provide debugging information about your cluster to Red Hat Support.
It is recommended to provide:
2.1. Gathering data about your cluster for Red Hat Support
The oc adm must-gather CLI command collects the information from your cluster that is most likely needed for debugging issues, such as:
- Resource definitions
- Audit logs
- Service logs
Prerequisites
-
Access to the cluster as a user with the
cluster-adminrole.
Procedure
Run the
oc adm must-gathercommand:$ oc adm must-gather
This creates a Pod on the cluster to perform the data collection on. All of the collected resources and data from your cluster are saved in the current directory in a new directory that starts with
must-gather.local.Create a compressed file from the
must-gatherdirectory. For example, on a computer that uses a Linux operating system, run the following command:$ tar cvaf must-gather.tar.gz must-gather.local.5421342344627712289/
- Attach the compressed file to your support case on the Red Hat Customer Portal.
2.2. Obtaining your cluster ID
When providing information to Red Hat Support, it is helpful to provide the unique identifier for your cluster. You can obtain your cluster ID by using the OpenShift CLI (oc) or by using the OpenShift Container Platform web console.
Prerequisites
-
Access to the cluster as a user with the
cluster-adminrole. -
The OpenShift Container Platform CLI (
oc) installed.
Procedure
To obtain your cluster ID using the OpenShift CLI (
oc), run the following command:$ oc get clusterversion -o jsonpath='{.items[].spec.clusterID}{"\n"}'To obtain your cluster ID using the OpenShift Container Platform web console:
- Navigate to Administration → Cluster Settings.
- The value is available in the Cluster ID field of the Overview tab.
Legal Notice
Copyright © 2024 Red Hat, Inc.
OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).
Modified versions must remove all Red Hat trademarks.
Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.
Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.
