1.2. CLI を使用したインストール

手順

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

   Namespace オブジェクトの例

   apiVersion: v1
   kind: Namespace
   metadata:
     name: openshift-operators-redhat 

   1

   
     labels:
       openshift.io/cluster-monitoring: "true" 

   2

   Copy to Clipboard Toggle word wrap

   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

   Copy to Clipboard Toggle word wrap

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

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

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

   1

   
   spec:
     upgradeStrategy: Default

   Copy to Clipboard Toggle word wrap

   1

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

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

   $ oc apply -f <filename>.yaml

   Copy to Clipboard Toggle word wrap

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

   Copy to Clipboard Toggle word wrap

   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

   Copy to Clipboard Toggle word wrap

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

   namespace オブジェクトの例

   apiVersion: v1
   kind: Namespace
   metadata:
     name: openshift-logging 

   1

   
     labels:
       openshift.io/cluster-monitoring: "true" 

   2

   Copy to Clipboard Toggle word wrap

   1

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

   2

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

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

   $ oc apply -f <filename>.yaml

   Copy to Clipboard Toggle word wrap

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: <secret_access_key>
     bucketnames: <s3_bucket_name>
     endpoint: https://s3.eu-central-1.amazonaws.com
     region: eu-central-1

   Copy to Clipboard Toggle word wrap

   1

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

   2

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

   重要

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

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

    $ oc apply -f <filename>.yaml

    Copy to Clipboard Toggle word wrap

11. LokiStack CR を作成します。

    LokiStack CR の例

    apiVersion: loki.grafana.com/v1
    kind: LokiStack
    metadata:
      name: logging-loki 

    1

    
      namespace: openshift-logging 

    2

    
    spec:
      managementState: Managed
      limits:
        global: 

    3

    
          retention: 

    4

    
            days: 20 # Set the value as per requirement
      size: 1x.small 

    5

    
      storage:
        schemas:
        - version: v13
          effectiveDate: "<yyyy>-<mm>-<dd>" 

    6

    
        secret:
          name: logging-loki-s3 

    7

    
          type: s3 

    8

    
      storageClassName: <storage_class_name> 

    9

    
      tenants:
        mode: openshift-logging 

    10

    Copy to Clipboard Toggle word wrap

    1

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

    2

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

    3

    LokiStack インスタンスに適用するグローバルの制限を定義します。ストリームベースの保持の設定方法は、Loki を使用したストリームベースの保持の有効化 を参照してください。このフィールドは、オブジェクトストレージに保存されるログの保持期間には影響しません。

    4

    このブロックが CR に追加されると、クラスターで保持が有効になります。

    5

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

    6

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

    7

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

    8

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

    9

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

    10

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

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

    $ oc apply -f <filename>.yaml

    Copy to Clipboard Toggle word wrap

手順

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

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

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

   1

   
   spec:
     upgradeStrategy: Default

   Copy to Clipboard Toggle word wrap

   1

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

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

   $ oc apply -f <filename>.yaml

   Copy to Clipboard Toggle word wrap

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

   Copy to Clipboard Toggle word wrap

   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

   Copy to Clipboard Toggle word wrap

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

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

   Copy to Clipboard Toggle word wrap

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

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

   Copy to Clipboard Toggle word wrap

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

   Copy to Clipboard Toggle word wrap

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

   Copy to Clipboard Toggle word wrap

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

   Copy to Clipboard Toggle word wrap

   1

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

   2

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

   3

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

   4

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

   5

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

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

   $ oc apply -f <filename>.yaml

   Copy to Clipboard Toggle word wrap

検証

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

   $ oc get pods -n openshift-logging

   Copy to Clipboard Toggle word wrap

   出力例

   $ 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

   Copy to Clipboard Toggle word wrap

手順

1. Cluster Observability Operator をインストールします。詳細は、Cluster Observability Operator のインストール を参照してください。

2. UIPlugin カスタムリソース (CR) を作成します。

   UIPlugin CR の例

   apiVersion: observability.openshift.io/v1alpha1
   kind: UIPlugin
   metadata:
     name: logging  

   1

   
   spec:
     type: Logging  

   2

   
     logging:
       lokiStack:
         name: logging-loki  

   3

   
       logsLimit: 50
       timeout: 30s
       schema: otel 

   4

   Copy to Clipboard Toggle word wrap

   1

   name を logging に設定します。

   2

   type を Logging に設定します。

   3

   name の値は、LokiStack インスタンスの名前と一致する必要があります。LokiStack を openshift-logging namespace にインストールしなかった場合は、lokiStack 設定の下に LokiStack namespace を設定してください。

   4

   schema は otel、viaq、select のいずれかです。値が指定されていない場合、デフォルトは viaq です。select を選択すると、クエリーを実行するときに UI でモードを選択できます。

   注記

   これらはロギング UI プラグインの既知の問題です。詳細は、OU-587 を参照してください。

   • schema 機能は、Red Hat OpenShift Logging 4.15 以降でのみサポートされます。それより前のバージョンの Red Hat OpenShift Logging では、ロギング UI プラグインは viaq 属性のみを使用し、他の値が設定されていても無視します。
   • 管理者以外のユーザーは、Red Hat OpenShift バージョン 5.8 から 6.2 のロギングで otel 属性を使用してログのクエリーを実行することはできません。この問題は、今後のロギングリリースで修正される予定です。(LOG-6589)
   • Red Hat OpenShift バージョン 5.9 のロギングでは、severity_text Otel 属性が設定されていません。

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

   $ oc apply -f <filename>.yaml

   Copy to Clipboard Toggle word wrap

検証

1. Red Hat OpenShift Logging Web コンソールにアクセスします。ポップアップにページを更新するよう指示が表示された場合は、ページを更新します。
2. Observe Logs パネルに移動すると、LogQL クエリーを実行できます。特定の Pod の Aggregated Logs タブから個々の Pod のログを照会することもできます。