Logging

1. must-gather 情報を保存する必要のあるディレクトリーに移動します。

2. ログイメージに対して oc adm must-gather コマンドを実行します。

   $ oc adm must-gather --image=$(oc -n openshift-logging get deployment.apps/cluster-logging-operator -o jsonpath='{.spec.template.spec.containers[?(@.name == "cluster-logging-operator")].image}')

   must-gather ツールは、現行ディレクトリー内の must-gather.local で始まる新規ディレクトリーを作成します。例: must-gather.local.4157245944708210408

3. 作成された must-gather ディレクトリーから圧縮ファイルを作成します。たとえば、Linux オペレーティングシステムを使用するコンピューターで以下のコマンドを実行します。

   $ tar -cvaf must-gather.tar.gz must-gather.local.4157245944708210408

4. 圧縮ファイルを Red Hat カスタマーポータル で作成したサポートケースに添付します。

手順

1. OperatorHub から Red Hat OpenShift Logging Operator、Loki Operator、および Cluster Observability Operator (COO) をインストールします。

2. openshift-logging namespace に LokiStack カスタムリソース (CR) を作成します。

   apiVersion: loki.grafana.com/v1
   kind: LokiStack
   metadata:
     name: logging-loki
     namespace: openshift-logging
   spec:
     managementState: Managed
     size: 1x.extra-small
     storage:
       schemas:
       - effectiveDate: '2024-10-01'
         version: v13
       secret:
         name: logging-loki-s3
         type: s3
     storageClassName: gp3-csi
     tenants:
       mode: openshift-logging

   注記

   事前に logging-loki-s3 シークレットが事前に作成されていることを確認します。このシークレットの内容は、使用しているオブジェクトストレージにより異なります。詳細は、シークレットと TLS 設定を参照してください。

3. コレクターのサービスアカウントを作成します。

   $ oc create sa collector -n openshift-logging

4. コレクターのサービスアカウントによる LokiStack CR へのデータ書き込みを許可します。

   $ oc adm policy add-cluster-role-to-user logging-collector-logs-writer -z collector -n openshift-logging

   注記

   ClusterRole リソースは、Cluster Logging Operato のインストール中に自動的に作成されるため、手動で作成する必要はありません。

5. ログを収集するために、次のコマンドを実行してコレクターのサービスアカウントを使用します。

   $ oc adm policy add-cluster-role-to-user collect-application-logs -z collector -n openshift-logging

   $ oc adm policy add-cluster-role-to-user collect-audit-logs -z collector -n openshift-logging

   $ oc adm policy add-cluster-role-to-user collect-infrastructure-logs -z collector -n openshift-logging

   注記

   この例では、コレクターを 3 つのロール (アプリケーション、インフラストラクチャー、監査) すべてにバインドしますが、デフォルトでは、アプリケーションログとインフラストラクチャーログのみが収集されます。監査ログを収集するには、ClusterLogForwarder 設定を更新して監査ログを含めます。環境に必要な特定のログタイプに基づきロールを割り当てます。

6. UIPlugin CR を作成して、Observe タブの Log セクションを有効にします。

   apiVersion: observability.openshift.io/v1alpha1
   kind: UIPlugin
   metadata:
     name: logging
   spec:
     type: Logging
     logging:
       lokiStack:
         name: logging-loki

7. ClusterLogForwarder CR を作成して、ログ転送を設定します。

   apiVersion: observability.openshift.io/v1
   kind: ClusterLogForwarder
   metadata:
     name: collector
     namespace: openshift-logging
   spec:
     serviceAccount:
       name: collector
     outputs:
     - name: default-lokistack
       type: lokiStack
       lokiStack:
         authentication:
           token:
             from: serviceAccount
         target:
           name: logging-loki
           namespace: openshift-logging
       tls:
         ca:
           key: service-ca.crt
           configMapName: openshift-service-ca.crt
     pipelines:
     - name: default-logstore
       inputRefs:
       - application
       - infrastructure
       outputRefs:
       - default-lokistack

   注記

   dataModel フィールドはオプションであり、デフォルトでは未設定 (dataModel: "") になっています。これにより、Cluster Logging Operator (CLO) はデータモデルを自動的に選択できるようになります。現在、このフィールドが設定されていない場合の CLO はデフォルトで ViaQ モデルになりますが、これは今後のリリースで変更される予定です。dataModel: ViaQ を指定すると、デフォルトが変更されても設定の互換性が維持されます。

手順

1. OperatorHub から、Red Hat OpenShift Logging Operator、Loki Operator、Cluster Observability Operator (COO) をインストールします。

2. openshift-logging namespace に LokiStack カスタムリソース (CR) を作成します。

   apiVersion: loki.grafana.com/v1
   kind: LokiStack
   metadata:
     name: logging-loki
     namespace: openshift-logging
   spec:
     managementState: Managed
     size: 1x.extra-small
     storage:
       schemas:
       - effectiveDate: '2024-10-01'
         version: v13
       secret:
         name: logging-loki-s3
         type: s3
     storageClassName: gp3-csi
     tenants:
       mode: openshift-logging

   注記

   事前に logging-loki-s3 シークレットが事前に作成されていることを確認します。このシークレットの内容は、使用しているオブジェクトストレージにより異なります。詳細は、「シークレットと TLS 設定」を参照してください。

3. コレクターのサービスアカウントを作成します。

   $ oc create sa collector -n openshift-logging

4. コレクターのサービスアカウントによる LokiStack CR へのデータ書き込みを許可します。

   $ oc adm policy add-cluster-role-to-user logging-collector-logs-writer -z collector

   注記

   ClusterRole リソースは、Cluster Logging Operato のインストール中に自動的に作成されるため、手動で作成する必要はありません。

5. コレクターのサービスアカウントによるログ収集を許可します。

   $ oc project openshift-logging

   $ oc adm policy add-cluster-role-to-user collect-application-logs -z collector

   $ oc adm policy add-cluster-role-to-user collect-audit-logs -z collector

   $ oc adm policy add-cluster-role-to-user collect-infrastructure-logs -z collector

   注記

   この例では、コレクターを 3 つのロール (アプリケーション、インフラストラクチャー、監査) すべてにバインドします。デフォルトでは、アプリケーションログとインフラストラクチャーログのみが収集されます。監査ログを収集するには、ClusterLogForwarder 設定を更新して監査ログを含めます。環境に必要な特定のログタイプに基づきロールを割り当てます。

6. UIPlugin CR を作成して、Observe タブの Log セクションを有効にします。

   apiVersion: observability.openshift.io/v1alpha1
   kind: UIPlugin
   metadata:
     name: logging
   spec:
     type: Logging
     logging:
       lokiStack:
         name: logging-loki

7. ClusterLogForwarder CR を作成して、ログ転送を設定します。

   apiVersion: observability.openshift.io/v1
   kind: ClusterLogForwarder
   metadata:
     name: collector
     namespace: openshift-logging
     annotations:
       observability.openshift.io/tech-preview-otlp-output: "enabled" 1
   spec:
     serviceAccount:
       name: collector
     outputs:
     - name: loki-otlp
       type: lokiStack 2
       lokiStack:
         target:
           name: logging-loki
           namespace: openshift-logging
         dataModel: Otel 3
         authentication:
           token:
             from: serviceAccount
       tls:
         ca:
           key: service-ca.crt
           configMapName: openshift-service-ca.crt
     pipelines:
     - name: my-pipeline
       inputRefs:
       - application
       - infrastructure
       outputRefs:
       - loki-otlp

   1

   アノテーションを使用して、テクノロジープレビュー機能である Otel データモデルを有効にします。

   2

   出力タイプを lokiStack として定義します。

   3

   OpenTelemetry データモデルを指定します。

   注記

   dataModel が Otel の場合、lokiStack.labelKeys は使用できません。dataModel が Otel の場合に同様の機能を得るには、「OTLP データ取り込み用の LokiStack 設定」を参照してください。

手順

1. Loki Operator の Namespace オブジェクトを作成します。

   Namespace オブジェクトの例

   apiVersion: v1
   kind: Namespace
   metadata:
     name: openshift-operators-redhat 1
     labels:
       openshift.io/cluster-monitoring: "true" 2

   1

   namespace として openshift-operators-redhat を指定する必要があります。Operator の監視を有効にするには、openshift-operators-redhat namespace ではなく openshift-operators namespace からメトリクスを取得するように Cluster Monitoring Operator を設定します。openshift-operators namespace には、信頼されていないコミュニティー Operator が含まれている可能性があります。コミュニティー Operator は、OpenShift Container Platform メトリクスと同じ名前のメトリクスを公開して競合を引き起こす可能性があります。

   2

   クラスターモニタリングが openshift-operators-redhat namespace をスクレイピングできるようにするために、示されているラベルを指定する文字列値。

