Red Hat Summit Red Hat Summitサポートコンソール開発者トライアルの開始お問い合わせ

1.11. Observability API

1.11.1. 概要
リンクのコピー

このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の MultiClusterObservability リソースについて説明します。MultiClusterObservability リソースには、create、query、delete、update の 4 つの要求を使用できます。

1.11.1.1. バージョン情報
リンクのコピー

バージョン: 2.7.0

1.11.1.2. URI スキーム
リンクのコピー

ベースパス: /kubernetes/apis
スキーム: HTTPS

1.11.1.3. タグ
リンクのコピー

  • observability.open-cluster-management.io: multiclusterobservabilities を作成して管理します。

1.11.2. パス
リンクのコピー

1.11.2.1. multiclusterobservability リソースの作成
リンクのコピー

POST /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities
Copy to Clipboard Toggle word wrap
1.11.2.1.1. 説明
リンクのコピー

MultiClusterObservability リソースを作成します。

1.11.2.1.2. パラメーター
リンクのコピー
Expand
型名前説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

ボディー

body
必須

作成する MultiClusterObservability リソースを記述するパラメーター

MultiClusterObservability

1.11.2.1.3. 応答
リンクのコピー
Expand
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.11.2.1.4. 消費
リンクのコピー
  • application/yaml
1.11.2.1.5. タグ
リンクのコピー
  • observability.apps.open-cluster-management.io
