Red Hat OpenShift Cluster Observability Operator について

手順

1. 次の設定を使用して MonitoringStack リソースを追加します。

   MonitoringStack オブジェクトの例

   apiVersion: monitoring.rhobs/v1alpha1
   kind: MonitoringStack
   metadata:
     labels:
       coo: example
     name: sample-monitoring-stack
     namespace: coo-demo
   spec:
     logLevel: debug
     retention: 1d
     resourceSelector:
       matchLabels:
         app: demo

   Copy to Clipboard Toggle word wrap

2. sample-monitoring-stack という名前の Prometheus リソースが、coo-demo namespace に生成されます。次のコマンドを実行して、生成された Prometheus リソースの管理対象フィールドを取得します。

   $ oc -n coo-demo get Prometheus.monitoring.rhobs -oyaml --show-managed-fields

   Copy to Clipboard Toggle word wrap

   出力例

   managedFields:
   - apiVersion: monitoring.rhobs/v1
     fieldsType: FieldsV1
     fieldsV1:
       f:metadata:
         f:labels:
           f:app.kubernetes.io/managed-by: {}
           f:app.kubernetes.io/name: {}
           f:app.kubernetes.io/part-of: {}
         f:ownerReferences:
           k:{"uid":"81da0d9a-61aa-4df3-affc-71015bcbde5a"}: {}
       f:spec:
         f:additionalScrapeConfigs: {}
         f:affinity:
           f:podAntiAffinity:
             f:requiredDuringSchedulingIgnoredDuringExecution: {}
         f:alerting:
           f:alertmanagers: {}
         f:arbitraryFSAccessThroughSMs: {}
         f:logLevel: {}
         f:podMetadata:
           f:labels:
             f:app.kubernetes.io/component: {}
             f:app.kubernetes.io/part-of: {}
         f:podMonitorSelector: {}
         f:replicas: {}
         f:resources:
           f:limits:
             f:cpu: {}
             f:memory: {}
           f:requests:
             f:cpu: {}
             f:memory: {}
         f:retention: {}
         f:ruleSelector: {}
         f:rules:
           f:alert: {}
         f:securityContext:
           f:fsGroup: {}
           f:runAsNonRoot: {}
           f:runAsUser: {}
         f:serviceAccountName: {}
         f:serviceMonitorSelector: {}
         f:thanos:
           f:baseImage: {}
           f:resources: {}
           f:version: {}
         f:tsdb: {}
     manager: observability-operator
     operation: Apply
   - apiVersion: monitoring.rhobs/v1
     fieldsType: FieldsV1
     fieldsV1:
       f:status:
         .: {}
         f:availableReplicas: {}
         f:conditions:
           .: {}
           k:{"type":"Available"}:
             .: {}
             f:lastTransitionTime: {}
             f:observedGeneration: {}
             f:status: {}
             f:type: {}
           k:{"type":"Reconciled"}:
             .: {}
             f:lastTransitionTime: {}
             f:observedGeneration: {}
             f:status: {}
             f:type: {}
         f:paused: {}
         f:replicas: {}
         f:shardStatuses:
           .: {}
           k:{"shardID":"0"}:
             .: {}
             f:availableReplicas: {}
             f:replicas: {}
             f:shardID: {}
             f:unavailableReplicas: {}
             f:updatedReplicas: {}
         f:unavailableReplicas: {}
         f:updatedReplicas: {}
     manager: PrometheusOperator
     operation: Update
     subresource: status

   Copy to Clipboard Toggle word wrap

3. metadata.managedFields 値を確認し、metadata と spec の一部のフィールドが MonitoringStack リソースによって管理されていることを確認します。

