手順

1. Service Telemetry Framework で利用可能な証明書の一覧を表示します。

   $ oc get secrets

2. default-interconnect-selfsigned シークレットの内容を取得して書き留めます。

   $ oc get secret/default-interconnect-selfsigned -o jsonpath='{.data.ca\.crt}' | base64 -d

手順

1. Red Hat OpenShift Container Platform 環境にログインします。

2. service-telemetry プロジェクトで、AMQ Interconnect ルートアドレスを取得します。

   $ oc get routes -ogo-template='{{ range .items }}{{printf "%s\n" .spec.host }}{{ end }}' | grep "\-5671"
   default-interconnect-5671-service-telemetry.apps.infra.watch

手順

1. Red Hat OpenStack Platform (RHOSP) アンダークラウドに stack ユーザーとしてログオンします。

2. /home/stack ディレクトリーに enable-stf.yaml という名前の設定ファイルを作成します。

   重要

   EventPipelinePublishers および PipelinePublishers を空のリストに設定すると、Gnocchi や Panko などの RHOSP Telemetry コンポーネントにイベントやメトリクスデータを渡すことはありません。追加のパイプラインにデータを送信する必要がある場合は、ExtraConfig で指定されるように、Ceilometer の 30 秒のポーリング間隔は、RHOSP のテレメトリーコンポーネントに圧倒され、300 などの大きな値に間隔を引き上げる必要があります。ポーリング間隔の値を増やすと、STF の Telemetry 解決が少なくなります。

   enable-stf.yaml

   parameter_defaults:
       # only send to STF, not other publishers
       EventPipelinePublishers: []
       PipelinePublishers: []
   
       # manage the polling and pipeline configuration files for Ceilometer agents
       ManagePolling: true
       ManagePipeline: true
   
       # enable Ceilometer metrics and events
       CeilometerQdrPublishMetrics: true
       CeilometerQdrPublishEvents: true
   
       # set collectd overrides for higher telemetry resolution and extra plugins to load
       CollectdConnectionType: amqp1
       CollectdAmqpInterval: 5
       CollectdDefaultPollingInterval: 5
       CollectdExtraPlugins:
       - vmem
   
       # set standard prefixes for where metrics and events are published to QDR
       MetricsQdrAddresses:
       - prefix: 'collectd'
         distribution: multicast
       - prefix: 'anycast/ceilometer'
         distribution: multicast
   
       ExtraConfig:
           ceilometer::agent::polling::polling_interval: 30
           ceilometer::agent::polling::polling_meters:
           - cpu
           - disk.*
           - ip.*
           - image.*
           - memory
           - memory.*
           - network.*
           - perf.*
           - port
           - port.*
           - switch
           - switch.*
           - storage.*
           - volume.*
   
           # to avoid filling the memory buffers if disconnected from the message bus
           # note: Adjust the value of the `send_queue_limit` to handle your required volume of metrics.
           collectd::plugin::amqp1::send_queue_limit: 5000
   
           # receive extra information about virtual memory
           collectd::plugin::vmem::verbose: true
   
           # set memcached collectd plugin to report its metrics by hostname
           # rather than host IP, ensuring metrics in the dashboard remain uniform
           collectd::plugin::memcached::instances:
             local:
               host: "%{hiera('fqdn_canonical')}"
               port: 11211
   
           # align defaults across OSP versions
           collectd::plugin::cpu::reportbycpu: true
           collectd::plugin::cpu::reportbystate: true
           collectd::plugin::cpu::reportnumcpu: false
           collectd::plugin::cpu::valuespercentage: true
           collectd::plugin::df::ignoreselected: true
           collectd::plugin::df::reportbydevice: true
           collectd::plugin::df::fstypes: ['xfs']
           collectd::plugin::load::reportrelative: true
           collectd::plugin::virt::extra_stats: "pcpu cpu_util vcpupin vcpu memory disk disk_err disk_allocation disk_capacity disk_physical domain_state job_stats_background perf"

手順

1. RHOSP のアンダークラウドに stack ユーザーとしてログインします。
2. /home/stack ディレクトリーに stf-connectors.yaml という設定ファイルを作成します。

