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.9.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
1.11.2.1.1. 説明
MultiClusterObservability リソースを作成します。
1.11.2.1.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Body |
body | 作成する MultiClusterObservability リソースを記述するパラメーター |
1.11.2.1.3. 応答
| 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. 要求の body
{
"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" : " "
}
}
}
}1.11.2.2. すべての multiclusterobservability のクエリー
GET /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities
1.11.2.2.1. 説明
MultiClusterObservability リソースに対してクエリーを実行して詳細を確認します。
1.11.2.2.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
1.11.2.2.3. レスポンス
| 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}1.11.2.3.1. 説明
単一の MultiClusterObservability リソースに対してクエリーを実行して詳細を確認します。
1.11.2.3.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| パス |
multiclusterobservability_name | 問い合わせる multiclusterobservability の名前 | string |
1.11.2.3.3. レスポンス
| 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}1.11.2.4.1. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| パス |
multiclusterobservability_name | 削除する multiclusterobservability の名前 | string |
1.11.2.4.2. レスポンス
| 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
| Name | 説明 | スキーマ |
|---|---|---|
|
apiVersion | MultiClusterObservability のバージョンスキーマ | string |
|
kind | REST リソース (MultiClusterObservability) を表す文字列の値 | string |
|
metadata | ポリシーを定義するルールを記述します。 | オブジェクト |
spec
| 名前 | 説明 | スキーマ |
|---|---|---|
|
enableDownsampling |
downsample を有効または無効にします。デフォルト値は | boolean |
|
imagePullPolicy |
MultiClusterObservability イメージのプルポリシー。デフォルト値は | corev1.PullPolicy |
|
imagePullSecret |
MultiClusterObservability イメージのプルシークレット。デフォルト値は | string |
|
nodeSelector | ノードセレクターの仕様 | map[string]string |
|
observabilityAddonSpec | 可観測性アドオンがインストール済みの全マネージドクラスターのグローバル設定 | |
|
storageConfig | 可観測性が使用するストレージ設定を指定します。 | StorageConfig |
|
tolerations | すべてのコンポーネントがテイントを容認する機能を提供します。 | []corev1.Toleration |
|
advanced | 可観測性の詳細設定 | |
|
resources | MultiClusterObservability で必要なコンピュートリソース | corev1.ResourceRequirements |
|
replicas | MultiClusterObservability のレプリカ | 整数 |
storageConfig
| Name | 説明 | スキーマ |
|---|---|---|
|
alertmanagerStorageSize |
alertmanager ステートフルセットに適用されるストレージの量。デフォルト値は | string |
|
compactStorageSize |
thanos のコンパクトなステートフルセットに適用されるストレージの量。デフォルト値は | string |
|
metricObjectStorage | メトリックのシークレットを設定するオブジェクトストア | |
|
receiveStorageSize |
thanos 受信ステートフルセットに適用されるストレージの量。デフォルト値は | string |
|
ruleStorageSize |
thanos ルールのステートフルセットに適用されるストレージの量。デフォルト値は | string |
|
storageClass |
| string |
|
storeStorageSize |
thanos ストアステートフルセットに適用されるストレージの量。デフォルト値は | string |
|
writeStorage | エンドポイントアクセス情報のリスト。 | [ ]WriteStorage |
writeStorage
| Name | 説明 | スキーマ |
|---|---|---|
|
name | エンドポイントアクセス情報を持つシークレットの名前。 | string |
|
key | 選択するシークレットのキー。 | string |
metricObjectStorage
| Name | 説明 | スキーマ |
|---|---|---|
|
key | 選択するシークレットのキー。有効な秘密鍵でなければなりません。Thanos のドキュメント を参照してください。 | string |
|
name |
| string |
observabilityAddonSpec
| Name | 説明 | スキーマ |
|---|---|---|
|
enableMetrics |
可観測性アドオンがメトリックをハブクラスターに送信するかどうかを指定します。デフォルト値は | boolean |
|
interval |
可観測性アドオンがメトリックをハブクラスターに送信する間隔。デフォルト値は 300 秒 ( | integer |
|
resources |
メトリックコレクターリソース要件のリソースデフォルトの CPU 要求は | corev1.ResourceRequirements |
advanced
| Name | 説明 | スキーマ |
|---|---|---|
|
retentionConfig | 可観測性によって使用されるデータ保持設定を指定します。 |
|
|
rbacQueryProxy | rbac-query-proxy デプロイメントのレプリカおよびリソースを指定します。 | CommonSpec |
|
grafana | grafana デプロイメントのレプリカおよびリソースを指定します。 | CommonSpec |
|
alertmanager | alertmanager ステートフルセットのレプリカおよびリソースを指定します。 | CommonSpec |
|
observatoriumAPI |
| CommonSpec |
|
queryFrontend | query-frontend デプロイメントのレプリカおよびリソースを指定します。 | CommonSpec |
|
query | クエリーデプロイメントのレプリカおよびリソースを指定します。 | CommonSpec |
|
receive | 受信ステートフルセットのレプリカおよびリソースを指定します。 | CommonSpec |
|
rule | ルールのステートフルセットのレプリカおよびリソースを指定します。 | CommonSpec |
|
store | ストアステートフルセットのレプリカおよびリソースを指定します。 | CommonSpec |
|
CompactSpec | コンパクトなステートフルセットのリソースを指定します。 | |
|
storeMemcached | store-memcached のレプリカ、リソースなどを指定します。 | |
|
queryFrontendMemcached | query-frontend-memcached のレプリカ、リソースなどを指定します。 | CacheConfig |
retentionConfig
| Name | 説明 | スキーマ |
|---|---|---|
|
blockDuration |
時系列データベース (TSDB) ブロックを停止する時間。デフォルト値は | string |
|
cleanupInterval |
部分的にアップロードされたブロックが消去される頻度および、 | string |
|
deleteDelay |
削除対象のブロックがバケットから削除されるまでの期間。デフォルト値は | string |
|
retentionInLocal |
ローカルストレージからの未加工のサンプルを保持する時間。デフォルト値は | string |
|
retentionResolutionRaw |
バスケットで未加工の解像度サンプルを保持する時間。デフォルト値は 30 日 ( | string |
|
retentionResolution5m |
バスケットに解像度 1 (5 分) のサンプルを保持する時間。デフォルト値は 180 日 ( | string |
|
retentionResolution1h |
バスケットに解像度 2 (1 時間) のサンプルを保持する時間。デフォルト値は 0 日 ( | string |
CompactSpec
| Name | 説明 | スキーマ |
|---|---|---|
|
resources | thanos compact に必要なリソースを計算します。 | corev1.ResourceRequirements |
|
serviceAccountAnnotations | アノテーションは、コンパクトサービスアカウントに保存されている非構造化キーバリューマップです。 | map[string]string |
storeMemcached
| Name | 説明 | スキーマ |
|---|---|---|
|
resources | MultiCLusterObservability で必要なコンピュートリソース | corev1.ResourceRequirements |
|
replicas | MultiClusterObservability のレプリカ | integer |
|
memoryLimitMb | メガバイト単位の Memcached のメモリー制限 | integer |
|
maxItemSize |
Memcached の最大項目サイズ。デフォルト値は | string |
|
connectionLimit | Memcached の同時接続の最大数。デフォルト値: | 整数 |
status
| Name | 説明 | スキーマ |
|---|---|---|
|
status | ステータスには、MultiClusterObservability のさまざまな条件のステータスが含まれます。 | metav1.Condition |
CommonSpec
| Name | 説明 | スキーマ |
|---|---|---|
|
resources | コンポーネントに必要なリソースを計算します。 | corev1.ResourceRequirements |
|
replicas | コンポーネントのレプリカ。 | 整数 |
QuerySpec
| Name | 説明 | スキーマ |
|
CommonSpec | クエリーデプロイメントのレプリカおよびリソースを指定します。 | CommonSpec |
|
serviceAccountAnnotations | アノテーションは、クエリーサービスアカウントとともに保存される非構造化キー値マップです。 | map[string]string |
ReceiveSpec
| Name | 説明 | スキーマ |
|
CommonSpec | クエリーデプロイメントのレプリカおよびリソースを指定します。 | CommonSpec |
|
serviceAccountAnnotations | アノテーションは、クエリーサービスアカウントとともに保存される非構造化キー値マップです。 | map[string]string |
StoreSpec
| Name | 説明 | スキーマ |
|
CommonSpec | クエリーデプロイメントのレプリカおよびリソースを指定します。 | CommonSpec |
|
serviceAccountAnnotations | アノテーションは、クエリーサービスアカウントとともに保存される非構造化キー値マップです。 | map[string]string |
RuleSpec
| Name | 説明 | スキーマ |
|
CommonSpec | クエリーデプロイメントのレプリカおよびリソースを指定します。 | CommonSpec |
|
evalInterval | ルールの評価間隔を指定します。 | string |
|
serviceAccountAnnotations | アノテーションは、クエリーサービスアカウントとともに保存される非構造化キー値マップです。 | map[string]string |