2. 次のコマンドを実行して、Namespace オブジェクトを適用します。

   $ oc apply -f <filename>.yaml

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

   OperatorGroup オブジェクトのサンプル

   apiVersion: operators.coreos.com/v1
   kind: OperatorGroup
   metadata:
     name: loki-operator
     namespace: openshift-operators-redhat 1
   spec:
     upgradeStrategy: Default

   1

   namespace として openshift-operators-redhat を指定する必要があります。

4. 以下のコマンドを実行して OperatorGroup オブジェクトを適用します。

   $ oc apply -f <filename>.yaml

5. Loki Operator の Subscription オブジェクトを作成します。

   Subscription オブジェクトの例

   apiVersion: operators.coreos.com/v1alpha1
   kind: Subscription
   metadata:
     name: loki-operator
     namespace: openshift-operators-redhat 1
   spec:
     channel: stable-6.<y> 2
     installPlanApproval: Automatic 3
     name: loki-operator
     source: redhat-operators 4
     sourceNamespace: openshift-marketplace

   1

   namespace として openshift-operators-redhat を指定する必要があります。

   2

   チャネルとして stable-6.<y> を指定します。

   3

   サブスクリプションの承認ストラテジーが Automatic に設定されている場合、選択したチャネルで新しい Operator バージョンが利用可能になると、すぐに更新プロセスが開始します。承認ストラテジーが Manual に設定されている場合は、保留中のアップグレードを手動で承認する必要があります。

   4

   値として redhat-operators を指定します。OpenShift Container Platform クラスターが制限付きネットワークにインストールされている場合 (非接続クラスターの場合)、Operator Lifecycle Manager (OLM) の設定時に作成した CatalogSource オブジェクトの名前を指定します。

6. 以下のコマンドを実行して Subscription オブジェクトを適用します。

   $ oc apply -f <filename>.yaml

7. LokiStack をデプロイするための namespace オブジェクトを作成します。

   namespace オブジェクトの例

   apiVersion: v1
   kind: Namespace
   metadata:
     name: openshift-logging 1
     labels:
       openshift.io/cluster-monitoring: "true" 2

   1

   openshift-logging namespace は、すべてのロギングワークロード専用です。

   2

   クラスターモニタリングによって openshift-logging namespace をスクレイピングするためのラベル (上記参照) を指定する文字列値。

8. 次のコマンドを実行して、namespace オブジェクトを適用します。

   $ oc apply -f <filename>.yaml

9. オブジェクトストレージにアクセスするための認証情報を含むシークレットを作成します。たとえば、Amazon Web Services (AWS) s3 にアクセスするためのシークレットを作成します。

   Secret オブジェクトの例

   apiVersion: v1
   kind: Secret
   metadata:
     name: logging-loki-s3 1
     namespace: openshift-logging
   stringData: 2
     access_key_id: <access_key_id>
     access_key_secret: <access_secret>
     bucketnames: s3-bucket-name
     endpoint: https://s3.eu-central-1.amazonaws.com
     region: eu-central-1

   1

   LokiStack で使用される名前と一致するように、logging-loki-s3 という名前を使用します。

   2

   シークレットの内容については、Loki オブジェクトストレージのセクションを参照してください。

   重要

   s3 バケットまたは LokiStack カスタムリソース (CR) に保存期間が定義されていない場合、ログは削除されず、s3 バケットに永久に残り、s3 ストレージがいっぱいになる可能性があります。

10. 次のコマンドを実行して、Secret オブジェクトを適用します。

    $ oc apply -f <filename>.yaml

11. LokiStack CR を作成します。

    LokiStack CR の例

    apiVersion: loki.grafana.com/v1
    kind: LokiStack
    metadata:
      name: logging-loki 1
      namespace: openshift-logging 2
    spec:
      size: 1x.small 3
      storage:
        schemas:
        - version: v13
          effectiveDate: "<yyyy>-<mm>-<dd>" 4
        secret:
          name: logging-loki-s3 5
          type: s3 6
      storageClassName: <storage_class_name> 7
      tenants:
        mode: openshift-logging 8

    1

    logging-loki という名前を使用します。

    2

    namespace として openshift-logging を指定する必要があります。

    3

    デプロイメントサイズを指定します。Loki の実稼働インスタンスでサポートされているサイズオプションは、1x.extra-small、1x.small、または 1x.medium です。さらに、logging 6.1 以降では 1x.pico がサポートされています。

    4

    この日付はスキーマが有効になる日付であるため、新規インストールの場合、"昨日" に相当する日付に設定する必要があります。

    5

    ログストアシークレットの名前を指定します。

    6

    対応するストレージタイプを指定します。

    7

    一時ストレージのストレージクラスの名前を指定します。最適なパフォーマンスを得るには、ブロックストレージを割り当てるストレージクラスを指定します。oc get storageclasses コマンドを使用して、クラスターで使用可能なストレージクラスをリスト表示できます。

    8

    openshift-logging モードは、デフォルトのテナンシーモードです。このモードでは、監査、インフラストラクチャー、アプリケーションなどのログタイプに対してテナントが作成されます。これにより、個々のユーザーおよびユーザーグループのさまざまなログストリームのアクセス制御が可能になります。

12. 次のコマンドを実行して、LokiStack CR オブジェクトを適用します。

    $ oc apply -f <filename>.yaml

手順

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

   OperatorGroup オブジェクトのサンプル

   apiVersion: operators.coreos.com/v1
   kind: OperatorGroup
   metadata:
     name: cluster-logging
     namespace: openshift-logging 1
   spec:
     upgradeStrategy: Default

   1

   namespace として openshift-logging を指定する必要があります。

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

   $ oc apply -f <filename>.yaml

3. Red Hat OpenShift Logging Operator の Subscription オブジェクトを作成します。

   Subscription オブジェクトの例

   apiVersion: operators.coreos.com/v1alpha1
   kind: Subscription
   metadata:
     name: cluster-logging
     namespace: openshift-logging 1
   spec:
     channel: stable-6.<y> 2
     installPlanApproval: Automatic 3
     name: cluster-logging
     source: redhat-operators 4
     sourceNamespace: openshift-marketplace

   1

   namespace として openshift-logging を指定する必要があります。

   2

   チャネルとして stable-6.<y> を指定します。

   3

   サブスクリプションの承認ストラテジーが Automatic に設定されている場合、選択したチャネルで新しい Operator バージョンが利用可能になると、すぐに更新プロセスが開始します。承認ストラテジーが Manual に設定されている場合は、保留中のアップグレードを手動で承認する必要があります。

   4

   値として redhat-operators を指定します。OpenShift Container Platform クラスターが制限付きネットワークにインストールされている場合 (非接続クラスターの場合)、Operator Lifecycle Manager (OLM) の設定時に作成した CatalogSource オブジェクトの名前を指定します。

4. 以下のコマンドを実行して Subscription オブジェクトを適用します。

   $ oc apply -f <filename>.yaml

5. ログコレクターが使用するサービスアカウントを作成します。

   $ oc create sa logging-collector -n openshift-logging

6. コレクターがログを収集して転送できるように、サービスアカウントに必要な権限を割り当てます。この例では、コレクターにインフラストラクチャーログとアプリケーションログの両方を収集する権限を付与します。

   $ oc adm policy add-cluster-role-to-user logging-collector-logs-writer -z logging-collector -n openshift-logging
   $ oc adm policy add-cluster-role-to-user collect-application-logs -z logging-collector -n openshift-logging
   $ oc adm policy add-cluster-role-to-user collect-infrastructure-logs -z logging-collector -n openshift-logging