3. stf-connectors.yaml ファイルで、オーバークラウド上の AMQ Interconnect を STF デプロイメントに接続するように MetricsQdrConnectors アドレスを設定します。このファイルの Sensubility、Ceilometer、および collectd のトピックアドレスを、STF のデフォルトに一致するように設定します。トピックおよびクラウド設定のカスタマイズに関する詳細は、「複数のクラウドの設定」 を参照してください。

   • 複数のクラウドデプロイメント用に collectd-write-qdr.yaml 環境ファイルを含めないため、resource_registry 設定は collectd サービスを直接ロードします。
   • host パラメーターは、「AMQ Interconnect ルートアドレスの取得」 で取得した HOST/PORT の値に置き換えます。
   • caCertFileContent パラメーターを、「オーバークラウドの設定向け Service Telemetry Framework からの CA 証明書の取得」 で取得したコンテンツに置き換えます。
   • MetricsQdrConnectors の host サブパラメーターを、取得した HOST/PORT の値に置き換えます。「AMQ Interconnect ルートアドレスの取得」 .
   • CeilometerQdrEventsConfig.topic を設定して、Ceilometer イベントのトピックを定義します。この値の形式は anycast/ceilometer/cloud1-event.sample です。
   • CeilometerQdrMetricsConfig.topic を設定して、Ceilometer メトリックのトピックを定義します。この値のフォーマットは、anycast/ceilometer/cloud1-metering.sample です。
   • CollectdAmqpInstances を設定して、collectd イベントのトピックを定義します。この値の形式は、collectd/cloud1-notify です。

   • CollectdAmqpInstances を設定して、collectd メトリックのトピックを定義します。この値の形式は collectd/cloud1-telemetry です。

     stf-connectors.yaml

     resource_registry:
       OS::TripleO::Services::Collectd: /usr/share/openstack-tripleo-heat-templates/deployment/metrics/collectd-container-puppet.yaml
     
     parameter_defaults:
         MetricsQdrConnectors:
             - host: stf-default-interconnect-5671-service-telemetry.apps.infra.watch
               port: 443
               role: edge
               verifyHostname: false
               sslProfile: sslProfile
     
         MetricsQdrSSLProfiles:
             - name: sslProfile
               caCertFileContent: |
                 -----BEGIN CERTIFICATE-----
                 <snip>
                 -----END CERTIFICATE-----
     
         CeilometerQdrEventsConfig:
             driver: amqp
             topic: cloud1-event
     
         CeilometerQdrMetricsConfig:
             driver: amqp
             topic: cloud1-metering
     
         CollectdAmqpInstances:
             cloud1-notify:
                 notify: true
                 format: JSON
                 presettle: false
             cloud1-telemetry:
                 format: JSON
                 presettle: false

手順

1. Red Hat OpenStack Platform (RHOSP) アンダークラウドに stack ユーザーとしてログオンします。

2. 認証ファイルのソース

   [stack@undercloud-0 ~]$ source stackrc
   
   (undercloud) [stack@undercloud-0 ~]$

3. RHOSP director デプロイメントに以下のファイルを追加して、データ収集と AMQ Interconnect を設定します。

   • Ceilometer Telemetry およびイベントが STF に送信されることを確認する ceilometer-write-qdr.yaml ファイル
   • メッセージバスが有効で、STF メッセージバスルーターに接続されていることを確認する qdr-edge-only.yaml ファイル
   • デフォルト値が正しく設定されていることを確認する enable-stf.yaml 環境ファイル
   • STF への接続を定義する stf-connectors.yaml 環境ファイル

4. RHOSP オーバークラウドをデプロイします。

   (undercloud) [stack@undercloud-0 ~]$ openstack overcloud deploy <other_arguments>
   --templates /usr/share/openstack-tripleo-heat-templates \
     --environment-file <...other_environment_files...> \
     --environment-file /usr/share/openstack-tripleo-heat-templates/environments/metrics/ceilometer-write-qdr.yaml \
     --environment-file /usr/share/openstack-tripleo-heat-templates/environments/metrics/qdr-edge-only.yaml \
     --environment-file /home/stack/enable-stf.yaml \
     --environment-file /home/stack/stf-connectors.yaml

手順

1. オーバークラウドノード (例: controller-0) にログインします。

2. metrics_qdr コンテナーがノードで実行されていることを確認します。

   $ sudo docker container inspect --format '{{.State.Status}}' metrics_qdr
   
   running

3. AMQ Interconnect が実行されている内部ネットワークアドレスを返します (ポート 5666 でリッスンする 172.17.1.44 など)。

   $ sudo docker exec -it metrics_qdr cat /etc/qpid-dispatch/qdrouterd.conf
   
   listener {
       host: 172.17.1.44
       port: 5666
       authenticatePeer: no
       saslMechanisms: ANONYMOUS
   }

4. ローカルの AMQ インターコネクトへの接続のリストを返します。

   $ sudo docker exec -it metrics_qdr qdstat --bus=172.17.1.44:5666 --connections
   
   Connections
     id   host                                                                  container                                                                                                  role    dir  security                            authentication  tenant
     ============================================================================================================================================================================================================================================================================================
     1    default-interconnect-5671-service-telemetry.apps.infra.watch:443      default-interconnect-7458fd4d69-bgzfb                                                                      edge    out  TLSv1.2(DHE-RSA-AES256-GCM-SHA384)  anonymous-user
     12   172.17.1.44:60290                                                     openstack.org/om/container/controller-0/ceilometer-agent-notification/25/5c02cee550f143ec9ea030db5cccba14  normal  in   no-security                         no-auth
     16   172.17.1.44:36408                                                     metrics                                                                                                    normal  in   no-security                         anonymous-user
     899  172.17.1.44:39500                                                     10a2e99d-1b8a-4329-b48c-4335e5f75c84                                                                       normal  in   no-security                         no-auth

   接続は 4 つあります。

   • STF へのアウトバウンド接続
   • ceilometer からのインバウンド接続
   • collectd からのインバウンド接続

   • qdstat クライアントからの受信接続

     STF の送信接続は MetricsQdrConnectors ホストパラメーターに提供され、STF ストレージドメインのルートとなります。他のホストは、この AMQ インターコネクトへのクライアント接続の内部ネットワークアドレスです。

