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

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. バージョン情報
リンクのコピー

バージョン: 2.14.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}
Copy to Clipboard Toggle word wrap
1.2.2.1.1. 説明
リンクのコピー

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

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

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. レスポンス
リンクのコピー
Expand
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>
Copy to Clipboard Toggle word wrap
1.2.2.2.1. 説明
リンクのコピー

選択したインストール方法に応じて、SiteConfig Operator を使用してインストールマニフェストを作成します。

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

Header

COOKIE
必須

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

string

Body

body
必須

作成するインストールマニフェストを記述するパラメーター。

ClusterInstance

Path

clusterinstance_namespace
必須

使用する ClusterInstance の namespace。

string

Path

clusterinstance_name
必須

使用する ClusterInstance の名前。

string

1.2.2.2.3. レスポンス
リンクのコピー
Expand
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
                                }
                            ]
                        }
                    }
                }
            }
        ]
    }
}
Copy to Clipboard Toggle word wrap

1.2.2.3. 単一クラスターのクエリー
リンクのコピー

GET /siteconfig.open-cluster-management.io/v1alpha1/<clusterinstance_namespace>/<clusterinstance_name>
Copy to Clipboard Toggle word wrap
1.2.2.3.1. 説明
リンクのコピー

1 つのクラスターに対してクエリーを実行して詳細を確認します。

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

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. レスポンス
リンクのコピー
Expand
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 は、次のドキュメントを参照してください。

Expand
名前説明スキーマ

apiVersion
必須

ClusterInstance のバージョン管理されたスキーマ。

string

kind
必須

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

string

metadata
必須

ClusterInstance のメタデータ。

object

spec
必須

ClusterInstance の仕様。

spec

status
必須

ClusterInstance のステータス。

status オブジェクト

spec

Expand
名前説明スキーマ

additionalNTPSources
任意

すべてのクラスターホストに追加する必要がある NTP ソースを指定します。これらは、他の手段で設定された NTP ソースに追加されます。

array

baseDomain
必須

デプロイされたクラスターに使用するベースドメインを指定します。

string

caBundleRef
任意

ホストの信頼済み証明書の新しいバンドルが含まれる ConfigMap オブジェクトを参照します。ConfigMap オブジェクトの tls-ca-bundle.pem エントリーは、/etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem に書き込まれます。

string

clusterImageSetNameRef
必須

デプロイする OpenShift Container Platform のバージョンを示す ClusterImageSet オブジェクトの名前を指定します。

string

clusterName
必須

クラスターの名前を指定します。

string

clusterNetwork
任意

Pod の IP アドレスプールのリストを指定します。

array

clusterType
任意

クラスタータイプを指定します。以下の値を使用できます。

SNO
シングルノード OpenShift
HighlyAvailable
マルチノード OpenShift

string

cpuPartitioningMode
任意

インストール時に CPU ワークロードのパーティション設定用にセットアップするクラスターを決定します。cpuPartitioningMode の値を AllNodes に設定して、ワークロードパーティショニングを設定します。設定を完了するには、PerformanceProfile CR で isolated および reserved CPU を指定します。デフォルト値は None です。

string

diskEncryption
任意

クラスターのディスク暗号化を有効または無効にします。

object

extraAnnotations
任意

次の形式を使用して、レンダリングされたテンプレートに適用する追加のクラスターレベルのアノテーションを指定します。

extraAnnotations:
  ClusterDeployment:
    myClusterAnnotation: success
Copy to Clipboard Toggle word wrap

object

extraLabels
任意

次の形式を使用して、レンダリングされたテンプレートに適用する追加のクラスターレベルのラベルを指定します。

extraLabels:
  ManagedCluster:
    common: "true"
    label-a : "value-a"
Copy to Clipboard Toggle word wrap

object

extraManifestsRefs
任意

クラスターに適用する追加のマニフェストが含まれる ConfigMap オブジェクト参照のリストを指定します。

