検索

4.6. Insights Operator の使用

download PDF

Insights Operator は設定およびコンポーネントの障害ステータスを定期的に収集し、デフォルトで 2 時間ごとにそのデータを Red Hat に報告します。この情報により、Red Hat は設定や Telemetry で報告されるデータよりも深層度の高いデータを評価できます。OpenShift Container Platform のユーザーは、Red Hat Hybrid Cloud Console の Insights Advisor サービスにレポートを表示できます。

関連情報

4.6.1. Insights Operator アラートについて

Insights Operator は、Prometheus モニタリングシステムを介して Alertmanager にアラートを宣言します。これらのアラートは、以下のいずれかの方法を使用して、OpenShift Container Platform Web コンソールのアラート UI で表示できます。

  • Administrator パースペクティブで、Observe Alerting をクリックします。
  • Developer パースペクティブで、Observe <project_name> Alerts タブをクリックします。

現在、Insights Operator は、条件が満たされたときに次のアラートを送信します。

表4.1 Insights Operator アラート
アラート説明

InsightsDisabled

Insights Operator が無効になっています。

SimpleContentAccessNotAvailable

Red Hat Subscription Management で、Simple Content Access が有効になっていません。

InsightsRecommendationActive

Insights に、クラスターに関するアクティブな推奨事項があります。

4.6.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 としてログインしている。

手順

  1. Workloads Secrets に移動します。
  2. Secrets ページで、Project リストから All Projects を選択し、Show default projects をオンに設定します。
  3. Projects リストから openshift-config プロジェクトを選択します。
  4. Search by name フィールドを使用して、support シークレットを検索します。

    • シークレットが存在する場合は以下を実行します。
  5. Options メニュー kebab をクリックしてから Edit Secret をクリックします。
  6. Add Key/Value をクリックします。

    1. Key フィールドに disableInsightsAlerts を入力します。
    2. Value フィールドに True を入力します。

      • シークレットが存在しない場合は以下を実行します。
    3. Create Key/value secret をクリックします。

      1. Secret name フィールドに support を入力します。
      2. Key フィールドに disableInsightsAlerts を入力します。
      3. Value フィールドに True を入力します。
    4. Create をクリックします。

変更を保存すると、Insights Operator はクラスターの Prometheus インスタンスにアラートを送信しなくなります。

4.6.3. Insights Operator アラートの有効化

アラートを無効にすると、Insights Operator はクラスター Prometheus インスタンスにアラートを送信しなくなります。この動作は変更できます。

前提条件

  • リモートヘルスレポートが有効になっている (デフォルト)。
  • OpenShift Container Platform Web コンソールに cluster-admin としてログインしている。

手順

  1. Workloads Secrets に移動します。
  2. Secrets ページで、Project リストから All Projects を選択し、Show default projectsON に設定します。
  3. Projects リストから openshift-config プロジェクトを選択します。
  4. Search by name フィールドを使用して、support シークレットを検索します。
  5. Options メニュー kebab をクリックしてから Edit Secret をクリックします。
  6. disableInsightsAlerts キーの場合、Value フィールドを false に設定します。

変更を保存すると、Insights Operator はクラスター Prometheus インスタンスにアラートを再度送信します。

4.6.4. Insights Operator アーカイブのダウンロード

Insights Operator は、収集したデータをクラスターの openshift-insights namespace にあるアーカイブに保存します。Insights Operator によって収集されたデータをダウンロードして確認できます。

前提条件

  • cluster-admin ロールを持つユーザーとしてクラスターにアクセスできる。

手順

  1. Insights Operator の実行中の Pod の名前を見つけます。

    $ oc get pods --namespace=openshift-insights -o custom-columns=:metadata.name --no-headers  --field-selector=status.phase=Running
  2. 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.5. Insights Operator の収集期間の表示

Insights Operator がアーカイブに含まれる情報を収集する際にかかる時間を表示できます。これは、Insights Operator のリソースの使用状況と Insights Advisor の問題を理解する上で役立ちます。

前提条件

  • Insights Operator アーカイブの最新のコピー。

手順

  1. アーカイブから /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 は、各収集操作にかかるミリ秒単位の時間です。
  2. 各収集操作に異常がないか検査します。

4.6.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 コンソールにログインしている。

手順

  1. Administration CustomResourceDefinitions に移動します。
  2. CustomResourceDefinitions ページで、Search by name フィールドを使用して InsightsDataGather リソース定義を見つけてクリックします。
  3. CustomResourceDefinition details ページで、Instances タブをクリックします。
  4. cluster をクリックし、YAML タブをクリックします。
  5. InsightsDataGather 設定ファイルに対して次のいずれかの編集を実行して、収集操作を無効にします。

    1. すべての収集操作を無効にするには、disabledGatherers キーの下に all を入力します。

      apiVersion: config.openshift.io/v1alpha1
      kind: InsightsDataGather
      metadata:
      ....
      
      spec: 1
        gatherConfig:
          disabledGatherers:
            - all 2
      1
      spec パラメーターは、収集設定を指定します。
      2
      all 値は、すべての収集操作を無効にします。
    2. 個々の収集操作を無効にするには、disabledGatherers キーの下に値を入力します。

      spec:
        gatherConfig:
          disabledGatherers:
            - clusterconfig/container_images 1
            - clusterconfig/host_subnets
            - workloads/workload_info
      1
      個別収集操作の例
  6. Save をクリックします。

    変更を保存すると、Insights Operator の収集設定が更新され、操作は行われなくなります。

注記