5. メッセージが配信されていることを確認するには、リンクを一覧表示して メッセージ配信の deliv 列に _edge アドレスを表示します。

   $ sudo docker exec -it metrics_qdr qdstat --bus=172.17.1.44:5666 --links
   Router Links
     type      dir  conn id  id    peer  class   addr                  phs  cap  pri  undel  unsett  deliv    presett  psdrop  acc  rej  rel     mod  delay  rate
     ===========================================================================================================================================================
     endpoint  out  1        5           local   _edge                      250  0    0      0       2979926  0        0       0    0    2979926 0    0      0
     endpoint  in   1        6                                              250  0    0      0       0        0        0       0    0    0       0    0      0
     endpoint  in   1        7                                              250  0    0      0       0        0        0       0    0    0       0    0      0
     endpoint  out  1        8                                              250  0    0      0       0        0        0       0    0    0       0    0      0
     endpoint  in   1        9                                              250  0    0      0       0        0        0       0    0    0       0    0      0
     endpoint  out  1        10                                             250  0    0      0       911      911      0       0    0    0       0    911    0
     endpoint  in   1        11                                             250  0    0      0       0        911      0       0    0    0       0    0      0
     endpoint  out  12       32          local   temp.lSY6Mcicol4J2Kp       250  0    0      0       0        0        0       0    0    0       0    0      0
     endpoint  in   16       41                                             250  0    0      0       2979924  0        0       0    0    2979924 0    0      0
     endpoint  in   912      1834        mobile  $management           0    250  0    0      0       1        0        0       1    0    0       0    0      0
     endpoint  out  912      1835        local   temp.9Ok2resI9tmt+CT       250  0    0      0       0        0        0       0    0    0       0    0      0

6. RHOSP ノードから STF へのアドレスを一覧表示するには、Red Hat OpenShift Container Platform に接続して AMQ Interconnect Pod 名を取得し、接続を一覧表示します。利用可能な AMQ Interconnect Pod を一覧表示します。

   $ oc get pods -l application=default-interconnect
   
   NAME                                    READY   STATUS    RESTARTS   AGE
   default-interconnect-7458fd4d69-bgzfb   1/1     Running   0          6d21h

7. Pod に接続し、既知の接続を一覧表示します。この例では、RHOSP ノードから接続 id 22、23、および 24 の 3 つの edge 接続があります。

   $ oc exec -it default-interconnect-7458fd4d69-bgzfb -- qdstat --connections
   
   2020-04-21 18:25:47.243852 UTC
   default-interconnect-7458fd4d69-bgzfb
   
   Connections
     id  host               container                                                      role    dir  security                                authentication  tenant  last dlv      uptime
     ===============================================================================================================================================================================================
     5   10.129.0.110:48498  bridge-3f5                                                    edge    in   no-security                             anonymous-user          000:00:00:02  000:17:36:29
     6   10.129.0.111:43254  rcv[default-cloud1-ceil-meter-smartgateway-58f885c76d-xmxwn]  edge    in   no-security                             anonymous-user          000:00:00:02  000:17:36:20
     7   10.130.0.109:50518  rcv[default-cloud1-coll-event-smartgateway-58fbbd4485-rl9bd]  normal  in   no-security                             anonymous-user          -             000:17:36:11
     8   10.130.0.110:33802  rcv[default-cloud1-ceil-event-smartgateway-6cfb65478c-g5q82]  normal  in   no-security                             anonymous-user          000:01:26:18  000:17:36:05
     22  10.128.0.1:51948   Router.ceph-0.redhat.local                                     edge    in   TLSv1/SSLv3(DHE-RSA-AES256-GCM-SHA384)  anonymous-user          000:00:00:03  000:22:08:43
     23  10.128.0.1:51950   Router.compute-0.redhat.local                                  edge    in   TLSv1/SSLv3(DHE-RSA-AES256-GCM-SHA384)  anonymous-user          000:00:00:03  000:22:08:43
     24  10.128.0.1:52082   Router.controller-0.redhat.local                               edge    in   TLSv1/SSLv3(DHE-RSA-AES256-GCM-SHA384)  anonymous-user          000:00:00:00  000:22:08:34
     27  127.0.0.1:42202    c2f541c1-4c97-4b37-a189-a396c08fb079                           normal  in   no-security                             no-auth                 000:00:00:00  000:00:00:00

8. ネットワークによって配信されるメッセージ数を表示するには、各アドレスを oc exec コマンドで使用します。

   $ oc exec -it default-interconnect-7458fd4d69-bgzfb -- qdstat --address
   
   2020-04-21 18:20:10.293258 UTC
   default-interconnect-7458fd4d69-bgzfb
   
   Router Addresses
     class   addr                                phs  distrib    pri  local  remote  in           out          thru  fallback
     ==========================================================================================================================
     mobile  anycast/ceilometer/event.sample     0    balanced   -    1      0       970          970          0     0
     mobile  anycast/ceilometer/metering.sample  0    balanced   -    1      0       2,344,833    2,344,833    0     0
     mobile  collectd/notify                     0    multicast  -    1      0       70           70           0     0
     mobile  collectd/telemetry                  0    multicast  -    1      0       216,128,890  216,128,890  0     0

手順

1. Red Hat OpenShift Container Platform にログインします。

2. service-telemetry namespace に切り替えます。

   $ oc project service-telemetry

