- リソース: BareMetalCluster
- 状態
- BareMetalNetworkConfig
- BareMetalIslandModeCidrConfig
- BareMetalMultipleNetworkInterfacesConfig
- BareMetalSrIovConfig
- BareMetalControlPlaneConfig
- BareMetalControlPlaneNodePoolConfig
- BareMetalApiServerArgument
- BareMetalLoadBalancerConfig
- BareMetalVipConfig
- BareMetalPortConfig
- BareMetalMetalLbConfig
- BareMetalLoadBalancerAddressPool
- BareMetalLoadBalancerNodePoolConfig
- BareMetalManualLbConfig
- BareMetalBgpLbConfig
- BareMetalBgpPeerConfig
- BareMetalStorageConfig
- BareMetalProxyConfig
- BareMetalClusterOperationsConfig
- BareMetalMaintenanceConfig
- BareMetalWorkloadNodeConfig
- ContainerRuntime
- BareMetalSecurityConfig
- BareMetalMaintenanceStatus
- BareMetalMachineDrainStatus
- BareMetalDrainingMachine
- BareMetalDrainedMachine
- BareMetalNodeAccessConfig
- BareMetalOsEnvironmentConfig
- BareMetalClusterUpgradePolicy
- NodePoolPolicy
- メソッド
リソース: BareMetalCluster
ベアメタル ユーザー クラスタを表すリソース。
| JSON 表現 | 
|---|
| { "name": string, "adminClusterMembership": string, "description": string, "bareMetalVersion": string, "uid": string, "state": enum ( | 
| フィールド | |
|---|---|
| name | 
 変更不可。ベアメタル ユーザー クラスタのリソース名。 | 
| adminClusterMembership | 
 必須。このベアメタル ユーザー クラスタが属する管理クラスタ。これは、管理クラスタのフリート メンバーシップの完全なリソース名です。 | 
| description | 
 このベアメタル ユーザー クラスタの説明(人が読める形式)。 | 
| bareMetalVersion | 
 必須。ユーザー クラスタの Anthos clusters on bare metal バージョン。 | 
| uid | 
 出力専用。ベアメタル ユーザー クラスタの固有識別子。 | 
| state | 
 出力専用。ベアメタル ユーザー クラスタの現在の状態。 | 
| endpoint | 
 出力専用。ベアメタル ユーザー クラスタの API サーバーの IP アドレス。 | 
| reconciling | 
 出力専用。設定されている場合は、現在ベアメタル ユーザー クラスタに対して処理中の変更があります。 | 
| createTime | 
 出力専用。ベアメタル ユーザー クラスタが作成された時刻。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例:  | 
| updateTime | 
 出力専用。ベアメタル ユーザー クラスタが最後に更新された時刻。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例:  | 
| deleteTime | 
 出力専用。ベアメタル ユーザー クラスタが削除された時刻。リソースが削除されていない場合は、空にする必要があります。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例:  | 
| localName | 
 出力専用。関連付けられた管理クラスタ上のベアメタル ユーザー クラスタ カスタム リソースのオブジェクト名。このフィールドは、既存のクラスタを API に登録するときに名前の競合をサポートするために使用されます。クラスタ登録の一部として使用される場合、このフィールドはリソース名の名前と異なります。新しいクラスタの場合、このフィールドはユーザーが指定したクラスタ名と一致し、リソース名の最後のコンポーネントに表示されます。変更はできません。 ローカル名とクラスタ名が異なる場合、管理クラスタ コントローラのログにはローカル名が使用されます。bmctl と kubectl を使用してクラスタにアクセスするときに、クラスタ名を使用します。 | 
| etag | 
 出力専用。このチェックサムは、他のフィールドの値に基づいてサーバーによって計算されます。これは、更新リクエストと削除リクエストで送信され、続行する前にクライアントが最新の値を持っていることを確認できます。クライアントがオプティミスティック同時実行制御で一貫した読み取り - 修正 - 書き込みを行えるようにします。 | 
| annotations | 
 ベアメタル ユーザー クラスタのアノテーション。このフィールドには、Kubernetes アノテーションと同じ制限があります。結合されたすべてのキーと値の合計サイズは 256k に制限されています。キーには、2 つのセグメントとして接頭辞(省略可)と名前(必須)をスラッシュ(/)で区切って配置できます。接頭辞は DNS サブドメインにする必要があります。名前は 63 文字以下にしてください。先頭と末尾には英数字を使用し、先頭と末尾の間にはダッシュ(-)、アンダースコア(_)、ドット(.)、英数字を使用します。 
 | 
| networkConfig | 
 必須。ネットワークの構成。 | 
| controlPlane | 
 必須。コントロール プレーンの構成。 | 
| loadBalancer | 
 必須。ロードバランサの構成。 | 
| storage | 
 必須。ストレージ構成。 | 
| proxy | 
 プロキシの構成。 | 
| clusterOperations | 
 クラスタ オペレーションの構成。 | 
| maintenanceConfig | 
 メンテナンスの構成。 | 
| nodeConfig | 
 ワークロード ノードの構成。 | 
| fleet | 
 出力専用。クラスタのフリート構成。 | 
| status | 
 出力専用。クラスタのステータスの詳細。 | 
| validationCheck | 
 出力専用。プリフライト チェックの結果。 | 
| securityConfig | 
 セキュリティ関連の構成。 | 
| maintenanceStatus | 
 出力専用。進行中のメンテナンス タスクのステータス。 | 
| adminClusterName | 
 出力専用。このユーザー クラスタを管理するベアメタル管理クラスタのリソース名。 | 
| nodeAccessConfig | 
 ノードアクセス関連の構成。 | 
| osEnvironmentConfig | 
 OS 環境関連の構成。 | 
| binaryAuthorization | 
 Binary Authorization 関連の構成。 | 
| upgradePolicy | 
 クラスタ アップグレード ポリシー。 | 
| localNamespace | 
 出力専用。クラスタの Namespace。 | 
状態
ベアメタル ユーザー クラスタのライフサイクル ステータス。
| 列挙型 | |
|---|---|
| STATE_UNSPECIFIED | 未設定。 | 
| PROVISIONING | PROVISIONING 状態は、クラスタが作成中であることを示します。 | 
| RUNNING | RUNNING 状態は、クラスタが作成済みで、完全に使用可能であることを示します。 | 
| RECONCILING | RECONCILING 状態は、クラスタが更新中であることを示します。引き続き利用できますが、パフォーマンスが低下する可能性があります。 | 
| STOPPING | STOPPING 状態は、クラスタの削除中であることを示します。 | 
| ERROR | ERROR 状態は、クラスタが破損して復元できない状態であることを示します。 | 
| DEGRADED | DEGRADED 状態は、クラスタで完全な機能を復元するためにユーザーの操作が必要であることを示します。 | 
BareMetalNetworkConfig
クラスタ ネットワーク構成を指定します。
| JSON 表現 | 
|---|
| { "advancedNetworking": boolean, "multipleNetworkInterfacesConfig": { object ( | 
| フィールド | |
|---|---|
| advancedNetworking | 
 BGP とバンドルされたロード バランシングや下り(外向き)NAT ゲートウェイなどの高度な Anthos ネットワーキング機能を使用できます。高度なネットワーキング機能の構成を設定すると、このフラグが自動的に設定されます。 | 
| multipleNetworkInterfacesConfig | 
 複数のネットワーク インターフェースの構成。 | 
| srIovConfig | 
 SR-IOV の構成。 | 
| 共用体フィールド cluster_cidr_configuration。ベアメタル ユーザー クラスタで使用される CIDR 構成。cluster_cidr_configurationは次のいずれかになります。 | |
| islandModeCidr | 
 アイランド モードの CIDR の構成。アイランド モード ネットワークでは、ノードには一意の IP アドレスが割り振られますが、Pod にはクラスタ全体で一意となるアドレスは割り振られません。あるクラスタの Pod が別のクラスタの Pod と直接通信することはないため、これが問題になることはありません。その代わりに、あるクラスタの Pod と別のクラスタの Pod との間を仲介するゲートウェイがあります。 | 
BareMetalIslandModeCidrConfig
アイランド モードで実行中にクラスタ CIDR 構成を指定します。
| JSON 表現 | 
|---|
| { "serviceAddressCidrBlocks": [ string ], "podAddressCidrBlocks": [ string ] } | 
| フィールド | |
|---|---|
| serviceAddressCidrBlocks[] | 
 必須。クラスタ内のすべてのサービスには、これらの範囲から RFC1918 IPv4 アドレスが割り当てられます。このフィールドは、バージョン 1.15 以降では作成後に変更可能です。 | 
| podAddressCidrBlocks[] | 
 必須。クラスタ内のすべての Pod には、これらの範囲から RFC1918 IPv4 アドレスが割り当てられます。作成後にこのフィールドを変更することはできません。 | 
BareMetalMultipleNetworkInterfacesConfig
複数のネットワーク インターフェース クラスタ構成を指定します。
| JSON 表現 | 
|---|
| { "enabled": boolean } | 
| フィールド | |
|---|---|
| enabled | 
 Pod の複数のネットワーク インターフェースを有効にするかどうか。 設定すると、networkConfig.advanced_networking が自動的に true に設定されます。 | 
BareMetalSrIovConfig
SR-IOV ネットワーキング演算子の構成を指定します。
| JSON 表現 | 
|---|
| { "enabled": boolean } | 
| フィールド | |
|---|---|
| enabled | 
 SR-IOV 演算子をインストールするかどうか。 | 
BareMetalControlPlaneConfig
コントロール プレーンの構成を指定します。
| JSON 表現 | 
|---|
| { "controlPlaneNodePoolConfig": { object ( | 
| フィールド | |
|---|---|
| controlPlaneNodePoolConfig | 
 必須。コントロール プレーンを実行するノードプールを構成します。 | 
| apiServerArgs[] | 
 デフォルトの API サーバー引数をカスタマイズします。カスタマイズされたフラグの一部のみがサポートされています。正確な形式については、API サーバーのドキュメントをご覧ください。 | 
BareMetalControlPlaneNodePoolConfig
コントロール プレーン ノードプールの構成を指定します。
| JSON 表現 | 
|---|
| {
  "nodePoolConfig": {
    object ( | 
| フィールド | |
|---|---|
| nodePoolConfig | 
 必須。コントロール プレーンを実行するノードプールの一般的な構成。 | 
BareMetalApiServerArgument
引数の名前と値のペアを表します。カスタマイズされたフラグの一部のみがサポートされています。正確な形式については、API サーバーのドキュメントをご覧ください。
| JSON 表現 | 
|---|
| { "argument": string, "value": string } | 
| フィールド | |
|---|---|
| argument | 
 必須。API サーバーのコマンドラインに表示される引数名。先頭のダッシュを削除してください。 | 
| value | 
 必須。API サーバーのコマンドラインに渡される引数の値。 | 
BareMetalLoadBalancerConfig
ロードバランサの構成を指定します。
| JSON 表現 | 
|---|
| { "vipConfig": { object ( | 
| フィールド | |
|---|---|
| vipConfig | 
 ロードバランサで使用される VIP。 | 
| portConfig | 
 ロードバランサがリッスンするポートを構成します。 | 
| 共用体フィールド load_balancer_configuration。ベアメタル ユーザー クラスタのロードバランサ構成。load_balancer_configurationは次のいずれかになります。 | |
| metalLbConfig | 
 MetalLB ロードバランサの構成。 | 
| manualLbConfig | 
 手動で構成されたロードバランサ。 | 
| bgpLbConfig | 
 BGP 型ロードバランサの構成。 設定すると、networkConfig.advanced_networking が自動的に true に設定されます。 | 
BareMetalVipConfig
ベアメタル ロードバランサの VIP 構成を指定します。
| JSON 表現 | 
|---|
| { "controlPlaneVip": string, "ingressVip": string } | 
| フィールド | |
|---|---|
| controlPlaneVip | 
 このベアメタル ユーザー クラスタの Kubernetes API 用に以前に確保した VIP。 | 
| ingressVip | 
 このベアメタル ユーザー クラスタへの上り(内向き)トラフィック用に以前に確保した VIP。 | 
BareMetalPortConfig
ベアメタル ユーザー クラスタのロードバランサ ポートを指定します。
| JSON 表現 | 
|---|
| { "controlPlaneLoadBalancerPort": integer } | 
| フィールド | |
|---|---|
| controlPlaneLoadBalancerPort | 
 コントロール プレーン ホスト型ロードバランサがリッスンするポート。 | 
BareMetalMetalLbConfig
MetalLB ロードバランサの構成パラメータを表します。
| JSON 表現 | 
|---|
| { "addressPools": [ { object ( | 
| フィールド | |
|---|---|
| addressPools[] | 
 必須。AddressPools は、ロードバランサ タイプの Service で使用される重複しない IP プールのリストです。すべてのアドレスがロードバランサ ノードにルーティング可能である必要があります。IngressVIP をプールに含める必要があります。 | 
| loadBalancerNodePoolConfig | 
 ロードバランサを実行するノードプールを指定します。このプール内のノード間には L2 接続が必要です。指定されていない場合、コントロール プレーン ノードプールがロードバランサ プールとして使用されます。 | 
BareMetalLoadBalancerAddressPool
ロードバランサで使用される IP プールを表します。
| JSON 表現 | 
|---|
| { "pool": string, "addresses": [ string ], "avoidBuggyIps": boolean, "manualAssign": boolean } | 
| フィールド | |
|---|---|
| pool | 
 必須。アドレスプールの名前。 | 
| addresses[] | 
 必須。このプールに含まれるアドレス。各アドレスは、CIDR 形式(1.2.3.0/24)または範囲形式(1.2.3.1-1.2.3.5)のいずれかである必要があります。 | 
| avoidBuggyIps | 
 true の場合、末尾が .0 または .255 の IP の使用を避けてください。これにより、バグの多いコンシューマー デバイスが、これらの特別な IP アドレスの IPv4 トラフィックを誤って破棄するという問題を回避できます。 | 
| manualAssign | 
 true の場合、IP アドレスが自動的に割り振られないようにします。 | 
BareMetalLoadBalancerNodePoolConfig
ロードバランサのノードプール構成を指定します。
| JSON 表現 | 
|---|
| {
  "nodePoolConfig": {
    object ( | 
| フィールド | |
|---|---|
| nodePoolConfig | 
 ロードバランサを実行するノードプールの一般的な構成。 | 
BareMetalManualLbConfig
手動ロードバランサの構成パラメータを表します。
| JSON 表現 | 
|---|
| { "enabled": boolean } | 
| フィールド | |
|---|---|
| enabled | 
 手動ロード バランシングが有効かどうか。 | 
BareMetalBgpLbConfig
BareMetalBgpLbConfig は、Border Gateway Protocol(BGP)ロードバランサの構成パラメータを表します。
| JSON 表現 | 
|---|
| { "asn": string, "bgpPeerConfigs": [ { object ( | 
| フィールド | |
|---|---|
| asn | 
 必須。クラスタの BGP 自律システム番号(ASN)。このフィールドは、クラスタの作成後に更新できます。 | 
| bgpPeerConfigs[] | 
 必須。クラスタが接続する BGP ピアのリスト。コントロール プレーン ノードごとに少なくとも 1 つのピアを構成する必要があります。 コントロール プレーン ノードは、これらのピアに接続してコントロール プレーン VIP をアドバタイズします。Services ロードバランサも、デフォルトでこれらのピアを使用します。 このフィールドは、クラスタの作成後に更新できます。 | 
| addressPools[] | 
 必須。AddressPools は、ロードバランサ タイプの Service で使用される重複しない IP プールのリストです。すべてのアドレスがロードバランサ ノードにルーティング可能である必要があります。IngressVIP をプールに含める必要があります。 | 
| loadBalancerNodePoolConfig | 
 データプレーン ロード バランシングを実行するノードプールを指定します。このプール内のノード間には L2 接続が必要です。指定されていない場合、コントロール プレーン ノードプールがデータプレーン ロード バランシングに使用されます。 | 
BareMetalBgpPeerConfig
BareMetalBgpPeerConfig は、Border Gateway Protocol(BGP)ピアの構成パラメータを表します。
| JSON 表現 | 
|---|
| { "asn": string, "ipAddress": string, "controlPlaneNodes": [ string ] } | 
| フィールド | |
|---|---|
| asn | 
 必須。外部ピアデバイスを含むネットワークの BGP 自律システム番号。 | 
| ipAddress | 
 必須。外部ピアデバイスの IP アドレス。 | 
| controlPlaneNodes[] | 
 外部ピアに接続するコントロール プレーン ノードの IP アドレス。コントロール プレーン ノードを指定しない場合、すべてのコントロール プレーン ノードが外部ピアに接続できます。1 つ以上の IP アドレスを指定すると、指定したノードのみがピアリング セッションに参加します。 | 
BareMetalStorageConfig
BareMetalStorageConfig は、クラスタ ストレージ構成を指定します。
| JSON 表現 | 
|---|
| { "lvpShareConfig": { object ( | 
| フィールド | |
|---|---|
| lvpShareConfig | 
 必須。共有ファイル システム内にサブディレクトリを基盤とするローカル PersistentVolumes の構成を指定します。これらのサブディレクトリは、クラスタの作成時に自動的に作成されます。 | 
| lvpNodeMountsConfig | 
 必須。マウントされたノードディスクを基盤とするローカル PersistentVolumes の構成を指定します。これらのディスクは、ユーザーがフォーマットしてマウントする必要があります。この操作は、クラスタの作成前でも作成後でも行うことができます。 | 
BareMetalProxyConfig
クラスタ プロキシ構成を指定します。
| JSON 表現 | 
|---|
| { "uri": string, "noProxy": [ string ] } | 
| フィールド | |
|---|---|
| uri | 
 必須。プロキシ サーバーのアドレスを指定します。例:  
 | 
| noProxy[] | 
 プロキシをスキップする IP、ホスト名、ドメインのリスト。例: ["127.0.0.1", "example.com", ".corp", "localhost"]。 | 
BareMetalClusterOperationsConfig
ベアメタル ユーザー クラスタのオブザーバビリティ インフラストラクチャを指定します。
| JSON 表現 | 
|---|
| { "enableApplicationLogs": boolean } | 
| フィールド | |
|---|---|
| enableApplicationLogs | 
 システムログ / 指標に加えて、アプリケーション ログ / 指標の収集を有効にするかどうか。 | 
BareMetalMaintenanceConfig
ベアメタル ノードをメンテナンス モードにする構成を指定します。
| JSON 表現 | 
|---|
| { "maintenanceAddressCidrBlocks": [ string ] } | 
| フィールド | |
|---|---|
| maintenanceAddressCidrBlocks[] | 
 必須。これらの範囲のすべての IPv4 アドレスがメンテナンス モードになります。メンテナンス モードのノードは閉鎖され、ドレインされます。両方が true の場合、ノードリソースに「baremetal.cluster.gke.io/maintenance」アノテーションが設定されます。 | 
BareMetalWorkloadNodeConfig
ワークロード ノードの構成を指定します。
| JSON 表現 | 
|---|
| {
  "maxPodsPerNode": string,
  "containerRuntime": enum ( | 
| フィールド | |
|---|---|
| maxPodsPerNode | 
 ノードで実行できる Pod の最大数。ノードに割り当てられる CIDR 範囲のサイズは、このパラメータから導出されます。 | 
| containerRuntime | 
 使用するコンテナ ランタイムを指定します。 | 
ContainerRuntime
このユーザー クラスタでコンテナを実行するために使用されるランタイム。
| 列挙型 | |
|---|---|
| CONTAINER_RUNTIME_UNSPECIFIED | コンテナ ランタイムが選択されていません。 | 
| CONTAINERD | containerd ランタイム。 | 
BareMetalSecurityConfig
ベアメタル ユーザー クラスタのセキュリティ関連の設定を指定します。
| JSON 表現 | 
|---|
| {
  "authorization": {
    object ( | 
| フィールド | |
|---|---|
| authorization | 
 ユーザー クラスタへのユーザー アクセスを構成します。 | 
BareMetalMaintenanceStatus
ベアメタル ユーザー クラスタのメンテナンス ステータスを表します。
| JSON 表現 | 
|---|
| {
  "machineDrainStatus": {
    object ( | 
| フィールド | |
|---|---|
| machineDrainStatus | 
 ノードマシンのメンテナンス ステータス。 | 
BareMetalMachineDrainStatus
ドレイン オペレーション中のノードマシンのステータスを表します。
| JSON 表現 | 
|---|
| { "drainingMachines": [ { object ( | 
| フィールド | |
|---|---|
| drainingMachines[] | 
 ドレイン中のマシンのリスト。 | 
| drainedMachines[] | 
 ドレインされたマシンのリスト。 | 
BareMetalDrainingMachine
現在ドレイン中のマシンを表します。
| JSON 表現 | 
|---|
| { "nodeIp": string, "podCount": integer } | 
| フィールド | |
|---|---|
| nodeIp | 
 ドレインするマシンの IP アドレス。 | 
| podCount | 
 まだドレインされていない Pod の数。 | 
BareMetalDrainedMachine
現在ドレインされているマシンを表します。
| JSON 表現 | 
|---|
| { "nodeIp": string } | 
| フィールド | |
|---|---|
| nodeIp | 
 ドレインされたマシンの IP アドレス。 | 
BareMetalNodeAccessConfig
ベアメタル ユーザー クラスタのノードアクセス関連の設定を指定します。
| JSON 表現 | 
|---|
| { "loginUser": string } | 
| フィールド | |
|---|---|
| loginUser | 
 LoginUser は、ノードマシンへのアクセスに使用されるユーザー名です。設定しない場合、デフォルトは「root」になります。 | 
BareMetalOsEnvironmentConfig
クラスタ プロビジョニングのオペレーティング システム設定を指定します。
| JSON 表現 | 
|---|
| { "packageRepoExcluded": boolean } | 
| フィールド | |
|---|---|
| packageRepoExcluded | 
 ベアメタル マシンの初期化時にパッケージ リポジトリを含めないかどうか。 | 
BareMetalClusterUpgradePolicy
BareMetalClusterUpgradePolicy は、クラスタ アップグレード ポリシーを定義します。
| JSON 表現 | 
|---|
| {
  "policy": enum ( | 
| フィールド | |
|---|---|
| policy | 
 使用するアップグレード ポリシーを指定します。 | 
| pause | 
 出力専用。一時停止は、アップグレードの一時停止ステータスを表示するために使用されます。現時点では表示専用です。 | 
NodePoolPolicy
ワーカー ノードプールのアップグレード ポリシーを指定します。
| 列挙型 | |
|---|---|
| NODE_POOL_POLICY_UNSPECIFIED | アップグレード ポリシーが選択されていません。 | 
| SERIAL | ワーカー ノードプールを順番にアップグレードします。 | 
| CONCURRENT | すべてのワーカー ノードプールを並列でアップグレードします。 | 
| メソッド | |
|---|---|
| 
 | 指定されたプロジェクトとロケーションに新しいベアメタル クラスタを作成します。 | 
| 
 | 1 つのベアメタル クラスタを削除します。 | 
| 
 | 既存のベアメタル ユーザー クラスタとそのノードプールを、指定されたプロジェクトとロケーションの Anthos On-Prem API に登録します。 | 
| 
 | 1 つのベアメタル クラスタの詳細を取得します。 | 
| 
 | 指定されたプロジェクトとロケーションのベアメタル クラスタを一覧表示します。 | 
| 
 | 1 つのベアメタル クラスタのパラメータを更新します。 | 
| 
 | ベアメタル ユーザー クラスタのバージョン構成をクエリします。 |