収集操作を無効にすると、クラスターに効果的な推奨事項を提供する Insights Advisor の機能が低下します。

4.6.7. Insights Operator の収集操作の有効化

収集操作が無効になっている場合は、Insights Operator の収集操作を有効にできます。

重要

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

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

前提条件

  • cluster-admin ロールを持つユーザーとして OpenShift Container Platform Web コンソールにログインしている。

手順

  1. Administration CustomResourceDefinitions に移動します。
  2. CustomResourceDefinitions ページで、Search by name フィールドを使用して InsightsDataGather リソース定義を見つけてクリックします。
  3. CustomResourceDefinition details ページで、Instances タブをクリックします。
  4. cluster をクリックし、YAML タブをクリックします。
  5. 次のいずれかの編集を実行して、収集操作を有効にします。

    • 無効になっているすべての収集操作を有効にするには、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 つ以上の収集操作を削除します。
  6. Save をクリックします。

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

注記

収集操作を無効にすると、クラスターに効果的な推奨事項を提供する Insights Advisor の機能が低下します。

4.6.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.6.8.1. Web コンソールを使用した Insights Operator 収集操作の実行

OpenShift Container Platform Web コンソールを使用して、Insights Operator 収集操作を実行できます。

前提条件

  • cluster-admin ロールを持つユーザーとして OpenShift Container Platform Web コンソールにログインしている。

手順

  1. Administration CustomResourceDefinitions に移動します。
  2. CustomResourceDefinitions ページで、Search by name フィールドを使用して DataGather リソース定義を見つけてクリックします。
  3. CustomResourceDefinition details ページで、Instances タブをクリックします。
  4. Create DataGather をクリックします。
  5. 新しい DataGather オペレーションを作成するには、設定ファイルを編集します。

    apiVersion: insights.openshift.io/v1alpha1
    kind: DataGather
    metadata:
      name: <your_data_gather> 1
    spec:
     gatherers: 2
       - name: workloads
         state: Disabled
    1
    <your_data_gather> を収集操作の一意の名前に置き換えます。
    2
    gatherers パラメーターで無効にする個々の収集操作を入力します。この例では、workloads データ収集操作を無効にし、残りのデフォルト操作を実行します。デフォルトの収集操作の完全なリストを実行するには、spec パラメーターを空のままにしておきます。収集操作の完全なリストは、Insights Operator のドキュメントで確認できます。
  6. Save をクリックします。

検証

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

4.6.8.2. 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
    1
    <your_data_gather> を収集操作の一意の名前に置き換えます。
    2
    gatherers パラメーターで無効にする個々の収集操作を入力します。この例では、workloads データ収集操作を無効にし、残りのデフォルト操作を実行します。デフォルトの収集操作の完全なリストを実行するには、spec パラメーターを空のままにしておきます。収集操作の完全なリストは、Insights Operator のドキュメントで確認できます。

検証

  • openshift-insights プロジェクトの Pod のリストで、新しい収集オペレーションに選択した名前の接頭辞が付いていることを確認します。完了すると、Insights Operator は処理のためにデータを Red Hat に自動的にアップロードします。

4.6.9. Insights Operator の設定

組織のニーズに合わせて Insights Operator を設定できます。Insights Operator は、Insights Operator Config ディレクトリーの pod.yaml ファイルのデフォルト設定と、openshift-config namespace の support シークレットに保存されている設定の組み合わせを使用して設定されます。support シークレットはデフォルトでは存在しないため、初めてカスタム設定を追加するときに作成する必要があります。support シークレットの設定は、pod.yaml ファイルで設定されたデフォルトをオーバーライドします。

次の表に、使用可能な設定属性を示します。

表4.2 Insights Operator の設定可能な属性
Attribute name説明値のタイプデフォルト値

enableGlobalObfuscation

IP アドレスとクラスタードメイン名のグローバル難読化を有効にします。

ブール値

false

scaInterval

Simple Content Access エンタイトルメントのダウンロード頻度を指定します。

時間間隔

8h

scaPullDisabled

Simple Content Access エンタイトルメントのダウンロードを無効にします。

ブール値

false

clusterTransferInterval

Insights Operator が使用可能なクラスター転送について OpenShift Cluster Manager をチェックする頻度を指定します。

時間間隔

24h

disableInsightsAlerts

クラスター Prometheus インスタンスへの Insights Operator アラートを無効にします。

ブール値

False

httpProxyhttpsProxynoProxy

Insights Operator のカスタムプロキシーを設定する

URL

デフォルトなし

この手順では、カスタムの Insights Operator 設定を行う方法について説明します。

重要

デフォルトの Insights Operator 設定を変更する前に、Red Hat サポートに相談することを推奨します。

前提条件

  • cluster-admin ロールを持つユーザーとして OpenShift Container Platform Web コンソールにログインしている。

手順

  1. Workloads Secrets に移動します。
  2. Secrets ページで、Project リストから All Projects を選択し、Show default projects をオンに設定します。
  3. Project リストから openshift-config プロジェクトを選択します。
  4. Search by name フィールドを使用して support シークレットを検索します。存在しない場合には、Create Key/value secret をクリックして作成します。
  5. シークレットの Options メニュー kebab をクリックし、Edit Secret をクリックします。
  6. Add Key/Value をクリックします。
  7. 適切な値を持つ属性名を入力し (上の表を参照)、Save をクリックします。
  8. 追加の設定について、上記の手順を繰り返します。
Red Hat logoGithubRedditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

© 2024 Red Hat, Inc.