3. default の ServiceTelemetry オブジェクトを編集し、設定で clouds パラメーターを追加します。

   警告

   クラウド名が長くなると、Pod 名の最大長 63 文字を超える可能性があります。ServiceTelemetry 名の default と clouds.name の組み合わせが 19 文字を超えないようにしてください。クラウド名には、- などの特殊文字を含めることはできません。クラウド名を英数字 (a-z、0-9) に制限します。

   トピックアドレスには文字の制限がなく、clouds.name の値とは異なる場合があります。

   $ oc edit stf default

   apiVersion: infra.watch/v1beta1
   kind: ServiceTelemetry
   metadata:
     ...
   spec:
     ...
     clouds:
     - name: cloud1
       events:
         collectors:
         - collectorType: collectd
           subscriptionAddress: collectd/cloud1-notify
         - collectorType: ceilometer
           subscriptionAddress: anycast/ceilometer/cloud1-event.sample
       metrics:
         collectors:
         - collectorType: collectd
           subscriptionAddress: collectd/cloud1-telemetry
         - collectorType: ceilometer
           subscriptionAddress: anycast/ceilometer/cloud1-metering.sample
     - name: cloud2
       events:
         ...

4. ServiceTelemetry オブジェクトを保存します。

5. 各 Smart Gateway が起動していることを確認します。この作業は、Smart Gateway の台数によっては数分かかることがあります。

   $ oc get po -l app=smart-gateway
   NAME                                                      READY   STATUS    RESTARTS   AGE
   default-cloud1-ceil-event-smartgateway-6cfb65478c-g5q82   2/2     Running   0          13h
   default-cloud1-ceil-meter-smartgateway-58f885c76d-xmxwn   2/2     Running   0          13h
   default-cloud1-coll-event-smartgateway-58fbbd4485-rl9bd   2/2     Running   0          13h
   default-cloud1-coll-meter-smartgateway-7c6fc495c4-jn728   2/2     Running   0          13h

手順

1. Service Telemetry Operator が管理するクラウドオブジェクトの一覧で clouds パラメーターを定義します。詳細は、「clouds パラメーター」 を参照してください。

2. ServiceTelemetry オブジェクトを編集し、cloudsRemoveOnMissing パラメーターを追加します。

   apiVersion: infra.watch/v1beta1
   kind: ServiceTelemetry
   metadata:
     ...
   spec:
     ...
     cloudsRemoveOnMissing: true
     clouds:
       ...

3. 修正内容を保存します。

4. オペレーターが Smart Gateway を削除したことを確認します。Operator が変更を調整する間、数分かかることがあります。

   $ oc get smartgateways

手順

1. 新しい環境ファイルを作成します (例: hostnames.yaml)。

2. 以下の例に示すように、環境ファイルで CloudDomain パラメーターを設定します。

   hostnames.yaml

   parameter_defaults:
       CloudDomain: newyork-west-04
       CephStorageHostnameFormat: 'ceph-%index%'
       ObjectStorageHostnameFormat: 'swift-%index%'
       ComputeHostnameFormat: 'compute-%index%'

3. 新しい環境ファイルをデプロイメントに追加します。

手順

1. Red Hat OpenStack Platform アンダークラウドに stack ユーザーとしてログオンします。
2. /home/stack ディレクトリーに stf-connectors.yaml という設定ファイルを作成します。

3. stf-connectors.yaml ファイルで、オーバークラウドデプロイメント上の AMQ Interconnect をに接続するように MetricsQdrConnectors アドレスを設定します。CeilometerQdrEventsConfig、CeilometerQdrMetricsConfig、および CollectdAmqpInstances トピックの値を、このクラウドデプロイメントに必要な AMQP アドレスに一致するように設定します。

   • 複数のクラウドデプロイメント用に collectd-write-qdr.yaml 環境ファイルを含めないため、resource_registry 設定は collectd サービスを直接ロードします。
   • MetricsQdrConnectors.host パラメーターは、「AMQ Interconnect ルートアドレスの取得」 で取得した HOST/PORT の値に置き換えます。
   • caCertFileContent パラメーターを、「オーバークラウドの設定向け Service Telemetry Framework からの CA 証明書の取得」 で取得したコンテンツに置き換えます。
   • CeilometerQdrEventsConfig.topic を設定して、Ceilometer イベントのトピックを定義します。この値は、anycast/ceilometer/cloud1-event.sample のアドレス形式です。
   • CeilometerQdrMetricsConfig.topic を設定して、Ceilometer メトリックのトピックを定義します。この値は、anycast/ceilometer/cloud1-metering.sample のアドレス形式です。
   • CollectdAmqpInstances を設定して、collectd イベントのトピックを定義します。この値は、collectd/cloud1-notify の形式になります。

   • CollectdAmqpInstances を設定して、collectd メトリックのトピックを定義します。この値は、collectd/cloud1-telemetry の形式になります。

     stf-connectors.yaml

     resource_registry:
       OS::TripleO::Services::Collectd: /usr/share/openstack-tripleo-heat-templates/deployment/metrics/collectd-container-puppet.yaml
     
     parameter_defaults:
         MetricsQdrConnectors:
             - host: stf-default-interconnect-5671-service-telemetry.apps.infra.watch
               port: 443
               role: edge
               verifyHostname: false
               sslProfile: sslProfile
     
         MetricsQdrSSLProfiles:
             - name: sslProfile
               caCertFileContent: |
                 -----BEGIN CERTIFICATE-----
                 <snip>
                 -----END CERTIFICATE-----
     
         CeilometerQdrEventsConfig:
             driver: amqp
             topic: cloud1-event
     
         CeilometerQdrMetricsConfig:
             driver: amqp
             topic: cloud1-metering
     
         CollectdAmqpInstances:
             cloud1-notify:
                 notify: true
                 format: JSON
                 presettle: false
             cloud1-telemetry:
                 format: JSON
                 presettle: false

