Support

OpenShift Container Platform 4.1

Getting support for OpenShift Container Platform 4.1

Red Hat OpenShift Documentation Team

Abstract

This document provides information on getting support from Red Hat for OpenShift Container Platform. It also contains information on remote health monitoring through Telemetry and the Insights Operator.

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.

    Note

    When 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-gather command
    • The unique cluster ID
  • 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-admin role.

Procedure

  1. Run the oc adm must-gather command:

    $ 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.

  2. Create a compressed file from the must-gather directory. 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/
  3. 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-admin role.
  • 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:

    1. Navigate to AdministrationCluster Settings.
    2. The value is available in the Cluster ID field of the Overview tab.

Legal Notice

Copyright © 2020 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat 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 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.