array

holdInstallation
任意

Assisted Installer を使用する場合は、インストールを防止するために true に設定します。検査と検証の手順は完了できますが、RequirementsMet 条件が true になった後は holdInstallation フィールドが false に設定されるまでインストールは開始されません。

bool

ignitionConfigOverride
任意

初期 Ignition 設定のユーザーオーバーライドを指定します。

string

installConfigOverrides
任意

インストール設定パラメーターを定義します。

string

machineNetwork
任意

マシンの IP アドレスプールのリストを指定します。

array

networkType
任意

インストールする Container Network Interface (CNI) プラグインを指定します。デフォルト値は、IPv4 の場合は OpenShiftSDN、IPv6 またはシングルノード OpenShift クラスターの場合は OVNKubernetes です。

string

platformType
任意

インストール先となる特定のプラットフォームの名前を定義します。以下の値を使用できます。

  • BareMetal
  • VSphere
  • Nutanix
  • 外部
  • ""
  • なし

string

proxy
任意

クラスターのインストール設定に使用するプロキシー設定を定義します。

object

pruneManifests
任意

apiVersion と Kind の値を指定して、削除するクラスターレベルのマニフェストのリストを定義します。

array

pullSecretRef
必須

イメージをプルするための pull-secret ファイルを設定します。pull-secret ファイルを作成するときは、ホストをプロビジョニングする ClusterInstance CR と同じ namespace を使用します。

object

serviceNetwork
任意

サービスの IP アドレスプールのリストを指定します。

array

sshPublicKey
任意

インスタンスへのアクセスを提供するための Secure Shell (SSH) 公開鍵を指定します。この鍵は、SSH アクセスを許可するためにホストに追加されます。

string

nodes
必須

各ノードの設定パラメーターを指定します。

ノード 配列

templateRefs
必須

クラスターレベルのテンプレートへの参照リストを指定します。クラスターレベルのテンプレートは ConfigMap オブジェクトで構成され、データフィールドのキーはインストールマニフェストの kind を表します。クラスターレベルのテンプレートは、ClusterInstance CR 内のクラスターごとに 1 回インスタンス化されます。

array

nodes

Expand
名前説明スキーマ

automatedCleaningMode
任意

値を metadata に設定すると、ディスクを完全にワイプせずに、ディスクのパーティションテーブルのみを削除できます。デフォルト値は、disabled です。

string

bmcAddress
必須

ホストへのアクセスに使用する BMC アドレス。すべてのクラスタータイプに適用されます。BMC アドレス指定の詳細は、関連情報の BMC アドレス指定 を参照してください。注記: ファーエッジの通信会社のユースケースでは、GitOps ZTP での使用は仮想メディアのみがサポートされます。

string

bmcCredentialsName
必須

ホスト BMC 認証情報を使用して、別途作成した bmh-secret CR を設定します。bmh-secret CR を作成するときは、ホストをプロビジョニングする ClusterInstance CR と同じ namespace を使用します。

string

bootMACAddress
必須

PXE ブートする MAC アドレスを指定します。仮想 BMC ドリブンの libvirt 仮想マシンに必要です。

string

bootMode
任意

ホストのブートモードを UEFI に設定します。デフォルト値は UEFI です。UEFISecureBoot を使用して、ホストでセキュアブートを有効にします。以下の値を使用できます。

  • UEFI
  • UEFISecureBoot
  • legacy

string

extraAnnotations
任意

次の形式を使用して、レンダリングされたテンプレートに適用する追加のノードレベルのアノテーションを指定します。

extraAnnotations:
  BareMetalHost:
    myNodeAnnotation: success
Copy to Clipboard Toggle word wrap

object

extraLabels
任意

レンダリングされたテンプレートに適用する追加のノードレベルのラベルを指定します。

extraLabels:
  ManagedCluster:
    common: "true"
    label-a : "value-a"
Copy to Clipboard Toggle word wrap