4. stf-connectors.yaml ファイルの命名規則が、Smart Gateway 設定の spec.bridge.amqpUrl フィールドと一致していることを確認します。たとえば、CeilometerQdrEventsConfig.topic フィールドを cloud1-event の値に設定します。

5. 認証ファイルのソース

   [stack@undercloud-0 ~]$ source stackrc
   
   (undercloud) [stack@undercloud-0 ~]$

6. 実際の環境に該当するその他の環境ファイルと共に、openstack overcloud deployment コマンドに stf-connectors.yaml ファイルおよび一意のドメイン名環境ファイル hostnames.yaml を追加します。

   警告

   カスタム CollectdAmqpInstances パラメーターで collectd-write-qdr.yaml ファイルを使用する場合、データはカスタムおよびデフォルトのトピックに公開されます。複数のクラウド環境では、stf-connectors.yaml ファイルの resource_registry パラメーターの設定では collectd サービスを読み込みます。

   (undercloud) [stack@undercloud-0 ~]$ openstack overcloud deploy <other_arguments>
   --templates /usr/share/openstack-tripleo-heat-templates \
     --environment-file <...other_environment_files...> \
     --environment-file /usr/share/openstack-tripleo-heat-templates/environments/metrics/ceilometer-write-qdr.yaml \
     --environment-file /usr/share/openstack-tripleo-heat-templates/environments/metrics/qdr-edge-only.yaml \
     --environment-file /home/stack/hostnames.yaml \
     --environment-file /home/stack/enable-stf.yaml \
     --environment-file /home/stack/stf-connectors.yaml

7. Red Hat OpenStack Platform オーバークラウドのデプロイ

手順

1. Red Hat OpenShift Container Platform にログインします。

2. service-telemetry namespace に切り替えます。

   $ oc project service-telemetry

3. Grafana オペレーターをデプロイします。

   $ oc apply -f - <<EOF
   apiVersion: operators.coreos.com/v1alpha1
   kind: Subscription
   metadata:
     name: grafana-operator
     namespace: service-telemetry
   spec:
     channel: v4
     installPlanApproval: Automatic
     name: grafana-operator
     source: operatorhubio-operators
     sourceNamespace: openshift-marketplace
   EOF

4. Operator が正常に起動したことを確認します。コマンド出力で、PHASE 列の値が Succeeded の場合には、Operator は正常に起動されています。

   $ oc get csv --selector operators.coreos.com/grafana-operator.service-telemetry
   
   NAME                       DISPLAY            VERSION   REPLACES                   PHASE
   grafana-operator.v4.6.0   Grafana Operator   4.6.0     grafana-operator.v4.5.1   Succeeded

5. Grafana インスタンスを起動するには、ServiceTelemetry オブジェクトを作成または変更します。graphing.enabled および graphing.grafana.ingressEnabled を true に設定します。オプションで、graphing.grafana.baseImage の値を、デプロイされる Grafana ワークロードコンテナーイメージに設定します。

   $ oc edit stf default
   
   apiVersion: infra.watch/v1beta1
   kind: ServiceTelemetry
   ...
   spec:
     ...
     graphing:
       enabled: true
       grafana:
         ingressEnabled: true
         baseImage: 'registry.redhat.io/rhel8/grafana:7'

6. Grafana インスタンスがデプロイされたことを確認します。

   $ oc get pod -l app=grafana
   
   NAME                                  READY   STATUS    RESTARTS   AGE
   grafana-deployment-7fc7848b56-sbkhv   1/1     Running   0          1m

7. Grafana のデータソースが正しくインストールされたことを確認します。

   $ oc get grafanadatasources
   
   NAME                    AGE
   default-datasources     20h

8. Grafana のルートが存在することを確認します。

   $ oc get route grafana-route
   
   NAME            HOST/PORT                                          PATH   SERVICES          PORT   TERMINATION   WILDCARD
   grafana-route   grafana-route-service-telemetry.apps.infra.watch          grafana-service   3000   edge          None

手順

1. Red Hat OpenShift Container Platform にログインします。

2. service-telemetry namespace に切り替えます。

   $ oc project service-telemetry

3. STF オブジェクトからデフォルトのユーザー名とパスワードを取得します。

   $ oc get stf default -o jsonpath="{.spec.graphing.grafana['adminUser','adminPassword']}"

4. ServiceTelemetry オブジェクトを介して Grafana 管理者のユーザー名およびパスワードのデフォルト値を変更するには、graphing.grafana.adminUser および graphing.grafana.adminPassword パラメーターを使用します。

手順

1. Red Hat OpenShift Container Platform にログインします。

2. service-telemetry namespace に切り替えます。

   $ oc project service-telemetry

3. Service Telemetry オブジェクトを編集します。

   $ oc edit stf default

4. retention: 7d を backends.metrics.prometheus.storage の storage セクションに追加し、保持期間を 7 日間増やします。

   注記

   保持期間を長く設定すると、設定された Prometheus システムからデータを取得すると、クエリーで結果の速度が遅くなる可能性があります。

   apiVersion: infra.watch/v1beta1
   kind: ServiceTelemetry
   metadata:
     name: stf-default
     namespace: service-telemetry
   spec:
     ...
     backends:
       metrics:
         prometheus:
           enabled: true
           storage:
             strategy: persistent
             retention: 7d
       ...