4. MonitoringStack リソースで制御されないフィールドを変更します。

   1. MonitoringStack リソースによって設定されていないフィールドである spec.enforcedSampleLimit を変更します。prom-spec-edited.yaml ファイルを作成します。

      prom-spec-edited.yaml

      apiVersion: monitoring.rhobs/v1
      kind: Prometheus
      metadata:
        name: sample-monitoring-stack
        namespace: coo-demo
      spec:
        enforcedSampleLimit: 1000

      Copy to Clipboard Toggle word wrap

   2. 以下のコマンドを実行して YAML を適用します。

      $ oc apply -f ./prom-spec-edited.yaml --server-side

      Copy to Clipboard Toggle word wrap
      注記

      --server-side フラグを使用する必要があります。

   3. 変更された Prometheus オブジェクトを取得し、spec.enforcedSampleLimit を持つ managedFields に、もう 1 つセクションがあることに注意してください。

      $ oc get prometheus -n coo-demo

      Copy to Clipboard Toggle word wrap

      出力例

      managedFields: 

      1

      
      - apiVersion: monitoring.rhobs/v1
        fieldsType: FieldsV1
        fieldsV1:
          f:metadata:
            f:labels:
              f:app.kubernetes.io/managed-by: {}
              f:app.kubernetes.io/name: {}
              f:app.kubernetes.io/part-of: {}
          f:spec:
            f:enforcedSampleLimit: {} 

      2

      
        manager: kubectl
        operation: Apply

      Copy to Clipboard Toggle word wrap

      1

      managedFields

      2

      spec.enforcedSampleLimit

5. MonitoringStack リソースによって管理されるフィールドを変更します。

   1. 次の YAML 設定を使用して、MonitoringStack リソースによって管理されるフィールドである spec.LogLevel を変更します。

      # changing the logLevel from debug to info
      apiVersion: monitoring.rhobs/v1
      kind: Prometheus
      metadata:
        name: sample-monitoring-stack
        namespace: coo-demo
      spec:
        logLevel: info 

      1

      Copy to Clipboard Toggle word wrap

      1

      spec.logLevel が追加されました。

   2. 以下のコマンドを実行して YAML を適用します。

      $ oc apply -f ./prom-spec-edited.yaml --server-side

      Copy to Clipboard Toggle word wrap

      出力例

      error: Apply failed with 1 conflict: conflict with "observability-operator": .spec.logLevel
      Please review the fields above--they currently have other managers. Here
      are the ways you can resolve this warning:
      * If you intend to manage all of these fields, please re-run the apply
        command with the `--force-conflicts` flag.
      * If you do not intend to manage all of the fields, please edit your
        manifest to remove references to the fields that should keep their
        current managers.
      * You may co-own fields by updating your manifest to match the existing
        value; in this case, you'll become the manager if the other manager(s)
        stop managing the field (remove it from their configuration).
      See https://kubernetes.io/docs/reference/using-api/server-side-apply/#conflicts

      Copy to Clipboard Toggle word wrap

   3. フィールド spec.logLevel は observability-operator によってすでに管理されているため、Server-Side Apply を使用して変更できないことに注意してください。

   4. この変更を強制するには、--force-conflicts フラグを使用します。

      $ oc apply -f ./prom-spec-edited.yaml --server-side --force-conflicts

      Copy to Clipboard Toggle word wrap

      出力例

      prometheus.monitoring.rhobs/sample-monitoring-stack serverside-applied

      Copy to Clipboard Toggle word wrap

      --force-conflicts フラグの場合、このフィールドは強制的に変更できますが、同じフィールドが MonitoringStack リソースでも管理されるため、Observability Operator は変更を検出し、MonitoringStack リソースによって設定された値に戻します。

      注記

      MonitoringStack リソースによって生成される一部の Prometheus フィールドは、logLevel など、MonitoringStack spec スタンザのフィールドの影響を受けます。これらは、MonitoringStack spec を変更することで変更できます。

   5. Prometheus オブジェクトの logLevel を変更するには、次の YAML を適用して MonitoringStack リソースを変更します。

      apiVersion: monitoring.rhobs/v1alpha1
      kind: MonitoringStack
      metadata:
        name: sample-monitoring-stack
        labels:
          coo: example
      spec:
        logLevel: info

      Copy to Clipboard Toggle word wrap

   6. 変更が実行されたことを確認するには、次のコマンドを実行してログレベルをクエリーします。

      $ oc -n coo-demo get Prometheus.monitoring.rhobs -o=jsonpath='{.items[0].spec.logLevel}'

      Copy to Clipboard Toggle word wrap

      出力例

      info

      Copy to Clipboard Toggle word wrap