object

hostName
必須

ホスト名を定義します。

string

installerArgs
任意

ホストの :op-system-first: インストーラー引数のユーザーオーバーライドを指定します。

string

ignitionConfigOverride
任意

初期 Ignition 設定のユーザーオーバーライドを指定します。このフィールドを使用して、永続ストレージのパーティションを割り当てます。ディスク ID とサイズを特定のハードウェアに合わせて調整します。

string

ironicInspect
任意

ベアメタルホストの登録中に自動イントロスペクションを実行するかどうかを指定します。

string

nodeLabels
任意

マネージドクラスター内のノードのカスタムノードラベルを指定します。これは、Red Hat Advanced Cluster Management コンポーネントでは使用されず、ユーザーのみが使用する追加のラベルです。カスタムノードラベルを追加すると、そのラベルの特定の設定を参照するカスタムマシン設定プールに関連付けることができます。インストール中にカスタムラベルを追加すると、デプロイメントプロセスがより効率的になり、インストール完了後に追加で再起動する必要がなくなります。

注記: BareMetalHost テンプレートで使用する場合、カスタムラベルは bmac.agent-install.openshift.io の接頭辞と併せて BareMetalHost アノテーションに追加されます。

object

nodeNetwork
任意

静的ネットワークを持つノードのネットワークを設定します。

object

pruneManifests
任意

apiVersion と Kind の値を指定して、削除するノードレベルのマニフェストのリストを定義します。

array

role
任意

master や worker など、ノードのロールを設定します。

string

rootDeviceHints
任意

デプロイ先となるデバイスを指定します。再起動しても維持される安定した識別子が推奨されます。たとえば、wwn: <disk_wwn> または deviceName: /dev/disk/by-path/<device_path> です。<by-path> 値が推奨されます。安定した識別子の詳細なリストは、「ルートデバイスヒントについて」を参照してください。デバイスの名前、モデル、サイズ、ベンダーも指定できます。

object

templateRefs
必須

ノードレベルのテンプレートへの参照のリストを指定します。ノードレベルのテンプレートは ConfigMap オブジェクトで構成され、データフィールドのキーはインストールマニフェストの kind を表します。ノードレベルのテンプレートは、ClusterInstance CR 内の各ノードに対して 1 回インスタンス化されます。

array

status

Expand
名前説明スキーマ

conditions
任意

ClusterInstance リソースで実行されるアクションに関連する条件をリスト表示します。

conditions array

deploymentConditions
任意

ClusterDeployment リソースに関連付けられているハイブステータス条件をリスト表示します。

deploymentConditions array

manifestsRendered
任意

レンダリングされたマニフェストとそのステータスをリスト表示します。

array

observedGeneration
任意

観測された ClusterInstance オブジェクト生成を追跡します。

integer

conditions

Expand
型説明

ClusterInstanceValidated

SiteConfig Operator が ClusterInstance spec フィールドを検証し、シークレットや追加のマニフェスト ConfigMaps オブジェクトなどの必須アーティファクトが存在することを確認したことを示します。

RenderedTemplates

SiteConfig Operator が参照された Golang クラスターテンプレートを正常に検証したことを示します。

RenderedTemplatesValidated

SiteConfig Operator がインストールマニフェストをレンダリングし、ドライランが成功したことを示します。

RenderedTemplatesApplied

SiteConfig Operator がインストールマニフェストを作成し、基盤となる Operator がそれを使用したことを示します。

Provisioned

基盤となる Operator がクラスターをプロビジョニングしていることを示します。

deploymentConditions

Expand
型説明

ClusterInstallRequirementsMet

インストールを開始できることを示します。

ClusterInstallCompleted

クラスターのインストールが成功したことを示します。

ClusterInstallFailed

クラスターのインストールが失敗したことを示します。

ClusterInstallStopped

クラスターのインストールが停止したことを示します。

関連情報

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

Theme

© 2025 Red Hat