5. 変更内容を保存し、オブジェクトを閉じます。

手順

1. Red Hat OpenShift Container Platform にログインします。

2. service-telemetry namespace に切り替えます。

   $ oc project service-telemetry

3. アラートルールを含む PrometheusRule オブジェクトを作成します。Prometheus Operator は、ルールを Prometheus に読み込みます。

   $ oc apply -f - <<EOF
   apiVersion: monitoring.coreos.com/v1
   kind: PrometheusRule
   metadata:
     creationTimestamp: null
     labels:
       prometheus: default
       role: alert-rules
     name: prometheus-alarm-rules
     namespace: service-telemetry
   spec:
     groups:
       - name: ./openstack.rules
         rules:
           - alert: Collectd metrics receive rate is zero
             expr: rate(sg_total_collectd_msg_received_count[1m]) == 0
   EOF

   ルールを変更するには、expr パラメーターの値を編集します。

4. Operator がルールを Prometheus に読み込んだことを確認するには、Basic 認証で default-prometheus-proxy ルートに対して curl コマンドを実行します。

   $ curl -k --user "internal:$(oc get secret default-prometheus-htpasswd -ogo-template='{{ .data.password | base64decode }}')" https://$(oc get route default-prometheus-proxy -ogo-template='{{ .spec.host }}')/api/v1/rules
   
   {"status":"success","data":{"groups":[{"name":"./openstack.rules","file":"/etc/prometheus/rules/prometheus-default-rulefiles-0/service-telemetry-prometheus-alarm-rules.yaml","rules":[{"state":"inactive","name":"Collectd metrics receive count is zero","query":"rate(sg_total_collectd_msg_received_count[1m]) == 0","duration":0,"labels":{},"annotations":{},"alerts":[],"health":"ok","evaluationTime":0.00034627,"lastEvaluation":"2021-12-07T17:23:22.160448028Z","type":"alerting"}],"interval":30,"evaluationTime":0.000353787,"lastEvaluation":"2021-12-07T17:23:22.160444017Z"}]}}

手順

1. oc edit コマンドを使用します。

   $ oc edit prometheusrules prometheus-alarm-rules

2. PrometheusRules マニフェストを編集します。
3. マニフェストを保存し、終了します。

手順

1. Red Hat OpenShift Container Platform にログインします。

2. service-telemetry namespace に切り替えます。

   $ oc project service-telemetry

3. STF デプロイメントの ServiceTelemetry オブジェクトを編集します。

   $ oc edit stf default

4. 新規パラメーター alertmanagerConfigManifest および Secret オブジェクトの内容を追加し、Alertmanager の alertmanager.yaml 設定を定義します。

   注記

   この手順では、Service Telemetry Operator が管理するデフォルトのテンプレートを読み込みます。変更が正しく入力されていることを確認するには、値を変更して alertmanager-default シークレットを返し、新しい値がメモリーに読み込まれていることを確認します。たとえば、パラメーター global.resolve_timeout の値を 5m から 10m に変更します。

   apiVersion: infra.watch/v1beta1
   kind: ServiceTelemetry
   metadata:
     name: default
     namespace: service-telemetry
   spec:
     backends:
       metrics:
         prometheus:
           enabled: true
     alertmanagerConfigManifest: |
       apiVersion: v1
       kind: Secret
       metadata:
         name: 'alertmanager-default'
         namespace: 'service-telemetry'
       type: Opaque
       stringData:
         alertmanager.yaml: |-
           global:
             resolve_timeout: 10m
           route:
             group_by: ['job']
             group_wait: 30s
             group_interval: 5m
             repeat_interval: 12h
             receiver: 'null'
           receivers:
           - name: 'null'

5. 設定がシークレットに適用されたことを確認します。

   $ oc get secret alertmanager-default -o go-template='{{index .data "alertmanager.yaml" | base64decode }}'
   
   global:
     resolve_timeout: 10m
   route:
     group_by: ['job']
     group_wait: 30s
     group_interval: 5m
     repeat_interval: 12h
     receiver: 'null'
   receivers:
   - name: 'null'

6. alertmanager-proxy サービスに対して curl コマンドを実行して、ステータスおよび configYAML コンテンツを取得し、指定された設定が Alertmanager の設定と一致することを確認します。

   $ oc run curl -it --serviceaccount=prometheus-k8s --restart='Never' --image=radial/busyboxplus:curl -- sh -c "curl -k -H \"Content-Type: application/json\" -H \"Authorization: Bearer \$(cat /var/run/secrets/kubernetes.io/serviceaccount/token)\" https://default-alertmanager-proxy:9095/api/v1/status"
   
   {"status":"success","data":{"configYAML":"...",...}}

7. configYAML フィールドに予想される変更が含まれることを確認します。

8. 環境を消去するには、curl Pod を削除します。

   $ oc delete pod curl
   
   pod "curl" deleted

手順

1. Red Hat OpenShift Container Platform にログインします。

2. service-telemetry namespace に切り替えます。

   $ oc project service-telemetry

3. STF デプロイメントの ServiceTelemetry オブジェクトを編集します。

   $ oc edit stf default