1.11.2.1.6. HTTP 要求の例
リンクのコピー
1.11.2.1.6.1. 要求のボディー
リンクのコピー
{
  "apiVersion": "observability.open-cluster-management.io/v1beta2",
  "kind": "MultiClusterObservability",
  "metadata": {
    "name": "example"
  },
  "spec": {
    "observabilityAddonSpec": {}
    "storageConfig": {
      "metricObjectStorage": {
        "name": "thanos-object-storage",
        "key": "thanos.yaml"
      "writeStorage": {
        - "key": " ",
          "name" : " "
        - "key": " ",
          "name" : " "
         }
       }
   }
}
Copy to Clipboard Toggle word wrap

1.11.2.2. すべての multiclusterobservability のクエリー
リンクのコピー

GET /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities
Copy to Clipboard Toggle word wrap
1.11.2.2.1. 説明
リンクのコピー

MultiClusterObservability リソースに対してクエリーを実行して詳細を確認します。

1.11.2.2.2. パラメーター
リンクのコピー
Expand
型名前説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

1.11.2.2.3. レスポンス
リンクのコピー
Expand
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.11.2.2.4. 消費
リンクのコピー
  • application/yaml
1.11.2.2.5. タグ
リンクのコピー
  • observability.apps.open-cluster-management.io

1.11.2.3. 単一の multiclusterobservability のクエリー
リンクのコピー

GET /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities/{multiclusterobservability_name}
Copy to Clipboard Toggle word wrap
1.11.2.3.1. 説明
リンクのコピー

単一の MultiClusterObservability リソースに対してクエリーを実行して詳細を確認します。

1.11.2.3.2. パラメーター
リンクのコピー
Expand
型名前説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

multiclusterobservability_name
必須

問い合わせる multiclusterobservability の名前

文字列

1.11.2.3.3. レスポンス
リンクのコピー
Expand
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.11.2.3.4. タグ
リンクのコピー
  • observability.apps.open-cluster-management.io

1.11.2.4. multiclusterobservability リソースの削除
リンクのコピー

DELETE /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities/{multiclusterobservability_name}
Copy to Clipboard Toggle word wrap
1.11.2.4.1. パラメーター
リンクのコピー
Expand
型名前説明スキーマ

ヘッダー

COOKIE
必須

Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。

文字列

パス

multiclusterobservability_name
必須

削除する multiclusterobservability の名前

文字列

1.11.2.4.2. レスポンス
リンクのコピー
Expand
HTTP コード説明スキーマ

200

成功

コンテンツなし

403

アクセス禁止

コンテンツなし

404

リソースが見つからない

コンテンツなし

500

内部サービスエラー

コンテンツなし

503

サービスが利用できない

コンテンツなし

1.11.2.4.3. タグ
リンクのコピー
  • observability.apps.open-cluster-management.io

1.11.3. 定義
リンクのコピー

1.11.3.1. MultiClusterObservability
リンクのコピー

Expand
Name説明スキーマ

apiVersion
必須

MultiClusterObservability のバージョンスキーマ

string

kind
必須

REST リソース (MultiClusterObservability) を表す文字列の値

string

metadata
必須

ポリシーを定義するルールを記述します。

オブジェクト

spec

Expand
名前説明スキーマ

enableDownsampling
任意

downsample を有効または無効にします。デフォルト値は true です。downsample データがない場合は、クエリーを利用できません。

boolean

imagePullPolicy
任意

MultiClusterObservability イメージのプルポリシー。デフォルト値は Always です。

corev1.PullPolicy

imagePullSecret
任意

MultiClusterObservability イメージのプルシークレット。デフォルト値は multiclusterhub-operator-pull-secret です。

string

nodeSelector
任意

ノードセレクターの仕様

map[string]string

observabilityAddonSpec
必須

可観測性アドオンがインストール済みの全マネージドクラスターのグローバル設定

observabilityAddonSpec

storageConfig
必須

可観測性が使用するストレージ設定を指定します。

StorageConfig

tolerations
任意

すべてのコンポーネントがテイントを容認する機能を提供します。

[]corev1.Toleration

advanced
任意

可観測性の詳細設定

advanced

resources
任意

MultiClusterObservability で必要なコンピュートリソース

corev1.ResourceRequirements

replicas
任意

MultiClusterObservability のレプリカ

整数

storageConfig

Expand
Name説明スキーマ

alertmanagerStorageSize
任意

alertmanager ステートフルセットに適用されるストレージの量。デフォルト値は 1Gi です。

string

compactStorageSize
任意

thanos のコンパクトなステートフルセットに適用されるストレージの量。デフォルト値は 100Gi です。

string

metricObjectStorage
必須

メトリクスのシークレットを設定するオブジェクトストア

metricObjectStorage

receiveStorageSize
任意

thanos 受信ステートフルセットに適用されるストレージの量。デフォルト値は 100Gi です。

string

ruleStorageSize
任意

thanos ルールのステートフルセットに適用されるストレージの量。デフォルト値は 1Gi です。

string

storageClass
任意

storageClass ステートフルセットを指定します。このストレージは、オペレーティングシステムでストレージを作成するように metricObjectStorage が設定されている場合に、オブジェクトストレージに使用します。デフォルト値は gp2 です。

string

storeStorageSize
任意

thanos ストアステートフルセットに適用されるストレージの量。デフォルト値は 10Gi です。

string

writeStorage
optional

エンドポイントアクセス情報のリスト。

[ ]WriteStorage

writeStorage

Expand
Name説明スキーマ

name
必須

エンドポイントアクセス情報を持つシークレットの名前。

string

key
必須

選択するシークレットのキー。

文字列

metricObjectStorage

Expand
Name説明スキーマ

key
必須

選択するシークレットのキー。有効な秘密鍵でなければなりません。Thanos のドキュメント を参照してください。

string

name
必須

metricObjectStorage の名前。詳細は、Kubernetes Names を参照してください。

文字列

observabilityAddonSpec

Expand
Name説明スキーマ

enableMetrics
任意

可観測性アドオンがメトリクスをハブクラスターに送信するかどうかを指定します。デフォルト値は true です。

boolean

interval
任意

可観測性アドオンがメトリクスをハブクラスターに送信する間隔。デフォルト値は 300 秒 (300s) です。

integer

resources
任意

メトリクスコレクターリソース要件のリソースデフォルトの CPU 要求は 100m で、メモリー要求は 100Mi です。

corev1.ResourceRequirements

advanced

Expand
Name説明スキーマ

retentionConfig
任意

可観測性によって使用されるデータ保持設定を指定します。

RetentionConfig

rbacQueryProxy
任意

rbac-query-proxy デプロイメントのレプリカおよびリソースを指定します。

CommonSpec

grafana
任意

grafana デプロイメントのレプリカおよびリソースを指定します。

CommonSpec

alertmanager
任意

alertmanager ステートフルセットのレプリカおよびリソースを指定します。

CommonSpec

observatoriumAPI
任意

observatorium-api デプロイメントのレプリカおよびリソースを指定します。

CommonSpec

queryFrontend
任意

query-frontend デプロイメントのレプリカおよびリソースを指定します。

CommonSpec

query
任意

クエリーデプロイメントのレプリカおよびリソースを指定します。

CommonSpec

receive
任意

受信ステートフルセットのレプリカおよびリソースを指定します。

CommonSpec

rule
任意

ルールのステートフルセットのレプリカおよびリソースを指定します。

CommonSpec

store
任意

ストアステートフルセットのレプリカおよびリソースを指定します。

CommonSpec

CompactSpec
optional

コンパクトなステートフルセットのリソースを指定します。

compact

storeMemcached
任意

store-memcached のレプリカ、リソースなどを指定します。

storeMemcached

queryFrontendMemcached
任意

query-frontend-memcached のレプリカ、リソースなどを指定します。

CacheConfig

retentionConfig

Expand
Name説明スキーマ

blockDuration
任意

時系列データベース (TSDB) ブロックを停止する時間。デフォルト値は 2h です。

string

cleanupInterval
任意

部分的にアップロードされたブロックが消去される頻度および、--wait が有効な削除マークの付いたブロックが消去される頻度。デフォルト値は 5m です。

string

deleteDelay
任意

削除対象のブロックがバケットから削除されるまでの期間。デフォルト値は 48h です。

string

retentionInLocal
任意

ローカルストレージからの未加工のサンプルを保持する時間。デフォルト値は 24h です。

string

retentionResolutionRaw
任意

バスケットで未加工の解像度サンプルを保持する時間。デフォルト値は 30 日 (30d) です。

string

retentionResolution5m
任意

バスケットに解像度 1 (5 分) のサンプルを保持する時間。デフォルト値は 180 日 (180d) です。

string

retentionResolution1h
任意

バスケットに解像度 2 (1 時間) のサンプルを保持する時間。デフォルト値は 0 日 (0d) です。

文字列

CompactSpec

Expand
Name説明スキーマ

resources
任意

thanos compact に必要なリソースを計算します。

corev1.ResourceRequirements

serviceAccountAnnotations
optional

注釈は、コンパクトサービスアカウントに保存されている非構造化キーバリューマップです。

map[string]string

storeMemcached

Expand
Name説明スキーマ

resources
任意

MultiCLusterObservability で必要なコンピュートリソース

corev1.ResourceRequirements

replicas
任意

MultiClusterObservability のレプリカ

integer

memoryLimitMb
任意

メガバイト単位の Memcached のメモリー制限

integer

maxItemSize
任意

Memcached の最大項目サイズ。デフォルト値は 1m, min:1k, max:1024m です。

string

connectionLimit
任意

Memcached の同時接続の最大数。デフォルト値:

整数

status

Expand
Name説明スキーマ

status
任意

ステータスには、MultiClusterObservability のさまざまな条件のステータスが含まれます。

metav1.Condition

CommonSpec

Expand
Name説明スキーマ

resources
任意

コンポーネントに必要なリソースを計算します。

corev1.ResourceRequirements

replicas
任意

コンポーネントのレプリカ。

整数

QuerySpec

Expand

Name

説明

スキーマ

CommonSpec
optional

クエリーデプロイメントのレプリカおよびリソースを指定します。

CommonSpec

serviceAccountAnnotations
optional

注釈は、クエリーサービスアカウントとともに保存される非構造化キー値マップです。

map[string]string

ReceiveSpec

Expand

Name

説明

スキーマ

CommonSpec
optional

クエリーデプロイメントのレプリカおよびリソースを指定します。

CommonSpec

serviceAccountAnnotations
optional

注釈は、クエリーサービスアカウントとともに保存される非構造化キー値マップです。

map[string]string

StoreSpec

Expand

Name

説明

スキーマ

CommonSpec
optional

クエリーデプロイメントのレプリカおよびリソースを指定します。

CommonSpec

serviceAccountAnnotations
optional

注釈は、クエリーサービスアカウントとともに保存される非構造化キー値マップです。

map[string]string

RuleSpec

Expand

Name

説明

スキーマ

CommonSpec
optional

クエリーデプロイメントのレプリカおよびリソースを指定します。

CommonSpec

evalInterval
optional

ルールの評価間隔を指定します。

string

serviceAccountAnnotations
optional

注釈は、クエリーサービスアカウントとともに保存される非構造化キー値マップです。

map[string]string

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

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

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat