Menu Close

Service Telemetry Framework リリースノート 1.3

Red Hat OpenStack Platform 16.2

Service Telemetry Framework 1.3 リリースの詳細

概要

本書では、Service Telemetry Framework の本リリースにおける主な機能、機能拡張、および既知の問題について概説します。

前書き

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。まずは、マスター (master)、スレーブ (slave)、ブラックリスト (blacklist)、ホワイトリスト (whitelist) の 4 つの用語の置き換えから始めます。この取り組みは膨大な作業を要するため、今後の複数のリリースで段階的に用語の置き換えを実施して参ります。詳細は、Red Hat CTO である Chris Wright のメッセージをご覧ください。

第1章 Service Telemetry Framework リリースの概要

Service Telemetry Framework (STF) の本リリースでは、新機能が提供され、STF に固有の問題が解決されました。

STF は、Red Hat の他の製品からのコンポーネントを使用します。これらのコンポーネントのサポートに関する詳細は、「https://access.redhat.com/site/support/policy/updates/openstack/platform/」および「https://access.redhat.com/support/policy/updates/openshift/」を参照してください。

STF 1.3 は、デプロイメントプラットフォームとして OpenShift Container Platform (OCP) バージョン 4.6 と互換性があります。

1.1. 製品サポート

Red Hat カスタマーポータルは、Service Telemetry Framework のインストールおよび設定についてのリソースを提供します。カスタマーポータルでは、以下のタイプのドキュメントが利用できます。

  • 製品ドキュメント
  • ナレッジベースのアーティクルおよびソリューション
  • テクニカルブリーフ
  • サポートケース管理

    カスタマーポータルには https://access.redhat.com/ からアクセスすることができます。

第2章 最も重要な新機能

以下の機能は、Service Telemetry Framework (STF) の新機能です。

Smart Gateway Operator インターフェース
従来の Smart Gateway は、今後の STF バージョンから削除されました。また、sg-core アプリケーションに新たなプラグ可能なアーキテクチャーが実装されています。管理者は、Smart Gateway Operator を使用して、より柔軟な API インターフェースを介して sg-core をより適切に使用することができます。

第3章 Service Telemetry Framework リリースの情報

この Service Telemetry Framework (STF) リリースのサポートされるライフサイクル期間にリリースされる更新についての情報は、各更新に関連するアドバイザリーテキストに表示されます。

3.1. Service Telemetry Framework 1.3

本リリースノートには主に、今回リリースされた Service Telemetry Framework (STF) のインストール時に考慮すべきテクノロジープレビューの項目、推奨事項、既知の問題、非推奨となった機能について記載します。

注記

サービス Telemetry Framework バージョン 1.1 のサポートは、2021 年 6 月 15 日で終了しました。

本リリースには、以下のアドバイザリーが含まれています。

RHEA-2021:2424-01
Service Telemetry Framework のコンポーネントリリース - RPM
RHEA-2021:2425-02
Service Telemetry Framework のコンポーネントリリース - コンテナーイメージ
RHBA-2021:2478-02
Service Telemetry Framework のコンポーネントリリース - コンテナーイメージ
RHBA-2021:2477-02
Service Telemetry Framework の一般的なコンポーネントリリース - コンテナーイメージ
RHBA-2021:2442
サービス Telemetry Framework バージョン 1.1 のサポートは 2021 年 6 月 15 日で終了しました。

3.1.1. 機能拡張

STF の本リリースでは、以下の機能拡張が提供されています。

BZ#1959594
今回の更新により、Smart Gateway Operator インターフェースは、sg-core で追加機能をサポートするようになりました。管理者は、Smart Gateway Operator を使用して、より柔軟な API インターフェースを介して sg-core をより適切に使用することができます。

3.1.2. リリースノート

本項では、STF の注目すべき変更点や推奨プラクティスなど、今回のリリースに関する重要な情報を記載しています。お使いのインストールに最大限の効果をもたらすために、以下の情報を考慮する必要があります。

BZ#1960025

STF 1.3 は infra.watch/v1alpha1 カスタムリソース定義に対応しておらず、infra.watch/v1beta1 をサポートするようになりました。

STF 1.2 では、infra.watch/v1alpha1 インターフェースは非推奨となり、Service Telemetry Operator は infra.watch/v1beta1 への変換を動的にサポートしてきました。STF 1.3 の時点で、このサポートは削除され、infra.watch/v1beta1 のみがサポートされます。STF 1.2 から STF 1.3 にアップグレードする前に、infra.watch/v1beta1 に移行するようにしてください。

BZ#1952188

Ceilometer メトリクスは、RabbitMQ バスを介して Red Hat OpenStack Platform (RHOSP) に内部的に配布され、ceilometer エージェントを介して収集され、sg-core 経由で Prometheus のストレージ用に STF に移動されます。