7. ClusterLogForwarder CR を作成します。

   ClusterLogForwarder CR の例

   apiVersion: observability.openshift.io/v1
   kind: ClusterLogForwarder
   metadata:
     name: instance
     namespace: openshift-logging 1
   spec:
     serviceAccount:
       name: logging-collector 2
     outputs:
     - name: lokistack-out
       type: lokiStack 3
       lokiStack:
         target: 4
           name: logging-loki
           namespace: openshift-logging
         authentication:
           token:
             from: serviceAccount
       tls:
         ca:
           key: service-ca.crt
           configMapName: openshift-service-ca.crt
     pipelines:
     - name: infra-app-logs
       inputRefs: 5
       - application
       - infrastructure
       outputRefs:
       - lokistack-out

   1

   openshift-logging namespace を指定する必要があります。

   2

   以前に作成したサービスアカウントの名前を指定します。

   3

   lokiStack 出力タイプを選択して、LokiStack インスタンスにログを送信します。

   4

   ClusterLogForwarder の参照先を、先ほど作成した LokiStack インスタンスに設定します。

   5

   LokiStack インスタンスに送信するログ出力タイプを選択します。

8. 次のコマンドを実行して、ClusterLogForwarder CR オブジェクトを適用します。

   $ oc apply -f <filename>.yaml

検証

1. 次のコマンドを実行して、インストールを確認します。

   $ oc get pods -n openshift-logging

   出力例

   $ oc get pods -n openshift-logging
   NAME                                               READY   STATUS    RESTARTS   AGE
   cluster-logging-operator-fb7f7cf69-8jsbq           1/1     Running   0          98m
   instance-222js                                     2/2     Running   0          18m
   instance-g9ddv                                     2/2     Running   0          18m
   instance-hfqq8                                     2/2     Running   0          18m
   instance-sphwg                                     2/2     Running   0          18m
   instance-vv7zn                                     2/2     Running   0          18m
   instance-wk5zz                                     2/2     Running   0          18m
   logging-loki-compactor-0                           1/1     Running   0          42m
   logging-loki-distributor-7d7688bcb9-dvcj8          1/1     Running   0          42m
   logging-loki-gateway-5f6c75f879-bl7k9              2/2     Running   0          42m
   logging-loki-gateway-5f6c75f879-xhq98              2/2     Running   0          42m
   logging-loki-index-gateway-0                       1/1     Running   0          42m
   logging-loki-ingester-0                            1/1     Running   0          42m
   logging-loki-querier-6b7b56bccc-2v9q4              1/1     Running   0          42m
   logging-loki-query-frontend-84fb57c578-gq2f7       1/1     Running   0          42m

手順

1. OpenShift Container Platform Web コンソールの Administrator パースペクティブで、Operators → OperatorHub に移動します。

2. Filter by keyword フィールドに Loki Operator と入力します。使用可能な Operator のリストで Loki Operator をクリックし、Install をクリックします。

   重要

   Community Loki Operator は Red Hat ではサポートされていません。

3. Update channel として stable-x.y を選択します。

   Loki Operator は、グローバルの Operator グループの namespace openshift-operators-redhat にデプロイする必要があります。そのため、Installation mode と Installed Namespace はすでに選択されています。この namespace がまだ存在しない場合は、自動的に作成されます。

4. Enable Operator-recommended cluster monitoring on this namespace. を選択します。

   このオプションは、Namespace オブジェクトに openshift.io/cluster-monitoring: "true" ラベルを設定します。クラスターモニタリングが openshift-operators-redhat namespace を収集できるように、このオプションを選択する必要があります。

5. Update approval で Automatic を選択し、Install をクリックします。

   サブスクリプションの承認ストラテジーが Automatic に設定されている場合、アップグレードプロセスは、選択したチャネルで新規 Operator バージョンが利用可能になるとすぐに開始します。承認ストラテジーが Manual に設定されている場合は、保留中のアップグレードを手動で承認する必要があります。

   注記

   インストールが完了する前に、Operator に Failed ステータスが表示される場合があります。Operator のインストールが完了し、InstallSucceeded というメッセージが表示されたら、ページを更新してください。

6. Operator をインストールしている間に、ログストアをデプロイする namespace を作成します。

   1. 画面右上の + をクリックして、Import YAML ページにアクセスします。

   2. openshift-logging namespace の YAML 定義を追加します。

      namespace オブジェクトの例

      apiVersion: v1
      kind: Namespace
      metadata:
        name: openshift-logging 1
        labels:
          openshift.io/cluster-monitoring: "true" 2

      1

      openshift-logging namespace は、すべてのロギングワークロード専用です。

      2

      クラスターモニタリングによって openshift-logging namespace をスクレイピングするためのラベル (上記参照) を指定する文字列値。

   3. Create をクリックします。

7. オブジェクトストレージにアクセスするための認証情報を含むシークレットを作成します。

   1. 画面右上の + をクリックして、Import YAML ページにアクセスします。

   2. シークレットの YAML 定義を追加します。たとえば、Amazon Web Services (AWS) s3 にアクセスするためのシークレットを作成します。

      Secret オブジェクトの例

      apiVersion: v1
      kind: Secret
      metadata:
        name: logging-loki-s3 1
        namespace: openshift-logging 2
      stringData: 3
        access_key_id: <access_key_id>
        access_key_secret: <access_key>
        bucketnames: s3-bucket-name
        endpoint: https://s3.eu-central-1.amazonaws.com
        region: eu-central-1

      1

      後で LokiStack リソースを作成するときに使用するために、このシークレットに使用する名前 logging-loki-s3 を書き留めておきます。

      2

      namespace は openshift-logging に設定します。これは LokiStack のデプロイに使用する namespace であるためです。

      3

      シークレットの内容については、Loki オブジェクトストレージのセクションを参照してください。

      重要

      s3 バケットまたは LokiStack カスタムリソース (CR) に保存期間が定義されていない場合、ログは削除されず、s3 バケットに永久に残り、s3 ストレージがいっぱいになる可能性があります。

   3. Create をクリックします。
8. Installed Operators ページに移動します。Provided API にある Loki Operator を選択し、LokiStack リソースを見つけて、Create Instance をクリックします。

9. YAML view を選択し、次のテンプレートを使用して LokiStack CR を作成します。

   LokiStack CR の例

   apiVersion: loki.grafana.com/v1
   kind: LokiStack
   metadata:
     name: logging-loki 1
     namespace: openshift-logging 2
   spec:
     size: 1x.small 3
     storage:
       schemas:
       - version: v13
         effectiveDate: "<yyyy>-<mm>-<dd>"
       secret:
         name: logging-loki-s3 4
         type: s3 5
     storageClassName: <storage_class_name> 6
     tenants:
       mode: openshift-logging 7

   1

   logging-loki という名前を使用します。

   2

   namespace として openshift-logging を指定する必要があります。

   3

   デプロイメントサイズを指定します。Loki の実稼働インスタンスでサポートされているサイズオプションは、1x.extra-small、1x.small、または 1x.medium です。さらに、logging 6.1 以降では 1x.pico がサポートされています。

   4

   ログストアシークレットの名前を指定します。

   5

   対応するストレージタイプを指定します。

   6

   一時ストレージのストレージクラスの名前を指定します。最適なパフォーマンスを得るには、ブロックストレージを割り当てるストレージクラスを指定します。oc get storageclasses コマンドを使用して、クラスターで使用可能なストレージクラスをリスト表示できます。

   7

   openshift-logging モードは、デフォルトのテナンシーモードです。このモードでは、監査、インフラストラクチャー、アプリケーションなどのログタイプに対してテナントが作成されます。これにより、個々のユーザーおよびユーザーグループのさまざまなログストリームのアクセス制御が可能になります。

10. Create をクリックします。

検証

1. LokiStack タブで、LokiStack インスタンスが表示されていることを確認します。
2. Status 列に、Condition: Ready というメッセージが緑色のチェックマークとともに表示されていることを確認します。

手順

1. OpenShift Container Platform Web コンソールの Administrator パースペクティブで、Operators → OperatorHub に移動します。
2. Filter by keyword フィールドに Red Hat OpenShift Logging Operator と入力します。利用可能な Operator のリストで Red Hat OpenShift Logging Operator をクリックし、Install をクリックします。

3. Update channel として stable-x.y を選択します。Version フィールドでは最新バージョンがすでに選択されています。

   Red Hat OpenShift Logging Operator は、ロギング namespace openshift-logging にデプロイする必要があります。そのため、Installation mode と Installed Namespace はすでに選択されています。この namespace がまだ存在しない場合は、自動的に作成されます。

4. Enable Operator-recommended cluster monitoring on this namespace. を選択します。

   このオプションは、Namespace オブジェクトに openshift.io/cluster-monitoring: "true" ラベルを設定します。クラスターモニタリングが openshift-logging namespace を収集できるように、このオプションを選択する必要があります。

