4.5. Insights Operator の使用
Insights Operator は設定およびコンポーネントの障害ステータスを定期的に収集し、デフォルトで 2 時間ごとにそのデータを Red Hat に報告します。この情報により、Red Hat は設定や Telemetry で報告されるデータよりも深層度の高いデータを評価できます。OpenShift Container Platform のユーザーは、Red Hat Hybrid Cloud Console の Insights Advisor サービスにレポートを表示できます。
4.5.1. 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.5.2. Insights Operator アラートの無効化 リンクのコピーリンクがクリップボードにコピーされました!
Insights Operator がクラスター Prometheus インスタンスにアラートを送信しないようにするには、support
シークレットを編集します。support
シークレットが存在しない場合は、最初にカスタム設定を追加する際に作成する必要があります。support
シークレット内の設定は、pod.yaml
ファイルで定義されているデフォルト設定よりも優先されることに注意してください。Insights Operator がクラスター Prometheus インスタンスにアラートを送信しないようにするには、support
シークレットを編集します。この secret
は、デフォルトで作成されることに注意してください。support シークレットに保存されている設定は、pod.yaml
ファイルで指定されているデフォルト設定よりも優先されます。
前提条件
- リモートヘルスレポートが有効になっている (デフォルト)。
-
OpenShift Container Platform Web コンソールに
cluster-admin
としてログインしている。
手順
-
Workloads
Secrets に移動します。 - Secrets ページで、Project リストから All Projects を選択し、Show default projects をオンに設定します。
- Projects リストから openshift-config プロジェクトを選択します。
Search by name フィールドを使用して、support シークレットを検索します。
- シークレットが存在する場合は以下を実行します。
-
Options メニュー
をクリックしてから Edit Secret をクリックします。
Add Key/Value をクリックします。
-
Key フィールドに
disableInsightsAlerts
を入力します。 Value フィールドに
True
を入力します。- シークレットが存在しない場合は以下を実行します。
Create
Key/value secret をクリックします。 -
Secret name フィールドに
support
を入力します。 -
Key フィールドに
disableInsightsAlerts
を入力します。 -
Value フィールドに
True
を入力します。
-
Secret name フィールドに
- Create をクリックします。
-
Key フィールドに
変更を保存すると、Insights Operator はクラスターの Prometheus インスタンスにアラートを送信しなくなります。
4.5.3. Insights Operator アラートの有効化 リンクのコピーリンクがクリップボードにコピーされました!
アラートを無効にすると、Insights Operator はクラスター Prometheus インスタンスにアラートを送信しなくなります。この動作は変更できます。
前提条件
- リモートヘルスレポートが有効になっている (デフォルト)。
-
OpenShift Container Platform Web コンソールに
cluster-admin
としてログインしている。
手順
-
Workloads
Secrets に移動します。 - Secrets ページで、Project リストから All Projects を選択し、Show default projects を ON に設定します。
- Projects リストから openshift-config プロジェクトを選択します。
- Search by name フィールドを使用して、support シークレットを検索します。
-
Options メニュー
をクリックしてから Edit Secret をクリックします。
-
disableInsightsAlerts
キーの場合、Value フィールドをfalse
に設定します。
変更を保存すると、Insights Operator はクラスター Prometheus インスタンスにアラートを再度送信します。
4.5.4. 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
$ oc get pods --namespace=openshift-insights -o custom-columns=:metadata.name --no-headers --field-selector=status.phase=Running
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Insights Operator で収集される最近のデータアーカイブをコピーします。
oc cp openshift-insights/<insights_operator_pod_name>:/var/lib/insights-operator ./insights-data
$ oc cp openshift-insights/<insights_operator_pod_name>:/var/lib/insights-operator ./insights-data
1 Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
<insights_operator_pod_name>
を、前のコマンドから出力された Pod 名に置き換えます。
最近の Insights Operator アーカイブが insights-data
ディレクトリーで利用可能になります。
4.5.5. Insights Operator の収集期間の表示 リンクのコピーリンクがクリップボードにコピーされました!
Insights Operator がアーカイブに含まれる情報を収集する際にかかる時間を表示できます。これは、Insights Operator のリソースの使用状況と Insights Advisor の問題を理解する上で役立ちます。
前提条件
- Insights Operator アーカイブの最新のコピー。
手順
アーカイブから
/insights-operator/gathers.json
を開きます。このファイルには、Insights Operator 収集操作のリストが含まれています。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
duration_in_ms
は、各収集操作にかかるミリ秒単位の時間です。
- 各収集操作に異常がないか検査します。
4.5.6. 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
設定ファイルに対して次のいずれかの編集を実行して、収集操作を無効にします。Save をクリックします。
変更を保存すると、Insights Operator の収集設定が更新され、操作は行われなくなります。
収集操作を無効にすると、クラスターに効果的な推奨事項を提供する Insights Advisor サービスの機能が低下します。
4.5.7. 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 タブをクリックします。
次のいずれかの編集を実行して、収集操作を有効にします。
Save をクリックします。
変更を保存すると、Insights Operator の収集設定が更新され、その影響を受けた収集操作が開始します。
収集操作を無効にすると、クラスターに効果的な推奨事項を提供する Insights Advisor の機能が低下します。
4.5.8. 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.5.8.1. Web コンソールを使用した Insights Operator 収集操作の実行 リンクのコピーリンクがクリップボードにコピーされました!
OpenShift Container Platform Web コンソールを使用して、Insights Operator 収集操作を実行できます。
前提条件
-
cluster-admin
ロールを持つユーザーとして OpenShift Container Platform Web コンソールにログインしている。
手順
-
Administration
CustomResourceDefinitions に移動します。 - CustomResourceDefinitions ページで、Search by name フィールドを使用して DataGather リソース定義を見つけてクリックします。
- CustomResourceDefinition details ページで、Instances タブをクリックします。
- Create DataGather をクリックします。
新しい
DataGather
オペレーションを作成するには、設定ファイルを編集します。Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Save をクリックします。
検証
-
Workloads
Pods に移動します。 - Pod ページで、Project プルダウンメニューを選択し、Show default projects を表示をオンにします。
-
Project プルダウンメニューから
openshift-insights
プロジェクトを選択します。 -
openshift-insights
プロジェクトの Pod のリストで、新しい収集オペレーションに選択した名前の接頭辞が付いていることを確認します。完了すると、Insights Operator は処理のためにデータを Red Hat に自動的にアップロードします。
4.5.8.2. OpenShift CLI を使用した Insights Operator 収集操作の実行 リンクのコピーリンクがクリップボードにコピーされました!
OpenShift Container Platform コマンドラインインターフェイスを使用して、Insights Operator の収集操作を実行できます。
前提条件
-
cluster-admin
ロールを持つユーザーとして OpenShift Container Platform にログインしている。
手順
次のコマンドを入力して、収集操作を実行します。
oc apply -f <your_datagather_definition>.yaml
$ oc apply -f <your_datagather_definition>.yaml
Copy to Clipboard Copied! Toggle word wrap Toggle overflow <your_datagather_definition>.yaml
を、次のパラメーターを使用した設定ファイルに置き換えます。Copy to Clipboard Copied! Toggle word wrap Toggle overflow
検証
-
openshift-insights
プロジェクトの Pod のリストで、新しい収集オペレーションに選択した名前の接頭辞が付いていることを確認します。完了すると、Insights Operator は処理のためにデータを Red Hat に自動的にアップロードします。
4.5.9. Insights Operator の設定 リンクのコピーリンクがクリップボードにコピーされました!
組織のニーズに合わせて Insights Operator を設定できます。Insights Operator は、Insights Operator Config
ディレクトリーの pod.yaml
ファイルのデフォルト設定と、openshift-config
namespace の support
シークレットに保存されている設定の組み合わせを使用して設定されます。support
シークレットはデフォルトでは存在しないため、初めてカスタム設定を追加するときに作成する必要があります。support
シークレットの設定は、pod.yaml
ファイルで設定されたデフォルトをオーバーライドします。
次の表に、使用可能な設定属性を示します。
Attribute name | 説明 | 値のタイプ | デフォルト値 |
---|---|---|---|
enableGlobalObfuscation
| IP アドレスとクラスタードメイン名のグローバル難読化を有効にします。 | Boolean |
|
endpoint
| アップロードエンドポイントを設定します。 | URL | |
clusterTransferEndpoint
| クラスター転送データを確認およびダウンロードするためのエンドポイント。 | URL | https://api.openshift.com/api/accounts_mgmt/v1/cluster_transfers/ |
clusterTransferInterval
| 利用可能なクラスター転送をチェックする頻度を設定します。 | 時間間隔 |
|
conditionalGathererEndpoint
| 条件付き収集ルール定義を提供するためのエンドポイントを設定します。 | URL | |
httpProxy, httpsProxy, noProxy
| Insights Operator のカスタムプロキシーを設定します。 | URL | デフォルトなし |
interval
| データの収集とアップロードの頻度を設定します。 | 時間間隔 |
|
reportEndpoint
|
最新の Insights 分析をダウンロードするためのエンドポイントを指定します。指定されたデフォルト値について、< | URL | https://console.redhat.com/api/insights-results-aggregator/v2/cluster/<cluster_id>/reports |
reportPullingDelay
| データアップロードとデータダウンロードの間の遅延を設定します。 | 時間間隔 |
|
reportPullingTimeout
| Insights ダウンロードリクエストのタイムアウト値を設定します。 | 時間間隔 |
|
reportMinRetryTime
| リクエストを再試行するタイミングを設定します。 | 時間間隔 |
|
scaEndpoint
| Simple Content Access (SCA) エンタイトルメントをダウンロードするためのエンドポイントを指定します。 | URL | https://api.openshift.com/api/accounts_mgmt/v1/entitlement_certificates |
scaInterval
| Simple Content Access エンタイトルメントのダウンロード頻度を指定します。 | 時間間隔 |
|
scaPullDisabled
| Simple Content Access エンタイトルメントのダウンロードを無効にします。 | Boolean |
|
4.5.9.1. insights-config ConfigMap オブジェクトの作成 リンクのコピーリンクがクリップボードにコピーされました!
この手順では、Insights Operator によるカスタム設定を行うための Insights-config ConfigMap
オブジェクトを作成する方法を説明します。
デフォルトの Insights Operator 設定を変更する前に、Red Hat サポートに相談することを推奨します。
前提条件
-
cluster-admin
ロールを持つユーザーとして OpenShift Container Platform Web コンソールにログインしている。
手順
-
Workloads
Secrets に移動します。 - Secrets ページで、Project リストから All Projects を選択し、Show default projects をオンに設定します。
- Project リストから openshift-config プロジェクトを選択します。
-
Search by name フィールドを使用して support シークレットを検索します。存在しない場合には、Create
Key/value secret をクリックして作成します。 -
シークレットの Options メニュー
をクリックし、Edit Secret をクリックします。
- Add Key/Value をクリックします。
- 適切な値を持つ属性名を入力し (上の表を参照)、Save をクリックします。
- 追加の設定について、上記の手順を繰り返します。