以前のリリースでは、高可用性モードで RHOSP 環境を設定すると、各コントローラーはコントローラー名が含まれるパブリッシャーラベルでメトリックを収集し、送信していました。その結果、検索していた ceilometer メトリックは Prometheus に書き込まれました。

今回の更新により、ceilometer メトリックのパブリッシャーラベルがドロップされ、ceilometer メトリックを 1 つのラベルセットに折りたたみます。その結果、ceilometer からのメトリックが複数のパブリッシャー全体で破損することはなくなりました。

パブリッシャーラベルに依存する以前のクエリーは機能しない可能性があります。デフォルトの ServiceMonitor オブジェクトを、ServiceTelemetry オブジェクトの servicemonitorManifest パラメーターを使用して上書きできます。

BZ#1954722
RHOSP から STF への接続を許可するには、RHOSP13 で caCertFile パラメーターが必要です。THT 環境ファイルの caCertFile パラメーターをサポートするように RHOSP13 を設定するには、Service Telemetry Framework 1.3Configuring Red Hat OpenStack Platform overcloud for Service Telemetry Frameworkを参照してください。

3.1.3. 非推奨の機能

これらの機能が非推奨になりました。

BZ#1965464
今回のリリースにより、prometheus-webhook-snmp を使用した SNMP によるアラートの配信が非推奨になりました。

3.1.4. 廃止された機能

以下の機能は、本リリースの STF から削除されました。

BZ#1983662
以前のリリースでは、EnableSTF の使用は、STF の OpenStack 設定の一部でした。本リリースでは、STF の設定がベース設定で行われ、EnableSTF の使用が削除されました。ベース設定の詳細は、https://access.redhat.com/documentation/ja-jp/red_hat_openstack_platform/16.1/html-single/service_telemetry_framework_1.3/index#creating-the-base-configuration-for-stf_assembly-completing-the-stf-configuration を参照してください。

3.2. Service Telemetry Framework 1.3.1 メンテナンスリリース (2021 年 7 月 19 日)

本リリースノートには、本リリースの Service Telemetry Framework (STF) のインストール時に考慮すべきバグ修正および機能拡張が強調表示されています。

本リリースには、以下のアドバイザリーが含まれています。

RHBA-2021:2771
Service Telemetry Framework のコンポーネントリリース v1.3.1

3.2.1. バグ修正

以下のバグは、以下の STF リリースで修正されました。

BZ#1979637

今回の更新以前は、sg-core により公開される Ceilometer メトリックにより、仮想マシンインスタンスの ID がラベル値 host として公開されるようになりました。その結果、ラベル host を使用すると、ノードインスタンスに加えて仮想マシンインスタンスと共にダッシュボードのドロップダウンメニューがオーバーロードされます。

今回の更新により、Ceilometer 仮想マシンインスタンスメトリックが vm_instance ラベルを使用して仮想マシンのインスタンス ID を公開し、仮想マシンインスタンス ID が STF ダッシュボードノードインスタンスのドロップダウンメニューに一覧表示されなくなりました。

BZ#1976981
今回の更新以前は、Service Telemetry Framework (STF) 1.3 で Interconnect クラスターをデプロイする際に、ポート 5672 が AMQ Interconnect に対して有効になりませんでした。そのため、管理者は、デプロイメントを検証するための qdstat でクエリーできませんでした。今回の更新により、AMQ Interconnect Operator によって管理される Interconnect オブジェクトのリスナーの一覧にポート 5672 が追加されました。管理者は qdstat を使用して AMQ Interconnect を検証およびデバッグできるようになりました。
BZ#1979378

本リリース以前は、Smart Gateway はデプロイされない空のオブジェクトを提供するために clouds: {} というドキュメントを参照します。その結果、Smart Gateway はクリアされず、以下のエラーが Service Telemetry Operator のログに表示されました。

"Invalid data passed to loop, it requires a list, got this instead: {}.Hint: If you passed a list/dict of just one element, try adding wantlist=True to your lookup invocation or use q/query instead of lookup."

ドキュメントは、clouds: [] が正しい形式であることを示しており、空のオブジェクトではなく空のリストが渡されるようになります。その結果、Smart Gateway は定義されません。

3.2.2. 機能拡張

STF の本リリースでは、以下の機能拡張が提供されています。

BZ#1975792
今回の更新により、Red Hat OpenShift Container Platform (OCP) 4.6 および 4.7 に Service Telemetry Framework (STF) 1.3 をインストールできるようになりました。

3.2.3. リリースノート

本項では、Service Telemetry Framework (STF) の注目すべき変更点や推奨プラクティスなど、今回のリリースに関する重要な情報を記載しています。お使いのデプロイメントに最大限の効果をもたらすために、以下の情報を考慮する必要があります。