5. Update approval で Automatic を選択し、Install をクリックします。

   サブスクリプションの承認ストラテジーが Automatic に設定されている場合、選択したチャネルで新しい Operator バージョンが利用可能になると、すぐに更新プロセスが開始します。承認ストラテジーが Manual に設定されている場合は、保留中のアップグレードを手動で承認する必要があります。

   注記

   インストールが完了する前に、Operator に Failed ステータスが表示される場合があります。Operator のインストールが完了し、InstallSucceeded というメッセージが表示されたら、ページを更新してください。

6. Operator をインストールしている間に、ログコレクターがログを収集するために使用するサービスアカウントを作成します。

   1. 画面右上の + をクリックして、Import YAML ページにアクセスします。

   2. サービスアカウントの YAML 定義を入力します。

      ServiceAccount オブジェクトの例

      apiVersion: v1
      kind: ServiceAccount
      metadata:
        name: logging-collector 1
        namespace: openshift-logging 2

      1

      後で ClusterLogForwarder リソースを作成するときに使用するために、このサービスアカウントに使用する名前 logging-collector を書き留めておきます。

      2

      namespace は openshift-logging に設定します。これは ClusterLogForwarder リソースをデプロイするための namespace であるためです。

   3. Create ボタンをクリックします。

7. ClusterRoleBinding オブジェクトを作成して、インフラストラクチャーログやアプリケーションログなど、収集するログにアクセスし、ログストアに書き込むために必要な権限をログコレクターに付与します。

   1. 画面右上の + をクリックして、Import YAML ページにアクセスします。

   2. ClusterRoleBinding リソースの YAML 定義を入力します。

      ClusterRoleBinding リソースの例

      apiVersion: rbac.authorization.k8s.io/v1
      kind: ClusterRoleBinding
      metadata:
        name: logging-collector:write-logs
      roleRef:
        apiGroup: rbac.authorization.k8s.io
        kind: ClusterRole
        name: logging-collector-logs-writer 1
      subjects:
      - kind: ServiceAccount
        name: logging-collector
        namespace: openshift-logging
      ---
      apiVersion: rbac.authorization.k8s.io/v1
      kind: ClusterRoleBinding
      metadata:
        name: logging-collector:collect-application
      roleRef:
        apiGroup: rbac.authorization.k8s.io
        kind: ClusterRole
        name: collect-application-logs 2
      subjects:
      - kind: ServiceAccount
        name: logging-collector
        namespace: openshift-logging
      ---
      apiVersion: rbac.authorization.k8s.io/v1
      kind: ClusterRoleBinding
      metadata:
        name: logging-collector:collect-infrastructure
      roleRef:
        apiGroup: rbac.authorization.k8s.io
        kind: ClusterRole
        name: collect-infrastructure-logs 3
      subjects:
      - kind: ServiceAccount
        name: logging-collector
        namespace: openshift-logging

      1

      ログコレクターが LokiStack にログを書き込むことを許可するクラスターロール。

      2

      ログコレクターがアプリケーションからログを収集することを許可するクラスターロール。

      3

      ログコレクターがインフラストラクチャーからログを収集することを許可するクラスターロール。

   3. Create ボタンをクリックします。
8. Operators → Installed Operators ページに移動します。Operator を選択し、All instances タブをクリックします。
9. サービスアカウントに必要な権限を付与した後、Installed Operator ページに移動します。Provided APIs で Red Hat OpenShift Logging Operator を選択し、ClusterLogForwarder リソースを見つけて、Create Instance をクリックします。

10. YAML view を選択し、次のテンプレートを使用して ClusterLogForwarder CR を作成します。

    ClusterLogForwarder CR の例

    apiVersion: observability.openshift.io/v1
    kind: ClusterLogForwarder
    metadata:
      name: instance
      namespace: openshift-logging 1
    spec:
      serviceAccount:
        name: logging-collector 2
      outputs:
      - name: lokistack-out
        type: lokiStack 3
        lokiStack:
          target: 4
            name: logging-loki
            namespace: openshift-logging
          authentication:
            token:
              from: serviceAccount
        tls:
          ca:
            key: service-ca.crt
            configMapName: openshift-service-ca.crt
      pipelines:
      - name: infra-app-logs
        inputRefs: 5
        - application
        - infrastructure
        outputRefs:
        - lokistack-out

    1

    namespace として openshift-logging を指定する必要があります。

    2

    先ほど作成したサービスアカウントの名前を指定します。

    3

    lokiStack 出力タイプを選択して、LokiStack インスタンスにログを送信します。

    4

    ClusterLogForwarder の参照先を、先ほど作成した LokiStack インスタンスに設定します。

    5

    LokiStack インスタンスに送信するログ出力タイプを選択します。

11. Create をクリックします。

検証

1. ClusterLogForwarder タブで、ClusterLogForwarder インスタンスが表示されていることを確認します。

2. Status 列に次のメッセージが表示されていることを確認します。

   • Condition: observability.openshift.io/Authorized
   • observability.openshift.io/Valid, Ready

手順

1. コレクターのサービスアカウントを作成します。認証にトークンを必要とするストレージにログを書き込む場合は、サービスアカウントにトークンを含める必要があります。

2. 適切なクラスターロールをサービスアカウントにバインドします。

   バインドコマンドの例

   $ oc adm policy add-cluster-role-to-user <cluster_role_name> system:serviceaccount:<namespace_name>:<service_account_name>

1. must-gather 情報を保存する必要のあるディレクトリーに移動します。

2. ログイメージに対して oc adm must-gather コマンドを実行します。

   $ oc adm must-gather --image=$(oc -n openshift-logging get deployment.apps/cluster-logging-operator -o jsonpath='{.spec.template.spec.containers[?(@.name == "cluster-logging-operator")].image}')

   must-gather ツールは、現行ディレクトリー内の must-gather.local で始まる新規ディレクトリーを作成します。例: must-gather.local.4157245944708210408

3. 作成された must-gather ディレクトリーから圧縮ファイルを作成します。たとえば、Linux オペレーティングシステムを使用するコンピューターで以下のコマンドを実行します。

   $ tar -cvaf must-gather.tar.gz must-gather.local.4157245944708210408

4. 圧縮ファイルを Red Hat カスタマーポータル で作成したサポートケースに添付します。

手順

1. OperatorHub から Red Hat OpenShift Logging Operator、Loki Operator、および Cluster Observability Operator (COO) をインストールします。

2. openshift-logging namespace に LokiStack カスタムリソース (CR) を作成します。

   apiVersion: loki.grafana.com/v1
   kind: LokiStack
   metadata:
     name: logging-loki
     namespace: openshift-logging
   spec:
     managementState: Managed
     size: 1x.extra-small
     storage:
       schemas:
       - effectiveDate: '2024-10-01'
         version: v13
       secret:
         name: logging-loki-s3
         type: s3
     storageClassName: gp3-csi
     tenants:
       mode: openshift-logging

   注記

   事前に logging-loki-s3 シークレットが事前に作成されていることを確認します。このシークレットの内容は、使用しているオブジェクトストレージにより異なります。詳細は、シークレットと TLS 設定を参照してください。

3. コレクターのサービスアカウントを作成します。

   $ oc create sa collector -n openshift-logging

4. コレクターのサービスアカウントによる LokiStack CR へのデータ書き込みを許可します。

   $ oc adm policy add-cluster-role-to-user logging-collector-logs-writer -z collector -n openshift-logging

   注記

   ClusterRole リソースは、Cluster Logging Operato のインストール中に自動的に作成されるため、手動で作成する必要はありません。

5. ログを収集するために、次のコマンドを実行してコレクターのサービスアカウントを使用します。

   $ oc adm policy add-cluster-role-to-user collect-application-logs -z collector -n openshift-logging

   $ oc adm policy add-cluster-role-to-user collect-audit-logs -z collector -n openshift-logging

   $ oc adm policy add-cluster-role-to-user collect-infrastructure-logs -z collector -n openshift-logging

   注記

   この例では、コレクターを 3 つのロール (アプリケーション、インフラストラクチャー、監査) すべてにバインドしますが、デフォルトでは、アプリケーションログとインフラストラクチャーログのみが収集されます。監査ログを収集するには、ClusterLogForwarder 設定を更新して監査ログを含めます。環境に必要な特定のログタイプに基づきロールを割り当てます。

