4.5. Insights Operator の使用

手順

1. Workloads ConfigMaps に移動し、Project: openshift-insights を選択します。
2. Create ConfigMap をクリックします。

3. Configure via: YAML view を選択し、次のように設定を入力します。

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: insights-config
     namespace: openshift-insights
   data:
     config.yaml: |
       dataReporting:
         obfuscation:
           - networking
           - workload_names
       sca:
         disabled: false
         interval: 2h
       alerting:
          disabled: false
   binaryData: {}
   immutable: false

   Copy to Clipboard Toggle word wrap
4. オプション: Form view を選択し、フォームで必要な情報を入力します。
5. ConfigMap Name フィールドに insights-config と入力します。
6. Key フィールドに config.yaml と入力します。
7. Value フィールドで、ファイルを探してフィールドにドラッグアンドドロップするか、設定パラメーターを手動で入力します。
8. Create をクリックすると、ConfigMap オブジェクトと設定情報が表示されます。

手順

1. Workloads ConfigMaps に移動し、Project: openshift-insights を選択します。
2. insights-config ConfigMap オブジェクトをクリックして開きます。
3. Actions をクリックし、Edit ConfigMap を選択します。
4. YAML view のラジオボタンをクリックします。

5. ファイル内で、alerting 属性を disabled: true に設定します。

   apiVersion: v1
   kind: ConfigMap
   # ...
   data:
     config.yaml: |
       alerting:
         disabled: true
   # ...

   Copy to Clipboard Toggle word wrap
6. Save をクリックします。insights-config config-map の詳細ページが開きます。
7. config.yaml の alerting 属性の値が disabled: true に設定されていることを確認します。

手順

1. Workloads ConfigMaps に移動し、Project: openshift-insights を選択します。
2. insights-config ConfigMap オブジェクトをクリックして開きます。
3. Actions をクリックし、Edit ConfigMap を選択します。
4. YAML view のラジオボタンをクリックします。

5. ファイル内で、alerting 属性を disabled: false に設定します。

   apiVersion: v1
   kind: ConfigMap
   # ...
   data:
     config.yaml: |
       alerting:
         disabled: false
   # ...

   Copy to Clipboard Toggle word wrap
6. Save をクリックします。insights-config config-map の詳細ページが開きます。
7. config.yaml の alerting 属性の値が disabled: false に設定されていることを確認します。

手順

1. アーカイブから /insights-operator/gathers.json を開きます。

   このファイルには、Insights Operator 収集操作のリストが含まれています。

       {
         "name": "clusterconfig/authentication",
         "duration_in_ms": 730, 

   1

   
         "records_count": 1,
         "errors": null,
         "panic": null
       }

   Copy to Clipboard Toggle word wrap

   1

   duration_in_ms は、各収集操作にかかるミリ秒単位の時間です。

2. 各収集操作に異常がないか検査します。

手順

1. コンソールで、Administration > CustomResourceDefinitions を選択します。
2. CustomResourceDefinitions ページの Search by name フィールドで DataGather リソース定義を見つけ、クリックします。
3. CustomResourceDefinition details ページで、Instances タブをクリックします。
4. Create DataGather をクリックします。

5. すべての収集操作を実行する新しい DataGather 操作を作成するには、次の YAML 仕様を完成させてから、変更を保存します。

   apiVersion: insights.openshift.io/v1alpha2
   kind: DataGather
   metadata:
     name: <your_data_gather>
   spec:
   # Gatherers configuration
     gatherers:
       mode: All # Options: All, Custom
   # ...

   Copy to Clipboard Toggle word wrap
   重要
   • 収集操作に指定する名前 <your_data_gather> は、一意である必要があり、periodic-gathering- という接頭辞を含むことはできません。この文字列は他の管理操作用に予約されており、目的の収集操作に影響を与える可能性があるためです。
   • DataGather CRD の spec が定義されていない場合は、デフォルトの Insights Operator データ収集ジョブが実行されます。つまり、すべての収集操作が実行され、収集されたデータは難読化されず、アーカイブファイルは保持されません。