BZ#1940181
STF 1.3 のダッシュボードは、OSP の新しいベース設定で提供されるデータと同期するように再設計されました。これらの場所は STF 1.2 とは異なり、ドキュメントに記載されています。Cloud View および Infrastructure View のダッシュボードは、単一のクラウド環境用に設計されています。

3.3. Service Telemetry Framework 1.3.2 メンテナンスリリース (2021 年 10 月 5 日)

本リリースノートには、本リリースの Service Telemetry Framework (STF) のインストール時に考慮すべきバグ修正および機能拡張が強調表示されています。

本リリースには、以下のアドバイザリーが含まれています。

RHBA-2021:3721
Service Telemetry Framework 1.3.2 のコンポーネントリリース - コンテナーイメージ

3.3.1. バグ修正

以下のバグは、以下の STF リリースで修正されました。

BZ#1979637
このドキュメントでは、Grafana Operator によってデプロイされた Grafana のバージョンが最新のダッシュボード更新と互換性があることを確認できる手順を説明します。管理者は、新しい graphing.grafana.baseImage パラメーターを使用して Grafana 8.1.0 以降を実行できるようになりました。これは最新のダッシュボードサンプルに必要です。
BZ#2008338
ServiceTelemetry マニフェストの clouds パラメーターの設定概要には、これまでは Sensubility の設定例がないため、対応する Smart Gateway はデプロイされませんでした。Sensubility サポートの設定を反映するようにドキュメントが更新されました。

3.3.2. 機能拡張

STF の本リリースでは、以下の機能拡張が提供されています。

BZ#1979642
ドキュメントで参照されるダッシュボードは、複数のクラウドと互換性を持つようになり、管理者が簡単に個々のクラウドを視覚化できるようになりました。
BZ#1958934
仮想マシンビューのダッシュボードが更新され、STF 1.3 と連携するようになりました。以前のバージョンでは、infrawatch/dashboard リポジトリーの vm-view.json ファイルは STF 1.3 では機能しませんでした。Grafana Operator によって管理される GrafanaDashboard オブジェクトとしてダッシュボードをインストールすることができませんでした。

3.3.3. リリースノート

本項では、Service Telemetry Framework (STF) の注目すべき変更点や推奨プラクティスなど、今回のリリースに関する重要な情報を記載しています。お使いのデプロイメントに最大限の効果をもたらすために、以下の情報を考慮する必要があります。

BZ#1989660
STF 1.3 の最新リリースが RHOSP 16.2.1 で動作するように検証されています。

3.3.4. 非推奨の機能

本項には、サポートされなくなった機能、または今後のリリースでサポートされなくなる予定の機能について記載します。

BZ#2002711
以前のバージョンでは、Elastic Cloud on Kubernetes (ECK) Operator は OperatorHub.io CatalogSource からインストールされていました。Service Telemetry Framework v1.3.2 では、ドキュメントは Certified Operators CatalogSource から ECK Operator を使用するように更新されました。
BZ#2002714

redhat-operators-stf CatalogSource の使用は、Service Telemetry Framework v1.3 のドキュメントから削除されました。これは、v4.5 を超えた OpenShift Container Platform バージョンで利用できない Operator への回避策として AMQ Certificate Manager Operator のコピーをインストールするために使用されます。

AMQ Certificate Operator は、OpenShift Container Platform v4.7 の redhat-operators CatalogSource で再び利用可能となり、追加の CatalogSource の使用は不要になりました。

ビルドされた AMQ Certificate Manager v1.0.1 に移行するには、以下の手順を実行します。

  1. redhat-operators-stf CatalogSource によって提供される既存の AMQ Certificate Manager をアンインストールします。
  2. Service Telemetry Framework v1.3」で説明されている redhat-operators CatalogSource によって提供される新しい AMQ Certificate Manager にサブスクライブします。
  3. redhat-operators-stf CatalogSource を削除します。

3.3.5. 廃止された機能

以下の機能は、本リリースの STF から削除されました。

BZ#2004142
管理者に必要なアクション項目がないため、Node Tuning Operator に関するドキュメントはドキュメントから削除されました。OpenShift Container Platform は、Service Telemetry Operator によって定義された ElasticSearch をスケジュールする際にノードのチューニングを適切に処理します。

3.4. Service Telemetry Framework 1.3.3 メンテナンスリリース(2021 年 11 月 10 日)

本リリースノートには、本リリースの Service Telemetry Framework (STF) のインストール時に考慮すべきバグ修正および機能拡張が強調表示されています。

本リリースには、以下のアドバイザリーが含まれています。

RHBA-2021:4582
Service Telemetry Framework 1.3.3 - コンテナーイメージ用のコンポーネントのリリース

3.4.1. バグ修正