6. UIPlugin CR を作成して、Observe タブの Log セクションを有効にします。

   apiVersion: observability.openshift.io/v1alpha1
   kind: UIPlugin
   metadata:
     name: logging
   spec:
     type: Logging
     logging:
       lokiStack:
         name: logging-loki

7. ClusterLogForwarder CR を作成して、ログ転送を設定します。

   apiVersion: observability.openshift.io/v1
   kind: ClusterLogForwarder
   metadata:
     name: collector
     namespace: openshift-logging
   spec:
     serviceAccount:
       name: collector
     outputs:
     - name: default-lokistack
       type: lokiStack
       lokiStack:
         authentication:
           token:
             from: serviceAccount
         target:
           name: logging-loki
           namespace: openshift-logging
       tls:
         ca:
           key: service-ca.crt
           configMapName: openshift-service-ca.crt
     pipelines:
     - name: default-logstore
       inputRefs:
       - application
       - infrastructure
       outputRefs:
       - default-lokistack

   注記

   dataModel フィールドはオプションであり、デフォルトでは未設定 (dataModel: "") になっています。これにより、Cluster Logging Operator (CLO) はデータモデルを自動的に選択できるようになります。現在、このフィールドが設定されていない場合の CLO はデフォルトで ViaQ モデルになりますが、これは今後のリリースで変更される予定です。dataModel: ViaQ を指定すると、デフォルトが変更されても設定の互換性が維持されます。

手順

1. OperatorHub から、Red Hat OpenShift Logging Operator、Loki Operator、Cluster Observability Operator (COO) をインストールします。

2. openshift-logging namespace に LokiStack カスタムリソース (CR) を作成します。

   apiVersion: loki.grafana.com/v1
   kind: LokiStack
   metadata:
     name: logging-loki
     namespace: openshift-logging
   spec:
     managementState: Managed
     size: 1x.extra-small
     storage:
       schemas:
       - effectiveDate: '2024-10-01'
         version: v13
       secret:
         name: logging-loki-s3
         type: s3
     storageClassName: gp3-csi
     tenants:
       mode: openshift-logging

   注記

   事前に logging-loki-s3 シークレットが事前に作成されていることを確認します。このシークレットの内容は、使用しているオブジェクトストレージにより異なります。詳細は、「シークレットと TLS 設定」を参照してください。

3. コレクターのサービスアカウントを作成します。

   $ oc create sa collector -n openshift-logging

4. コレクターのサービスアカウントによる LokiStack CR へのデータ書き込みを許可します。

   $ oc adm policy add-cluster-role-to-user logging-collector-logs-writer -z collector

   注記

   ClusterRole リソースは、Cluster Logging Operato のインストール中に自動的に作成されるため、手動で作成する必要はありません。

5. コレクターのサービスアカウントによるログ収集を許可します。

   $ oc project openshift-logging

   $ oc adm policy add-cluster-role-to-user collect-application-logs -z collector

   $ oc adm policy add-cluster-role-to-user collect-audit-logs -z collector

   $ oc adm policy add-cluster-role-to-user collect-infrastructure-logs -z collector

   注記

   この例では、コレクターを 3 つのロール (アプリケーション、インフラストラクチャー、監査) すべてにバインドします。デフォルトでは、アプリケーションログとインフラストラクチャーログのみが収集されます。監査ログを収集するには、ClusterLogForwarder 設定を更新して監査ログを含めます。環境に必要な特定のログタイプに基づきロールを割り当てます。

6. UIPlugin CR を作成して、Observe タブの Log セクションを有効にします。

   apiVersion: observability.openshift.io/v1alpha1
   kind: UIPlugin
   metadata:
     name: logging
   spec:
     type: Logging
     logging:
       lokiStack:
         name: logging-loki

7. ClusterLogForwarder CR を作成して、ログ転送を設定します。

   apiVersion: observability.openshift.io/v1
   kind: ClusterLogForwarder
   metadata:
     name: collector
     namespace: openshift-logging
     annotations:
       observability.openshift.io/tech-preview-otlp-output: "enabled" 1
   spec:
     serviceAccount:
       name: collector
     outputs:
     - name: loki-otlp
       type: lokiStack 2
       lokiStack:
         target:
           name: logging-loki
           namespace: openshift-logging
         dataModel: Otel 3
         authentication:
           token:
             from: serviceAccount
       tls:
         ca:
           key: service-ca.crt
           configMapName: openshift-service-ca.crt
     pipelines:
     - name: my-pipeline
       inputRefs:
       - application
       - infrastructure
       outputRefs:
       - loki-otlp

   1

   アノテーションを使用して、テクノロジープレビュー機能である Otel データモデルを有効にします。

   2

   出力タイプを lokiStack として定義します。

   3

   OpenTelemetry データモデルを指定します。

   注記

   dataModel が Otel の場合、lokiStack.labelKeys は使用できません。dataModel が Otel の場合に同様の機能を得るには、「OTLP データ取り込み用の LokiStack 設定」を参照してください。

手順

1. Loki Operator の Namespace オブジェクトを作成します。

   Namespace オブジェクトの例

   apiVersion: v1
   kind: Namespace
   metadata:
     name: openshift-operators-redhat 1
     labels:
       openshift.io/cluster-monitoring: "true" 2

   1

   namespace として openshift-operators-redhat を指定する必要があります。Operator の監視を有効にするには、openshift-operators-redhat namespace ではなく openshift-operators namespace からメトリクスを取得するように Cluster Monitoring Operator を設定します。openshift-operators namespace には、信頼されていないコミュニティー Operator が含まれている可能性があります。コミュニティー Operator は、OpenShift Container Platform メトリクスと同じ名前のメトリクスを公開して競合を引き起こす可能性があります。

   2

   クラスターモニタリングが openshift-operators-redhat namespace をスクレイピングできるようにするために、示されているラベルを指定する文字列値。

2. 次のコマンドを実行して、Namespace オブジェクトを適用します。

   $ oc apply -f <filename>.yaml

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

   OperatorGroup オブジェクトのサンプル

   apiVersion: operators.coreos.com/v1
   kind: OperatorGroup
   metadata:
     name: loki-operator
     namespace: openshift-operators-redhat 1
   spec:
     upgradeStrategy: Default

   1

   namespace として openshift-operators-redhat を指定する必要があります。

4. 以下のコマンドを実行して OperatorGroup オブジェクトを適用します。

   $ oc apply -f <filename>.yaml

5. Loki Operator の Subscription オブジェクトを作成します。

   Subscription オブジェクトの例

   apiVersion: operators.coreos.com/v1alpha1
   kind: Subscription
   metadata:
     name: loki-operator
     namespace: openshift-operators-redhat 1
   spec:
     channel: stable-6.<y> 2
     installPlanApproval: Automatic 3
     name: loki-operator
     source: redhat-operators 4
     sourceNamespace: openshift-marketplace

   1

   namespace として openshift-operators-redhat を指定する必要があります。

   2

   チャネルとして stable-6.<y> を指定します。

   3

   サブスクリプションの承認ストラテジーが Automatic に設定されている場合、選択したチャネルで新しい Operator バージョンが利用可能になると、すぐに更新プロセスが開始します。承認ストラテジーが Manual に設定されている場合は、保留中のアップグレードを手動で承認する必要があります。

   4

   値として redhat-operators を指定します。OpenShift Container Platform クラスターが制限付きネットワークにインストールされている場合 (非接続クラスターの場合)、Operator Lifecycle Manager (OLM) の設定時に作成した CatalogSource オブジェクトの名前を指定します。

6. 以下のコマンドを実行して Subscription オブジェクトを適用します。

   $ oc apply -f <filename>.yaml

7. LokiStack をデプロイするための namespace オブジェクトを作成します。

   namespace オブジェクトの例

   apiVersion: v1
   kind: Namespace
   metadata:
     name: openshift-logging 1
     labels:
       openshift.io/cluster-monitoring: "true" 2

   1

   openshift-logging namespace は、すべてのロギングワークロード専用です。

   2

   クラスターモニタリングによって openshift-logging namespace をスクレイピングするためのラベル (上記参照) を指定する文字列値。

8. 次のコマンドを実行して、namespace オブジェクトを適用します。

   $ oc apply -f <filename>.yaml

