Red Hat Summit Red Hat Summitサポートコンソール開発者トライアルの開始お問い合わせ

5.2. Support Log Gather について

Support Log Gather Operator は、従来の must-gather ツールの機能に基づいて構築され、デバッグデータの収集を自動化します。収集された情報を単一の .tar ファイルにパッケージ化し、指定された Red Hat サポートケースに自動的にアップロードすることで、トラブルシューティングを効率化します。

重要

サポート対象かどうかサポートログ収集は、テクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。

Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。

Support Log Gather の主な機能は次のとおりです。

  • 管理者特権は不要: 昇格権限を必要とせずにログを収集およびアップロードできるため、管理者以外のユーザーがセキュアにより簡単にデータを収集できます。
  • 簡素化されたログ収集: リソース定義やサービスログなどのデバッグデータをクラスターから収集します。
  • 設定可能なデータアップロード: .tar ファイルをサポートケースに自動的にアップロードするか、ローカルに保存して手動でアップロードするかを設定するオプションを提供します。

5.2.1. Web コンソールを使用して Support Log Gather をインストールする
リンクのコピー

Web コンソールを使用して Support Log Gather をインストールできます。

重要

サポート対象かどうかサポートログ収集は、テクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。

Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。

前提条件

  • cluster-admin 権限でクラスターにアクセスできる。
  • OpenShift Container Platform Web コンソールにアクセスできる。

手順

  1. OpenShift Container Platform Web コンソールにログインします。
  2. Ecosystem Software Catalog に移動します。
  3. フィルターボックスに Support Log Gather と入力します。
  4. Support Log Gather を選択します。
  5. Version リストから Support Log Gather バージョンを選択し、Install をクリックします。

  6. Install Operator ページで、インストール設定を設定します。

    1. Operator の Installed Namespace を選択します。

      デフォルトの Operator namespace は must-gather-operator です。must-gather-operator namespace が存在しない場合は自動的に作成されます。

    2. Update approval strategy を選択します。

      • 新しいバージョンが利用可能になったときに Operator Lifecycle Manager (OLM) が Operator を自動的に更新するようにするには、Automatic を選択します。
      • 適切な認証情報を持つユーザーによって Operator の更新が承認される必要がある場合は、Manual を選択します。
    3. Install をクリックします。

検証

  1. Operator が正常にインストールされていることを確認します。

    1. Ecosystem Software Catalog に移動します。
    2. Support Log Gather が must-gather-operator namespace に Succeeded の Status でリストされていることを確認します。

  2. Support Log Gather Pod が実行されていることを確認します。

    1. Workloads Pods に移動します。

    2. Support Log Gather Pod のステータスが Running であることを確認します。

      Support Log Gather は、Pod を起動して実行した後にのみ使用できます。

5.2.2. CLI を使用して Support Log Gather をインストールする
リンクのコピー

コマンドラインインターフェイス (CLI) から Support Log Gather をインストールして、サポートケースの自動ログ収集を有効にできます。

重要

サポート対象かどうかサポートログ収集は、テクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。

Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。

前提条件

  • cluster-admin 権限でクラスターにアクセスできる。

手順

  1. 次のコマンドを実行して、must-gather-operator という名前の新しいプロジェクトを作成します。 

    $ oc new-project must-gather-operator
    Copy to Clipboard Toggle word wrap

  2. OperatorGroup オブジェクトを作成します。

    1. OperatorGroup オブジェクトを定義する YAML ファイル (例: operatorGroup.yaml) を作成します。 

      apiVersion: operators.coreos.com/v1
kind: OperatorGroup
metadata:
  name: must-gather-operator
  namespace: must-gather-operator
spec: {}
      Copy to Clipboard Toggle word wrap

    2. 以下のコマンドを実行して OperatorGroup オブジェクトを作成します。 

      $ oc create -f operatorGroup.yaml
      Copy to Clipboard Toggle word wrap

  3. Subscription オブジェクトを作成します。

    1. Subscription オブジェクトを定義する YAML ファイル (例: subscription.yaml) を作成します。 

      apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: support-log-gather-operator
  namespace: must-gather-operator
spec:
  channel: tech-preview
  name: support-log-gather-operator
  source: redhat-operators
  sourceNamespace: openshift-marketplace
  installPlanApproval: Automatic
      Copy to Clipboard Toggle word wrap

    2. 以下のコマンドを実行して Subscription オブジェクトを作成します。 

      $ oc create -f subscription.yaml
      Copy to Clipboard Toggle word wrap

検証

  1. 次のコマンドを実行して、Operator namespace 内の Pod のステータスを確認します。 

    $ oc get pods
    Copy to Clipboard Toggle word wrap

    出力例

    NAME                                                              READY   STATUS      RESTARTS   AGE
must-gather-operator-657fc74d64-2gg2w                             1/1     Running     0          13m
    Copy to Clipboard Toggle word wrap

    すべての Pod のステータスは Running である必要があります。

  2. 次のコマンドを実行して、サブスクリプションが作成されたことを確認します。 

    $ oc get subscription -n must-gather-operator
    Copy to Clipboard Toggle word wrap

    出力例

    NAME                          PACKAGE                       SOURCE            CHANNEL