6. オプション: データ収集操作をカスタマイズするには、DataGather YAML ファイルで次のオプションを設定できます。

   • 特定の gatherer を無効にするには、mode の値を Custom に変更し、無効にする個々の gatherer を指定します。たとえば、ワークロードの gatherer を無効にするには、次の例を追加します。

     apiVersion: insights.openshift.io/v1alpha2
     kind: DataGather
     metadata:
       name: <your_data_gather>
     spec:
         # Gatherers configuration
       gatherers:
         mode: Custom  # Options: All, Custom
         custom:
           configs:
             # Essential cluster configuration gatherers
             - name: clusterconfig/authentication
               state: Enabled
             - name: clusterconfig/clusteroperators
               state: Enabled
             - name: workloads
               state: Disabled

     Copy to Clipboard Toggle word wrap

   • 永続ストレージで直近 10 件までのデータ収集ジョブのデータアーカイブファイルと履歴を保持できるようにするには、storage 仕様を定義します。次の例に示すように、type を PersistentVolume に設定し、ボリュームの mountPath と name を定義します。

     apiVersion: insights.openshift.io/v1alpha2
     kind: DataGather
     metadata:
       name: <your_data_gather>
     spec:
       storage:
         type: PersistentVolume
         mountPath: /data
         persistentVolume:
           claim:
             name: on-demand-gather-pvc

     Copy to Clipboard Toggle word wrap
     重要

     指定したボリューム名が、openshift-insights namespace 内の既存の PersistentVolumeClaim 値と一致していることを確認してください。詳細は、永続ボリューム要求 を参照してください。

   • データの難読化を有効にするには、dataPolicy キーと必要な値を定義します。たとえば、IP アドレスとワークロード名を難読化するには、次の設定を追加します。

     apiVersion: insights.openshift.io/v1alpha2
     kind: DataGather
     metadata:
       name: <your_data_gather>
     spec:
       dataPolicy:
         - ObfuscateNetworking
         - WorkloadNames

     Copy to Clipboard Toggle word wrap

検証

1. コンソールで、Workloads > Pods を選択します。
2. Pods ページで Project プルダウンメニューに移動し、Show default projects を選択します。
3. Project プルダウンメニューから openshift-insights プロジェクトを選択します。
4. openshift-insights プロジェクトの Pod のリストで、新しい収集オペレーションに選択した名前の接頭辞が付いていることを確認します。完了すると、Insights Operator は処理のためにデータを Red Hat に自動的にアップロードします。

手順

1. 次の DataGather 仕様を含む YAML ファイルを作成します。

   apiVersion: insights.openshift.io/v1alpha2
   kind: DataGather
   metadata:
     name: <your_data_gather>
   spec:
   # Gatherers configuration
     gatherers:
       mode: All # Options: All, Custom
   # ...

   Copy to Clipboard Toggle word wrap
   重要
   • 収集操作に指定する名前 <your_data_gather> は、一意である必要があり、periodic-gathering- という接頭辞を含むことはできません。この文字列は他の管理操作用に予約されており、目的の収集操作に影響を与える可能性があるためです。
   • DataGather CRD の spec が定義されていない場合は、デフォルトの Insights Operator データ収集ジョブが実行されます。つまり、すべての収集操作が実行され、収集されたデータは難読化されず、アーカイブファイルは保持されません。

2. オプション: データ収集操作をカスタマイズするには、DataGather YAML ファイルで次のオプションを設定できます。

   • 特定の gatherer を無効にするには、mode の値を Custom に変更し、無効にする個々の gatherer を指定します。たとえば、ワークロードの gatherer を無効にするには、次の例を追加します。

     apiVersion: insights.openshift.io/v1alpha2
     kind: DataGather
     metadata:
       name: <your_data_gather>
     spec:
         # Gatherers configuration
       gatherers:
         mode: Custom  # Options: All, Custom
         custom:
           configs:
             # Essential cluster configuration gatherers
             - name: clusterconfig/authentication
               state: Enabled
             - name: clusterconfig/clusteroperators
               state: Enabled
             - name: workloads
               state: Disabled

     Copy to Clipboard Toggle word wrap

   • 永続ストレージで直近 10 件までのデータ収集ジョブのデータアーカイブファイルと履歴を保持できるようにするには、storage 仕様を定義します。次の例に示すように、type を PersistentVolume に設定し、ボリュームの mountPath と name を定義します。

     apiVersion: insights.openshift.io/v1alpha2
     kind: DataGather
     metadata:
       name: <your_data_gather>
     spec:
       storage:
         type: PersistentVolume
         mountPath: /data
         persistentVolume:
           claim:
             name: on-demand-gather-pvc

     Copy to Clipboard Toggle word wrap
     重要

     指定したボリューム名が、openshift-insights namespace 内の既存の PersistentVolumeClaim 値と一致していることを確認してください。詳細は、永続ボリューム要求 を参照してください。

   • データの難読化を有効にするには、dataPolicy キーと必要な値を定義します。たとえば、IP アドレスとワークロード名を難読化するには、次の設定を追加します。

     apiVersion: insights.openshift.io/v1alpha2
     kind: DataGather
     metadata:
       name: <your_data_gather>
     spec:
       dataPolicy:
         - ObfuscateNetworking
         - WorkloadNames

     Copy to Clipboard Toggle word wrap