9. オブジェクトストレージにアクセスするための認証情報を含むシークレットを作成します。たとえば、Amazon Web Services (AWS) s3 にアクセスするためのシークレットを作成します。

   Secret オブジェクトの例

   apiVersion: v1
   kind: Secret
   metadata:
     name: logging-loki-s3 1
     namespace: openshift-logging
   stringData: 2
     access_key_id: <access_key_id>
     access_key_secret: <access_secret>
     bucketnames: s3-bucket-name
     endpoint: https://s3.eu-central-1.amazonaws.com
     region: eu-central-1

   1

   LokiStack で使用される名前と一致するように、logging-loki-s3 という名前を使用します。

   2

   シークレットの内容については、Loki オブジェクトストレージのセクションを参照してください。

   重要

   s3 バケットまたは LokiStack カスタムリソース (CR) に保存期間が定義されていない場合、ログは削除されず、s3 バケットに永久に残り、s3 ストレージがいっぱいになる可能性があります。

10. 次のコマンドを実行して、Secret オブジェクトを適用します。

    $ oc apply -f <filename>.yaml

11. LokiStack CR を作成します。

    LokiStack CR の例

    apiVersion: loki.grafana.com/v1
    kind: LokiStack
    metadata:
      name: logging-loki 1
      namespace: openshift-logging 2
    spec:
      size: 1x.small 3
      storage:
        schemas:
        - version: v13
          effectiveDate: "<yyyy>-<mm>-<dd>" 4
        secret:
          name: logging-loki-s3 5
          type: s3 6
      storageClassName: <storage_class_name> 7
      tenants:
        mode: openshift-logging 8

    1

    logging-loki という名前を使用します。

    2

    namespace として openshift-logging を指定する必要があります。

    3

    デプロイメントサイズを指定します。Loki の実稼働インスタンスでサポートされているサイズオプションは、1x.extra-small、1x.small、または 1x.medium です。さらに、logging 6.1 以降では 1x.pico がサポートされています。

    4

    この日付はスキーマが有効になる日付であるため、新規インストールの場合、"昨日" に相当する日付に設定する必要があります。

    5

    ログストアシークレットの名前を指定します。

    6

    対応するストレージタイプを指定します。

    7

    一時ストレージのストレージクラスの名前を指定します。最適なパフォーマンスを得るには、ブロックストレージを割り当てるストレージクラスを指定します。oc get storageclasses コマンドを使用して、クラスターで使用可能なストレージクラスをリスト表示できます。

    8

    openshift-logging モードは、デフォルトのテナンシーモードです。このモードでは、監査、インフラストラクチャー、アプリケーションなどのログタイプに対してテナントが作成されます。これにより、個々のユーザーおよびユーザーグループのさまざまなログストリームのアクセス制御が可能になります。

12. 次のコマンドを実行して、LokiStack CR オブジェクトを適用します。

    $ oc apply -f <filename>.yaml

手順

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

   OperatorGroup オブジェクトのサンプル

   apiVersion: operators.coreos.com/v1
   kind: OperatorGroup
   metadata:
     name: cluster-logging
     namespace: openshift-logging 1
   spec:
     upgradeStrategy: Default

   1

   namespace として openshift-logging を指定する必要があります。

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

   $ oc apply -f <filename>.yaml

3. Red Hat OpenShift Logging Operator の Subscription オブジェクトを作成します。

   Subscription オブジェクトの例

   apiVersion: operators.coreos.com/v1alpha1
   kind: Subscription
   metadata:
     name: cluster-logging
     namespace: openshift-logging 1
   spec:
     channel: stable-6.<y> 2
     installPlanApproval: Automatic 3
     name: cluster-logging
     source: redhat-operators 4
     sourceNamespace: openshift-marketplace

   1

   namespace として openshift-logging を指定する必要があります。

   2

   チャネルとして stable-6.<y> を指定します。

   3

   サブスクリプションの承認ストラテジーが Automatic に設定されている場合、選択したチャネルで新しい Operator バージョンが利用可能になると、すぐに更新プロセスが開始します。承認ストラテジーが Manual に設定されている場合は、保留中のアップグレードを手動で承認する必要があります。

   4

   値として redhat-operators を指定します。OpenShift Container Platform クラスターが制限付きネットワークにインストールされている場合 (非接続クラスターの場合)、Operator Lifecycle Manager (OLM) の設定時に作成した CatalogSource オブジェクトの名前を指定します。

4. 以下のコマンドを実行して Subscription オブジェクトを適用します。

   $ oc apply -f <filename>.yaml

5. ログコレクターが使用するサービスアカウントを作成します。

   $ oc create sa logging-collector -n openshift-logging

6. コレクターがログを収集して転送できるように、サービスアカウントに必要な権限を割り当てます。この例では、コレクターにインフラストラクチャーログとアプリケーションログの両方を収集する権限を付与します。

   $ oc adm policy add-cluster-role-to-user logging-collector-logs-writer -z logging-collector -n openshift-logging
   $ oc adm policy add-cluster-role-to-user collect-application-logs -z logging-collector -n openshift-logging
   $ oc adm policy add-cluster-role-to-user collect-infrastructure-logs -z logging-collector -n openshift-logging

7. ClusterLogForwarder CR を作成します。

   ClusterLogForwarder CR の例

   apiVersion: observability.openshift.io/v1
   kind: ClusterLogForwarder
   metadata:
     name: instance
     namespace: openshift-logging 1
   spec:
     serviceAccount:
       name: logging-collector 2
     outputs:
     - name: lokistack-out
       type: lokiStack 3
       lokiStack:
         target: 4
           name: logging-loki
           namespace: openshift-logging
         authentication:
           token:
             from: serviceAccount
       tls:
         ca:
           key: service-ca.crt
           configMapName: openshift-service-ca.crt
     pipelines:
     - name: infra-app-logs
       inputRefs: 5
       - application
       - infrastructure
       outputRefs:
       - lokistack-out

   1

   openshift-logging namespace を指定する必要があります。

   2

   以前に作成したサービスアカウントの名前を指定します。

   3

   lokiStack 出力タイプを選択して、LokiStack インスタンスにログを送信します。

   4

   ClusterLogForwarder の参照先を、先ほど作成した LokiStack インスタンスに設定します。

   5

   LokiStack インスタンスに送信するログ出力タイプを選択します。

8. 次のコマンドを実行して、ClusterLogForwarder CR オブジェクトを適用します。

   $ oc apply -f <filename>.yaml

検証

1. 次のコマンドを実行して、インストールを確認します。

   $ oc get pods -n openshift-logging

   出力例

   $ oc get pods -n openshift-logging
   NAME                                               READY   STATUS    RESTARTS   AGE
   cluster-logging-operator-fb7f7cf69-8jsbq           1/1     Running   0          98m
   instance-222js                                     2/2     Running   0          18m
   instance-g9ddv                                     2/2     Running   0          18m
   instance-hfqq8                                     2/2     Running   0          18m
   instance-sphwg                                     2/2     Running   0          18m
   instance-vv7zn                                     2/2     Running   0          18m
   instance-wk5zz                                     2/2     Running   0          18m
   logging-loki-compactor-0                           1/1     Running   0          42m
   logging-loki-distributor-7d7688bcb9-dvcj8          1/1     Running   0          42m
   logging-loki-gateway-5f6c75f879-bl7k9              2/2     Running   0          42m
   logging-loki-gateway-5f6c75f879-xhq98              2/2     Running   0          42m
   logging-loki-index-gateway-0                       1/1     Running   0          42m
   logging-loki-ingester-0                            1/1     Running   0          42m
   logging-loki-querier-6b7b56bccc-2v9q4              1/1     Running   0          42m
   logging-loki-query-frontend-84fb57c578-gq2f7       1/1     Running   0          42m

手順

1. OpenShift Container Platform Web コンソールの Administrator パースペクティブで、Operators → OperatorHub に移動します。

2. Filter by keyword フィールドに Loki Operator と入力します。使用可能な Operator のリストで Loki Operator をクリックし、Install をクリックします。

   重要

   Community Loki Operator は Red Hat ではサポートされていません。

3. Update channel として stable-x.y を選択します。

   Loki Operator は、グローバルの Operator グループの namespace openshift-operators-redhat にデプロイする必要があります。そのため、Installation mode と Installed Namespace はすでに選択されています。この namespace がまだ存在しない場合は、自動的に作成されます。

