4.20. サポートケースのデバッグデータの収集

サポートケースを開くときは、クラスターに関するデバッグ情報を Red Hat サポートチームに提供する必要があります。must-Gather ツールを使用して、プロジェクトレベルのリソース、クラスターレベルのリソース、および Red Hat OpenShift GitOps コンポーネントの診断情報を収集できます。 

注記

迅速なサポートが必要な場合は、OpenShift Container Platform と Red Hat OpenShift GitOps の両方の診断情報を提供してください。

4.20.1. must-gather ツールについて

oc adm must-gather CLI コマンドは、以下のような問題のデバッグに必要となる可能性のあるクラスターからの情報を収集します。

  • リソース定義
  • サービスログ

デフォルトで、oc adm must-gather コマンドはデフォルトのプラグインイメージを使用し、./must-gather.local に書き込みを行います。

または、以下のセクションで説明されているように、適切な引数を指定してコマンドを実行すると、特定の情報を収集できます。

  • 1 つ以上の特定の機能に関連するデータを収集するには、以下のセクションに示すように、イメージと共に --image 引数を使用します。

    以下に例を示します。

    $ oc adm must-gather \
      --image=registry.redhat.io/container-native-virtualization/cnv-must-gather-rhel9:v4.13.3
  • 監査ログを収集するには、以下のセクションで説明されているように -- /usr/bin/gather_audit_logs 引数を使用します。

    以下に例を示します。

    $ oc adm must-gather -- /usr/bin/gather_audit_logs
    注記

    ファイルのサイズを小さくするために、監査ログはデフォルトの情報セットの一部として収集されません。

oc adm must-gather を実行すると、ランダムな名前を持つ新規 Pod がクラスターの新規プロジェクトに作成されます。データは Pod で収集され、must-gather.local で始まる新規ディレクトリーに保存されます。このディレクトリーは、現行の作業ディレクトリーに作成されます。

以下に例を示します。

NAMESPACE                      NAME                 READY   STATUS      RESTARTS      AGE
...
openshift-must-gather-5drcj    must-gather-bklx4    2/2     Running     0             72s
openshift-must-gather-5drcj    must-gather-s8sdh    2/2     Running     0             72s
...

任意で、--run-namespace オプションを使用して、特定の namespace で oc adm must-gather コマンドを実行できます。

以下に例を示します。

$ oc adm must-gather --run-namespace <namespace> \
  --image=registry.redhat.io/container-native-virtualization/cnv-must-gather-rhel9:v4.13.3

4.20.2. Red Hat OpenShift GitOps のデバッグデータの収集

oc adm must-gather CLI コマンドを使用して、Red Hat OpenShift GitOps に関連付けられているクラスターに関する次の詳細を収集します。

  • Red Hat OpenShift GitOps Operator のサブスクリプションと namespace。
  • ArgoCD オブジェクトが利用できる namespace と、ArgoCDApplicationsApplicationSetsAppProjectsconfigmaps などのこれらの namespace のオブジェクト。
  • Red Hat OpenShift GitOps Operator によって管理される namespace の一覧およびそれらの namespace からのリソース。
  • すべての GitOps 関連のカスタムリソースオブジェクトと定義。
  • Operator および Argo CD のログ。
  • 警告およびエラーレベルのイベント。

前提条件

  • OpenShift Container Platform クラスターに管理者としてログインしていること。
  • OpenShift Container Platform CLI (oc) をインストールしている。
  • Red Hat OpenShift GitOps Operator がインストールされている。

手順

  1. デバッグ情報を保存するディレクトリーに移動します。
  2. Red Hat OpenShift GitOps の must-gather イメージを使用して oc adm must-gather コマンドを実行します。

    $ oc adm must-gather --image=registry.redhat.io/openshift-gitops-1/gitops-must-gather-rhel8:v1.9.0

    must-gather ツールは、現在のディレクトリーに ./must-gather.local で始まる新しいディレクトリーを作成します。例: ./must-gather.local.4157245944708210399.

  3. 作成したばかりのディレクトリーから圧縮ファイルを作成します。たとえば、Linux オペレーティングシステムを使用するコンピューターで以下のコマンドを実行します。

    $ tar -cvaf must-gather.tar.gz must-gather.local.4157245944708210399
  4. 圧縮ファイルを Red Hat カスタマーポータル で作成したサポートケースに添付します。