3. OpenShift Container Platform CLI で、次のコマンドを入力して収集操作を実行します。

   $ oc apply -f <your_data_gather_definition>.yaml

   Copy to Clipboard Toggle word wrap

手順

1. Administration > CustomResourceDefinitions に移動します。
2. CustomResourceDefinitions ページで、Search by name フィールドを使用して InsightsDataGather カスタムリソース定義 (CRD) を見つけ、クリックして開きます。
3. CustomResourceDefinition details ページで、Instances タブをクリックします。
4. cluster をクリックし、YAML タブをクリックします。

5. InsightsDataGather CRD を編集し、次のいずれかのステップを実行します。

   • すべての収集操作とデータ収集を無効にするには、次の例の抜粋に示すように、gatherers 仕様を定義し、mode、None に設定します。

     apiVersion: insights.openshift.io/v1alpha2
     kind: InsightsDataGather
     metadata:
       name: cluster
     spec:
     # Gatherers configuration
       gatherers:
         mode: None # Options: All, None, Custom

     Copy to Clipboard Toggle word wrap

   • 個々の収集操作を無効にするには、gatherers の下で mode を Custom に設定し、無効にする個々の gatherer を指定します。たとえば、ワークロードの gatherer を無効にするには、次の仕様を定義します。

     apiVersion: insights.openshift.io/v1alpha2
     kind: InsightsDataGather
     metadata:
       name: cluster
     spec:
         # Gatherers configuration
       gatherers:
         mode: Custom  # Options: All, None, Custom
         custom:
           configs:
             # Essential cluster configuration gatherers
             - name: clusterconfig/authentication
               state: Enabled
             - name: clusterconfig/clusteroperators
               state: Enabled
             - name: workloads
               state: Disabled

     Copy to Clipboard Toggle word wrap
6. Save をクリックします。

手順

1. Administration > CustomResourceDefinitions に移動します。
2. CustomResourceDefinitions ページで、Search by name フィールドを使用して InsightsDataGather カスタムリソース定義 (CRD) を見つけ、クリックして開きます。
3. CustomResourceDefinition details ページで、Instances タブをクリックします。
4. cluster をクリックし、YAML タブをクリックします。

5. InsightsDataGather CRD を編集し、次のいずれかのステップを実行します。

   • 無効にしたすべての収集操作を有効にするには、次の例の抜粋に示すように、gatherers 仕様で mode を All に戻します。

     apiVersion: insights.openshift.io/v1alpha2
     kind: InsightsDataGather
     metadata:
       name: cluster
     spec:
     # Gatherers configuration
       gatherers:
         mode: All # Options: All, None, Custom

     Copy to Clipboard Toggle word wrap

   • 以前無効にした個々の収集操作を有効にするには、gatherers:custom:configs キーセクションで収集操作の名前を見つけて、state を Enabled に変更します。または、config 仕様の下で、有効にする操作の name および state 設定行を削除します。

     apiVersion: insights.openshift.io/v1alpha2
     kind: InsightsDataGather
     metadata:
       name: cluster
     spec:
         # Gatherers configuration
       gatherers:
         mode: Custom  # Options: All, None, Custom
         custom:
           configs:
             # Essential cluster configuration gatherers
             - name: clusterconfig/authentication
               state: Enabled
             - name: clusterconfig/clusteroperators
               state: Enabled
             - name: workloads
               state: Enabled

     Copy to Clipboard Toggle word wrap

6. Save をクリックします。

   変更を保存すると、Insights Operator の収集設定が更新され、その影響を受けた収集操作が開始します。