4. Enable Operator-recommended cluster monitoring on this namespace. を選択します。

   このオプションは、Namespace オブジェクトに openshift.io/cluster-monitoring: "true" ラベルを設定します。クラスターモニタリングが openshift-operators-redhat namespace を収集できるように、このオプションを選択する必要があります。

5. Update approval で Automatic を選択し、Install をクリックします。

   サブスクリプションの承認ストラテジーが Automatic に設定されている場合、アップグレードプロセスは、選択したチャネルで新規 Operator バージョンが利用可能になるとすぐに開始します。承認ストラテジーが Manual に設定されている場合は、保留中のアップグレードを手動で承認する必要があります。

   注記

   インストールが完了する前に、Operator に Failed ステータスが表示される場合があります。Operator のインストールが完了し、InstallSucceeded というメッセージが表示されたら、ページを更新してください。

6. Operator をインストールしている間に、ログストアをデプロイする namespace を作成します。

   1. 画面右上の + をクリックして、Import YAML ページにアクセスします。

   2. openshift-logging namespace の YAML 定義を追加します。

      namespace オブジェクトの例

      apiVersion: v1
      kind: Namespace
      metadata:
        name: openshift-logging 1
        labels:
          openshift.io/cluster-monitoring: "true" 2

      1

      openshift-logging namespace は、すべてのロギングワークロード専用です。

      2

      クラスターモニタリングによって openshift-logging namespace をスクレイピングするためのラベル (上記参照) を指定する文字列値。

   3. Create をクリックします。

7. オブジェクトストレージにアクセスするための認証情報を含むシークレットを作成します。

   1. 画面右上の + をクリックして、Import YAML ページにアクセスします。

   2. シークレットの YAML 定義を追加します。たとえば、Amazon Web Services (AWS) s3 にアクセスするためのシークレットを作成します。

      Secret オブジェクトの例

      apiVersion: v1
      kind: Secret
      metadata:
        name: logging-loki-s3 1
        namespace: openshift-logging 2
      stringData: 3
        access_key_id: <access_key_id>
        access_key_secret: <access_key>
        bucketnames: s3-bucket-name
        endpoint: https://s3.eu-central-1.amazonaws.com
        region: eu-central-1

      1

      後で LokiStack リソースを作成するときに使用するために、このシークレットに使用する名前 logging-loki-s3 を書き留めておきます。

      2

      namespace は openshift-logging に設定します。これは LokiStack のデプロイに使用する namespace であるためです。

      3

      シークレットの内容については、Loki オブジェクトストレージのセクションを参照してください。

      重要

      s3 バケットまたは LokiStack カスタムリソース (CR) に保存期間が定義されていない場合、ログは削除されず、s3 バケットに永久に残り、s3 ストレージがいっぱいになる可能性があります。

   3. Create をクリックします。
8. Installed Operators ページに移動します。Provided API にある Loki Operator を選択し、LokiStack リソースを見つけて、Create Instance をクリックします。

9. YAML view を選択し、次のテンプレートを使用して LokiStack CR を作成します。

   LokiStack CR の例

   apiVersion: loki.grafana.com/v1
   kind: LokiStack
   metadata:
     name: logging-loki 1
     namespace: openshift-logging 2
   spec:
     size: 1x.small 3
     storage:
       schemas:
       - version: v13
         effectiveDate: "<yyyy>-<mm>-<dd>"
       secret:
         name: logging-loki-s3 4
         type: s3 5
     storageClassName: <storage_class_name> 6
     tenants:
       mode: openshift-logging 7

   1

   logging-loki という名前を使用します。

   2

   namespace として openshift-logging を指定する必要があります。

   3

   デプロイメントサイズを指定します。Loki の実稼働インスタンスでサポートされているサイズオプションは、1x.extra-small、1x.small、または 1x.medium です。さらに、logging 6.1 以降では 1x.pico がサポートされています。

   4

   ログストアシークレットの名前を指定します。

   5

   対応するストレージタイプを指定します。

   6

   一時ストレージのストレージクラスの名前を指定します。最適なパフォーマンスを得るには、ブロックストレージを割り当てるストレージクラスを指定します。oc get storageclasses コマンドを使用して、クラスターで使用可能なストレージクラスをリスト表示できます。

   7

   openshift-logging モードは、デフォルトのテナンシーモードです。このモードでは、監査、インフラストラクチャー、アプリケーションなどのログタイプに対してテナントが作成されます。これにより、個々のユーザーおよびユーザーグループのさまざまなログストリームのアクセス制御が可能になります。

10. Create をクリックします。

検証

1. LokiStack タブで、LokiStack インスタンスが表示されていることを確認します。
2. Status 列に、Condition: Ready というメッセージが緑色のチェックマークとともに表示されていることを確認します。

手順

1. OpenShift Container Platform Web コンソールの Administrator パースペクティブで、Operators → OperatorHub に移動します。
2. Filter by keyword フィールドに Red Hat OpenShift Logging Operator と入力します。利用可能な Operator のリストで Red Hat OpenShift Logging Operator をクリックし、Install をクリックします。

3. Update channel として stable-x.y を選択します。Version フィールドでは最新バージョンがすでに選択されています。

   Red Hat OpenShift Logging Operator は、ロギング namespace openshift-logging にデプロイする必要があります。そのため、Installation mode と Installed Namespace はすでに選択されています。この namespace がまだ存在しない場合は、自動的に作成されます。

4. Enable Operator-recommended cluster monitoring on this namespace. を選択します。

   このオプションは、Namespace オブジェクトに openshift.io/cluster-monitoring: "true" ラベルを設定します。クラスターモニタリングが openshift-logging namespace を収集できるように、このオプションを選択する必要があります。

5. Update approval で Automatic を選択し、Install をクリックします。

   サブスクリプションの承認ストラテジーが Automatic に設定されている場合、選択したチャネルで新しい Operator バージョンが利用可能になると、すぐに更新プロセスが開始します。承認ストラテジーが Manual に設定されている場合は、保留中のアップグレードを手動で承認する必要があります。

   注記

   インストールが完了する前に、Operator に Failed ステータスが表示される場合があります。Operator のインストールが完了し、InstallSucceeded というメッセージが表示されたら、ページを更新してください。

6. Operator をインストールしている間に、ログコレクターがログを収集するために使用するサービスアカウントを作成します。

   1. 画面右上の + をクリックして、Import YAML ページにアクセスします。

   2. サービスアカウントの YAML 定義を入力します。

      ServiceAccount オブジェクトの例

      apiVersion: v1
      kind: ServiceAccount
      metadata:
        name: logging-collector 1
        namespace: openshift-logging 2

      1

      後で ClusterLogForwarder リソースを作成するときに使用するために、このサービスアカウントに使用する名前 logging-collector を書き留めておきます。

      2

      namespace は openshift-logging に設定します。これは ClusterLogForwarder リソースをデプロイするための namespace であるためです。

   3. Create ボタンをクリックします。

7. ClusterRoleBinding オブジェクトを作成して、インフラストラクチャーログやアプリケーションログなど、収集するログにアクセスし、ログストアに書き込むために必要な権限をログコレクターに付与します。

   1. 画面右上の + をクリックして、Import YAML ページにアクセスします。

   2. ClusterRoleBinding リソースの YAML 定義を入力します。

      ClusterRoleBinding リソースの例

      apiVersion: rbac.authorization.k8s.io/v1
      kind: ClusterRoleBinding
      metadata:
        name: logging-collector:write-logs
      roleRef:
        apiGroup: rbac.authorization.k8s.io
        kind: ClusterRole
        name: logging-collector-logs-writer 1
      subjects:
      - kind: ServiceAccount
        name: logging-collector
        namespace: openshift-logging
      ---
      apiVersion: rbac.authorization.k8s.io/v1
      kind: ClusterRoleBinding
      metadata:
        name: logging-collector:collect-application
      roleRef:
        apiGroup: rbac.authorization.k8s.io
        kind: ClusterRole
        name: collect-application-logs 2
      subjects:
      - kind: ServiceAccount
        name: logging-collector
        namespace: openshift-logging
      ---
      apiVersion: rbac.authorization.k8s.io/v1
      kind: ClusterRoleBinding
      metadata:
        name: logging-collector:collect-infrastructure
      roleRef:
        apiGroup: rbac.authorization.k8s.io
        kind: ClusterRole
        name: collect-infrastructure-logs 3
      subjects:
      - kind: ServiceAccount
        name: logging-collector
        namespace: openshift-logging

      1

      ログコレクターが LokiStack にログを書き込むことを許可するクラスターロール。

      2

      ログコレクターがアプリケーションからログを収集することを許可するクラスターロール。

      3

      ログコレクターがインフラストラクチャーからログを収集することを許可するクラスターロール。

   3. Create ボタンをクリックします。