support-log-gather-operator   support-log-gather-operator   redhat-operators  tech-preview
    Copy to Clipboard Toggle word wrap

  3. 次のコマンドを実行して、Operator がインストールされていることを確認します。 

    $ oc get csv -n must-gather-operator
    Copy to Clipboard Toggle word wrap

    出力例

    NAME                                  DISPLAY                VERSION   REPLACES   PHASE
support-log-gather-operator.v4.20.0   support log gather     4.20.0               Succeeded
    Copy to Clipboard Toggle word wrap

5.2.3. Support Log Gather インスタンスの設定
リンクのコピー

クラスターからの診断データの収集を自動化するには、コマンドラインインターフェイス (CLI) から MustGather カスタムリソース (CR) を作成する必要があります。このプロセスでは、データが Red Hat サポートケースにも自動的にアップロードされます。

重要

サポート対象かどうかサポートログ収集は、テクノロジープレビュー機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行い、フィードバックを提供していただくことを目的としています。

Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。

前提条件

  • OpenShift CLI (oc) ツールがインストールされている。
  • クラスターに Support Log Gather がインストールされている。
  • Red Hat サポートケース ID がある。
  • Red Hat お客様ポータルの認証情報を含む Kubernetes シークレットを作成した。シークレットには、ユーザー名フィールドとパスワードフィールドが含まれている必要があります。
  • サービスアカウントを作成している。

手順

  1. 次の基本設定を含む、MustGather CR の YAML ファイル (support-log-gather.yaml など) を作成します。

    support-log-gather.yaml の例

    apiVersion: operator.openshift.io/v1alpha1
kind: MustGather
metadata:
  name: example-mg
  namespace: must-gather-operator
spec:
  serviceAccountName: must-gather-operator
  audit: true
  proxyConfig:
    httpProxy: "http://proxy.example.com:8080"
    httpsProxy: "https://proxy.example.com:8443"
    noProxy: ".example.com,localhost"
  mustGatherTimeout: "1h30m9s"
  uploadTarget:
    type: SFTP
    sftp:
      caseID: "04230315"
      caseManagementAccountSecretRef:
        name: mustgather-creds
      host: "sftp.access.redhat.com"
  retainResourcesOnCompletion: true
  storage:
    type: PersistentVolume
    persistentVolume:
      claim:
        name: mustgather-pvc
      subPath: must-gather-bundles/case-04230315
    Copy to Clipboard Toggle word wrap

    設定パラメーターの詳細は、「MustGather カスタムリソースの設定パラメーター」を参照してください。

  2. 次のコマンドを実行して MustGather オブジェクトを作成します。 

    $ oc create -f support-log-gather.yaml
    Copy to Clipboard Toggle word wrap

検証

  1. 次のコマンドを実行して、MustGather CR が作成されたことを確認します。 

    $ oc get mustgather
    Copy to Clipboard Toggle word wrap

    出力例

    NAME          AGE
example-mg    7s
    Copy to Clipboard Toggle word wrap

  2. 次のコマンドを実行して、Operator namespace 内の Pod のステータスを確認します。 

    $ oc get pods
    Copy to Clipboard Toggle word wrap

    出力例

    NAME                                                              READY   STATUS      RESTARTS   AGE
must-gather-operator-657fc74d64-2gg2w                             1/1     Running     0          13m
example-mg-gk8m8                                                  2/2     Running     0          13s
    Copy to Clipboard Toggle word wrap

    MustGather CR に基づいた名前を指定した Pod を新規作成する必要があります。すべての Pod のステータスは Running である必要があります。

  3. ファイルのアップロードの進行状況を監視するには、次のコマンドを実行して、ジョブ Pod 内のアップロードコンテナーのログを表示します。 

    oc logs -f pod/example-mg-gk8m8 -c upload
    Copy to Clipboard Toggle word wrap

    成功した場合、プロセスはアーカイブを作成し、指定されたケースの Red Hat Secure File Transfer Protocol (SFTP) サーバーにアップロードする必要があります。

5.2.4. MustGather カスタムリソースの設定パラメーター
リンクのコピー

データ収集とアップロードプロセスのパラメーターを指定する YAML ファイルを作成することで、MustGather カスタムリソース (CR) を管理できます。次の表は、MustGather CR で設定できるパラメーターの概要を示しています。

Expand
パラメーター名説明種類

spec.audit

オプション: 監査ログを収集するかどうかを指定します。有効な値は true および false です。デフォルト値は false です。

boolean

spec.mustGatherTimeout

オプション: must-gather コマンドが完了するまでの時間制限を指定します。

値は時間単位を持つ浮動小数点数である必要があります。有効な単位は s (秒)、m (分)、または h (時間) です。デフォルトでは時間制限は設定されていません。

spec.proxyConfig

オプション: 使用するプロキシー設定を定義します。デフォルト値は、クラスターレベルのプロキシー設定に設定されています。

Object

spec.proxyConfig.httpProxy

HTTP リクエストのプロキシーの URL を指定します。

URL

