Logging のインストール

手順

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: <access_secret>
     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:
      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

    Copy to Clipboard Toggle word wrap

    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

    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
   $ 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

   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. 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

      Copy to Clipboard Toggle word wrap

      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

      Copy to Clipboard Toggle word wrap

      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

   Copy to Clipboard Toggle word wrap

   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

      Copy to Clipboard Toggle word wrap

      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

      Copy to Clipboard Toggle word wrap

      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

    Copy to Clipboard Toggle word wrap

    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