以下のバグは、以下の STF リリースで修正されました。

BZ#2011603
今回の更新により、servicetelemetrys.infra.watch CRD には clouds[].name を英数字 10 文字に制限する検証が追加され、クラウド名に追加の文字が加えられる問題や、名前が長くなりすぎる問題を回避できます。
BZ#1959166

以前のバージョンでは、Elastic Cloud on Kubernetes(ECK)Operator をインストールせずに STF をインストールすると、エラーメッセージ「Failed to find exact match for elasticsearch.k8s.elastic.co/v1beta1.Elasticsearch」が返されていました。このエラーは、存在しない API インターフェースから情報を検索しようとする Service Telemetry Operator が原因でした。

今回の更新により、Service Telemetry Operator は ECK 提供の API インターフェースへの要求作成を試行する前に API が存在することを確認します。

BZ#1875854

今回の更新以前は、alert.yaml での CPU 使用率の高いクエリーが無効となっていました。また、rhos-dashboard のグローバルアラートパネルに保留中のアラートが表示されるので誤検出が発生します。つまり、CPU が高いという警告や重要なアラームが誤ってトリガーされたり、CPU 使用率が高いことが検出されても、警告やアラームがトリガーされない場合があります。

今回のリリースでは、ホストごとにグループ化された CPU 使用率の合計を計算してその値をホストのコア数で除算することで、CPU アラートクエリーが新しい記録ルールを使用するようになり、CPU 使用率が 0 から 100% の間で使用できるようになります。

BZ#2011145
Alertmanager ルールの作成を確認するために使用されるコマンドには、有効でなくなった oc CLI パラメーターが使用されていました。ドキュメントが更新され、非推奨のパラメーターを使用しなくなりました。

3.4.2. リリースノート

本項では、Service Telemetry Framework (STF) の注目すべき変更点や推奨プラクティスなど、今回のリリースに関する重要な情報を記載しています。お使いのデプロイメントに最大限の効果をもたらすために、以下の情報を考慮する必要があります。

BZ#2013268
STF 1.3.3 は、インストールプラットフォームとして OpenShift Container Platform 4.8 をサポートするようになりました。
BZ#2023763
このリリースでは、base64 でエンコードされた設定を使用して、複雑な alertmanager ルートの設定を定義する方法についての追加ドキュメントがあります。一部の alertmanager.yaml 設定では、Ansible Operator が構成をインラインで解析しようとするため、Operator が失敗する可能性がありました。

3.5. Service Telemetry Framework 1.3.4 Maintenance Release(2022 年 2 月 22 日)

本リリースノートには、本リリースの Service Telemetry Framework (STF) のインストール時に考慮すべきバグ修正および機能拡張が強調表示されています。

3.5.1. バグ修正

以下のバグは、以下の STF リリースで修正されました。

BZ#2016460
Ceilometer のメトリックは sg-core によって適切に処理されないことがありました。これにより、一部の Ceilometer メトリックが Prometheus に保存されませんでした。本リリースでは、メトリックの処理がより堅牢になりました。sg-core は Ceilometer の大きなメッセージをサポートするように強化されましたが、sg-bridge リングバッファーを介して大きなメッセージを渡すには、追加の変更が必要になります。この機能を完全にサポートするために必要な変更は RHBZ#2053683 で追跡されています。
BZ#2047932
以前のバージョンでは、サンプルカスタムリソースと ClusterServiceVersion リソースの x-descriptor に無効な設定がありました。OpenShift UI から ServiceTelemetry マニフェストをインストールすると無効な CustomResource マニフェストが発生し、これにより STF 1.4 へのアップグレードで問題が発生する可能性がありました。今回の更新により、CustomResource の例および alertmanager パラメーターの ClusterServiceVersion x-descriptors が修正されました。デフォルトの UI 設定で STF 1.3 をデプロイすると、STF は 1.3 から 1.4 にアップグレードされました。
BZ#2046538
Service Telemetry Framework(STF)1.4 のリリースにより、依存関係のインストールに不適切な Smart Gateway Operator チャネルが使用されます。その結果、新規の STF 1.3 インストールは、誤った Smart Gateway Operator チャネルおよび誤った Smart Gateway Operator バージョンを使用します。今回の更新により、ドキュメントには、Smart Gateway Operator サブスクリプションで適切なチャネルを使用するためのステップが含まれるようになりました。

3.5.2. 機能拡張

STF の本リリースでは、以下の機能拡張が提供されています。

BZ#2032661
STF 1.3.4 リリースでは、backend .events.elasticsearch.version パラメーターが ServiceTelemetry マニフェストに追加され、Service Telemetry Framework が Elastic Cloud on Kubernetes(ECK)Operator にインストールする Elasticsearch バージョンを要求できます。