Red Hat SummitAPI
Red Hat Advanced Cluster Management の API のリストを示します。
概要
第1章 API
API にアクセスして、アプリケーションリソース、チャネル、サブスクリプションの作成や管理、さらに情報のクエリーを行うことができます。
非推奨: API のドキュメントは非推奨となりました。現在のサポートされている API を表示するには、コンソールの API Explorer または oc コマンドを使用します。
ユーザーに必要なアクセス権: ロールが割り当てられているアクションのみを実行できます。ロールベースのアクセス制御 のドキュメントで、アクセス要件を確認してください。
統合コンソールからすべての API にアクセスすることもできます。local-cluster ビューから、Home > API Explorer に移動して、API グループを確認します。
詳細は、以下の各リソースに関する API のドキュメントを参照してください。
- Clusters API
- ClusterInstance API
- ClusterSets API (v1beta2)
- ClusterSetBindings API (v1beta2)
- Channels API
- Subscriptions API
- PlacementRules API (非推奨)
- Applications API
- Helm API
- Policy API
- Observability API
- Search query API
- MultiClusterHub API
- Placements API (v1beta1)
- PlacementDecisions API (v1beta1)
- DiscoveryConfig API
- DiscoveredCluster API
- AddOnDeploymentConfig API (v1alpha1)
- ClusterManagementAddOn API (v1alpha1)
- ManagedClusterAddOn API (v1alpha1)
- ManagedClusterSet API
- KlusterletConfig API (v1alpha1)
1.1. Clusters API
非推奨: API のドキュメントは非推奨となりました。現在のサポートされている API を表示するには、コンソールの API Explorer または oc コマンドを使用します。
1.1.1. 概要
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes のクラスターリソースを説明します。Cluster リソースには、create、query、delete、update の 4 つの要求を使用できます。ManagedCluster はマネージドクラスターの望ましい状態と現在の状態を表します。ManagedCluster はクラスタースコープのリソースです。
1.1.1.1. バージョン情報
Version : 2.13.0
1.1.1.2. URI スキーム
BasePath: /kubernetes/apis
Schemes: HTTPS
1.1.1.3. タグ
- cluster.open-cluster-management.io: クラスターを作成して管理します。
1.1.2. パス
1.1.2.1. 全クラスターのクエリー
GET /cluster.open-cluster-management.io/v1/managedclusters1.1.2.1.1. 説明
クラスターに対してクエリーを実行して詳細を確認します。
1.1.2.1.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
1.1.2.1.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.1.2.1.4. 消費されるアイテム
-
cluster/yaml
1.1.2.1.5. タグ
- cluster.open-cluster-management.io
1.1.2.2. クラスターの作成
POST /cluster.open-cluster-management.io/v1/managedclusters1.1.2.2.1. 説明
クラスターの作成
1.1.2.2.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Body |
body | 作成するクラスターを記述するパラメーター |
1.1.2.2.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.1.2.2.4. 消費されるアイテム
-
cluster/yaml
1.1.2.2.5. タグ
- cluster.open-cluster-management.io
1.1.2.2.6. HTTP リクエストの例
1.1.2.2.6.1. リクエストのボディー
{
"apiVersion" : "cluster.open-cluster-management.io/v1",
"kind" : "ManagedCluster",
"metadata" : {
"labels" : {
"vendor" : "OpenShift"
},
"name" : "cluster1"
},
"spec": {
"hubAcceptsClient": true,
"managedClusterClientConfigs": [
{
"caBundle": "test",
"url": "https://test.com"
}
]
},
"status" : { }
}1.1.2.3. 単一クラスターのクエリー
GET /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}1.1.2.3.1. 説明
1 つのクラスターに対してクエリーを実行して詳細を確認します。
1.1.2.3.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
cluster_name | 問い合わせるクラスターの名前。 | string |
1.1.2.3.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.1.2.3.4. タグ
- cluster.open-cluster-management.io
1.1.2.4. クラスターの削除
DELETE /cluster.open-cluster-management.io/v1/managedclusters/{cluster_name}DELETE /hive.openshift.io/v1/{cluster_name}/clusterdeployments/{cluster_name}1.1.2.4.1. 説明
単一クラスターを削除します。
1.1.2.4.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
cluster_name | 削除するクラスターの名前。 | string |
1.1.2.4.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.1.2.4.4. タグ
- cluster.open-cluster-management.io
1.1.3. 定義
1.1.3.1. クラスター
| 名前 | 説明 | スキーマ |
|---|---|---|
|
apiVersion |
| string |
|
kind | REST リソースを表す文字列の値 | string |
|
metadata |
| object |
|
spec |
|
spec
| 名前 | 説明 | スキーマ |
|---|---|---|
|
hubAcceptsClient |
ハブがマネージドクラスター上の klusterlet エージェントとの接続を確立できるかどうかを指定します。デフォルト値は | bool |
|
managedClusterClientConfigs | マネージドクラスターの apiserver アドレスを一覧表示します。 | |
|
leaseDurationSeconds | マネージドクラスター上の klusterlet エージェントのリース更新時間間隔を指定します。デフォルトでは、klusterlet エージェントはそのリースを 60 秒ごとに更新します。 | integer (int32) |
|
taints | スケジューリング中にマネージドクラスターが 1 つ以上のマネージドクラスターセットに割り当てられないようにします。 | taint array |
managedClusterClientConfigs
| 名前 | 説明 | スキーマ |
|---|---|---|
|
URL | string | |
|
CABundle | Pattern: | string (バイト) |
taint
| 名前 | 説明 | スキーマ |
|---|---|---|
|
key | クラスターに適用される taint キー。 | string |
|
value | テイントキーに対応する taint 値。 | string |
|
effect |
taint を許容しない配置に対する taint の影響。有効な値は | string |
1.2. ClusterInstance API
非推奨: API のドキュメントは非推奨となりました。現在のサポートされている API を表示するには、コンソールの API Explorer または oc コマンドを使用します。
1.2.1. 概要
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の ClusterInstance リソースを説明します。ClusterInstance リソースには、create、query、delete、update の 4 つの要求を使用できます。
1.2.1.1. バージョン情報
Version : 2.13.0
1.2.1.2. URI スキーム
BasePath: /kubernetes/apis
Schemes: HTTPS
1.2.1.3. タグ
- siteconfig.open-cluster-management.io: クラスターを作成して管理します。
1.2.2. パス
1.2.2.1. 全クラスターのクエリー
GET /siteconfig.open-cluster-management.io/v1alpha1/{clusterinstance_namespace}/{clusterinstance_name}1.2.2.1.1. 説明
クラスターに対してクエリーを実行して詳細を確認します。
1.2.2.1.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
clusterinstance_namespace | クエリーを実行する ClusterInstance の namespace。 | string |
| Path |
clusterinstance_name | クエリーを実行する ClusterInstance の名前。 | string |
1.2.2.1.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.2.2.1.4. 消費されるアイテム
-
clusterinstance/json
1.2.2.1.5. タグ
- siteconfig.open-cluster-management.io
1.2.2.2. インストールマニフェストの作成
POST /siteconfig.open-cluster-management.io/v1alpha1/<clusterinstance_namespace>/<clusterinstance_name>1.2.2.2.1. 説明
選択したインストール方法に応じて、SiteConfig Operator を使用してインストールマニフェストを作成します。
1.2.2.2.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Body |
body | 作成するインストールマニフェストを記述するパラメーター。 | |
| Path |
clusterinstance_namespace | 使用する ClusterInstance の namespace。 | string |
| Path |
clusterinstance_name | 使用する ClusterInstance の名前。 | string |
1.2.2.2.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.2.2.2.4. 消費されるアイテム
-
clusterinstance/json
1.2.2.2.5. タグ
- siteconfig.open-cluster-management.io
1.2.2.2.6. HTTP リクエストの例
1.2.2.2.6.1. リクエストのボディー
{
"apiVersion": "siteconfig.open-cluster-management.io/v1alpha1",
"kind": "ClusterInstance",
"metadata": {
"name": "site-sno-du-1",
"namespace": "site-sno-du-1"
},
"spec": {
"baseDomain": "example.com",
"pullSecretRef": {
"name": "pullSecretName"
},
"sshPublicKey": "ssh-rsa ",
"clusterName": "site-sno-du-1",
"proxy": {
"noProxys": "foobar"
},
"caBundleRef": {
"name": "my-bundle-ref"
},
"extraManifestsRefs": [
{
"name": "foobar1"
},
{
"name": "foobar2"
}
],
"networkType": "OVNKubernetes",
"installConfigOverrides": "{\"capabilities\":{\"baselineCapabilitySet\": \"None\", \"additionalEnabledCapabilities\": [ \"marketplace\", \"NodeTuning\" ] }}",
"extraLabels": {
"ManagedCluster": {
"group-du-sno": "test",
"common": "true",
"sites": "site-sno-du-1"
}
},
"clusterNetwork": [
{
"cidr": "203.0.113.0/24",
"hostPrefix": 23
}
],
"machineNetwork": [
{
"cidr": "203.0.113.0/24"
}
],
"serviceNetwork": [
{
"cidr": "203.0.113.0/24"
}
],
"additionalNTPSources": [
"NTP.server1",
"198.51.100.100"
],
"ignitionConfigOverride": "{\"ignition\": {\"version\": \"3.1.0\"}, \"storage\": {\"files\": [{\"path\": \"/etc/containers/registries.conf\", \"overwrite\": true, \"contents\": {\"source\": \"data:text/plain;base64,foobar==\"}}]}}",
"diskEncryption": {
"type": "nbde",
"tang": [
{
"url": "http://192.0.2.5:7500",
"thumbprint": "1234567890"
}
]
},
"clusterType": "SNO",
"templateRefs": [
{
"name": "ai-cluster-templates-v1",
"namespace": "rhacm"
}
],
"nodes": [
{
"hostName": "node1",
"role": "master",
"templateRefs": [
{
"name": "ai-node-templates-v1",
"namespace": "rhacm"
}
],
"ironicInspect": "",
"bmcAddress": "idrac-virtualmedia+https://203.0.113.100/redfish/v1/Systems/System.Embedded.1",
"bmcCredentialsName": {
"name": "<bmcCredentials_secre_name>"
},
"bootMACAddress": "00:00:5E:00:53:00",
"bootMode": "UEFI",
"installerArgs": "[\"--append-karg\", \"nameserver=8.8.8.8\", \"-n\"]",
"ignitionConfigOverride": "{\"ignition\": {\"version\": \"3.1.0\"}, \"storage\": {\"files\": [{\"path\": \"/etc/containers/registries.conf\", \"overwrite\": true, \"contents\": {\"source\": \"data:text/plain;base64,foobar==\"}}]}}",
"nodeNetwork": {
"interfaces": [
{
"name": "eno1",
"macAddress": "00:00:5E:00:53:01"
}
],
"config": {
"interfaces": [
{
"name": "eno1",
"type": "ethernet",
"ipv4": {
"enabled": true,
"dhcp": false,
"address": [
{
"ip": "192.0.2.1",
"prefix-length": 24
}
]
},
"ipv6": {
"enabled": true,
"dhcp": false,
"address": [
{
"ip": "2001:0DB8:0:0:0:0:0:1",
"prefix-length": 32
}
]
}
}
],
"dns-resolver": {
"config": {
"server": [
"198.51.100.1"
]
}
},
"routes": {
"config": [
{
"destination": "0.0.0.0/0",
"next-hop-address": "203.0.113.255",
"next-hop-interface": "eno1",
"table-id": 254
}
]
}
}
}
}
]
}
}1.2.2.3. 単一クラスターのクエリー
GET /siteconfig.open-cluster-management.io/v1alpha1/<clusterinstance_namespace>/<clusterinstance_name>1.2.2.3.1. 説明
1 つのクラスターに対してクエリーを実行して詳細を確認します。
1.2.2.3.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
clusterinstance_namespace | クエリーを実行する ClusterInstance の namespace。 | string |
| Path |
clusterinstance_name | クエリーを実行する ClusterInstance の名前。 | string |
1.2.2.3.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.2.2.3.4. タグ
- siteconfig.open-cluster-management.io
1.2.3. 定義
1.2.3.1. ClusterInstance
重要: 特定のフィールドは特定のインストールフローでのみ使用します。関連するドキュメントで、選択したインストール方法で使用するフィールドを確認してください。Assisted Installer と Image Based Install は、次のドキュメントを参照してください。
| 名前 | 説明 | スキーマ |
|---|---|---|
|
apiVersion |
| string |
|
kind | REST リソースを表す文字列の値 | string |
|
metadata |
| object |
|
spec |
| |
|
status |
| status オブジェクト |
spec
| 名前 | 説明 | スキーマ |
|---|---|---|
|
additionalNTPSources | すべてのクラスターホストに追加する必要がある NTP ソースを指定します。これらは、他の手段で設定された NTP ソースに追加されます。 | array |
|
baseDomain | デプロイされたクラスターに使用するベースドメインを指定します。 | string |
|
caBundleRef |
ホストの信頼済み証明書の新しいバンドルが含まれる | string |
|
clusterImageSetNameRef |
デプロイする OpenShift Container Platform のバージョンを示す | string |
|
clusterName | クラスターの名前を指定します。 | string |
|
clusterNetwork | Pod の IP アドレスプールのリストを指定します。 | array |
|
clusterType | クラスタータイプを指定します。以下の値を使用できます。
| string |
|
cpuPartitioningMode |
インストール時に CPU ワークロードのパーティション設定用にセットアップするクラスターを決定します。 | string |
|
diskEncryption | クラスターのディスク暗号化を有効または無効にします。 | object |
|
extraAnnotations |
次の形式を使用して、レンダリングされたテンプレートに適用する追加のクラスターレベルのアノテーションを指定します。 | object |
|
extraLabels |
次の形式を使用して、レンダリングされたテンプレートに適用する追加のクラスターレベルのラベルを指定します。 | object |
|
extraManifestsRefs |
クラスターに適用する追加のマニフェストが含まれる | array |
|
holdInstallation |
Assisted Installer を使用する場合は、インストールを防止するために | bool |
|
ignitionConfigOverride |
初期 Ignition 設定のユーザーオーバーライドを指定します。 | string |
|
installConfigOverrides | インストール設定パラメーターを定義します。 | string |
|
machineNetwork | マシンの IP アドレスプールのリストを指定します。 | array |
|
networkType |
インストールする Container Network Interface (CNI) プラグインを指定します。デフォルト値は、IPv4 の場合は | string |
|
platformType | インストール先となる特定のプラットフォームの名前を定義します。以下の値を使用できます。
| string |
|
proxy | クラスターのインストール設定に使用するプロキシー設定を定義します。 | object |
|
pruneManifests |
| array |
|
pullSecretRef |
イメージをプルするための | object |
|
serviceNetwork | サービスの IP アドレスプールのリストを指定します。 | array |
|
sshPublicKey | インスタンスへのアクセスを提供するための Secure Shell (SSH) 公開鍵を指定します。この鍵は、SSH アクセスを許可するためにホストに追加されます。 | string |
|
nodes | 各ノードの設定パラメーターを指定します。 | ノード 配列 |
|
templateRefs |
クラスターレベルのテンプレートへの参照リストを指定します。クラスターレベルのテンプレートは | array |
nodes
| 名前 | 説明 | スキーマ |
|---|---|---|
|
automatedCleaningMode |
値を | string |
|
bmcAddress | ホストへのアクセスに使用する BMC アドレス。すべてのクラスタータイプに適用されます。BMC アドレス指定の詳細は、関連情報の BMC アドレス指定 を参照してください。注記: ファーエッジの通信会社のユースケースでは、GitOps ZTP での使用は仮想メディアのみがサポートされます。 | string |
|
bmcCredentialsName |
ホスト BMC 認証情報を使用して、別途作成した | string |
|
bootMACAddress |
PXE ブートする MAC アドレスを指定します。仮想 BMC ドリブンの | string |
|
bootMode |
ホストのブートモードを
| string |
|
extraAnnotations |
次の形式を使用して、レンダリングされたテンプレートに適用する追加のノードレベルのアノテーションを指定します。 | object |
|
extraLabels |
レンダリングされたテンプレートに適用する追加のノードレベルのラベルを指定します。 | object |
|
hostName | ホスト名を定義します。 | string |
|
installerArgs | ホストの :op-system-first: インストーラー引数のユーザーオーバーライドを指定します。 | string |
|
ignitionConfigOverride | 初期 Ignition 設定のユーザーオーバーライドを指定します。このフィールドを使用して、永続ストレージのパーティションを割り当てます。ディスク ID とサイズを特定のハードウェアに合わせて調整します。 | string |
|
ironicInspect | ベアメタルホストの登録中に自動イントロスペクションを実行するかどうかを指定します。 | string |
|
nodeLabels | マネージドクラスター内のノードのカスタムノードラベルを指定します。これは、Red Hat Advanced Cluster Management コンポーネントでは使用されず、ユーザーのみが使用する追加のラベルです。カスタムノードラベルを追加すると、そのラベルの特定の設定を参照するカスタムマシン設定プールに関連付けることができます。インストール中にカスタムラベルを追加すると、デプロイメントプロセスがより効率的になり、インストール完了後に追加で再起動する必要がなくなります。
注記: | object |
|
nodeNetwork | 静的ネットワークを持つノードのネットワークを設定します。 | object |
|
pruneManifests |
| array |
|
role |
| string |
|
rootDeviceHints |
デプロイ先となるデバイスを指定します。再起動しても維持される安定した識別子が推奨されます。たとえば、 | object |
|
templateRefs |
ノードレベルのテンプレートへの参照のリストを指定します。ノードレベルのテンプレートは | array |
status
| 名前 | 説明 | スキーマ |
|---|---|---|
|
conditions |
| conditions array |
|
deploymentConditions |
| deploymentConditions array |
|
manifestsRendered | レンダリングされたマニフェストとそのステータスをリスト表示します。 | array |
|
observedGeneration |
観測された | integer |
conditions
| 型 | 説明 |
|---|---|
|
ClusterInstanceValidated |
SiteConfig Operator が |
|
RenderedTemplates | SiteConfig Operator が参照された Golang クラスターテンプレートを正常に検証したことを示します。 |
|
RenderedTemplatesValidated | SiteConfig Operator がインストールマニフェストをレンダリングし、ドライランが成功したことを示します。 |
|
RenderedTemplatesApplied | SiteConfig Operator がインストールマニフェストを作成し、基盤となる Operator がそれを使用したことを示します。 |
|
Provisioned | 基盤となる Operator がクラスターをプロビジョニングしていることを示します。 |
deploymentConditions
| 型 | 説明 |
|---|---|
|
ClusterInstallRequirementsMet | インストールを開始できることを示します。 |
|
ClusterInstallCompleted | クラスターのインストールが成功したことを示します。 |
|
ClusterInstallFailed | クラスターのインストールが失敗したことを示します。 |
|
ClusterInstallStopped | クラスターのインストールが停止したことを示します。 |
関連情報
1.3. Clustersets API (v1beta2)
非推奨: API のドキュメントは非推奨となりました。現在のサポートされている API を表示するには、コンソールの API Explorer または oc コマンドを使用します。
1.3.1. 概要
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の ClusterSet リソースを説明します。ClusterSet リソースには、create、query、delete、update の 4 つのリクエストを使用できます。ManagedClusterSet は、ManagedClusters のグループを定義します。ManagedClusterSet を参照する ManagedCluster に cluster.open-cluster-management.io/clusterset という名前のラベルを追加することで、ManagedCluster を特定の ManagedClusterSet に割り当てることができます。managedclustersets/join の仮想サブリソースに対する create 権限を許可する RBAC ルールがある場合にのみ、ManagedCluster でこのラベルを追加または削除できます。このラベルを更新するには、ソースとターゲットの両方の ManagedClusterSets でこの権限が必要です。
1.3.1.1. バージョン情報
Version : 2.13.0
1.3.1.2. URI スキーム
BasePath: /kubernetes/apis
Schemes: HTTPS
1.3.1.3. タグ
- cluster.open-cluster-management.io: Clustersets を作成して管理します。
1.3.2. パス
1.3.2.1. 全 clusterset のクエリー
GET /cluster.open-cluster-management.io/v1beta2/managedclustersets1.3.2.1.1. 説明
Clustersets に対してクエリーを実行して詳細を確認します。
1.3.2.1.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
1.3.2.1.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.3.2.1.4. 消費されるアイテム
-
clusterset/yaml
1.3.2.1.5. タグ
- cluster.open-cluster-management.io
1.3.2.2. clusterset の作成
POST /cluster.open-cluster-management.io/v1beta2/managedclustersets1.3.2.2.1. 説明
Clusterset を作成します。
1.3.2.2.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Body |
body | 作成する clusterset を記述するパラメーター |
1.3.2.2.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.3.2.2.4. 消費されるアイテム
-
clusterset/yaml
1.3.2.2.5. タグ
- cluster.open-cluster-management.io
1.3.2.2.6. HTTP リクエストの例
1.3.2.2.6.1. リクエストのボディー
{
"apiVersion": "cluster.open-cluster-management.io/v1beta2",
"kind": "ManagedClusterSet",
"metadata": {
"name": "clusterset1"
},
"spec": {
"clusterSelector": {
"selectorType": "ExclusiveClusterSetLabel"
}
},
"status": {}
}1.3.2.3. 単一 clusterset のクエリー
GET /cluster.open-cluster-management.io/v1beta2/managedclustersets/{clusterset_name}1.3.2.3.1. 説明
単一の clusterset に対してクエリーを実行して詳細を確認します。
1.3.2.3.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
clusterset_name | 問い合わせる clusterset の名前。 | string |
1.3.2.3.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.3.2.3.4. タグ
- cluster.open-cluster-management.io
1.3.2.4. clusterset の削除
DELETE /cluster.open-cluster-management.io/v1beta2/managedclustersets/{clusterset_name}1.3.2.4.1. 説明
単一 clusterset を削除します。
1.3.2.4.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
clusterset_name | 削除する clusterset の名前。 | string |
1.3.2.4.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.3.2.4.4. タグ
- cluster.open-cluster-management.io
1.3.3. 定義
1.3.3.1. Clusterset
| 名前 | スキーマ |
|---|---|
|
apiVersion | string |
|
kind | string |
|
metadata | object |
1.4. Clustersetbindings API (v1beta2)
非推奨: API のドキュメントは非推奨となりました。現在のサポートされている API を表示するには、コンソールの API Explorer または oc コマンドを使用します。
1.4.1. 概要
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の ClusterSetBinding リソースを説明します。ClusterSetBinding リソースには、create、query、delete、update の 4 つのリクエストを使用できます。ManagedClusterSetBinding は、ManagedClusterSet を特定の namespace に投影します。managedclustersets/bind の仮想サブリソースでの create を許可する RBAC ルールがある場合は、namespace で ManagedClusterSetBinding を作成し、ManagedClusterSet にバインドできます。
1.4.1.1. バージョン情報
Version : 2.13.0
1.4.1.2. URI スキーム
BasePath: /kubernetes/apis
Schemes: HTTPS
1.4.1.3. タグ
- cluster.open-cluster-management.io: clustersetbinding を作成して管理します。
1.4.2. パス
1.4.2.1. 全 clustersetbinding のクエリー
GET /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersetbindings1.4.2.1.1. 説明
clustersetbinding に対してクエリーを実行して詳細を確認します。
1.4.2.1.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
1.4.2.1.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.4.2.1.4. 消費されるアイテム
-
clustersetbinding/yaml
1.4.2.1.5. タグ
- cluster.open-cluster-management.io
1.4.2.2. clustersetbinding の作成
POST /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersetbindings1.4.2.2.1. 説明
clustersetbinding を作成します。
1.4.2.2.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
namespace |
使用する namespace (例: | string |
| Body |
body | 作成する clustersetbinding を記述するパラメーター |
1.4.2.2.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.4.2.2.4. 消費されるアイテム
-
clustersetbinding/yaml
1.4.2.2.5. タグ
- cluster.open-cluster-management.io
1.4.2.2.6. HTTP リクエストの例
1.4.2.2.6.1. リクエストのボディー
{
"apiVersion" : "cluster.open-cluster-management.io/v1beta2",
"kind" : "ManagedClusterSetBinding",
"metadata" : {
"name" : "clusterset1",
"namespace" : "ns1"
},
"spec": {
"clusterSet": "clusterset1"
},
"status" : { }
}1.4.2.3. 単一 clustersetbinding のクエリー
GET /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersetbindings/{clustersetbinding_name}1.4.2.3.1. 説明
単一の clustersetbinding に対してクエリーを実行して詳細を確認します。
1.4.2.3.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
namespace |
使用する namespace (例: | string |
| Path |
clustersetbinding_name | 問い合わせる clustersetbinding の名前 | string |
1.4.2.3.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.4.2.3.4. タグ
- cluster.open-cluster-management.io
1.4.2.4. clustersetbinding の削除
DELETE /cluster.open-cluster-management.io/v1beta2/managedclustersetbindings/{clustersetbinding_name}1.4.2.4.1. 説明
単一 clustersetbinding を削除します。
1.4.2.4.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
namespace |
使用する namespace (例: | string |
| Path |
clustersetbinding_name | 削除する clustersetbinding の名前 | string |
1.4.2.4.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.4.2.4.4. タグ
- cluster.open-cluster-management.io
1.4.3. 定義
1.4.3.1. Clustersetbinding
| 名前 | 説明 | スキーマ |
|---|---|---|
|
apiVersion |
| string |
|
kind | REST リソースを表す文字列の値 | string |
|
metadata |
| object |
|
spec |
|
spec
| 名前 | 説明 | スキーマ |
|---|---|---|
|
clusterSet |
バインドする | string |
1.5. Clusterview API (v1alpha1)
非推奨: API のドキュメントは非推奨となりました。現在のサポートされている API を表示するには、コンソールの API Explorer または oc コマンドを使用します。
1.5.1. 概要
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の clusterview リソースを説明します。clusterview リソースには、アクセス可能なマネージドクラスターおよびマネージドクラスターセットのリストを表示できる CLI コマンドが含まれます。使用できる要求は、list、get、および watch の 3 つです。
1.5.1.1. バージョン情報
Version : 2.13.0
1.5.1.2. URI スキーム
BasePath: /kubernetes/apis
Schemes: HTTPS
1.5.1.3. タグ
- clusterview.open-cluster-management.io: お使いの ID がアクセスできるマネージドクラスターのリストを表示します。
1.5.2. パス
1.5.2.1. マネージドクラスターの取得
GET /managedclusters.clusterview.open-cluster-management.io1.5.2.1.1. 説明
アクセス可能なマネージドクラスターのリストを表示します。
1.5.2.1.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
1.5.2.1.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.5.2.1.4. 消費されるアイテム
-
managedcluster/yaml
1.5.2.1.5. タグ
- clusterview.open-cluster-management.io
1.5.2.2. マネージドクラスターのリスト表示
LIST /managedclusters.clusterview.open-cluster-management.io1.5.2.2.1. 説明
アクセス可能なマネージドクラスターのリストを表示します。
1.5.2.2.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Body |
body | マネージドクラスターをリスト表示するユーザー ID の名前 | string |
1.5.2.2.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.5.2.2.4. 消費されるアイテム
-
managedcluster/yaml
1.5.2.2.5. タグ
- clusterview.open-cluster-management.io
1.5.2.2.6. HTTP リクエストの例
1.5.2.2.6.1. リクエストのボディー
{
"apiVersion" : "clusterview.open-cluster-management.io/v1alpha1",
"kind" : "ClusterView",
"metadata" : {
"name" : "<user_ID>"
},
"spec": { },
"status" : { }
}1.5.2.3. マネージドクラスターセットの監視
WATCH /managedclusters.clusterview.open-cluster-management.io1.5.2.3.1. 説明
アクセス可能なマネージドクラスターを確認します。
1.5.2.3.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
clusterview_name | 監視するユーザー ID の名前 | string |
1.5.2.3.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.5.2.4. マネージドクラスターセットのリスト表示
GET /managedclustersets.clusterview.open-cluster-management.io1.5.2.4.1. 説明
アクセス可能なマネージドクラスターをリスト表示します。
1.5.2.4.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
clusterview_name | 監視するユーザー ID の名前 | string |
1.5.2.4.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.5.2.5. マネージドクラスターセットのリスト表示
LIST /managedclustersets.clusterview.open-cluster-management.io1.5.2.5.1. 説明
アクセス可能なマネージドクラスターをリスト表示します。
1.5.2.5.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
clusterview_name | 監視するユーザー ID の名前 | string |
1.5.2.5.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.5.2.6. マネージドクラスターセットの監視
WATCH /managedclustersets.clusterview.open-cluster-management.io1.5.2.6.1. 説明
アクセス可能なマネージドクラスターを確認します。
1.5.2.6.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
clusterview_name | 監視するユーザー ID の名前 | string |
1.5.2.6.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.6. Channels API
非推奨: API のドキュメントは非推奨となりました。現在のサポートされている API を表示するには、コンソールの API Explorer または oc コマンドを使用します。
1.6.1. 概要
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の Channel リソースを説明します。Channel リソースには、create、query、delete、update の 4 つの要求を使用できます。
1.6.1.1. バージョン情報
Version : 2.13.0
1.6.1.2. URI スキーム
BasePath: /kubernetes/apis
Schemes: HTTPS
1.6.1.3. タグ
- channels.apps.open-cluster-management.io: deployable を作成して管理します。
1.6.2. パス
1.6.2.1. チャネルの作成
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels1.6.2.1.1. 説明
チャネルを作成します。
1.6.2.1.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
| Body |
body | 作成する deployable を記述するパラメーター |
1.6.2.1.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.6.2.1.4. 消費されるアイテム
-
application/yaml
1.6.2.1.5. タグ
- channels.apps.open-cluster-management.io
1.6.2.1.6. HTTP リクエストの例
1.6.2.1.6.1. リクエストのボディー
{
"apiVersion": "apps.open-cluster-management.io/v1",
"kind": "Channel",
"metadata": {
"name": "sample-channel",
"namespace": "default"
},
"spec": {
"configMapRef": {
"kind": "configmap",
"name": "info-resource-filter-configmap"
},
"pathname": "https://charts.helm.sh/stable",
"type": "HelmRepo"
}
}1.6.2.2. ターゲット namespace の全チャネルのクエリー
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels1.6.2.2.1. 説明
チャネルに対してクエリーを実行して詳細を確認します。
1.6.2.2.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
1.6.2.2.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.6.2.2.4. 消費されるアイテム
-
application/yaml
1.6.2.2.5. タグ
- channels.apps.open-cluster-management.io
1.6.2.3. namespace の単一チャネルのクエリー
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}1.6.2.3.1. 説明
単一のチャネルに対してクエリーを実行して詳細を確認します。
1.6.2.3.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
channel_name | 問い合わせる deployable の名前 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
1.6.2.3.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.6.2.3.4. タグ
- channels.apps.open-cluster-management.io
1.6.2.4. Channel の削除
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/channels/{channel_name}1.6.2.4.1. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
channel_name | 削除する Channel の名前 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
1.6.2.4.2. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.6.2.4.3. タグ
- channels.apps.open-cluster-management.io
1.6.3. 定義
1.6.3.1. チャネル
| 名前 | スキーマ |
|---|---|
|
apiVersion | string |
|
kind | string |
|
metadata | object |
|
spec |
spec
| 名前 | 説明 | スキーマ |
|---|---|---|
|
configMapRef | ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。 | |
|
gates | ChannelGate はチャネルにプロモートする基準を定義します。 | |
|
pathname | string | |
|
secretRef | ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。 | |
|
sourceNamespaces | enum (Namespace、HelmRepo、ObjectBucket、Git、namespace、helmrepo、objectbucket、github) array |
configMapRef
| 名前 | 説明 | スキーマ |
|---|---|---|
|
apiVersion | 参照先の API バージョン。 | string |
|
fieldPath | オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。TODO: この設計は最終版ではないため、このフィールドは今後変更になる場合があります。 | string |
|
kind | 参照先の種類。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/ |
name |
| 参照先の名前。詳細: Names | string |
namespace |
| 参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ | string |
resourceVersion |
| この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | string |
uid |
gates
| 名前 | 説明 | スキーマ |
|---|---|---|
|
annotations | k8s の典型的なアノテーション | |
|
labelSelector | ラベルセレクターとは、一連のリソースに対するラベルクエリー機能です。matchLabels と matchExpressions の結果は AND を使用して結合されます。ラベルセレクターが空の場合は、全オブジェクトをマッチします。ラベルセレクターが null の場合は、どのオブジェクトもマッチしません。 | |
|
name | string |
annotations
| 名前 | スキーマ |
|---|---|
|
key | string |
|
value | string |
labelSelector
| 名前 | 説明 | スキーマ |
|---|---|---|
|
matchExpressions | matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 | matchExpressions array |
|
matchLabels | matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 | string、string map |
matchExpressions
| 名前 | 説明 | スキーマ |
|---|---|---|
|
key | key は、セレクターの適用先のラベルキーです。 | string |
|
operator | operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 | string |
|
values | values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 | string array |
secretRef
| 名前 | 説明 | スキーマ |
|---|---|---|
|
apiVersion | 参照先の API バージョン。 | string |
|
fieldPath | オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。TODO: この設計は最終版ではないため、このフィールドは今後変更になる場合があります。 | string |
|
kind | 参照先の種類。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 | string |
|
name | 参照先の名前。詳細: Names | string |
|
namespace | 参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ | string |
|
resourceVersion | この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency | string |
|
uid | 参照先の UID。詳細: UIIDs | string |
1.7. Subscriptions API
非推奨: API のドキュメントは非推奨となりました。現在のサポートされている API を表示するには、コンソールの API Explorer または oc コマンドを使用します。
1.7.1. 概要
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の Subscription リソースを説明します。Subscription リソースには、create、query、delete、update の 4 つの要求を使用できます。非推奨: PlacementRule
1.7.1.1. バージョン情報
Version : 2.13.0
1.7.1.2. URI スキーム
BasePath: /kubernetes/apis
Schemes: HTTPS
1.7.1.3. タグ
- subscriptions.apps.open-cluster-management.io: サブスクリプションを作成して管理します。
1.7.2. パス
1.7.2.1. サブスクリプションの作成
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions1.7.2.1.1. 説明
サブスクリプションを作成します。
1.7.2.1.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
| Body |
body | 作成するサブスクリプションを記述するパラメーター |
1.7.2.1.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.7.2.1.4. 消費されるアイテム
-
subscription/yaml
1.7.2.1.5. タグ
- subscriptions.apps.open-cluster-management.io
1.7.2.1.6. HTTP リクエストの例
1.7.2.1.6.1. リクエストのボディー
{
"apiVersion" : "apps.open-cluster-management.io/v1",
"kind" : "Subscription",
"metadata" : {
"name" : "sample_subscription",
"namespace" : "default",
"labels" : {
"app" : "sample_subscription-app"
},
"annotations" : {
"apps.open-cluster-management.io/git-path" : "apps/sample/",
"apps.open-cluster-management.io/git-branch" : "sample_branch"
}
},
"spec" : {
"channel" : "channel_namespace/sample_channel",
"packageOverrides" : [ {
"packageName" : "my-sample-application",
"packageAlias" : "the-sample-app",
"packageOverrides" : [ {
"path" : "spec",
"value" : {
"persistence" : {
"enabled" : false,
"useDynamicProvisioning" : false
},
"license" : "accept",
"tls" : {
"hostname" : "my-mcm-cluster.icp"
},
"sso" : {
"registrationImage" : {
"pullSecret" : "hub-repo-docker-secret"
}
}
}
} ]
} ],
"placement" : {
"placementRef" : {
"kind" : "PlacementRule",
"name" : "demo-clusters"
}
}
}
}1.7.2.2. 全サブスクリプションのクエリー
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions1.7.2.2.1. 説明
サブスクリプションにクエリーを行い、詳細を確認します。
1.7.2.2.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
1.7.2.2.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.7.2.2.4. 消費されるアイテム
-
subscription/yaml
1.7.2.2.5. タグ
- subscriptions.apps.open-cluster-management.io
1.7.2.3. 単一サブスクリプションのクエリー
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}1.7.2.3.1. 説明
1 つのサブスクリプションにクエリーを行い、詳細を確認します。
1.7.2.3.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
| Path |
subscription_name | 問い合わせるサブスクリプションの名前 | string |
1.7.2.3.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.7.2.3.4. タグ
- subscriptions.apps.open-cluster-management.io
1.7.2.4. サブスクリプションの削除
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/subscriptions/{subscription_name}1.7.2.4.1. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
| Path |
subscription_name | 削除するサブスクリプションの名前 | string |
1.7.2.4.2. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.7.2.4.3. タグ
- subscriptions.apps.open-cluster-management.io
1.7.3. 定義
1.7.3.1. サブスクリプション
metadata
| 名前 | スキーマ |
|---|---|
|
annotations | object |
|
labels | object |
|
name | string |
|
namespace | string |
spec
| 名前 | スキーマ |
|---|---|
|
channel | string |
|
name | string |
|
overrides | overrides array |
|
packageFilter | |
|
packageOverrides | packageOverrides array |
|
placement | |
|
timewindow |
overrides
| 名前 | スキーマ |
|---|---|
|
clusterName | string |
|
clusterOverrides | object array |
packageFilter
| 名前 | 説明 | スキーマ |
|---|---|---|
|
annotations | string、string map | |
|
filterRef | ||
|
labelSelector | ||
|
version |
Pattern : | string |
filterRef
| 名前 | スキーマ |
|---|---|
|
name | string |
labelSelector
| 名前 | スキーマ |
|---|---|
|
matchExpressions | matchExpressions array |
|
matchLabels | string、string map |
matchExpressions
| 名前 | スキーマ |
|---|---|
|
key | string |
|
operator | string |
|
values | string array |
packageOverrides
| 名前 | スキーマ |
|---|---|
|
packageAlias | string |
|
packageName | string |
|
packageOverrides | object array |
placement
| 名前 | スキーマ |
|---|---|
|
clusterSelector | |
|
clusters | clusters array |
|
local | boolean |
|
placementRef |
clusterSelector
| 名前 | スキーマ |
|---|---|
|
matchExpressions | matchExpressions array |
|
matchLabels | string、string map |
matchExpressions
| 名前 | スキーマ |
|---|---|
|
key | string |
|
operator | string |
|
values | string array |
clusters
| 名前 | スキーマ |
|---|---|
|
name | string |
placementRef
| 名前 | スキーマ |
|---|---|
|
apiVersion | string |
|
fieldPath | string |
|
kind | string |
|
name | string |
|
namespace | string |
|
resourceVersion | string |
|
uid | string |
timewindow
| 名前 | スキーマ |
|---|---|
|
daysofweek | string array |
|
hours | hours array |
|
location | string |
|
windowtype | 列挙 (active、blocked、Active、Blocked) |
hours
| 名前 | スキーマ |
|---|---|
|
end | string |
|
start | string |
status
| 名前 | スキーマ |
|---|---|
|
lastUpdateTime | string (date-time) |
|
message | string |
|
phase | string |
|
reason | string |
|
statuses | object |
1.8. PlacementRules API (非推奨)
非推奨: この API は非推奨となりました。残りのすべての API の ドキュメント も非推奨となりました。現在のサポートされている API を表示するには、コンソールの API Explorer または oc コマンドを使用します。
1.8.1. 概要
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の PlacementRule リソースを説明します。PlacementRule リソースには、create、query、delete、update の 4 つの要求を使用できます。
1.8.1.1. バージョン情報
Version : 2.13.0
1.8.1.2. URI スキーム
BasePath: /kubernetes/apis
Schemes: HTTPS
1.8.1.3. タグ
- placementrules.apps.open-cluster-management.io: 配置ルールを作成して管理します。
1.8.2. パス
1.8.2.1. 配置ルールの作成
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules1.8.2.1.1. 説明
配置ルールを作成します。
1.8.2.1.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
| Body |
body | 作成する配置ルールを記述するパラメーター |
1.8.2.1.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.8.2.1.4. 消費されるアイテム
-
application/yaml
1.8.2.1.5. タグ
- placementrules.apps.open-cluster-management.io
1.8.2.1.6. HTTP リクエストの例
1.8.2.1.6.1. リクエストのボディー
{
"apiVersion" : "apps.open-cluster-management.io/v1",
"kind" : "PlacementRule",
"metadata" : {
"name" : "towhichcluster",
"namespace" : "ns-sub-1"
},
"spec" : {
"clusterConditions" : [ {
"type": "ManagedClusterConditionAvailable",
"status": "True"
} ],
"clusterSelector" : { }
}
}1.8.2.2. 全配置ルールのクエリー
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules1.8.2.2.1. 説明
配置ルールに対してクエリーを実行して詳細を確認します。
1.8.2.2.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
1.8.2.2.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.8.2.2.4. 消費されるアイテム
-
application/yaml
1.8.2.2.5. タグ
- placementrules.apps.open-cluster-management.io
1.8.2.3. 単一の placementrule のクエリー
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}1.8.2.3.1. 説明
1 つの配置ルールに対してクエリーを実行して詳細を確認します。
1.8.2.3.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
| Path |
placementrule_name | 問い合わせる placementrule の名前 | string |
1.8.2.3.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.8.2.3.4. タグ
- placementrules.apps.open-cluster-management.io
1.8.2.4. placementrule の削除
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/placementrules/{placementrule_name}1.8.2.4.1. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
| Path |
placementrule_name | 削除する placementrule の名前 | string |
1.8.2.4.2. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.8.2.4.3. タグ
- placementrules.apps.open-cluster-management.io
1.8.3. 定義
1.8.3.1. Placementrule
| 名前 | スキーマ |
|---|---|
|
apiVersion | string |
|
kind | string |
|
metadata | object |
|
spec |
spec
| 名前 | スキーマ |
|---|---|
|
clusterConditions | clusterConditions array |
|
clusterReplicas | integer |
|
clusterSelector | |
|
clusters | clusters array |
|
policies | policies array |
|
resourceHint | |
|
schedulerName | string |
clusterConditions
| 名前 | スキーマ |
|---|---|
|
status | string |
|
type | string |
clusterSelector
| 名前 | スキーマ |
|---|---|
|
matchExpressions | matchExpressions array |
|
matchLabels | string、string map |
matchExpressions
| 名前 | スキーマ |
|---|---|
|
key | string |
|
operator | string |
|
values | string array |
clusters
| 名前 | スキーマ |
|---|---|
|
name | string |
policies
| 名前 | スキーマ |
|---|---|
|
apiVersion | string |
|
fieldPath | string |
|
kind | string |
|
name | string |
|
namespace | string |
|
resourceVersion | string |
|
uid | string |
resourceHint
| 名前 | スキーマ |
|---|---|
|
order | string |
|
type | string |
1.9. Applications API
非推奨: API のドキュメントは非推奨となりました。現在のサポートされている API を表示するには、コンソールの API Explorer または oc コマンドを使用します。
1.9.1. 概要
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の Application リソースを説明します。Application リソースには、create、query、delete、update の 4 つの要求を使用できます。
1.9.1.1. バージョン情報
Version : 2.13.0
1.9.1.2. URI スキーム
BasePath: /kubernetes/apis
Schemes: HTTPS
1.9.1.3. タグ
- applications.app.k8s.io: アプリケーションを作成して管理します。
1.9.2. パス
1.9.2.1. アプリケーションの作成
POST /app.k8s.io/v1beta1/namespaces/{namespace}/applications1.9.2.1.1. 説明
アプリケーションを作成します。
1.9.2.1.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
| Body |
body | 作成するアプリケーションを記述するパラメーター |
1.9.2.1.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.9.2.1.4. 消費されるアイテム
-
application/yaml
1.9.2.1.5. タグ
- applications.app.k8s.io
1.9.2.1.6. HTTP リクエストの例
1.9.2.1.6.1. リクエストのボディー
{
"apiVersion" : "app.k8s.io/v1beta1",
"kind" : "Application",
"metadata" : {
"labels" : {
"app" : "nginx-app-details"
},
"name" : "nginx-app-3",
"namespace" : "ns-sub-1"
},
"spec" : {
"componentKinds" : [ {
"group" : "apps.open-cluster-management.io",
"kind" : "Subscription"
} ]
},
"selector" : {
"matchLabels" : {
"app" : "nginx-app-details"
}
},
"status" : { }
}1.9.2.2. 全アプリケーションのクエリー
GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications1.9.2.2.1. 説明
アプリケーションにクエリーを行い、詳細を確認します。
1.9.2.2.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
1.9.2.2.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.9.2.2.4. 消費されるアイテム
-
application/yaml
1.9.2.2.5. タグ
- applications.app.k8s.io
1.9.2.3. 単一アプリケーションのクエリー
GET /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}1.9.2.3.1. 説明
1 つのアプリケーションに対してクエリーを行い、詳細を確認します。
1.9.2.3.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
application_name | 問い合わせるアプリケーションの名前 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
1.9.2.3.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.9.2.3.4. タグ
- applications.app.k8s.io
1.9.2.4. アプリケーションの削除
DELETE /app.k8s.io/v1beta1/namespaces/{namespace}/applications/{application_name}1.9.2.4.1. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
application_name | 削除するアプリケーションの名前 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
1.9.2.4.2. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.9.2.4.3. タグ
- applications.app.k8s.io
1.9.3. 定義
1.9.3.1. アプリケーション
| 名前 | スキーマ |
|---|---|
|
apiVersion | string |
|
kind | string |
|
metadata | object |
|
spec |
spec
| 名前 | スキーマ |
|---|---|
|
assemblyPhase | string |
|
componentKinds | object array |
|
descriptor | |
|
info | info array |
|
selector | object |
記述子
| 名前 | スキーマ |
|---|---|
|
description | string |
|
icons | icons array |
|
keywords | string array |
|
links | links array |
|
maintainers | maintainers array |
|
notes | string |
|
owners | owners array |
|
type | string |
|
version | string |
icons
| 名前 | スキーマ |
|---|---|
|
size | string |
|
src | string |
|
type | string |
links
| 名前 | スキーマ |
|---|---|
|
description | string |
|
url | string |
maintainers
| 名前 | スキーマ |
|---|---|
|
email | string |
|
name | string |
|
url | string |
owners
| 名前 | スキーマ |
|---|---|
|
email | string |
|
name | string |
|
url | string |
info
| 名前 | スキーマ |
|---|---|
|
name | string |
|
type | string |
|
value | string |
|
valueFrom |
valueFrom
| 名前 | スキーマ |
|---|---|
|
configMapKeyRef | |
|
ingressRef | |
|
secretKeyRef | |
|
serviceRef | |
|
type | string |
configMapKeyRef
| 名前 | スキーマ |
|---|---|
|
apiVersion | string |
|
fieldPath | string |
|
key | string |
|
kind | string |
|
name | string |
|
namespace | string |
|
resourceVersion | string |
|
uid | string |
ingressRef
| 名前 | スキーマ |
|---|---|
|
apiVersion | string |
|
fieldPath | string |
|
host | string |
|
kind | string |
|
name | string |
|
namespace | string |
|
path | string |
|
resourceVersion | string |
|
uid | string |
secretKeyRef
| 名前 | スキーマ |
|---|---|
|
apiVersion | string |
|
fieldPath | string |
|
key | string |
|
kind | string |
|
name | string |
|
namespace | string |
|
resourceVersion | string |
|
uid | string |
serviceRef
| 名前 | スキーマ |
|---|---|
|
apiVersion | string |
|
fieldPath | string |
|
kind | string |
|
name | string |
|
namespace | string |
|
path | string |
|
port | integer (int32) |
|
resourceVersion | string |
|
uid | string |
1.10. Helm API
非推奨: API のドキュメントは非推奨となりました。現在のサポートされている API を表示するには、コンソールの API Explorer または oc コマンドを使用します。
1.10.1. 概要
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の HelmRelease リソースを説明します。HelmRelease リソースには、create、query、delete、update の 4 つの要求を使用できます。
1.10.1.1. バージョン情報
Version : 2.13.0
1.10.1.2. URI スキーム
BasePath: /kubernetes/apis
Schemes: HTTPS
1.10.1.3. タグ
- helmreleases.apps.open-cluster-management.io: helmreleases を作成して管理します。
1.10.2. パス
1.10.2.1. helmrelease の作成
POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases1.10.2.1.1. 説明
helmrelease を作成します。
1.10.2.1.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
| Body |
body | 作成する helmrelease を記述するパラメーター |
1.10.2.1.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.10.2.1.4. 消費されるアイテム
-
application/yaml
1.10.2.1.5. タグ
- helmreleases.apps.open-cluster-management.io
1.10.2.1.6. HTTP リクエストの例
1.10.2.1.6.1. リクエストのボディー
{
"apiVersion" : "apps.open-cluster-management.io/v1",
"kind" : "HelmRelease",
"metadata" : {
"name" : "nginx-ingress",
"namespace" : "default"
},
"repo" : {
"chartName" : "nginx-ingress",
"source" : {
"helmRepo" : {
"urls" : [ "https://kubernetes-charts.storage.googleapis.com/nginx-ingress-1.26.0.tgz" ]
},
"type" : "helmrepo"
},
"version" : "1.26.0"
},
"spec" : {
"defaultBackend" : {
"replicaCount" : 3
}
}
}1.10.2.2. 全 helmrelease のクエリー
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases1.10.2.2.1. 説明
helmrelease に対してクエリーを実行して詳細を確認します。
1.10.2.2.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
1.10.2.2.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.10.2.2.4. 消費されるアイテム
-
application/yaml
1.10.2.2.5. タグ
- helmreleases.apps.open-cluster-management.io
1.10.2.3. 単一の helmrelease のクエリー
GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}1.10.2.3.1. 説明
1 つの helmrelease に対してクエリーを実行して詳細を確認します。
1.10.2.3.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
helmrelease_name | 問い合わせる helmrelease の名前 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
1.10.2.3.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.10.2.3.4. タグ
- helmreleases.apps.open-cluster-management.io
1.10.2.4. helmrelease の削除
DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}1.10.2.4.1. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
helmrelease_name | 削除する helmrelease の名前 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
1.10.2.4.2. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.10.2.4.3. タグ
- helmreleases.apps.open-cluster-management.io
1.10.3. 定義
1.10.3.1. HelmRelease
| 名前 | スキーマ |
|---|---|
|
apiVersion | string |
|
kind | string |
|
metadata | object |
|
repo | |
|
spec | object |
|
status |
repo
| 名前 | スキーマ |
|---|---|
|
chartName | string |
|
configMapRef | |
|
secretRef | |
|
source | |
|
version | string |
configMapRef
| 名前 | スキーマ |
|---|---|
|
apiVersion | string |
|
fieldPath | string |
|
kind | string |
|
name | string |
|
namespace | string |
|
resourceVersion | string |
|
uid | string |
secretRef
| 名前 | スキーマ |
|---|---|
|
apiVersion | string |
|
fieldPath | string |
|
kind | string |
|
name | string |
|
namespace | string |
|
resourceVersion | string |
|
uid | string |
source
github
| 名前 | スキーマ |
|---|---|
|
branch | string |
|
chartPath | string |
|
urls | string array |
helmRepo
| 名前 | スキーマ |
|---|---|
|
urls | string array |
status
| 名前 | スキーマ |
|---|---|
|
conditions | conditions array |
|
deployedRelease |
conditions
| 名前 | スキーマ |
|---|---|
|
lastTransitionTime | string (date-time) |
|
message | string |
|
reason | string |
|
status | string |
|
type | string |
deployedRelease
| 名前 | スキーマ |
|---|---|
|
manifest | string |
|
name | string |
1.11. Policy API
非推奨: API のドキュメントは非推奨となりました。現在のサポートされている API を表示するには、コンソールの API Explorer または oc コマンドを使用します。
1.11.1. 概要
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の Policy リソースを説明します。Policy リソースには、create、query、delete、update の 4 つの要求を使用できます。
1.11.1.1. バージョン情報
Version : 2.13.0
1.11.1.2. URI スキーム
BasePath: /kubernetes/apis
Schemes: HTTPS
1.11.1.3. タグ
- policy.open-cluster-management.io/v1: ポリシーを作成して管理します。
1.11.2. パス
1.11.2.1. ポリシーの作成
POST /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}1.11.2.1.1. 説明
ポリシーを作成します。
1.11.2.1.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
| Body |
body | 作成するポリシーを記述するパラメーター |
1.11.2.1.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.11.2.1.4. 消費されるアイテム
-
application/json
1.11.2.1.5. タグ
- policy.open-cluster-management.io
1.11.2.1.6. HTTP リクエストの例
1.11.2.1.6.1. リクエストのボディー
{
"apiVersion": "policy.open-cluster-management.io/v1",
"kind": "Policy",
"metadata": {
"name": "test-policy-swagger",
},
"spec": {
"remediationAction": "enforce",
"namespaces": {
"include": [
"default"
],
"exclude": [
"kube*"
]
},
"policy-templates": {
"kind": "ConfigurationPolicy",
"apiVersion": "policy.open-cluster-management.io/v1",
"metadata": {
"name": "test-role"
},
"spec" : {
"object-templates": {
"complianceType": "musthave",
"metadataComplianceType": "musthave",
"objectDefinition": {
"apiVersion": "rbac.authorization.k8s.io/v1",
"kind": "Role",
"metadata": {
"name": "role-policy",
},
"rules": [
{
"apiGroups": [
"extensions",
"apps"
],
"resources": [
"deployments"
],
"verbs": [
"get",
"list",
"watch",
"delete"
]
},
{
"apiGroups": [
"core"
],
"resources": [
"pods"
],
"verbs": [
"create",
"update",
"patch"
]
},
{
"apiGroups": [
"core"
],
"resources": [
"secrets"
],
"verbs": [
"get",
"watch",
"list",
"create",
"delete",
"update",
"patch"
],
},
],
},
},
},
},1.11.2.2. 全ポリシーのクエリー
GET /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}1.11.2.2.1. 説明
ポリシーに対してクエリーを実行して詳細を確認します。
1.11.2.2.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
namespace | ポリシーを適用する namespace (例: default) | string |
1.11.2.2.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.11.2.2.4. 消費されるアイテム
-
application/json
1.11.2.2.5. タグ
- policy.open-cluster-management.io
1.11.2.3. 単一ポリシーのクエリー
GET /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}1.11.2.3.1. 説明
1 つのポリシーに対してクエリーを実行して詳細を確認します。
1.11.2.3.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
policy_name | 問い合わせるポリシーの名前 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
1.11.2.3.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.11.2.3.4. タグ
- policy.open-cluster-management.io
1.11.2.4. ポリシーの削除
DELETE /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}1.11.2.4.1. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
policy_name | 削除するポリシーの名前 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
1.11.2.4.2. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.11.2.4.3. タグ
- policy.open-cluster-management.io
1.11.3. 定義
1.11.3.1. ポリシー
| 名前 | 説明 | スキーマ |
|---|---|---|
|
apiVersion | Policy のバージョンスキーマ | string |
|
kind | REST リソースを表す文字列の値 | string |
|
metadata | ポリシーを定義するルールを記述します。 | object |
spec
| 名前 | 説明 | スキーマ |
|---|---|---|
|
remediationAction | リソースで定義されているように違反をどのように処理するかを表す値 | string |
policy-templates
| 名前 | 説明 | スキーマ |
|---|---|---|
|
apiVersion | Policy のバージョンスキーマ | string |
|
kind | REST リソースを表す文字列の値 | string |
|
metadata | ポリシーを定義するルールを記述します。 | object |
|
rules | string |
rules
| 名前 | 説明 | スキーマ |
|---|---|---|
|
apiGroups | このルールが適用される API のリスト | string |
|
resources | リソースタイプのリスト | object |
|
verbs | 動詞のリスト | string |
1.12. Observability API
非推奨: API のドキュメントは非推奨となりました。現在のサポートされている API を表示するには、コンソールの API Explorer または oc コマンドを使用します。
1.12.1. 概要
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の MultiClusterObservability リソースを説明します。MultiClusterObservability リソースには、create、query、delete、update の 4 つの要求を使用できます。
1.12.1.1. バージョン情報
Version : 2.13.0
1.12.1.2. URI スキーム
BasePath: /kubernetes/apis
Schemes: HTTPS
1.12.1.3. タグ
- observability.open-cluster-management.io: multiclusterobservabilities を作成して管理します。
1.12.2. パス
1.12.2.1. multiclusterobservability リソースの作成
POST /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities1.12.2.1.1. 説明
MultiClusterObservability リソースを作成します。
1.12.2.1.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Body |
body | 作成する MultiClusterObservability リソースを記述するパラメーター |
1.12.2.1.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.12.2.1.4. 消費されるアイテム
-
application/yaml
1.12.2.1.5. タグ
- observability.apps.open-cluster-management.io
1.12.2.1.6. HTTP リクエストの例
1.12.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" : " "
}
}
}
}1.12.2.2. すべての multiclusterobservability のクエリー
GET /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities1.12.2.2.1. 説明
MultiClusterObservability リソースに対してクエリーを実行して詳細を確認します。
1.12.2.2.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
1.12.2.2.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.12.2.2.4. 消費されるアイテム
-
application/yaml
1.12.2.2.5. タグ
- observability.apps.open-cluster-management.io
1.12.2.3. 単一の multiclusterobservability のクエリー
GET /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities/{multiclusterobservability_name}1.12.2.3.1. 説明
単一の MultiClusterObservability リソースに対してクエリーを実行して詳細を確認します。
1.12.2.3.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
multiclusterobservability_name | 問い合わせる multiclusterobservability の名前 | string |
1.12.2.3.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.12.2.3.4. タグ
- observability.apps.open-cluster-management.io
1.12.2.4. multiclusterobservability リソースの削除
DELETE /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities/{multiclusterobservability_name}1.12.2.4.1. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
multiclusterobservability_name | 削除する multiclusterobservability の名前 | string |
1.12.2.4.2. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.12.2.4.3. タグ
- observability.apps.open-cluster-management.io
1.12.3. 定義
1.12.3.1. MultiClusterObservability
| 名前 | 説明 | スキーマ |
|---|---|---|
|
apiVersion | MultiClusterObservability のバージョンスキーマ | string |
|
kind | REST リソース (MultiClusterObservability) を表す文字列の値 | string |
|
metadata | ポリシーを定義するルールを記述します。 | object |
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 のレプリカ | integer |
storageConfig
| 名前 | 説明 | スキーマ |
|---|---|---|
|
alertmanagerStorageSize |
alertmanager ステートフルセットに適用されるストレージの量。デフォルト値は | string |
|
compactStorageSize |
thanos のコンパクトなステートフルセットに適用されるストレージの量。デフォルト値は | string |
|
metricObjectStorage | メトリックのシークレットを設定するオブジェクトストア | |
|
receiveStorageSize |
thanos 受信ステートフルセットに適用されるストレージの量。デフォルト値は | string |
|
ruleStorageSize |
thanos ルールのステートフルセットに適用されるストレージの量。デフォルト値は | string |
|
storageClass |
| string |
|
storeStorageSize |
thanos ストアステートフルセットに適用されるストレージの量。デフォルト値は | string |
|
writeStorage | エンドポイントアクセス情報のリスト。 | [ ]WriteStorage |
writeStorage
| 名前 | 説明 | スキーマ |
|---|---|---|
|
name | エンドポイントアクセス情報を持つシークレットの名前。 | string |
|
key | 選択するシークレットのキー。 | string |
metricObjectStorage
| 名前 | 説明 | スキーマ |
|---|---|---|
|
key | 選択するシークレットのキー。有効な秘密鍵でなければなりません。Thanos のドキュメント を参照してください。 | string |
|
name |
| string |
observabilityAddonSpec
| 名前 | 説明 | スキーマ |
|---|---|---|
|
enableMetrics |
可観測性アドオンがメトリックをハブクラスターに送信するかどうかを指定します。デフォルト値は | boolean |
|
interval |
可観測性アドオンがメトリックをハブクラスターに送信する間隔。デフォルト値は 300 秒 ( | integer |
|
resources |
メトリックコレクターリソース要件のリソースデフォルトの CPU 要求は | corev1.ResourceRequirements |
advanced
| 名前 | 説明 | スキーマ |
|---|---|---|
|
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
| 名前 | 説明 | スキーマ |
|---|---|---|
|
blockDuration |
時系列データベース (TSDB) ブロックを停止する時間。デフォルト値は | string |
|
deleteDelay |
削除対象のブロックがバケットから削除されるまでの期間。デフォルト値は | string |
|
retentionInLocal |
ローカルストレージからの未加工のサンプルを保持する時間。デフォルト値は | string |
|
retentionResolutionRaw |
バスケットで未加工の解像度サンプルを保持する時間。デフォルト値は 365 日 ( | string |
|
retentionResolution5m |
バスケットに解像度 1 (5 分) のサンプルを保持する時間。デフォルト値は 365 日 ( | string |
|
retentionResolution1h |
バスケットに解像度 2 (1 時間) のサンプルを保持する時間。デフォルト値は 365 日 ( | string |
CompactSpec
| 名前 | 説明 | スキーマ |
|---|---|---|
|
resources | thanos compact に必要なリソースを計算します。 | corev1.ResourceRequirements |
|
serviceAccountAnnotations | アノテーションは、コンパクトサービスアカウントに保存されている非構造化キーバリューマップです。 | map[string]string |
storeMemcached
| 名前 | 説明 | スキーマ |
|---|---|---|
|
resources | MultiCLusterObservability で必要なコンピュートリソース | corev1.ResourceRequirements |
|
replicas | MultiClusterObservability のレプリカ | integer |
|
memoryLimitMb | メガバイト単位の Memcached のメモリー制限 | integer |
|
maxItemSize |
Memcached の最大項目サイズ。デフォルト値は | string |
|
connectionLimit | Memcached の同時接続の最大数。デフォルト値: | integer |
status
| 名前 | 説明 | スキーマ |
|---|---|---|
|
status | ステータスには、MultiClusterObservability のさまざまな条件のステータスが含まれます。 | metav1.Condition |
CommonSpec
| 名前 | 説明 | スキーマ |
|---|---|---|
|
resources | コンポーネントに必要なリソースを計算します。 | corev1.ResourceRequirements |
|
replicas | コンポーネントのレプリカ。 | integer |
QuerySpec
| 名前 | 説明 | スキーマ |
|
CommonSpec | クエリーデプロイメントのレプリカおよびリソースを指定します。 | CommonSpec |
|
serviceAccountAnnotations | アノテーションは、クエリーサービスアカウントとともに保存される非構造化キー値マップです。 | map[string]string |
ReceiveSpec
| 名前 | 説明 | スキーマ |
|
CommonSpec | クエリーデプロイメントのレプリカおよびリソースを指定します。 | CommonSpec |
|
serviceAccountAnnotations | アノテーションは、クエリーサービスアカウントとともに保存される非構造化キー値マップです。 | map[string]string |
StoreSpec
| 名前 | 説明 | スキーマ |
|
CommonSpec | クエリーデプロイメントのレプリカおよびリソースを指定します。 | CommonSpec |
|
serviceAccountAnnotations | アノテーションは、クエリーサービスアカウントとともに保存される非構造化キー値マップです。 | map[string]string |
RuleSpec
| 名前 | 説明 | スキーマ |
|
CommonSpec | クエリーデプロイメントのレプリカおよびリソースを指定します。 | CommonSpec |
|
evalInterval | ルールの評価間隔を指定します。 | string |
|
serviceAccountAnnotations | アノテーションは、クエリーサービスアカウントとともに保存される非構造化キー値マップです。 | map[string]string |
1.13. Search query API
検索クエリー API は Kubernetes API ではないため、Red Hat OpenShift Container Platform API Explorer では表示されません。検索クエリー API の機能を理解するには、このドキュメントの続きもご確認ください。
非推奨: API のドキュメントは非推奨となりました。現在のサポートされている API を表示するには、コンソールの API Explorer または oc コマンドを使用します。
1.13.1. 概要
検索クエリー API をルートで公開し、API を使用して検索クエリーを解決できます。API は GraphQL エンドポイントです。curl や Postman などの任意のクライアントを使用できます。
1.13.1.1. バージョン情報
バージョン: 2.10.0
1.13.1.2. URI スキーム
BasePath : /searchapi/graphql
スキーム : HTTPS
1.13.1.3. API アクセスの設定
以下のコマンドを使用して、クラスターの外部から Search API にアクセスするためのルートを作成します。
oc create route passthrough search-api --service=search-search-api -n open-cluster-management重要: 環境を保護するには、ルートを設定する必要があります。詳細は、OpenShift Container Platform ドキュメントの ルート設定 を参照してください。
1.13.2. スキーマ設計
input SearchFilter {
property: String!
values: [String]!
}
input SearchInput {
keywords: [String]
filters: [SearchFilter]
limit: Int
relatedKinds: [String]
}
type SearchResult {
count: Int
items: [Map]
related: [SearchRelatedResult]
}
type SearchRelatedResult {
kind: String!
count: Int
items: [Map]
}
! を使用したパラメーターは、フィールドが必要であることを示します。
1.13.2.1. クエリー入力の説明表
| 型 | 説明 | プロパティー |
|---|---|---|
| SearchFilter | 結果をフィルタリングするキーと値を定義します。プロパティーに多くの値を指定すると、API は値を "OR" 操作として解釈します。多くのフィルターを指定すると、結果はすべてのフィルターに一致し、API は "AND" 操作として解釈します。 | string |
| SearchInput | リソースの一覧を表示するには、主要な用語を入力します。多くのキーワードを指定すると、API はそれを "AND" 操作として解釈します。 | String |
| limit |
クエリーを入力した後に返される結果の最大数を決定します。デフォルト値は | Integer |
1.13.2.2. スキーマの例
{
"query": "type SearchResult {count: Intitems: [Map]related: [SearchRelatedResult]} type SearchRelatedResult {kind: String!count: Intitems: [Map]}",
"variables": {
"input": [
{
"keywords": [],
"filters": [
{
"property": "kind",
"values": [
"Deployment"
]
}
],
"limit": 10
}
]
}
}1.13.3. 汎用スキーマ
type Query {
search(input: [SearchInput]): [SearchResult]
searchComplete(property: String!, query: SearchInput, limit: Int): [String]
searchSchema: Map
messages: [Message]
}1.13.4. サポートされているクエリー
JSON 形式でサポートされているクエリータイプを確認するには、このまま読み進めてください。
1.13.4.1. デプロイメントの検索
クエリー:
query mySearch($input: [SearchInput]) {
search(input: $input) {
items
}
}変数:
{"input":[
{
"keywords":[],
"filters":[
{"property":"kind","values":["Deployment"]}],
"limit":10
}
]}1.13.4.2. Pod の検索
クエリー:
query mySearch($input: [SearchInput]) {
search(input: $input) {
items
}
}変数:
{"input":[
{
"keywords":[],
"filters":[
{"property":"kind","values":["Pod"]}],
"limit":10
}
]}1.14. MultiClusterHub API
非推奨: API のドキュメントは非推奨となりました。現在のサポートされている API を表示するには、コンソールの API Explorer または oc コマンドを使用します。
1.14.1. 概要
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の MultiClusterHub リソースを説明します。MultiClusterHub リソースには、create、query、delete、update の 4 つの要求を使用できます。
1.14.1.1. バージョン情報
Version : 2.13.0
1.14.1.2. URI スキーム
BasePath: /kubernetes/apis
Schemes: HTTPS
1.14.1.3. タグ
- multiclusterhubs.operator.open-cluster-management.io: マルチクラスターハブ演算子を作成して管理します。
1.14.2. パス
1.14.2.1. MultiClusterHub リソースの作成
POST /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/mch1.14.2.1.1. 説明
MultiClusterHub リソースを作成し、multicluster hub のインスタンスの設定を定義します。
1.14.2.1.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
| Body |
body | 作成する multicluster hub を記述するパラメーター |
1.14.2.1.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.14.2.1.4. 消費されるアイテム
-
multiclusterhubs/yaml
1.14.2.1.5. タグ
- multiclusterhubs.operator.open-cluster-management.io
1.14.2.1.6. HTTP リクエストの例
1.14.2.1.6.1. リクエストのボディー
{
"apiVersion": "apiextensions.k8s.io/v1",
"kind": "CustomResourceDefinition",
"metadata": {
"name": "multiclusterhubs.operator.open-cluster-management.io"
},
"spec": {
"group": "operator.open-cluster-management.io",
"names": {
"kind": "MultiClusterHub",
"listKind": "MultiClusterHubList",
"plural": "multiclusterhubs",
"shortNames": [
"mch"
],
"singular": "multiclusterhub"
},
"scope": "Namespaced",
"versions": [
{
"additionalPrinterColumns": [
{
"description": "The overall status of the multicluster hub.",
"jsonPath": ".status.phase",
"name": "Status",
"type": "string"
},
{
"jsonPath": ".metadata.creationTimestamp",
"name": "Age",
"type": "date"
}
],
"name": "v1",
"schema": {
"openAPIV3Schema": {
"description": "MultiClusterHub defines the configuration for an instance of
the multiCluster hub, a central point for managing multiple Kubernetes-based
clusters. The deployment of multicluster hub components is determined based
on the configuration that is defined in this resource.",
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. The value is in CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
},
"metadata": {
"type": "object"
},
"spec": {
"description": "MultiClusterHubSpec defines the desired state of MultiClusterHub.",
"properties": {
"availabilityConfig": {
"description": "Specifies deployment replication for improved availability.
Options are: Basic and High (default).",
"type": "string"
},
"customCAConfigmap": {
"description": "Provide the customized OpenShift default ingress CA certificate
to Red Hat Advanced Cluster Management.",
}
"type": "string"
},
"disableHubSelfManagement": {
"description": "Disable automatic import of the hub cluster as a managed
cluster.",
"type": "boolean"
},
"disableUpdateClusterImageSets": {
"description": "Disable automatic update of ClusterImageSets.",
"type": "boolean"
},
"hive": {
"description": "(Deprecated) Overrides for the default HiveConfig specification.",
"properties": {
"additionalCertificateAuthorities": {
"description": "(Deprecated) AdditionalCertificateAuthorities is
a list of references to secrets in the 'hive' namespace that
contain an additional Certificate Authority to use when communicating
with target clusters. These certificate authorities are
used in addition to any self-signed CA generated by each cluster
on installation.",
"items": {
"description": "LocalObjectReference contains the information
to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"backup": {
"description": "(Deprecated) Backup specifies configuration for backup
integration. If absent, backup integration is disabled.",
"properties": {
"minBackupPeriodSeconds": {
"description": "(Deprecated) MinBackupPeriodSeconds specifies
that a minimum of MinBackupPeriodSeconds occurs in between
each backup. This is used to rate limit backups. This potentially
batches together multiple changes into one backup. No backups
are lost for changes that happen during the interval
that is queued up, and results in a backup once
the interval has been completed.",
"type": "integer"
},
"velero": {
"description": "(Deprecated) Velero specifies configuration for the Velero backup integration.",
"properties": {
"enabled": {
"description": "(Deprecated) Enabled dictates if the Velero backup integration is enabled. If not specified, the default is disabled.",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"externalDNS": {
"description": "(Deprecated) ExternalDNS specifies configuration for external-dns if it is to be deployed by Hive. If absent, external-dns is not deployed.",
"properties": {
"aws": {
"description": "(Deprecated) AWS contains AWS-specific settings for external DNS.",
"properties": {
"credentials": {
"description": "(Deprecated) Credentials reference a secret that is used to authenticate with AWS Route53. It needs permission to manage entries in each of the managed domains for this cluster. Secret should have AWS keys named 'aws_access_key_id' and 'aws_secret_access_key'.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"gcp": {
"description": "(Deprecated) GCP contains Google Cloud Platform specific settings for external DNS.",
"properties": {
"credentials": {
"description": "(Deprecated) Credentials reference a secret that is used to authenticate with GCP DNS. It needs permission to manage entries in each of the managed domains for this cluster. Secret should have a key names 'osServiceAccount.json'. The credentials must specify the project to use.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"failedProvisionConfig": {
"description": "(Deprecated) FailedProvisionConfig is used to configure settings related to handling provision failures.",
"properties": {
"skipGatherLogs": {
"description": "(Deprecated) SkipGatherLogs disables functionality that attempts to gather full logs from the cluster if an installation fails for any reason. The logs are stored in a persistent volume for up to seven days.",
"type": "boolean"
}
},
"type": "object"
},
"globalPullSecret": {
"description": "(Deprecated) GlobalPullSecret is used to specify a pull secret that is used globally by all of the cluster deployments. For each cluster deployment, the contents of GlobalPullSecret are merged with the specific pull secret for a cluster deployment(if specified), with precedence given to the contents of the pull secret for the cluster deployment.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object"
},
"maintenanceMode": {
"description": "(Deprecated) MaintenanceMode can be set to true to disable the Hive controllers in situations where you need to ensure nothing is running that adds or act upon finalizers on Hive types. This should rarely be needed. Sets replicas to zero for the 'hive-controllers' deployment to accomplish this.",
"type": "boolean"
}
},
"required": [
"failedProvisionConfig"
],
"type": "object"
},
"imagePullSecret": {
"description": "Override pull secret for accessing MultiClusterHub operand and endpoint images.",
"type": "string"
},
"ingress": {
"description": "Configuration options for ingress management.",
"properties": {
"sslCiphers": {
"description": "List of SSL ciphers enabled for management ingress. Defaults to full list of supported ciphers.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "Set the node selectors..",
"type": "object"
},
"overrides": {
"description": "Developer overrides.",
"properties": {
"imagePullPolicy": {
"description": "Pull policy of the multicluster hub images.",
"type": "string"
}
},
"type": "object"
},
"separateCertificateManagement": {
"description": "(Deprecated) Install cert-manager into its own namespace.",
"type": "boolean"
}
},
"type": "object"
},
"status": {
"description": "MulticlusterHubStatus defines the observed state of MultiClusterHub.",
"properties": {
"components": {
"additionalProperties": {
"description": "StatusCondition contains condition information.",
"properties": {
"lastTransitionTime": {
"description": "LastTransitionTime is the last time the condition changed from one status to another.",
"format": "date-time",
"type": "string"
},
"message": {
"description": "Message is a human-readable message indicating\ndetails about the last status change.",
"type": "string"
},
"reason": {
"description": "Reason is a (brief) reason for the last status change of the condition.",
"type": "string"
},
"status": {
"description": "Status is the status of the condition. One of True, False, Unknown.",
"type": "string"
},
"type": {
"description": "Type is the type of the cluster condition.",
"type": "string"
}
},
"type": "object"
},
"description": "Components []ComponentCondition `json:\"manifests,omitempty\"`",
"type": "object"
},
"conditions": {
"description": "Conditions contain the different condition statuses for the MultiClusterHub.",
"items": {
"description": "StatusCondition contains condition information.",
"properties": {
"lastTransitionTime": {
"description": "LastTransitionTime is the last time the condition changed from one status to another.",
"format": "date-time",
"type": "string"
},
"lastUpdateTime": {
"description": "The last time this condition was updated.",
"format": "date-time",
"type": "string"
},
"message": {
"description": "Message is a human-readable message indicating details about the last status change.",
"type": "string"
},
"reason": {
"description": "Reason is a (brief) reason for the last status change of the condition.",
"type": "string"
},
"status": {
"description": "Status is the status of the condition. One of True, False, Unknown.",
"type": "string"
},
"type": {
"description": "Type is the type of the cluster condition.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"currentVersion": {
"description": "CurrentVersion indicates the current version..",
"type": "string"
},
"desiredVersion": {
"description": "DesiredVersion indicates the desired version.",
"type": "string"
},
"phase": {
"description": "Represents the running phase of the MultiClusterHub",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"served": true,
"storage": true,
"subresources": {
"status": {}
}
}
]
}
}1.14.2.2. 全 MultiClusterHubs のクエリー
GET /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator1.14.2.2.1. 説明
multicluster hub 演算子に対してクエリーを実行して詳細を確認します。
1.14.2.2.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
1.14.2.2.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.14.2.2.4. 消費されるアイテム
-
operator/yaml
1.14.2.2.5. タグ
- multiclusterhubs.operator.open-cluster-management.io
1.14.2.3. MultiClusterHub 演算子のクエリー
GET /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator/{multiclusterhub_name}1.14.2.3.1. 説明
単一の multicluster hub 演算子に対してクエリーを実行して詳細を確認します。
1.14.2.3.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
application_name | 問い合わせるアプリケーションの名前。 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
1.14.2.3.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.14.2.3.4. タグ
- multiclusterhubs.operator.open-cluster-management.io
1.14.2.4. MultiClusterHub 演算子の削除
DELETE /operator.open-cluster-management.io/v1beta1/namespaces/{namespace}/operator/{multiclusterhub_name}1.14.2.4.1. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
application_name | 削除する multicluster hub 演算子の名前 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
1.14.2.4.2. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.14.2.4.3. タグ
- multiclusterhubs.operator.open-cluster-management.io
1.14.3. 定義
1.14.3.1. Multicluster hub operator
| 名前 | 説明 | スキーマ |
|---|---|---|
|
apiVersion | MultiClusterHub のバージョンスキーマ。 | string |
|
kind | REST リソースを表す文字列の値 | string |
|
metadata | リソースを定義するルールを記述します。 | object |
|
spec | リソース仕様 |
spec
| availabilityConfig 任意 | デプロイメントレプリケーションを指定して可用性を向上させます。デフォルト値は High です。 | string |
|---|---|---|
|
customCAConfigmap | カスタマイズされた OpenShift デフォルト Ingress CA 証明書を Red Hat Advanced Cluster Management に提供します。 | string |
|
disableHubSelfManagement | マネージドクラスターとしてハブクラスターの自動インポートを無効にします。 | boolean |
|
disableUpdateClusterImageSets | ClusterImageSets の自動更新を無効にします。 | boolean |
|
hive | (非推奨) デフォルトの HiveConfig 仕様を上書きするオブジェクト。 | |
|
imagePullSecret | MultiClusterHub オペランドおよびエンドポイントイメージにアクセスするためのプルシークレットを上書きします。 | string |
|
ingress | Ingress 管理の設定オプション。 | |
|
nodeSelector | ノードセレクターを設定します。 | string |
|
separateCertificateManagement |
(非推奨) | boolean |
hive
| additionalCertificateAuthorities 任意 | (非推奨) ターゲットクラスターとの通信時に使用する追加の認証局が含まれる hive namespace のシークレットへの参照リスト。インストール時に各クラスターが生成する自己署名の CA のほかに、この認証局が使用されます。 | object |
|---|---|---|
|
backup | (非推奨) バックアップ統合の設定を指定します。存在しない場合、バックアップ統合は無効になります。 | |
|
externalDNS |
(非推奨) Hive でデプロイする場合は | object |
|
failedProvisionConfig | (非推奨) プロビジョニングの失敗の処理に関連する設定に使用します。 | |
|
globalPullSecret |
(非推奨) 全クラスターデプロイメントがグローバルで使用するプルシークレットを指定するのに使用します。クラスターデプロイメントごとに、 | object |
|
maintenanceMode |
(非推奨) true に設定して、Hive タイプのファイナライザーに対して追加したり、実行したりするような操作が行われないようにする必要がある場合など、hive コントローラーを無効にできます。このような状況はほぼ発生しないはずです。 | boolean |
Ingress
| sslCiphers 任意 | 管理 Ingress 向けに有効になっている SSL 暗号のリスト。デフォルトは、対応している暗号の全リストです。 | string |
|---|
backup
| minBackupPeriodSeconds 任意 | (非推奨) 次のバックアップが発生するまでの最小の MinBackupPeriodSeconds を指定します。これは、レート制限バックアップに使用します。これにより、1 つのバックアップに複数の変更がまとめられる可能性があります。この期間に加えられた変更がキューに格納され、この期間が終了したらバックアップが行われるので、バックアップは失われません。 | integer |
|---|---|---|
|
velero | (非推奨) Velero は Velero バックアップ統合の設定を指定します。 | object |
failedProvisionConfig
| skipGatherLogs 任意 | (非推奨) インストールに失敗した場合に、クラスターから全ログの収集を試行する機能を無効にします。ログは最長 7 日間永続ボリュームに保存されます。 | boolean |
|---|
status
| components 任意 | ステータス設定のコンポーネント。 | object |
|---|---|---|
|
conditions | multicluster hub のさまざまな条件が含まれます。 | |
|
desiredVersion | 必要なバージョンを指定します。 | string |
|
phase |
MultiClusterHub リソースのアクティブなフェーズを表します。このパラメーターに使用される値は、 | string |
conditions
| lastTransitionTime 任意 | 状態が別のステータスに最後に変わった時刻 | string |
|---|---|---|
|
lastUpdateTime | この状態が最後に更新された時刻。 | string |
|
message | メッセージは人間が判読できるメッセージで、最後にステータスが変更されたときの情報を指定します。 | string |
|
reason | 状態のステータスが変更された理由の簡単な説明 | string |
|
status | 状態のテータス。 | string |
|
type | クラスターの状態のタイプ | string |
StatusConditions
| kind 必須 | このステータスを表すリソースの kind | string |
|---|---|---|
|
available | このコンポーネントが適切に実行されているかどうかを示します。 | boolean |
|
lastTransitionTime | 状態が別のステータスに最後に変わった時刻 | metav1.time |
|
lastUpdateTime | この状態が最後に更新された時刻。 | metav1.time |
|
message | メッセージは人間が判読できるメッセージで、最後にステータスが変更されたときの情報を指定します。 | string |
|
reason | 状態のステータスが変更された理由の簡単な説明 | string |
|
status | 状態のテータス。 | string |
|
type | クラスターの状態のタイプ | string |
1.15. Placement API (v1beta1)
非推奨: API のドキュメントは非推奨となりました。現在のサポートされている API を表示するには、コンソールの API Explorer または oc コマンドを使用します。
1.15.1. 概要
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の Placement リソースを説明します。Placement リソースには、create、query、delete、update の 4 つのリクエストを使用できます。Placement は、placement namespace にバインドされている ManagedClusterSets から一連の ManagedClusters を選択するルールを定義します。ラベル cluster.open-cluster-management.io/placement={placement name} を持つ PlacementDecisions のスライスが作成され、この配置によって選択される ManagedClusters が表されます。
1.15.1.1. バージョン情報
Version : 2.13.0
1.15.1.2. URI スキーム
BasePath: /kubernetes/apis
Schemes: HTTPS
1.15.1.3. タグ
- cluster.open-cluster-management.io: Placement を作成して管理します。
1.15.2. パス
1.15.2.1. 全 Placement のクエリー
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placement1.15.2.1.1. 説明
Placement に対してクエリーを実行して詳細を確認します。
1.15.2.1.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
1.15.2.1.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.15.2.1.4. 消費されるアイテム
-
placement/yaml
1.15.2.1.5. タグ
- cluster.open-cluster-management.io
1.15.2.2. Placement の作成
POST /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements1.15.2.2.1. 説明
Placement を作成します。
1.15.2.2.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Body |
body | 作成する配置バインディングを記述するパラメーター。 |
1.15.2.2.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.15.2.2.4. 消費されるアイテム
-
placement/yaml
1.15.2.2.5. タグ
- cluster.open-cluster-management.io
1.15.2.2.6. HTTP リクエストの例
1.15.2.2.6.1. リクエストのボディー
{
"apiVersion" : "cluster.open-cluster-management.io/v1beta1",
"kind" : "Placement",
"metadata" : {
"name" : "placement1",
"namespace": "ns1"
},
"spec": {
"predicates": [
{
"requiredClusterSelector": {
"labelSelector": {
"matchLabels": {
"vendor": "OpenShift"
}
}
}
}
]
},
"status" : { }
}1.15.2.3. 単一の Placement のクエリー
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements/{placement_name}1.15.2.3.1. 説明
1 つの Placement に対してクエリーを実行して詳細を確認します。
1.15.2.3.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
placement_name | 問い合わせる Placement の名前 | string |
1.15.2.3.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.15.2.3.4. タグ
- cluster.open-cluster-management.io
1.15.2.4. Placement の削除
DELETE /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placements/{placement_name}1.15.2.4.1. 説明
単一の Placement を削除します。
1.15.2.4.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
placement_name | 削除する Placement の名前 | string |
1.15.2.4.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.15.2.4.4. タグ
- cluster.open-cluster-management.io
1.15.3. 定義
1.15.3.1. Placement
| 名前 | 説明 | スキーマ |
|---|---|---|
|
apiVersion | Placement のバージョン管理されたスキーマ。 | string |
|
kind | REST リソースを表す文字列の値 | string |
|
metadata | Placement のメタデータ。 | object |
|
spec | Placement の仕様。 |
spec
| 名前 | 説明 | スキーマ |
|---|---|---|
|
clusterSets |
| string array |
|
numberOfClusters |
選択する | integer (int32) |
|
predicates |
| clusterPredicate アレイ |
|
prioritizerPolicy | プライオリタイザーのポリシー。 | |
|
tolerations | 特定の taint を持つマネージドクラスターが、一致する許容範囲を持つプレースメントによって選択されることを許可するが、必須ではない値。 | toleration array |
clusterPredicate
| 名前 | 説明 | スキーマ |
|---|---|---|
|
requiredClusterSelector |
ラベルおよびクラスター要求のある |
clusterSelector
| 名前 | 説明 | スキーマ |
|---|---|---|
|
labelSelector |
ラベル別の | object |
|
claimSelector |
要求別の |
clusterClaimSelector
| 名前 | 説明 | スキーマ |
|---|---|---|
|
matchExpressions | クラスター要求セレクター要件のサブセット。条件ロジックは AND です。 | < オブジェクト > 配列 |
prioritizerPolicy
| 名前 | 説明 | スキーマ |
|---|---|---|
|
mode |
| string |
|
configurations | プライオリタイザーの設定。 | prioritizerConfig array |
prioritizerConfig
| 名前 | 説明 | スキーマ |
|---|---|---|
|
scoreCoordinate | プライオリタイザーおよびスコアソースの設定。 | |
|
weight | プライオリタイザースコアの重み。値は [-10,10] の範囲内である必要があります。 | int32 |
scoreCoordinate
| 名前 | 説明 | スキーマ |
|---|---|---|
|
type | プライオリタイザースコアのタイプ。有効な値は "BuiltIn" または "AddOn" です。 | string |
|
builtIn |
次のオプションからの | string |
|
addOn |
type が | object |
toleration
| 名前 | 説明 | スキーマ |
|---|---|---|
|
key | toleration が適用される taint キー。空は、すべての taint キーに一致することを意味します。 | string |
|
operator |
キーと値の関係。有効な Operator は | string |
|
value | toleration に一致する taint 値。 | string |
|
effect |
一致する taint 効果。空は、すべての taint 効果に一致することを意味します。指定した場合、許可される値は | string |
|
tolerationSeconds | taint が許容される時間の長さ。その後、taint は許容されません。デフォルト値は nil です。これは、taint が許容される期間に時間制限がないことを示します。 | int64 |
1.16. PlacementDecisions API (v1beta1)
非推奨: API のドキュメントは非推奨となりました。現在のサポートされている API を表示するには、コンソールの API Explorer または oc コマンドを使用します。
1.16.1. 概要
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の PlacementDecision リソースを説明します。PlacementDecision リソースには、create、query、delete、update の 4 つのリクエストを使用できます。PlacementDecision は、プレースメントからの決定を示します。PlacementDecision は、ラベル cluster.open-cluster-management.io/placement={placement name} を使用して特定の配置を参照します。
1.16.1.1. バージョン情報
Version : 2.13.0
1.16.1.2. URI スキーム
BasePath: /kubernetes/apis
Schemes: HTTPS
1.16.1.3. タグ
- cluster.open-cluster-management.io: PlacementDecision を作成して管理します。
1.16.2. パス
1.16.2.1. 全 PlacementDecision のクエリー
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions1.16.2.1.1. 説明
PlacementDecisions に対してクエリーを実行して詳細を確認します。
1.16.2.1.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
1.16.2.1.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.16.2.1.4. 消費されるアイテム
-
placementdecision/yaml
1.16.2.1.5. タグ
- cluster.open-cluster-management.io
1.16.2.2. PlacementDecision の作成
POST /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions1.16.2.2.1. 説明
PlacementDecision を作成します。
1.16.2.2.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Body |
body | 作成する PlacementDecision を記述するパラメーター |
1.16.2.2.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.16.2.2.4. 消費されるアイテム
-
placementdecision/yaml
1.16.2.2.5. タグ
- cluster.open-cluster-management.io
1.16.2.2.6. HTTP リクエストの例
1.16.2.2.6.1. リクエストのボディー
{
"apiVersion" : "cluster.open-cluster-management.io/v1beta1",
"kind" : "PlacementDecision",
"metadata" : {
"labels" : {
"cluster.open-cluster-management.io/placement" : "placement1"
},
"name" : "placement1-decision1",
"namespace": "ns1"
},
"status" : { }
}1.16.2.3. 単一の PlacementDecision のクエリー
GET /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions/{placementdecision_name}1.16.2.3.1. 説明
1 つの PlacementDecision に対してクエリーを実行して詳細を確認します。
1.16.2.3.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
placementdecision_name | 問い合わせる PlacementDecision の名前 | string |
1.16.2.3.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.16.2.3.4. タグ
- cluster.open-cluster-management.io
1.16.2.4. PlacementDecision の削除
DELETE /cluster.open-cluster-management.io/v1beta1/namespaces/{namespace}/placementdecisions/{placementdecision_name}1.16.2.4.1. 説明
単一の PlacementDecision を削除します。
1.16.2.4.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
placementdecision_name | 削除する PlacementDecision の名前 | string |
1.16.2.4.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.16.2.4.4. タグ
- cluster.open-cluster-management.io
1.16.3. 定義
1.16.3.1. PlacementDecision
| 名前 | 説明 | スキーマ |
|---|---|---|
|
apiVersion |
| string |
|
kind | REST リソースを表す文字列の値 | string |
|
metadata |
| object |
|
status |
|
PlacementStatus
| 名前 | 説明 | スキーマ |
|---|---|---|
|
Decisions | プレースメントに応じた決定のスライス。 | ClusterDecision array |
ClusterDecision
| 名前 | 説明 | スキーマ |
|---|---|---|
|
clusterName |
| string |
|
reason |
| string |
1.17. DiscoveryConfig API
非推奨: API のドキュメントは非推奨となりました。現在のサポートされている API を表示するには、コンソールの API Explorer または oc コマンドを使用します。
1.17.1. 概要
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の DiscoveryConfig リソースを説明します。DiscoveryConfig リソースには、create、query、delete、update の 4 つの要求を使用できます。
1.17.1.1. バージョン情報
Version : 2.13.0
1.17.1.2. URI スキーム
BasePath: /kubernetes/apis
Schemes: HTTPS
1.17.1.3. タグ
- discoveryconfigs.discovery.open-cluster-management.io: DiscoveryConfigs を作成して管理します。
1.17.2. パス
1.17.2.1. DiscoveryConfig の作成
POST /app.k8s.io/v1/namespaces/{namespace}/discoveryconfigs1.17.2.1.1. 説明
DiscoveryConfig を作成します。
1.17.2.1.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
| Body |
body | 作成する DiscoveryConfig を記述するパラメーター。 | DiscoveryConfig |
1.17.2.1.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.17.2.1.4. 消費されるアイテム
-
discoveryconfigs/yaml
1.17.2.1.5. タグ
- discoveryconfigs.discovery.open-cluster-management.io
1.17.2.1.5.1. リクエストのボディー
{
"apiVersion": "apiextensions.k8s.io/v1",
"kind": "CustomResourceDefinition",
"metadata": {
"annotations": {
"controller-gen.kubebuilder.io/version": "v0.4.1",
},
"creationTimestamp": null,
"name": "discoveryconfigs.discovery.open-cluster-management.io",
},
"spec": {
"group": "discovery.open-cluster-management.io",
"names": {
"kind": "DiscoveryConfig",
"listKind": "DiscoveryConfigList",
"plural": "discoveryconfigs",
"singular": "discoveryconfig"
},
"scope": "Namespaced",
"versions": [
{
"name": "v1",
"schema": {
"openAPIV3Schema": {
"description": "DiscoveryConfig is the Schema for the discoveryconfigs API",
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
},
"metadata": {
"type": "object"
},
"spec": {
"description": "DiscoveryConfigSpec defines the desired state of DiscoveryConfig",
"properties": {
"credential": {
"description": "Credential is the secret containing credentials to connect to the OCM api on behalf of a user",
"type": "string"
},
"filters": {
"description": "Sets restrictions on what kind of clusters to discover",
"properties": {
"lastActive": {
"description": "LastActive is the last active in days of clusters to discover, determined by activity timestamp",
"type": "integer"
},
"openShiftVersions": {
"description": "OpenShiftVersions is the list of release versions of OpenShift of the form \"<Major>.<Minor>\"",
"items": {
"description": "Semver represents a partial semver string with the major and minor version in the form \"<Major>.<Minor>\". For example: \"4.16\"",
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
},
"required": [
"credential"
],
"type": "object"
},
"status": {
"description": "DiscoveryConfigStatus defines the observed state of DiscoveryConfig",
"type": "object"
}
},
"type": "object"
}
},
"served": true,
"storage": true,
"subresources": {
"status": {}
}
}
]
},
"status": {
"acceptedNames": {
"kind": "",
"plural": ""
},
"conditions": [],
"storedVersions": []
}
}1.17.2.2. すべての DiscoveryConfigs のクエリー
GET /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator1.17.2.2.1. 説明
discovery config 演算子に対してクエリーを実行して詳細を確認します。
1.17.2.2.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
1.17.2.2.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.17.2.2.4. 消費されるアイテム
-
operator/yaml
1.17.2.2.5. タグ
- discoveryconfigs.discovery.open-cluster-management.io
1.17.2.3. DiscoveryConfig 演算子の削除
DELETE /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator/{discoveryconfigs_name}1.17.2.3.1. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
application_name | 削除する Discovery Config 演算子の名前。 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
1.17.2.3.2. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.17.2.3.3. タグ
- discoveryconfigs.operator.open-cluster-management.io
1.17.3. 定義
1.17.3.1. DiscoveryConfig
| 名前 | 説明 | スキーマ |
|---|---|---|
|
apiVersion | discoveryconfigs のバージョンスキーマ。 | string |
|
kind | REST リソースを表す文字列の値 | string |
|
metadata | リソースを定義するルールを記述します。 | object |
|
spec | DiscoveryConfig の必要な状態を定義します。 | 仕様のリスト を参照してください。 |
1.17.3.2. 仕様のリスト
| 名前 | 説明 | スキーマ |
|---|---|---|
|
credential | credential は、ユーザーの代わりに OCM API に接続するための認証情報が含まれるシークレットです。 | string |
|
filters | 検出するクラスターの種類に制限を設定します。 | フィルターの一覧 を参照してください。 |
1.17.3.3. フィルターのリスト
| 名前 | 説明 | スキーマ |
|---|---|---|
|
lastActive | LastActive は、検出するクラスターの最後のアクティブ日数で、アクティビティーのタイムスタンプによって決定されます。 | integer |
|
openShiftVersions | OpenShiftVersions は、OpenShift のリリースバージョン ("<Major>.<Minor>" 形式) のリストです。 | object |
1.18. DiscoveredCluster API
非推奨: API のドキュメントは非推奨となりました。現在のサポートされている API を表示するには、コンソールの API Explorer または oc コマンドを使用します。
1.18.1. 概要
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の DiscoveredCluster リソースを説明します。DiscoveredCluster リソースには、create、query、delete、update の 4 つの要求を使用できます。
1.18.1.1. バージョン情報
Version : 2.13.0
1.18.1.2. URI スキーム
BasePath: /kubernetes/apis
Schemes: HTTPS
1.18.1.3. タグ
- discoveredclusters.discovery.open-cluster-management.io: DiscoveredClusters を作成して管理します。
1.18.2. パス
1.18.2.1. DiscoveredCluster の作成
POST /app.k8s.io/v1/namespaces/{namespace}/discoveredclusters1.18.2.1.1. 説明
DiscoveredCluster を作成します。
1.18.2.1.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
| Body |
body | 作成する DiscoveredCluster を記述するパラメーター。 | DiscoveredCluster |
1.18.2.1.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.18.2.1.4. 消費されるアイテム
-
discoveredclusters/yaml
1.18.2.1.5. タグ
- discoveredclusters.discovery.open-cluster-management.io
1.18.2.1.5.1. リクエストのボディー
{
"apiVersion": "apiextensions.k8s.io/v1",
"kind": "CustomResourceDefinition",
"metadata": {
"annotations": {
"controller-gen.kubebuilder.io/version": "v0.4.1",\
},
"creationTimestamp": null,
"name": "discoveredclusters.discovery.open-cluster-management.io",
},
"spec": {
"group": "discovery.open-cluster-management.io",
"names": {
"kind": "DiscoveredCluster",
"listKind": "DiscoveredClusterList",
"plural": "discoveredclusters",
"singular": "discoveredcluster"
},
"scope": "Namespaced",
"versions": [
{
"name": "v1",
"schema": {
"openAPIV3Schema": {
"description": "DiscoveredCluster is the Schema for the discoveredclusters API",
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
},
"metadata": {
"type": "object"
},
"spec": {
"description": "DiscoveredClusterSpec defines the desired state of DiscoveredCluster",
"properties": {
"activityTimestamp": {
"format": "date-time",
"type": "string"
},
"apiUrl": {
"type": "string"
},
"cloudProvider": {
"type": "string"
},
"console": {
"type": "string"
},
"creationTimestamp": {
"format": "date-time",
"type": "string"
},
"credential": {
"description": "ObjectReference contains enough information to let you inspect or modify the referred object. --- New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs. 1. Ignored fields. It includes many fields which are not generally honored. For instance, ResourceVersion and FieldPath are both very rarely valid in actual usage. 2. Invalid usage help. It is impossible to add specific help for individual usage. In most embedded usages, there are particular restrictions like, \"must refer only to types A and B\" or \"UID not honored\" or \"name must be restricted\". Those cannot be well described when embedded. 3. Inconsistent validation. Because the usages are different, the validation rules are different by usage, which makes it hard for users to predict what will happen. 4. The fields are both imprecise and overly precise. Kind is not a precise mapping to a URL. This can produce ambiguity during interpretation and require a REST mapping. In most cases, the dependency is on the group,resource tuple and the version of the actual struct is irrelevant. 5. We cannot easily change it. Because this type is embedded in many locations, updates to this type will affect numerous schemas. Don't make new APIs embed an underspecified API type they do not control. Instead of using this type, create a locally provided and used type that is well-focused on your reference. For example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 .",
"properties": {
"apiVersion": {
"description": "API version of the referent.",
"type": "string"
},
"fieldPath": {
"description": "If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: \"spec.containers{name}\" (where \"name\" refers to the name of the container that triggered the event) or if no container name is specified \"spec.containers[2]\" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.",
"type": "string"
},
"kind": {
"description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"namespace": {
"description": "Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/",
"type": "string"
},
"resourceVersion": {
"description": "Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency",
"type": "string"
},
"uid": {
"description": "UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids",
"type": "string"
}
},
"type": "object"
},
"displayName": {
"type": "string"
},
"isManagedCluster": {
"type": "boolean"
},
"name": {
"type": "string"
},
"openshiftVersion": {
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"apiUrl",
"displayName",
"isManagedCluster",
"name",
"type"
],
"type": "object"
},
"status": {
"description": "DiscoveredClusterStatus defines the observed state of DiscoveredCluster",
"type": "object"
}
},
"type": "object"
}
},
"served": true,
"storage": true,
"subresources": {
"status": {}
}
}
]
},
"status": {
"acceptedNames": {
"kind": "",
"plural": ""
},
"conditions": [],
"storedVersions": []
}
}1.18.2.2. すべての DiscoveredClusters のクエリー
GET /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator1.18.2.2.1. 説明
discovered clusters 演算子に対してクエリーを実行して詳細を確認します。
1.18.2.2.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
1.18.2.2.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.18.2.2.4. 消費されるアイテム
-
operator/yaml
1.18.2.2.5. タグ
- discoveredclusters.discovery.open-cluster-management.io
1.18.2.3. DiscoveredCluster 演算子の削除
DELETE /operator.open-cluster-management.io/v1/namespaces/{namespace}/operator/{discoveredclusters_name}1.18.2.3.1. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
application_name | 削除する Discovered Cluster 演算子の名前。 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
1.18.2.3.2. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.18.2.3.3. タグ
- discoveredclusters.operator.open-cluster-management.io
1.18.3. 定義
1.18.3.1. DiscoveredCluster
| 名前 | 説明 | スキーマ |
|---|---|---|
|
apiVersion | discoveredclusters のバージョンスキーマ。 | string |
|
kind | REST リソースを表す文字列の値 | string |
|
metadata | リソースを定義するルールを記述します。 | object |
|
spec | DiscoveredClusterSpec は、DiscoveredCluster の必要な状態を定義します。 | 仕様のリスト を参照してください。 |
1.18.3.2. 仕様のリスト
| 名前 | 説明 | スキーマ |
|---|---|---|
|
activityTimestamp | Discoveredclusters 最後に利用可能なアクティビティータイムスタンプ。 | metav1.time |
|
apiUrl | Discoveredclusters API URL エンドポイント。 | string |
|
cloudProvider | discoveredcluster のクラウドプロバイダー。 | string |
|
console | Discoveredclusters コンソール URL エンドポイント。 | string |
|
creationTimestamp | Discoveredclusters 作成タイプスタンプ。 | metav1.time |
|
credential | クラスターが検出された認証情報への参照。 | corev1.ObjectReference |
|
displayName | 検出されたクラスターの表示名。 | string |
|
isManagedCluster | true の場合、クラスターは ACM によって管理されます。 | boolean |
|
name | 検出されたクラスターの名前。 | string |
|
openshiftVersion | 検出されたクラスターの OpenShift バージョン。 | string |
|
status | 検出されたクラスターのステータス。 | string |
|
type | OpenShift フレーバー (例:OCP、ROSA など)。 | string |
1.19. AddOnDeploymentConfig API (v1alpha1)
1.19.1. 概要
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の AddOnDeploymentConfig リソースを説明します。AddOnDeploymentConfig リソースでは、create、query、delete、update の 4 つの要求を使用できます。AddOnDeploymentConfig は、アドオンのデプロイメント設定を表します。
1.19.1.1. バージョン情報
Version : 2.13.0
1.19.1.2. URI スキーム
BasePath: /kubernetes/apis
Schemes: HTTPS
1.19.1.3. タグ
- addon.open-cluster-management.io: AddOnDeploymentConfigs の作成と管理
1.19.2. パス
1.19.2.1. Query all AddOnDeploymentConfigs
GET /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/addondeploymentconfigs1.19.2.1.1. 説明
AddOnDeploymentConfig に対してクエリーを実行し、詳細を確認します。
1.19.2.1.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
1.19.2.1.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.19.2.1.4. 消費されるアイテム
-
addondeploymentconfig/yaml
1.19.2.1.5. タグ
- addon.open-cluster-management.io
1.19.2.2. Create a AddOnDeploymentConfig
POST /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/addondeploymentconfigs1.19.2.2.1. 説明
AddOnDeploymentConfig を作成します。
1.19.2.2.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Body |
body | 作成する AddOnDeploymentConfig バインディングを記述するパラメーター。 |
1.19.2.2.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.19.2.2.4. 消費されるアイテム
-
addondeploymentconfig/yaml
1.19.2.2.5. タグ
- addon.open-cluster-management.io
1.19.2.2.6. HTTP リクエストの例
1.19.2.2.6.1. リクエストのボディー
{
"apiVersion": "addon.open-cluster-management.io/v1alpha1",
"kind": "AddOnDeploymentConfig",
"metadata": {
"name": "deploy-config",
"namespace": "open-cluster-management-hub"
},
"spec": {
"nodePlacement": {
"nodeSelector": {
"node-dedicated": "acm-addon"
},
"tolerations": [
{
"effect": "NoSchedule",
"key": "node-dedicated",
"operator": "Equal",
"value": "acm-addon"
}
]
}
}
}1.19.2.3. Query a single AddOnDeploymentConfig
GET /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/addondeploymentconfigs/{addondeploymentconfig_name}1.19.2.3.1. 説明
1 つの AddOnDeploymentConfig に対してクエリーを実行し、詳細を確認します。
1.19.2.3.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
addondeploymentconfig_name | クエリーを実行する AddOnDeploymentConfig の名前 | string |
1.19.2.3.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.19.2.3.4. タグ
- addon.open-cluster-management.io
1.19.2.4. AddOnDeploymentConfig を削除する
DELETE /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/addondeploymentconfigs/{addondeploymentconfig_name}1.19.2.4.1. 説明
1 つの AddOnDeploymentConfig を削除します。
1.19.2.4.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
addondeploymentconfig_name | 削除する AddOnDeploymentConfig の名前。 | string |
1.19.2.4.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.19.2.4.4. タグ
- addon.open-cluster-management.io
1.19.3. 定義
1.19.3.1. AddOnDeploymentConfig
| 名前 | 説明 | スキーマ |
|---|---|---|
|
apiVersion | AddOnDeploymentConfig のバージョン管理スキーマ。 | string |
|
kind | REST リソースを表す文字列の値 | string |
|
metadata | AddOnDeploymentConfig のメタデータ。 | object |
|
spec | AddOnDeploymentConfig の仕様。 |
spec
| 名前 | 説明 | スキーマ |
|---|---|---|
|
customizedVariables | 現在のアドオンデプロイメントの name-value 変数のリスト。アドオン実装では、これらの変数を使用してアドオンのデプロイメントをレンダリングできます。 | customizedVariable array |
|
nodePlacement | マネージドクラスターのアドオンエージェントに対するスケジューリングの明示的な制御を有効にします。 |
customizedVariable
| 名前 | 説明 | スキーマ |
|---|---|---|
|
name | この変数の名前。 | string |
|
value | この変数の値。 | string |
nodePlacement
| 名前 | 説明 | スキーマ |
|---|---|---|
|
nodeSelector |
Pod の実行がスケジュールされるノードを定義します。 | map[string]string |
|
tolerations |
Pod に適用され、一致するマシン Operator ( | []corev1.Toleration |
1.20. ClusterManagementAddOn API (v1alpha1)
非推奨: API のドキュメントは非推奨となりました。現在のサポートされている API を表示するには、コンソールの API Explorer または oc コマンドを使用します。
1.20.1. 概要
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の ClusterManagementAddOn リソースを説明します。ClusterManagementAddOn リソースには、create、query、delete、update の 4 つの要求を使用できます。
ClusterManagementAddOn は、クラスターマネージャーへのアドオンの登録を表します。このリソースを使用すると、ユーザーはクラスターマネージャーで使用できるアドオンを見つけ、アドオンに関するメタデータ情報を取得できます。このリソースは、namespace のスコープが指定された ManagedClusterAddOn リソースに使用される ClusterManagementAddOn リソースの名前である ManagedClusterAddOn への参照も指定します。ClusterManagementAddOn はクラスターのスコープが指定されたリソースです。
1.20.1.1. バージョン情報
Version : 2.13.0
1.20.1.2. URI スキーム
BasePath: /kubernetes/apis
Schemes: HTTPS
1.20.1.3. タグ
- addon.open-cluster-management.io: ClusterManagementAddOns の作成と管理
1.20.2. パス
1.20.2.1. Query all ClusterManagementAddOns
GET /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons1.20.2.1.1. 説明
ClusterManagementAddOns に対してクエリーを実行し、詳細を確認します。
1.20.2.1.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
1.20.2.1.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.20.2.1.4. 消費されるアイテム
-
clustermanagementaddon/yaml
1.20.2.1.5. タグ
- addon.open-cluster-management.io
1.20.2.2. Create a ClusterManagementAddOn
POST /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons1.20.2.2.1. 説明
ClusterManagementAddOn を作成します。
1.20.2.2.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Body |
body | 作成する ClusterManagementAddon バインディングを記述するパラメーター。 |
1.20.2.2.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.20.2.2.4. 消費されるアイテム
-
clustermanagementaddon/yaml
1.20.2.2.5. タグ
- addon.open-cluster-management.io
1.20.2.2.6. HTTP リクエストの例
1.20.2.2.6.1. リクエストのボディー
{
"apiVersion": "addon.open-cluster-management.io/v1alpha1",
"kind": "ClusterManagementAddOn",
"metadata": {
"name": "helloworld"
},
"spec": {
"supportedConfigs": [
{
"defaultConfig": {
"name": "deploy-config",
"namespace": "open-cluster-management-hub"
},
"group": "addon.open-cluster-management.io",
"resource": "addondeploymentconfigs"
}
]
},
"status" : { }
}1.20.2.3. Query a single ClusterManagementAddOn
GET /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons/{clustermanagementaddon_name}1.20.2.3.1. 説明
1 つの ClusterManagementAddOn に対してクエリーを実行し、詳細を確認します。
1.20.2.3.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
clustermanagementaddon_name | クエリーを実行する ClusterManagementAddOn の名前。 | string |
1.20.2.3.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.20.2.3.4. タグ
- addon.open-cluster-management.io
1.20.2.4. ClusterManagementAddOn の削除
DELETE /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons/{clustermanagementaddon_name}1.20.2.4.1. 説明
1 つの ClusterManagementAddOn を削除します。
1.20.2.4.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
clustermanagementaddon_name | 削除する ClusterManagementAddOn の名前。 | string |
1.20.2.4.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.20.2.4.4. タグ
- addon.open-cluster-management.io
1.20.3. 定義
1.20.3.1. ClusterManagementAddOn
| 名前 | 説明 | スキーマ |
|---|---|---|
|
apiVersion | ClusterManagementAddOn のバージョン管理されたスキーマ。 | string |
|
kind | REST リソースを表す文字列の値 | string |
|
metadata | ClusterManagementAddOn のメタデータ。 | object |
|
spec | ClusterManagementAddOn の仕様。 |
spec
| 名前 | 説明 | スキーマ |
|---|---|---|
|
addOnMeta | AddOnMeta は、アドオンのメタデータ情報への参照です。 | |
|
supportedConfigs | SupportedConfigs は、アドオンでサポートされる設定タイプのリストです。 | configMeta array |
addOnMeta
| 名前 | 説明 | スキーマ |
|---|---|---|
|
displayName | 表示されるアドオンの名前を表します。 | string |
|
description | アドオンの詳細な説明を表します。 | string |
configMeta
| 名前 | 説明 | スキーマ |
|---|---|---|
|
group | アドオン設定のグループ。 | string |
|
resource | アドオン設定のリソース。 | string |
|
defaultConfig | デフォルトのアドオン設定の namespace と名前を表します。すべてのアドオンで同じ設定になります。 |
configReferent
| 名前 | 説明 | スキーマ |
|---|---|---|
|
namespace | アドオン設定の namespace。このフィールドが設定されていない場合、設定は cluster-scope になります。 | string |
|
name | アドオン設定の名前。 | string |
1.21. ManagedClusterAddOn API (v1alpha1)
非推奨: API のドキュメントは非推奨となりました。現在のサポートされている API を表示するには、コンソールの API Explorer または oc コマンドを使用します。
1.21.1. 概要
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の ManagedClusterAddOn リソースを説明します。ManagedClusterAddOn リソースには、create、query、delete、update の 4 つの要求を使用できます。ManagedClusterAddOn は、アドオンの現在の状態を保持するカスタムリソースオブジェクトです。このリソースは ManagedCluster namespace で作成する必要があります。
1.21.1.1. バージョン情報
Version : 2.13.0
1.21.1.2. URI スキーム
BasePath: /kubernetes/apis
Schemes: HTTPS
1.21.1.3. タグ
- addon.open-cluster-management.io: ManagedClusterAddOns の作成と管理
1.21.2. パス
1.21.2.1. Query all ManagedClusterAddOns
GET /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclusteraddons1.21.2.1.1. 説明
ManagedClusterAddOn に対してクエリーを実行し、詳細を確認します。
1.21.2.1.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
1.21.2.1.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.21.2.1.4. 消費されるアイテム
-
managedclusteraddon/yaml
1.21.2.1.5. タグ
- addon.open-cluster-management.io
1.21.2.2. Create a ManagedClusterAddOn
POST /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclusteraddons1.21.2.2.1. 説明
ManagedClusterAddOn を作成します。
1.21.2.2.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Body |
body | 作成される ManagedClusterAddOn バインディングを記述するパラメーター。 |
1.21.2.2.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.21.2.2.4. 消費されるアイテム
-
managedclusteraddon/yaml
1.21.2.2.5. タグ
- addon.open-cluster-management.io
1.21.2.2.6. HTTP リクエストの例
1.21.2.2.6.1. リクエストのボディー
{
"apiVersion": "addon.open-cluster-management.io/v1alpha1",
"kind": "ManagedClusterAddOn",
"metadata": {
"name": "helloworld",
"namespace": "cluster1"
},
"spec": {
"configs": [
{
"group": "addon.open-cluster-management.io",
"name": "cluster-deploy-config",
"namespace": "open-cluster-management-hub",
"resource": "addondeploymentconfigs"
}
],
"installNamespace": "default"
},
"status" : { }
}1.21.2.3. Query a single ManagedClusterAddOn
GET /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclusteraddons/{managedclusteraddon_name}1.21.2.3.1. 説明
1 つの ManagedClusterAddOn に対してクエリーを実行し、詳細を確認します。
1.21.2.3.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
managedclusteraddon_name | クエリーを実行する ManagedClusterAddOn の名前。 | string |
1.21.2.3.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.21.2.3.4. タグ
- addon.open-cluster-management.io
1.21.2.4. Delete a ManagedClusterAddOn
DELETE /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclusteraddons/{managedclusteraddon_name}1.21.2.4.1. 説明
1 つの ManagedClusterAddOn を削除します。
1.21.2.4.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
managedclusteraddon_name | 削除する ManagedClusterAddOn の名前。 | string |
1.21.2.4.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.21.2.4.4. タグ
- addon.open-cluster-management.io
1.21.3. 定義
1.21.3.1. ManagedClusterAddOn
| 名前 | 説明 | スキーマ |
|---|---|---|
|
apiVersion | ManagedClusterAddOn のバージョン管理されたスキーマ。 | string |
|
kind | REST リソースを表す文字列の値 | string |
|
metadata | ManagedClusterAddOn のメタデータ。 | object |
|
spec | ManagedClusterAddOn の仕様。 |
spec
| 名前 | 説明 | スキーマ |
|---|---|---|
|
installNamespace | アドオンエージェントをインストールするためのマネージドクラスター上の namespace。設定されていない場合は、open-cluster-management-agent-addon namespace を使用してアドオンエージェントをインストールします。 | string |
|
configs | 現在のアドオンに独自の設定があるアドオン設定のリスト。 | addOnConfig array |
addOnConfig
| 名前 | 説明 | スキーマ |
|---|---|---|
|
group | アドオン設定のグループ。 | string |
|
resource | アドオン設定のリソース。 | string |
|
namespace | アドオン設定の namespace。このフィールドが設定されていない場合、設定は cluster-scope になります。 | string |
|
name | アドオン設定の名前。 | string |
1.22. ManagedClusterSet API (v1beta2)
非推奨: API のドキュメントは非推奨となりました。現在のサポートされている API を表示するには、コンソールの API Explorer または oc コマンドを使用します。
1.22.1. 概要
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の ManagedClusterSet リソースを説明します。ManagedClusterSet リソースには、create、query、delete、update の 4 つの要求を使用できます。ManagedClusterSet は、2 つ以上のマネージドクラスターを 1 つのセットにグループ化し、一緒に操作できるようにします。セットに属するマネージドクラスターは、使用目的の共有や同じデプロイメントリージョンなど、同様の属性を持つことができます。
1.22.1.1. バージョン情報
Version : 2.13.0
1.22.1.2. URI スキーム
BasePath: /kubernetes/apis
Schemes: HTTPS
1.22.1.3. タグ
- cluster.open-cluster-management.io : ManagedClusterSets の作成と管理
1.22.2. パス
1.22.2.1. すべての managedclusterset のクエリー
GET /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersets1.22.2.1.1. 説明
詳細は、managedclustersets をクエリーしてください。
1.22.2.1.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
namespace | 使用する namespace (例: default) | string |
1.22.2.1.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.22.2.1.4. 消費されるアイテム
-
managedclusterset/yaml
1.22.2.1.5. タグ
- cluster.open-cluster-management.io
1.22.2.2. managedclusterset の作成
POST /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersets1.22.2.2.1. 説明
managedclusterset を作成します。
1.22.2.2.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
namespace |
使用する namespace (例: | string |
| Body |
body | 作成する managedclusterset を記述するパラメーター。 |
1.22.2.2.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.22.2.2.4. 消費されるアイテム
-
managedclusterset/yaml
1.22.2.2.5. タグ
- cluster.open-cluster-management.io
1.22.2.2.6. HTTP リクエストの例
1.22.2.2.6.1. リクエストのボディー
{
"apiVersion" : "cluster.open-cluster-management.io/v1beta2",
"kind" : "ManagedClusterSet",
"metadata" : {
"name" : "example-clusterset",
},
"spec": {
},
"status" : { }
}1.22.2.3. 単一の managedclusterset のクエリー
GET /cluster.open-cluster-management.io/v1beta2/namespaces/{namespace}/managedclustersets/{managedclusterset_name}1.22.2.3.1. 説明
詳細は、単一の managedclusterset をクエリーしてください。
1.22.2.3.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
namespace |
使用する namespace (例: | string |
| Path |
managedclusterset_name | クエリーを行う managedclusterset の名前。 | string |
1.22.2.3.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.22.2.3.4. タグ
- cluster.open-cluster-management.io
1.22.2.4. managedclusterset の削除
DELETE /cluster.open-cluster-management.io/v1beta2/managedclustersets/{managedclusterset_name}1.22.2.4.1. 説明
単一の managedclusterset を削除します。
1.22.2.4.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
namespace |
使用する namespace (例: | string |
| Path |
managedclusterset_name | 削除する managedclusterset の名前。 | string |
1.22.2.4.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.22.2.4.4. タグ
- cluster.open-cluster-management.io
1.22.3. 定義
1.22.3.1. ManagedClusterSet
| 名前 | 説明 | スキーマ |
|---|---|---|
|
apiVersion |
| string |
|
kind | REST リソースを表す文字列の値 | string |
|
metadata |
| object |
| spec 必須 |
| spec |
1.23. KlusterletConfig API (v1alpha1)
非推奨: API のドキュメントは非推奨となりました。現在のサポートされている API を表示するには、コンソールの API Explorer または oc コマンドを使用します。
1.23.1. 概要
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の KlusterletConfig リソースを説明します。KlusterletConfig リソースには、create、query、delete、update の 4 つの要求を使用できます。KlusterletConfig には、nodeSelector、tolerations、および pullSecret などの klusterlet 設定情報が含まれます。KlusterletConfig はクラスタースコープのリソースで、open-cluster-managemnet-agent namespace 内の klusterlet Pod でのみ機能します。KlusterletConfig は、アドオンのデプロイメント設定には影響しません。
1.23.1.1. バージョン情報
Version : 2.13.0
1.23.1.2. URI スキーム
BasePath: /kubernetes/apis
Schemes: HTTPS
1.23.1.3. タグ
- config.open-cluster-management.io: KlusterletConfig を作成して管理します。
1.23.2. パス
1.23.2.1. 全 KlusterletConfig のクエリー
GET /config.open-cluster-management.io/v1alpha1/namespaces/{namespace}/klusterletconfigs1.23.2.1.1. 説明
KlusterletConfig に対してクエリーを実行して詳細を確認します。
1.23.2.1.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
1.23.2.1.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.23.2.1.4. 消費されるアイテム
-
klusterletconfig/yaml
1.23.2.1.5. タグ
- config.open-cluster-management.io
1.23.2.2. KlusterletConfig を作成します。
POST /config.open-cluster-management.io/v1alpha1/namespaces/{namespace}/klusterletconfigs1.23.2.2.1. 説明
KlusterletConfig を作成します。
1.23.2.2.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Body |
body | 作成する KlusterletConfig バインディングを記述するパラメーター。 |
1.23.2.2.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.23.2.2.4. 消費されるアイテム
-
klusterletconfig/yaml
1.23.2.2.5. タグ
- config.open-cluster-management.io
1.23.2.2.6. HTTP リクエストの例
1.23.2.2.6.1. リクエストのボディー
{
"apiVersion": "apiextensions.k8s.io/v1",
"kind": "CustomResourceDefinition",
"metadata": {
"annotations": {
"controller-gen.kubebuilder.io/version": "v0.7.0"
},
"creationTimestamp": null,
"name": "klusterletconfigs.config.open-cluster-management.io"
},
"spec": {
"group": "config.open-cluster-management.io",
"names": {
"kind": "KlusterletConfig",
"listKind": "KlusterletConfigList",
"plural": "klusterletconfigs",
"singular": "klusterletconfig"
},
"preserveUnknownFields": false,
"scope": "Cluster",
"versions": [
{
"name": "v1alpha1",
"schema": {
"openAPIV3Schema": {
"description": "KlusterletConfig contains the configuration of a klusterlet including the upgrade strategy, config overrides, proxy configurations etc.",
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
},
"metadata": {
"type": "object"
},
"spec": {
"description": "Spec defines the desired state of KlusterletConfig",
"properties": {
"hubKubeAPIServerProxyConfig": {
"description": "HubKubeAPIServerProxyConfig holds proxy settings for connections between klusterlet/add-on agents on the managed cluster and the kube-apiserver on the hub cluster. Empty means no proxy settings is available.",
"properties": {
"caBundle": {
"description": "CABundle is a CA certificate bundle to verify the proxy server. It will be ignored if only HTTPProxy is set; And it is required when HTTPSProxy is set and self signed CA certificate is used by the proxy server.",
"format": "byte",
"type": "string"
},
"httpProxy": {
"description": "HTTPProxy is the URL of the proxy for HTTP requests",
"type": "string"
},
"httpsProxy": {
"description": "HTTPSProxy is the URL of the proxy for HTTPS requests HTTPSProxy will be chosen if both HTTPProxy and HTTPSProxy are set.",
"type": "string"
}
},
"type": "object"
},
"nodePlacement": {
"description": "NodePlacement enables explicit control over the scheduling of the agent components. If the placement is nil, the placement is not specified, it will be omitted. If the placement is an empty object, the placement will match all nodes and tolerate nothing.",
"properties": {
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "NodeSelector defines which Nodes the Pods are scheduled on. The default is an empty list.",
"type": "object"
},
"tolerations": {
"description": "Tolerations is attached by pods to tolerate any taint that matches the triple <key,value,effect> using the matching operator <operator>. The default is an empty list.",
"items": {
"description": "The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.",
"properties": {
"effect": {
"description": "Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.",
"type": "string"
},
"key": {
"description": "Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.",
"type": "string"
},
"operator": {
"description": "Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.",
"type": "string"
},
"tolerationSeconds": {
"description": "TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.",
"format": "int64",
"type": "integer"
},
"value": {
"description": "Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"pullSecret": {
"description": "PullSecret is the name of image pull secret.",
"properties": {
"apiVersion": {
"description": "API version of the referent.",
"type": "string"
},
"fieldPath": {
"description": "If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: \"spec.containers{name}\" (where \"name\" refers to the name of the container that triggered the event) or if no container name is specified \"spec.containers[2]\" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.",
"type": "string"
},
"kind": {
"description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"namespace": {
"description": "Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/",
"type": "string"
},
"resourceVersion": {
"description": "Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency",
"type": "string"
},
"uid": {
"description": "UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids",
"type": "string"
}
},
"type": "object"
},
"registries": {
"description": "Registries includes the mirror and source registries. The source registry will be replaced by the Mirror.",
"items": {
"properties": {
"mirror": {
"description": "Mirror is the mirrored registry of the Source. Will be ignored if Mirror is empty.",
"type": "string"
},
"source": {
"description": "Source is the source registry. All image registries will be replaced by Mirror if Source is empty.",
"type": "string"
}
},
"required": [
"mirror"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"status": {
"description": "Status defines the observed state of KlusterletConfig",
"type": "object"
}
},
"type": "object"
}
},
"served": true,
"storage": true,
"subresources": {
"status": {}
}
}
]
},
"status": {
"acceptedNames": {
"kind": "",
"plural": ""
},
"conditions": [],
"storedVersions": []
}
}1.23.2.3. 単一の KlusterletConfig のクエリー
GET /config.open-cluster-management.io/v1alpha1/namespaces/{namespace}/klusterletconfigs/{klusterletconfig_name}1.23.2.3.1. 説明
1 つの KlusterletConfig に対してクエリーを実行して詳細を確認します。
1.23.2.3.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
klusterletconfig_name | クエリーを実行する KlusterletConfig の名前。 | string |
1.23.2.3.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.23.2.3.4. タグ
- config.open-cluster-management.io
1.23.2.4. KlusterletConfig の削除
DELETE /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/klusterletconfigs/{klusterletconfig_name}1.23.2.4.1. 説明
単一の klusterletconfig を削除します。
1.23.2.4.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| Header |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | string |
| Path |
klusterletconfig_name | 削除する KlusterletConfig の名前。 | string |
1.23.2.4.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.23.2.4.4. タグ
- config.open-cluster-management.io
1.23.3. 定義
1.23.3.1. KlusterletConfig
| 名前 | 説明 | スキーマ |
|---|---|---|
|
apiVersion | KlusterletConfig のバージョン管理されたスキーマ。 | string |
|
kind | REST リソースを表す文字列の値 | string |
|
metadata | KlusterletConfig のメタデータ。 | object |
|
spec | KlusterletConfig の仕様。 |
spec
| 名前 | 説明 | スキーマ |
|---|---|---|
|
registries | ミラーおよびソースレジストリーが含まれます。ソースレジストリーはミラーに置き換えられます。 | registry |
|
pullSecret | イメージプルシークレットの名前。 | object |
|
nodePlacement | マネージドクラスターでアドオンエージェントのスケジューリング制御を有効にします。 | |
|
hubKubeAPIServerProxyConfig | マネージドクラスターの klusterlet またはアドオンエージェントとハブクラスターの kube-apiserver 間の接続のプロキシー設定が含まれています。空白は、使用できるプロキシー設定がないことを意味します。 |
nodePlacement
| 名前 | 説明 | スキーマ |
|---|---|---|
|
nodeSelector |
Pod の実行がスケジュールされるノードを定義します。 | map[string]string |
|
tolerations |
Pod に適用され、一致するマシン Operator ( | []corev1.Toleration |
kubeAPIServerProxyConfig
| 名前 | 説明 | スキーマ |
|---|---|---|
|
caBundle | プロキシーサーバーを検証するための CA 証明書バンドルです。HTTPProxy のみが設定されている場合、バンドルは無視されます。このバンドルは、HTTPSProxy が設定され、自己署名 CA 証明書がプロキシーサーバーによって使用される場合に必要になります。 | map[string]string |
|
httpProxy | HTTP リクエストのプロキシーの URL | map[string]string |
|
httpsProxy | HTTPS 要求のプロキシーの URL。HTTPProxy および HTTPSProxy の両方が設定されている場合は、HTTPSProxy が選択されます。 | map[string]string |
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}