4. STF を使用してカスタム Alertmanager ルートをデプロイするには、alertmanagerConfigManifest パラメーターを Service Telemetry Operator に渡す必要があります。これにより、更新されたシークレットが作成され、Prometheus Operator の管理対象となります。

   apiVersion: infra.watch/v1beta1
   kind: ServiceTelemetry
   metadata:
     name: default
     namespace: service-telemetry
   spec:
     backends:
       metrics:
         prometheus:
           enabled: true
     alertmanagerConfigManifest: |
       apiVersion: v1
       kind: Secret
       metadata:
         name: 'alertmanager-default'
         namespace: 'service-telemetry'
       type: Opaque
       data:
         alertmanager.yaml: Z2xvYmFsOgogIHJlc29sdmVfdGltZW91dDogMTBtCiAgc2xhY2tfYXBpX3VybDogPHNsYWNrX2FwaV91cmw+CnJlY2VpdmVyczoKICAtIG5hbWU6IHNsYWNrCiAgICBzbGFja19jb25maWdzOgogICAgLSBjaGFubmVsOiAjc3RmLWFsZXJ0cwogICAgICB0aXRsZTogfC0KICAgICAgICAuLi4KICAgICAgdGV4dDogPi0KICAgICAgICAuLi4Kcm91dGU6CiAgZ3JvdXBfYnk6IFsnam9iJ10KICBncm91cF93YWl0OiAzMHMKICBncm91cF9pbnRlcnZhbDogNW0KICByZXBlYXRfaW50ZXJ2YWw6IDEyaAogIHJlY2VpdmVyOiAnc2xhY2snCg==

5. 設定がシークレットに適用されたことを確認します。

   $ oc get secret alertmanager-default -o go-template='{{index .data "alertmanager.yaml" | base64decode }}'
   
   global:
     resolve_timeout: 10m
     slack_api_url: <slack_api_url>
   receivers:
     - name: slack
       slack_configs:
       - channel: #stf-alerts
         title: |-
           ...
         text: >-
           ...
   route:
     group_by: ['job']
     group_wait: 30s
     group_interval: 5m
     repeat_interval: 12h
     receiver: 'slack'

6. alertmanager-proxy サービスに対して curl コマンドを実行して、ステータスおよび configYAML コンテンツを取得し、指定された設定が Alertmanager の設定と一致することを確認します。

   $ oc run curl -it --serviceaccount=prometheus-k8s --restart='Never' --image=radial/busyboxplus:curl -- sh -c "curl -k -H \"Content-Type: application/json\" -H \"Authorization: Bearer \$(cat /var/run/secrets/kubernetes.io/serviceaccount/token)\" https://default-alertmanager-proxy:9095/api/v1/status"
   
   {"status":"success","data":{"configYAML":"...",...}}

7. configYAML フィールドに予想される変更が含まれることを確認します。

8. 環境を消去するには、curl Pod を削除します。

   $ oc delete pod curl
   
   pod "curl" deleted

手順

1. Red Hat OpenShift Container Platform にログインします。

2. service-telemetry namespace に切り替えます。

   $ oc project service-telemetry

3. oc コマンドで ServiceTelemetry オブジェクトを編集します。

   $ oc edit stf default

4. highAvailability.enabled: true を spec セクションに追加します。

   apiVersion: infra.watch/v1beta1
   kind: ServiceTelemetry
   ...
   spec:
     ...
     highAvailability:
       enabled: true

5. 変更内容を保存し、オブジェクトを閉じます。

手順

1. Red Hat OpenShift Container Platform にログインします。

2. service-telemetry namespace に切り替えます。

   $ oc project service-telemetry

3. Service Telemetry オブジェクトを編集します。

   $ oc edit stf default

4. ...storage.strategy: ephemeral パラメーターを関連コンポーネントの spec セクションに追加します。

   apiVersion: infra.watch/v1beta1
   kind: ServiceTelemetry
   metadata:
     name: stf-default
     namespace: service-telemetry
   spec:
     alerting:
       enabled: true
       alertmanager:
         storage:
           strategy: ephemeral
     backends:
       metrics:
         prometheus:
           enabled: true
           storage:
             strategy: ephemeral
       events:
         elasticsearch:
           enabled: true
           storage:
             strategy: ephemeral

5. 変更内容を保存し、オブジェクトを閉じます。

手順

1. spec パラメーターに observabilityStrategy: none プロパティーを指定して ServiceTelemetry オブジェクトを作成します。マニフェストは、すべてのメトリクスコレクタータイプを持つ単一のクラウドから Telemetry を受け取るのに適した STF のデフォルトデプロイメントを示しています。

   $ oc apply -f - <<EOF
   apiVersion: infra.watch/v1beta1
   kind: ServiceTelemetry
   metadata:
     name: default
     namespace: service-telemetry
   spec:
     observabilityStrategy: none
   EOF

2. すべてのワークロードが適切に動作していることを確認するには、Pod および各 Pod のステータスを確認します。

   $ oc get pods
   NAME                                                      READY   STATUS    RESTARTS   AGE
   default-cloud1-ceil-meter-smartgateway-59c845d65b-gzhcs   3/3     Running   0          132m
   default-cloud1-coll-meter-smartgateway-75bbd948b9-d5phm   3/3     Running   0          132m
   default-cloud1-sens-meter-smartgateway-7fdbb57b6d-dh2g9   3/3     Running   0          132m
   default-interconnect-668d5bbcd6-57b2l                     1/1     Running   0          132m
   interconnect-operator-b8f5bb647-tlp5t                     1/1     Running   0          47h
   service-telemetry-operator-566b9dd695-wkvjq               1/1     Running   0          156m
   smart-gateway-operator-58d77dcf7-6xsq7                    1/1     Running   0          47h