8. Operators → Installed Operators ページに移動します。Operator を選択し、All instances タブをクリックします。
9. サービスアカウントに必要な権限を付与した後、Installed Operator ページに移動します。Provided APIs で Red Hat OpenShift Logging Operator を選択し、ClusterLogForwarder リソースを見つけて、Create Instance をクリックします。

10. YAML view を選択し、次のテンプレートを使用して ClusterLogForwarder CR を作成します。

    ClusterLogForwarder CR の例

    apiVersion: observability.openshift.io/v1
    kind: ClusterLogForwarder
    metadata:
      name: instance
      namespace: openshift-logging 1
    spec:
      serviceAccount:
        name: logging-collector 2
      outputs:
      - name: lokistack-out
        type: lokiStack 3
        lokiStack:
          target: 4
            name: logging-loki
            namespace: openshift-logging
          authentication:
            token:
              from: serviceAccount
        tls:
          ca:
            key: service-ca.crt
            configMapName: openshift-service-ca.crt
      pipelines:
      - name: infra-app-logs
        inputRefs: 5
        - application
        - infrastructure
        outputRefs:
        - lokistack-out

    1

    namespace として openshift-logging を指定する必要があります。

    2

    先ほど作成したサービスアカウントの名前を指定します。

    3

    lokiStack 出力タイプを選択して、LokiStack インスタンスにログを送信します。

    4

    ClusterLogForwarder の参照先を、先ほど作成した LokiStack インスタンスに設定します。

    5

    LokiStack インスタンスに送信するログ出力タイプを選択します。

11. Create をクリックします。

検証

1. ClusterLogForwarder タブで、ClusterLogForwarder インスタンスが表示されていることを確認します。

2. Status 列に次のメッセージが表示されていることを確認します。

   • Condition: observability.openshift.io/Authorized
   • observability.openshift.io/Valid, Ready

手順

1. コレクターのサービスアカウントを作成します。認証にトークンを必要とするストレージにログを書き込む場合は、サービスアカウントにトークンを含める必要があります。

2. 適切なクラスターロールをサービスアカウントにバインドします。

   バインドコマンドの例

   $ oc adm policy add-cluster-role-to-user <cluster_role_name> system:serviceaccount:<namespace_name>:<service_account_name>

手順

1. フィルターの設定を ClusterLogForwarder CR の filters 仕様に追加します。

   以下の例は、正規表現に基づいてログレコードを削除するように ClusterLogForwarder CR を設定する方法を示しています。

   ClusterLogForwarder CR の例

   apiVersion: observability.openshift.io/v1
   kind: ClusterLogForwarder
   metadata:
   # ...
   spec:
     serviceAccount:
       name: <service_account_name>
     filters:
     - name: <filter_name>
       type: drop 1
       drop: 2
       - test: 3
         - field: .kubernetes.labels."foo-bar/baz" 4
           matches: .+ 5
         - field: .kubernetes.pod_name
           notMatches: "my-pod" 6
     pipelines:
     - name: <pipeline_name> 7
       filterRefs: ["<filter_name>"]
   # ...

   1

   フィルターのタイプを指定します。drop フィルターは、フィルター設定に一致するログレコードをドロップします。

   2

   drop フィルターを適用するための設定オプションを指定します。

   3

   ログレコードが削除されるかどうかを評価するために使用されるテストの設定を指定します。

   • テストに指定されたすべての条件が true の場合、テストは合格し、ログレコードは削除されます。
   • drop フィルター設定に複数のテストが指定されている場合、いずれかのテストに合格すると、レコードは削除されます。
   • 条件の評価中にエラーが発生した場合 (たとえば、評価対象のログレコードにフィールドがない場合)、その条件は false と評価されます。

   4

   ドットで区切られたフィールドパス (ログレコード内のフィールドへのパス) を指定します。パスには、英数字とアンダースコア (a-zA-Z0-9_) を含めることができます (例: .kubernetes.namespace_name)。セグメントにこの範囲外の文字が含まれている場合、セグメントを引用符で囲む必要があります (例: .kubernetes.labels."foo.bar-bar/baz")。1 つの test 設定に複数のフィールドパスを含めることができますが、テストに合格して drop フィルターを適用するには、すべてのフィールドパスが true と評価される必要があります。

   5

   正規表現を指定します。ログレコードがこの正規表現と一致する場合は、破棄されます。単一の field パスに対して matches または notMatches 条件のいずれかを設定できますが、両方を設定することはできません。

   6

   正規表現を指定します。ログレコードがこの正規表現に一致しない場合、破棄されます。単一の field パスに対して matches または notMatches 条件のいずれかを設定できますが、両方を設定することはできません。

   7

   drop フィルターが適用されるパイプラインを指定します。

2. 次のコマンドを実行して、ClusterLogForwarder CR を適用します。

   $ oc apply -f <filename>.yaml

手順

1. ClusterLogForwarder CR の input 仕様にフィルターの設定を追加します。

   以下の例は、ラベル式または一致したラベルキー/値に基づいてログを組み込むように ClusterLogForwarder CR を設定する方法を示しています。

   ClusterLogForwarder CR の例

   apiVersion: observability.openshift.io/v1
   kind: ClusterLogForwarder
   # ...
   spec:
     serviceAccount:
       name: <service_account_name>
     inputs:
       - name: mylogs
         application:
           selector:
             matchExpressions:
             - key: env 1
               operator: In 2
               values: ["prod", "qa"] 3
             - key: zone
               operator: NotIn
               values: ["east", "west"]
             matchLabels: 4
               app: one
               name: app1
         type: application
   # ...

   1

   照合するラベルキーを指定します。

   2

   Operator を指定します。有効な値には、In、NotIn、Exists、DoesNotExist などがあります。

   3

   文字列値の配列を指定します。Operator 値が Exists または DoesNotExist のいずれかの場合、値の配列は空である必要があります。

   4

   正確なキーまたは値のマッピングを指定します。

2. 次のコマンドを実行して、ClusterLogForwarder CR を適用します。

   $ oc apply -f <filename>.yaml

手順

1. フィルターの設定を ClusterLogForwarder CR の prune 仕様に追加します。

   次の例は、フィールドパスに基づいてログレコードを削除するように ClusterLogForwarder CR を設定する方法を示しています。

   重要

   両方が指定されている場合、最初に notIn 配列に基づいてレコードが整理され、in 配列よりも優先されます。notIn 配列を使用してレコードが整理された後、in 配列を使用してレコードが整理されます。

   ClusterLogForwarder CR の例

   apiVersion: observability.openshift.io/v1
   kind: ClusterLogForwarder
   metadata:
   # ...
   spec:
     serviceAccount:
       name: <service_account_name>
     filters:
     - name: <filter_name>
       type: prune 1
       prune: 2
         in: [.kubernetes.annotations, .kubernetes.namespace_id] 3
         notIn: [.kubernetes,.log_type,.message,."@timestamp"] 4
     pipelines:
     - name: <pipeline_name> 5
       filterRefs: ["<filter_name>"]
   # ...

   1

   フィルターのタイプを指定します。prune フィルターでは、設定されたフィールドでログレコードをプルーニングします。

   2

   prune フィルターを適用するための設定オプションを指定します。in フィールドと notIn フィールドは、ログレコード内のフィールドへのパスであるドット区切りのフィールドパスの配列として指定されます。これらのパスには、英数字とアンダースコア (a-zA-Z0-9_) を含めることができます (例: .kubernetes.namespace_name)。セグメントにこの範囲外の文字が含まれている場合、セグメントを引用符で囲む必要があります (例: .kubernetes.labels."foo.bar-bar/baz")。

   3

   オプション: この配列で指定されたフィールドはすべてログレコードから削除されます。

   4

   オプション: この配列で指定されていないフィールドはログレコードから削除されます。

   5

   prune フィルターを適用するパイプラインを指定します。

   注記

   フィルターは、log_type、.log_source、および .message フィールドを除外します。

2. 次のコマンドを実行して、ClusterLogForwarder CR を適用します。

   $ oc apply -f <filename>.yaml