4.6. Insights Operator の使用
Insights Operator は設定およびコンポーネントの障害ステータスを定期的に収集し、デフォルトで 2 時間ごとにそのデータを Red Hat に報告します。この情報により、Red Hat は設定や Telemetry で報告されるデータよりも深層度の高いデータを評価できます。OpenShift Container Platform のユーザーは、Red Hat Hybrid Cloud Console の Insights Advisor サービスにレポートを表示できます。
関連情報
- Insights Operator はデフォルトでインストールされ、有効にされます。リモートヘルスレポートをオプトアウトする必要がある場合は、リモートヘルスレポートのオプトアウト を参照してください。
- Insights Advisor を使用したクラスターの問題の特定に関する詳細は、Insights を使用したクラスターの問題の特定 を参照してください。
4.6.1. Insights Operator の設定
Insights Operator 設定は、デフォルトの Operator 設定と、openshift-insights
namespace の insights-config ConfigMap
オブジェクト、または openshift-config
namespace のサポートシークレットのいずれかに保存されている設定を組み合わせたものです。
ConfigMap
オブジェクトかサポートシークレットが存在する場合、含まれる属性値によってデフォルトの Operator 設定値がオーバーライドされます。ConfigMap
オブジェクトとサポートシークレットが 両方とも 存在する場合、Operator は ConfigMap
オブジェクトを読み取ります。
ConfigMap
オブジェクトはデフォルトでは存在しないため、OpenShift Container Platform クラスター管理者が作成する必要があります。
ConfigMap オブジェクトの設定の構造
この insights-config ConfigMap
オブジェクトの例 (config.yaml
設定) は、標準の YAML 形式を使用した設定オプションを示しています。
設定可能な属性とデフォルト値
次の表に、使用可能な設定属性を示します。
insights-config ConfigMap
オブジェクトは、標準の YAML 形式に準拠しています。子の値が親属性の下にあり、2 つのスペースでインデントされています。Obfuscation 属性では、親属性の子として箇条書きで値を入力します。
Attribute name | 説明 | 値のタイプ | デフォルト値 |
---|---|---|---|
| IP アドレスとクラスタードメイン名のグローバル難読化を有効にします。 | Boolean |
|
| Deployment Validation Operator がインストールされている場合、Deployment Validation Operator からのデータを難読化します。 | Boolean |
|
| Simple Content Access エンタイトルメントのダウンロード頻度を指定します。 | 時間間隔 |
|
| Simple Content Access エンタイトルメントのダウンロードを無効にします。 | Boolean |
|
| クラスターの Prometheus インスタンスへの Insights Operator アラートを無効にします。 | Boolean |
|
| Insights Operator のカスタムプロキシーを設定する | URL | デフォルトなし |
4.6.1.1. insights-config ConfigMap オブジェクトの作成
この手順では、Insights Operator によるカスタム設定を行うための Insights-config ConfigMap
オブジェクトを作成する方法を説明します。
デフォルトの Insights Operator 設定を変更する前に、Red Hat サポートに相談することを推奨します。
前提条件
- リモートヘルスレポートが有効になっている (デフォルト)。
-
cluster-admin
ロールを持つユーザーとして OpenShift Container Platform Web コンソールにログインしている。
手順
-
Workloads
ConfigMaps に移動し、Project: openshift-insights を選択します。 - Create ConfigMap をクリックします。
Configure via: YAML view を選択し、次のように設定を入力します。
apiVersion: v1 kind: ConfigMap metadata: name: insights-config namespace: openshift-insights data: config.yaml: | dataReporting: obfuscation: - networking - workload_names sca: disable: false interval: 2h alerting: disabled: false binaryData: {} immutable: false
- オプション: Form view を選択し、フォームで必要な情報を入力します。
- ConfigMap Name フィールドに insights-config と入力します。
- Key フィールドに config.yaml と入力します。
- Value フィールドで、ファイルを探してフィールドにドラッグアンドドロップするか、設定パラメーターを手動で入力します。
-
Create をクリックすると、
ConfigMap
オブジェクトと設定情報が表示されます。
4.6.2. Insights Operator アラートについて
Insights Operator は、Prometheus モニタリングシステムを介して Alertmanager にアラートを宣言します。これらのアラートは、以下のいずれかの方法を使用して、OpenShift Container Platform Web コンソールのアラート UI で表示できます。
-
Administrator パースペクティブで、Observe
Alerting をクリックします。 -
Developer パースペクティブで、Observe
<project_name> Alerts タブをクリックします。
現在、Insights Operator は、条件が満たされたときに次のアラートを送信します。
アラート | 説明 |
---|---|
| Insights Operator が無効になっています。 |
| Red Hat Subscription Management で、Simple Content Access が有効になっていません。 |
| Insights に、クラスターに関するアクティブな推奨事項があります。 |
4.6.2.1. Insights Operator アラートの無効化
Insights Operator がクラスター Prometheus インスタンスにアラートを送信しないようにするには、insights-config ConfigMap
オブジェクトを作成または編集します。
以前は、クラスター管理者は、openshift-config
namespace の サポートシークレット を使用して Insights Operator 設定を作成または編集していました。Red Hat Insights が、Operator を設定するための ConfigMap
オブジェクトの作成をサポートするようになりました。両方とも存在する場合、Operator はサポートシークレットよりも config map 設定を優先します。
insights-config ConfigMap
オブジェクトが存在しない場合は、カスタム設定を初めて追加するときに作成する必要があります。ConfigMap
オブジェクト内の設定は、config/pod.yaml
ファイルで定義されているデフォルト設定よりも優先されることに注意してください。
前提条件
- リモートヘルスレポートが有効になっている (デフォルト)。
-
OpenShift Container Platform Web コンソールに
cluster-admin
としてログインしている。 -
insights-config
ConfigMap
オブジェクトが、openshift-insights
namespace に存在する。
手順
-
Workloads
ConfigMaps に移動し、Project: openshift-insights を選択します。 -
insights-config
ConfigMap
オブジェクトをクリックして開きます。 - Actions をクリックし、Edit ConfigMap を選択します。
- YAML view のラジオボタンをクリックします。
ファイル内で、
alerting
属性をdisabled: true
に設定します。apiVersion: v1 kind: ConfigMap # ... data: config.yaml: | alerting: disabled: true # ...
- Save をクリックします。insights-config config-map の詳細ページが開きます。
-
config.yaml
のalerting
属性の値がdisabled: true
に設定されていることを確認します。
変更を保存すると、Insights Operator はクラスターの Prometheus インスタンスにアラートを送信しなくなります。
4.6.2.2. Insights Operator アラートの有効化
アラートを無効にすると、Insights Operator はクラスター Prometheus インスタンスにアラートを送信しなくなります。アラートは再度有効にできます。
以前は、クラスター管理者は、openshift-config
namespace の サポートシークレット を使用して Insights Operator 設定を作成または編集していました。Red Hat Insights が、Operator を設定するための ConfigMap
オブジェクトの作成をサポートするようになりました。両方とも存在する場合、Operator はサポートシークレットよりも config map 設定を優先します。
前提条件
- リモートヘルスレポートが有効になっている (デフォルト)。
-
OpenShift Container Platform Web コンソールに
cluster-admin
としてログインしている。 -
insights-config
ConfigMap
オブジェクトが、openshift-insights
namespace に存在する。
手順
-
Workloads
ConfigMaps に移動し、Project: openshift-insights を選択します。 -
insights-config
ConfigMap
オブジェクトをクリックして開きます。 - Actions をクリックし、Edit ConfigMap を選択します。
- YAML view のラジオボタンをクリックします。
ファイル内で、
alerting
属性をdisabled: false
に設定します。apiVersion: v1 kind: ConfigMap # ... data: config.yaml: | alerting: disabled: false # ...
- Save をクリックします。insights-config config-map の詳細ページが開きます。
-
config.yaml
のalerting
属性の値がdisabled: false
に設定されていることを確認します。
変更を保存すると、Insights Operator はクラスター Prometheus インスタンスにアラートを再度送信します。
4.6.3. Insights Operator アーカイブのダウンロード
Insights Operator は、収集したデータをクラスターの openshift-insights
namespace にあるアーカイブに保存します。Insights Operator によって収集されたデータをダウンロードして確認できます。
前提条件
-
cluster-admin
ロールを持つユーザーとしてクラスターにアクセスできる。
手順
Insights Operator の実行中の Pod の名前を見つけます。
$ oc get pods --namespace=openshift-insights -o custom-columns=:metadata.name --no-headers --field-selector=status.phase=Running
Insights Operator で収集される最近のデータアーカイブをコピーします。
$ oc cp openshift-insights/<insights_operator_pod_name>:/var/lib/insights-operator ./insights-data 1
- 1
<insights_operator_pod_name>
を、前のコマンドから出力された Pod 名に置き換えます。
最近の Insights Operator アーカイブが insights-data
ディレクトリーで利用可能になります。
4.6.4. Insights Operator の収集操作の実行
Insights Operator データ収集操作をオンデマンドで実行できます。次の手順では、OpenShift Web コンソールまたは CLI を使用して収集操作のデフォルトのリストを実行する方法を説明します。オンデマンド収集機能をカスタマイズして、選択した収集操作を除外できます。デフォルトのリストからの収集操作を無効にすると、クラスターに効果的な推奨事項を提供する Insights Advisor の機能が低下します。クラスター内で Insights Operator の収集操作を無効にしていた場合は、この手順がそれらのパラメーターをオーバーライドします。
DataGather
カスタムリソースはテクノロジープレビューのみの機能です。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビューの機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行いフィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
クラスターでテクノロジープレビューを有効にすると、Insights Operator は個々の Pod で収集操作を実行します。これは、Insights Operator のテクノロジープレビュー機能セットの一部であり、新しいデータ収集機能をサポートします。
4.6.4.1. Insights Operator の収集期間の表示
Insights Operator がアーカイブに含まれる情報を収集する際にかかる時間を表示できます。これは、Insights Operator のリソースの使用状況と Insights Advisor の問題を理解する上で役立ちます。
前提条件
- Insights Operator アーカイブの最新のコピー。
手順
アーカイブから
/insights-operator/gathers.json
を開きます。このファイルには、Insights Operator 収集操作のリストが含まれています。
{ "name": "clusterconfig/authentication", "duration_in_ms": 730, 1 "records_count": 1, "errors": null, "panic": null }
- 1
duration_in_ms
は、各収集操作にかかるミリ秒単位の時間です。
- 各収集操作に異常がないか検査します。
4.6.4.2. Web コンソールから Insights Operator の収集操作を実行する
データを収集するには、OpenShift Container Platform Web コンソールを使用して Insights Operator の収集操作を実行できます。
前提条件
-
cluster-admin
ロールを持つユーザーとして OpenShift Container Platform Web コンソールにログインしている。
手順
-
コンソールで、Administration
CustomResourceDefinitions を選択します。 - CustomResourceDefinitions ページの Search by name フィールドで DataGather リソース定義を見つけ、クリックします。
-
コンソールで、Administration
CustomResourceDefinitions を選択します。 - CustomResourceDefinitions ページの Search by name フィールドで DataGather リソース定義を見つけ、クリックします。
- CustomResourceDefinition details ページで、Instances タブをクリックします。
- Create DataGather をクリックします。
新しい
DataGather
操作を作成するには、次の設定ファイルを編集し、変更を保存します。apiVersion: insights.openshift.io/v1alpha1 kind: DataGather metadata: name: <your_data_gather> 1 spec: gatherers: 2 - name: workloads state: Disabled
収集操作の名前に periodic-gathering-
の接頭辞は追加しないでください。この文字列は他の管理操作用に予約されており、意図した収集操作に影響を及ぼす可能性があります。
検証
-
コンソールで Workloads
Pods を選択します。 - Pods ページで Project プルダウンメニューに移動し、Show default projects を選択します。
-
Project プルダウンメニューから
openshift-insights
プロジェクトを選択します。 -
コンソールで Workloads
Pods を選択します。 - Pods ページで Project プルダウンメニューに移動し、Show default projects を選択します。
-
Project プルダウンメニューから
openshift-insights
プロジェクトを選択します。 -
openshift-insights
プロジェクトの Pod のリストで、新しい収集オペレーションに選択した名前の接頭辞が付いていることを確認します。完了すると、Insights Operator は処理のためにデータを Red Hat に自動的にアップロードします。
4.6.4.3. OpenShift CLI から Insights Operator 収集操作を実行する
OpenShift Container Platform コマンドラインインターフェイスを使用して、Insights Operator 収集操作を実行できます。
前提条件
-
cluster-admin
ロールを持つユーザーとして OpenShift Container Platform にログインしている。
手順
次のコマンドを入力して、収集操作を実行します。
$ oc apply -f <your_datagather_definition>.yaml
<your_datagather_definition>.yaml
を、以下のパラメーターが含まれる設定ファイルに置き換えます。apiVersion: insights.openshift.io/v1alpha1 kind: DataGather metadata: name: <your_data_gather> 1 spec: gatherers: 2 - name: workloads state: Disabled
収集操作の名前に periodic-gathering-
の接頭辞は追加しないでください。この文字列は他の管理操作用に予約されており、意図した収集操作に影響を及ぼす可能性があります。
検証
-
openshift-insights
プロジェクトの Pod のリストで、新しい収集オペレーションに選択した名前の接頭辞が付いていることを確認します。完了すると、Insights Operator は処理のためにデータを Red Hat に自動的にアップロードします。
4.6.4.4. Insights Operator の収集操作の無効化
Insights Operator の収集操作を無効にすることができます。収集操作を無効にすると、Insights Operator が Insights クラスターレポートを収集して Red Hat に送信しなくなるため、組織のプライバシーを高めることができます。これにより、クラスター転送などの Red Hat との通信を必要とする他のコア機能に影響を与えることなく、クラスターの Insights 分析と推奨事項が無効になります。Insights Operator アーカイブの /insights-operator/gathers.json
ファイルから、クラスターに対して試行された収集操作のリストを表示できます。一部の収集操作は、特定の条件が満たされた場合にのみ発生し、最新のアーカイブには表示されない可能性があることに注意してください。
InsightsDataGather
カスタムリソースは、テクノロジープレビュー機能としてのみ提供されます。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビューの機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行いフィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
クラスターでテクノロジープレビューを有効にすると、Insights Operator は個々の Pod で収集操作を実行します。これは、Insights Operator のテクノロジープレビュー機能セットの一部であり、新しいデータ収集機能をサポートします。
前提条件
-
cluster-admin
ロールを持つユーザーとして OpenShift Container Platform Web コンソールにログインしている。
手順
-
Administration
CustomResourceDefinitions に移動します。 - CustomResourceDefinitions ページで、Search by name フィールドを使用して InsightsDataGather リソース定義を見つけてクリックします。
- CustomResourceDefinition details ページで、Instances タブをクリックします。
- cluster をクリックし、YAML タブをクリックします。
InsightsDataGather
設定ファイルに対して次のいずれかの編集を実行して、収集操作を無効にします。すべての収集操作を無効にするには、
disabledGatherers
キーの下にall
を入力します。apiVersion: config.openshift.io/v1alpha1 kind: InsightsDataGather metadata: .... spec: 1 gatherConfig: disabledGatherers: - all 2
個々の収集操作を無効にするには、
disabledGatherers
キーの下に値を入力します。spec: gatherConfig: disabledGatherers: - clusterconfig/container_images 1 - clusterconfig/host_subnets - workloads/workload_info
- 1
- 個別収集操作の例
Save をクリックします。
変更を保存すると、Insights Operator の収集設定が更新され、操作は行われなくなります。
収集操作を無効にすると、クラスターに効果的な推奨事項を提供する Insights Advisor の機能が低下します。
4.6.4.5. Insights Operator の収集操作の有効化
収集操作が無効になっている場合は、Insights Operator の収集操作を有効にできます。
InsightsDataGather
カスタムリソースは、テクノロジープレビュー機能としてのみ提供されます。テクノロジープレビュー機能は、Red Hat 製品のサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではないことがあります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビューの機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行いフィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
前提条件
-
cluster-admin
ロールを持つユーザーとして OpenShift Container Platform Web コンソールにログインしている。
手順
-
Administration
CustomResourceDefinitions に移動します。 - CustomResourceDefinitions ページで、Search by name フィールドを使用して InsightsDataGather リソース定義を見つけてクリックします。
- CustomResourceDefinition details ページで、Instances タブをクリックします。
- cluster をクリックし、YAML タブをクリックします。
次のいずれかの編集を実行して、収集操作を有効にします。
無効になっているすべての収集操作を有効にするには、
gatherConfig
スタンザを削除します。apiVersion: config.openshift.io/v1alpha1 kind: InsightsDataGather metadata: .... spec: gatherConfig: 1 disabledGatherers: all
- 1
- すべての収集操作を有効にするには、
gatherConfig
スタンザを削除します。
個々の収集操作を有効にするには、
disabledGatherers
キーの下の値を削除します。spec: gatherConfig: disabledGatherers: - clusterconfig/container_images 1 - clusterconfig/host_subnets - workloads/workload_info
- 1
- 1 つ以上の収集操作を削除します。
Save をクリックします。
変更を保存すると、Insights Operator の収集設定が更新され、その影響を受けた収集操作が開始します。
収集操作を無効にすると、クラスターに効果的な推奨事項を提供する Insights Advisor の機能が低下します。
4.6.5. Deployment Validation Operator のデータの難読化
Deployment Validation Operator (DVO) がインストールされている場合、クラスター管理者は、この Operator からのデータを難読化するように Insight Operator を設定できます。workload_names
値を insights-config ConfigMap
オブジェクトに追加すると、UID ではなくワークロード名が Insights for Openshift に表示され、クラスター管理者が認識しやすくなります。
前提条件
- リモートヘルスレポートが有効になっている (デフォルト)。
- "cluster-admin" ロールを使用して OpenShift Container Platform Web コンソールにログインしている。
-
insights-config
ConfigMap
オブジェクトが、openshift-insights
namespace に存在する。 - クラスターがセルフマネージドであり、Deployment Validation Operator がインストールされている。
手順
-
Workloads
ConfigMaps に移動し、Project: openshift-insights を選択します。 -
insights-config
ConfigMap
オブジェクトをクリックして開きます。 - Actions をクリックし、Edit ConfigMap を選択します。
- YAML view のラジオボタンをクリックします。
ファイル内で、
workload_names
値を使用してobfuscation
属性を設定します。apiVersion: v1 kind: ConfigMap # ... data: config.yaml: | dataReporting: obfuscation: - workload_names # ...
- Save をクリックします。insights-config config-map の詳細ページが開きます。
-
config.yaml
のobfuscation
属性の値が- workload_names
に設定されていることを確認します。