手順

1. service-telemetry プロジェクトに変更します。

   $ oc project service-telemetry

2. Service Telemetry Operator サブスクリプションを削除します。

   $ oc delete sub --selector=operators.coreos.com/service-telemetry-operator.service-telemetry
   
   subscription.operators.coreos.com "service-telemetry-operator" deleted

3. Service Telemetry Operator ClusterServiceVersion を削除します。

   $ oc delete csv --selector=operators.coreos.com/service-telemetry-operator.service-telemetry
   
   clusterserviceversion.operators.coreos.com "service-telemetry-operator.v1.4.1669718959" deleted

検証

1. Service Telemetry Operator のデプロイが実行されていないことを確認します。

   $ oc get deploy --selector=operators.coreos.com/service-telemetry-operator.service-telemetry
   
   No resources found in service-telemetry namespace.

2. Service Telemetry Operator サブスクリプションが存在しないことを確認します。

   $ oc get sub --selector=operators.coreos.com/service-telemetry-operator.service-telemetry
   
   No resources found in service-telemetry namespace.

3. Service Telemetry Operator ClusterServiceVersion が存在しないことを確認します。

   $ oc get csv --selector=operators.coreos.com/service-telemetry-operator.service-telemetry
   
   No resources found in service-telemetry namespace.

手順

1. service-telemetry プロジェクトに変更します。

   $ oc project service-telemetry

2. Smart Gateway Operator サブスクリプションを削除します。

   $ oc delete sub --selector=operators.coreos.com/smart-gateway-operator.service-telemetry
   
   subscription.operators.coreos.com "smart-gateway-operator-stable-1.4-redhat-operators-openshift-marketplace" deleted

3. Smart Gateway Operator ClusterServiceVersion を削除します。

   $ oc delete csv --selector=operators.coreos.com/smart-gateway-operator.service-telemetry
   
   clusterserviceversion.operators.coreos.com "smart-gateway-operator.v4.0.1669718962" deleted

検証

1. Smart Gateway Operator デプロイメントが実行されていないことを確認します。

   $ oc get deploy --selector=operators.coreos.com/smart-gateway-operator.service-telemetry
   
   No resources found in service-telemetry namespace.

2. Smart Gateway Operator サブスクリプションが存在しないことを確認します。

   $ oc get sub --selector=operators.coreos.com/smart-gateway-operator.service-telemetry
   
   No resources found in service-telemetry namespace.

3. Smart Gateway Operator ClusterServiceVersion が存在しないことを確認します。

   $ oc get csv --selector=operators.coreos.com/smart-gateway-operator.service-telemetry
   
   No resources found in service-telemetry namespace.

手順

1. AMQ Certificate Manager Operator サブスクリプションを削除します。

   $ oc delete sub --namespace openshift-operators --selector=operators.coreos.com/amq7-cert-manager-operator.openshift-operators
   
   subscription.operators.coreos.com "amq7-cert-manager-operator" deleted

2. AMQ Certificate Manager Operator ClusterServiceVersion を削除します。

   $ oc delete csv --namespace openshift-operators --selector=operators.coreos.com/amq7-cert-manager-operator.openshift-operators
   
   clusterserviceversion.operators.coreos.com "amq7-cert-manager.v1.0.11" deleted

検証

1. AMQ Certificate Manager Operator デプロイメントが実行されていないことを確認します。

   $ oc get deploy --namespace openshift-operators --selector=operators.coreos.com/amq7-cert-manager-operator.openshift-operators
   
   No resources found in openshift-operators namespace.

2. AMQ Certificate Manager Operator サブスクリプションが存在しないことを確認します。

   $ oc get sub --namespace openshift-operators --selector=operators.coreos.com/amq7-cert-manager-operator.service-telemetry
   
   No resources found in openshift-operators namespace.

3. AMQ Certificate Manager オペレータークラスターサービスバージョンが存在しないことを確認します。

   $ oc get csv --namespace openshift-operators --selector=operators.coreos.com/amq7-cert-manager-operator.openshift-operators
   
   No resources found in openshift-operators namespace.

手順

1. Grafana オペレーターのサブスクリプションを削除します。

   $ oc delete sub --selector=operators.coreos.com/grafana-operator.service-telemetry
   
   subscription.operators.coreos.com "grafana-operator" deleted

2. Grafana オペレーター ClusterServiceVersion を削除します。

   $ oc delete csv --selector=operators.coreos.com/grafana-operator.service-telemetry
   
   clusterserviceversion.operators.coreos.com "grafana-operator.v3.10.3" deleted

検証

1. Grafana Operator デプロイメントが実行されていないことを確認します。

   $ oc get deploy --selector=operators.coreos.com/grafana-operator.service-telemetry
   
   No resources found in service-telemetry namespace.

2. Grafana Operator サブスクリプションが存在しないことを確認します。

   $ oc get sub --selector=operators.coreos.com/grafana-operator.service-telemetry
   
   No resources found in service-telemetry namespace.

3. Grafana オペレータークラスターサービスバージョンが存在しないことを確認します。

   $ oc get csv --selector=operators.coreos.com/grafana-operator.service-telemetry
   
   No resources found in service-telemetry namespace.