spec.proxyConfig.httpsProxy

HTTPS リクエストのプロキシーの URL を指定します。

 

spec.proxyConfig.noProxy

プロキシーを使用してはならないドメインのコンマ区切りリストを指定します。

URL のリスト

spec.retainResourcesOnCompletion

オプション: データ収集の完了後に、must-gather ジョブとその関連リソースを保持するかどうかを指定します。有効な値は true および false です。デフォルト値は false です。

boolean

spec.serviceAccountName

オプション: サービスアカウントの名前を指定します。デフォルト値は default です。

string

spec.storage

オプション: must-gather バンドルのストレージ設定を定義します。

Object

spec.storage.persistentVolume

永続ボリュームの詳細を定義します。

Object

spec.storage.persistentVolume.claim

永続ボリューム要求 (PVC) の詳細を定義します。

Object

spec.storage.persistentVolume.claim.name

ストレージに使用する PVC の名前を指定します。

string

spec.storage.persistentVolume.subPath

オプション: バンドルを保存するための PVC 内のパスを指定します。

string

spec.storage.type

ストレージのタイプを定義します。サポートされている値は PersistentVolume のみです。

string

spec.uploadTarget

オプション: must-gather バンドルのアップロード場所を定義します。

Object

spec.uploadTarget.host

オプション: バンドルのアップロード先のサーバーを指定します。デフォルトでは、バンドルは sftp.access.redhat.com にアップロードされます。

デフォルトでは、バンドルは sftp.access.redhat.com にアップロードされます。

spec.uploadTarget.sftp.caseID

診断データが収集される Red Hat サポートケース ID を指定します。

string

spec.uploadTarget.sftp.caseManagementAccountSecretRef

Red Hat カスタマーポータルサポートケースへのファイルの認証とアップロードに必要な認証情報を定義します。値には username と password フィールドが含まれている必要があります。

Object

spec.uploadTarget.sftp.caseManagementAccountSecretRef.name

認証情報を含む Kubernetes シークレットの名前を指定します。

string

spec.uploadTarget.sftp.internalUser

オプション: caseManagementAccountSecretRef で指定されたユーザーが Red Hat 内部ユーザーであるかどうかを指定します。有効な値は true および false です。デフォルト値は false です。

boolean

spec.uploadTarget.type

must-gather バンドルのアップロード場所のタイプを指定します。サポートされる値は SFTP のみです。

string

注記

spec.uploadTarget または spec.storage を指定しない場合、Pod はデータを一時ボリュームに保存し、Pod が終了するとデータは完全に削除されます。

5.2.5. Support Log Gather のアンインストール
リンクのコピー

Web コンソールを使用して Support Log Gather をアンインストールできます。

前提条件

  • cluster-admin 権限でクラスターにアクセスできる。
  • OpenShift Container Platform Web コンソールにアクセスできる。
  • Support Log Gather がインストールされている。

手順

  1. OpenShift Container Platform Web コンソールにログインします。

  2. Support Log Gather Operator をアンインストールします。

    1. Ecosystem Installed Operators に移動します。
    2. Support Log Gather エントリーの横にある Options メニュー kebab をクリックして Uninstall Operator をクリックします。
    3. 確認ダイアログで、Uninstall をクリックします。

5.2.6. Support Log Gather リソースの削除
リンクのコピー

Support Log Gather をアンインストールしたら、クラスターから関連リソースを削除できます。

前提条件

  • cluster-admin 権限でクラスターにアクセスできる。
  • OpenShift Container Platform Web コンソールにアクセスできる。

手順

  1. OpenShift Container Platform Web コンソールにログインします。

  2. must-gather-operator namespace 内のコンポーネントのデプロイメントを削除します。

    1. Project ドロップダウンメニューをクリックして、利用可能なすべてのプロジェクトのリストを表示し、must-gather-operator プロジェクトを選択します。
    2. Workloads Deployments に移動します。
    3. 削除するデプロイメントを選択します。
    4. Actions ドロップダウンメニューをクリックし、Delete Deployment を選択します。
    5. 確認ダイアログボックスで、Delete をクリックしてデプロイメントを削除します。

    6. または、コマンドラインインターフェイス (CLI) を使用して、must-gather-operator namespace にあるコンポーネントのデプロイメントを削除します。 

      $ oc delete deployment -n must-gather-operator -l operators.coreos.com/support-log-gather-operator.must-gather-operator
      Copy to Clipboard Toggle word wrap

  3. オプション: Support Log Gather によってインストールされたカスタムリソース定義 (CRD) を削除します。

    1. Administration CustomResourceDefinitions に移動します。
    2. CRD をフィルタリングするには、Name フィールドに MustGather と入力します。

    3. 次の各 CRD の横にある Options メニュー kebab をクリックし、Delete Custom Resource Definition を選択します。

      • MustGather

  4. オプション: must-gather-operator namespace を削除します。

    1. Administration Namespaces に移動します。
    2. must-gather-operator の横にある Options メニュー kebab をクリックし、Delete Namespace を選択します。
    3. 確認ダイアログボックスで must-gather-operator と入力し、Delete をクリックします。
トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat