REST Resource: projects.locations.bareMetalAdminClusters

リソース: BareMetalAdminCluster

ベアメタル管理クラスタを表すリソース。

JSON 表現 
{
  "name": string,
  "description": string,
  "uid": string,
  "bareMetalVersion": string,
  "state": enum (State),
  "endpoint": string,
  "reconciling": boolean,
  "createTime": string,
  "updateTime": string,
  "deleteTime": string,
  "localName": string,
  "etag": string,
  "annotations": {
    string: string,
    ...
  },
  "networkConfig": {
    object (BareMetalAdminNetworkConfig)
  },
  "controlPlane": {
    object (BareMetalAdminControlPlaneConfig)
  },
  "loadBalancer": {
    object (BareMetalAdminLoadBalancerConfig)
  },
  "storage": {
    object (BareMetalAdminStorageConfig)
  },
  "fleet": {
    object (Fleet)
  },
  "clusterOperations": {
    object (BareMetalAdminClusterOperationsConfig)
  },
  "status": {
    object (ResourceStatus)
  },
  "maintenanceConfig": {
    object (BareMetalAdminMaintenanceConfig)
  },
  "maintenanceStatus": {
    object (BareMetalAdminMaintenanceStatus)
  },
  "validationCheck": {
    object (ValidationCheck)
  },
  "nodeConfig": {
    object (BareMetalAdminWorkloadNodeConfig)
  },
  "proxy": {
    object (BareMetalAdminProxyConfig)
  },
  "securityConfig": {
    object (BareMetalAdminSecurityConfig)
  },
  "nodeAccessConfig": {
    object (BareMetalAdminNodeAccessConfig)
  },
  "osEnvironmentConfig": {
    object (BareMetalAdminOsEnvironmentConfig)
  },
  "binaryAuthorization": {
    object (BinaryAuthorization)
  }
}
フィールド
name

string

変更不可。ベアメタル管理クラスタのリソース名。
description

string

このベアメタル管理クラスタの説明（人が読める形式）。
uid

string

出力専用。ベアメタル管理クラスタの一意の識別子。
bareMetalVersion

string

ベアメタル管理クラスタの Anthos clusters on bare metal のバージョン。
state

enum (State)

出力専用。ベアメタル管理クラスタの現在の状態。
endpoint

string

出力専用。ベアメタル管理クラスタの API サーバーの IP アドレス名。
reconciling

boolean

出力専用。設定されている場合は、現在ベアメタル管理クラスタに対して処理中の変更があります。
createTime

string (Timestamp format)

出力専用。このベアメタル管理クラスタが作成された時刻。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

出力専用。このベアメタル管理クラスタが最後に更新された時刻。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
deleteTime

string (Timestamp format)

出力専用。このベアメタル管理クラスタが削除された時刻。リソースが削除されていない場合は、空にする必要があります

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
localName

string

出力専用。ベアメタル クラスタのカスタム リソースのオブジェクト名。このフィールドは、既存のクラスタを API に登録するときに競合する名前をサポートするために使用されます。クラスタ登録の一部として使用する場合、このフィールドはリソース名の ID とは異なります。新しいクラスタの場合、このフィールドはユーザー指定のクラスタ名と一致し、リソース名の最後のコンポーネントに表示されます。変更はできません。

すべてのユーザーは、この名前を使用して gkectl または kubectl を使用してクラスタにアクセスする必要があります。また、管理クラスタ コントローラ ログを表示するときにローカル名が表示されることを想定する必要があります。
etag

string

このチェックサムは、他のフィールドの値に基づいてサーバーによって計算されて、更新リクエストと削除リクエストで送信され、続行する前にクライアントが最新の値を持っていることを確認できます。クライアントがオプティミスティック同時実行制御で一貫した読み取り - 修正 - 書き込みを行えるようにします。
annotations

map (key: string, value: string)

ベアメタル管理クラスタのアノテーション。このフィールドには、Kubernetes アノテーションと同じ制限があります。すべてのキーと値を合わせた合計サイズは 256,000 に制限されています。キーには、スラッシュ（/）で区切られる、接頭辞（省略可）と名前（必須）の 2 つのセグメントを含めることができます。接頭辞は DNS サブドメインにする必要があります。名前は 63 文字以下にしてください。先頭と末尾には英数字を使用し、先頭と末尾の間にはダッシュ（-）、アンダースコア（_）、ドット（.）、英数字を使用します。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
networkConfig

object (BareMetalAdminNetworkConfig)

ネットワーク構成。
controlPlane

object (BareMetalAdminControlPlaneConfig)

コントロール プレーンの構成。
loadBalancer

object (BareMetalAdminLoadBalancerConfig)

ロードバランサの構成。
storage

object (BareMetalAdminStorageConfig)

ストレージ構成。
fleet

object (Fleet)

出力専用。クラスタのフリート構成。
clusterOperations

object (BareMetalAdminClusterOperationsConfig)

クラスタ オペレーションの構成。
status

object (ResourceStatus)

出力専用。クラスタの詳細なステータスを表す ResourceStatus。
maintenanceConfig

object (BareMetalAdminMaintenanceConfig)

メンテナンスの構成。
maintenanceStatus

object (BareMetalAdminMaintenanceStatus)

出力専用。メンテナンスのステータスを表す MaintenanceStatus。
validationCheck

object (ValidationCheck)

出力専用。プリフライト チェックの結果を表す ValidationCheck。
nodeConfig

object (BareMetalAdminWorkloadNodeConfig)

ワークロード ノードの構成。
proxy

object (BareMetalAdminProxyConfig)

プロキシの構成。
securityConfig

object (BareMetalAdminSecurityConfig)

セキュリティ関連の構成。
nodeAccessConfig

object (BareMetalAdminNodeAccessConfig)

ノードアクセス関連の構成。
osEnvironmentConfig

object (BareMetalAdminOsEnvironmentConfig)

OS 環境関連の構成。
binaryAuthorization

object (BinaryAuthorization)

Binary Authorization 関連の構成。

State

ベアメタル管理クラスタのライフサイクル ステータス。

列挙型
STATE_UNSPECIFIED 未設定。
PROVISIONING PROVISIONING 状態は、クラスタが作成中であることを示します。
RUNNING RUNNING 状態は、クラスタが作成済みで、完全に使用可能であることを示します。
RECONCILING RECONCILING 状態は、クラスタが更新中であることを示します。引き続き使用できますが、パフォーマンスが低下する可能性があります。
STOPPING STOPPING 状態は、クラスタの削除中であることを示します。
ERROR ERROR 状態は、クラスタが破損していて復元できない状態であることを示します。
DEGRADED DEGRADED 状態は、クラスタで完全な機能を復元するにはユーザーの操作が必要であることを示します。

BareMetalAdminNetworkConfig

BareMetalAdminNetworkConfig には、クラスタ ネットワーク構成を指定します。

JSON 表現 
{

  // Union field cluster_cidr_configuration can be only one of the following:
  "islandModeCidr": {
    object (BareMetalAdminIslandModeCidrConfig)
  }
  // End of list of possible types for union field cluster_cidr_configuration.
}
フィールド
共用体フィールド cluster_cidr_configuration。管理クラスタで使用する CIDR 構成。cluster_cidr_configuration は次のいずれかになります。
islandModeCidr

object (BareMetalAdminIslandModeCidrConfig)

アイランドモードの CIDR の構成。

BareMetalAdminIslandModeCidrConfig

BareMetalAdminIslandModeCidrConfig は、アイランドモードでの実行中のクラスタ CIDR 構成を指定します。

JSON 表現 
{
  "serviceAddressCidrBlocks": [
    string
  ],
  "podAddressCidrBlocks": [
    string
  ]
}
フィールド
serviceAddressCidrBlocks[]

string

必須。クラスタ内のすべてのサービスには、これらの範囲から RFC1918 IPv4 アドレスが割り当てられます。作成後にこのフィールドを変更することはできません。
podAddressCidrBlocks[]

string

必須。クラスタ内のすべての Pod には、これらの範囲から RFC1918 IPv4 アドレスが割り当てられます。作成後にこのフィールドを変更することはできません。

BareMetalAdminControlPlaneConfig

BareMetalAdminControlPlaneConfig でコントロール プレーンの構成を指定します。

JSON 表現 
{
  "controlPlaneNodePoolConfig": {
    object (BareMetalAdminControlPlaneNodePoolConfig)
  },
  "apiServerArgs": [
    {
      object (BareMetalAdminApiServerArgument)
    }
  ]
}
フィールド
controlPlaneNodePoolConfig

object (BareMetalAdminControlPlaneNodePoolConfig)

必須。コントロール プレーンを実行するノードプールを構成します。指定すると、クラスタのコントロール プレーンに対応する NodePool が作成されます。NodePool の名前と Namespace はクラスタと同じになります。
apiServerArgs[]

object (BareMetalAdminApiServerArgument)

デフォルトの API サーバー引数をカスタマイズします。カスタマイズされたフラグの一部のみがサポートされています。正確な形式については、以下の API サーバーのドキュメントをご覧ください。https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/

BareMetalAdminControlPlaneNodePoolConfig

BareMetalAdminControlPlaneNodePoolConfig は、コントロール プレーン ノードプールの構成を指定します。コントロール プレーン固有のノードプール構成が用意されているため、将来的にコントロール プレーン固有のフィールドを柔軟にサポートできます。

JSON 表現 
{
  "nodePoolConfig": {
    object (BareMetalNodePoolConfig)
  }
}
フィールド
nodePoolConfig

object (BareMetalNodePoolConfig)

必須。コントロール プレーンを実行するノードプールの一般的な構成。

BareMetalAdminApiServerArgument

BareMetalAdminApiServerArgument は、引数名と値のペアを表します。カスタマイズされたフラグの一部のみがサポートされています。正確な形式については、以下の API サーバーのドキュメントをご覧ください。https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/

JSON 表現 
{
  "argument": string,
  "value": string
}
フィールド
argument

string

必須。API サーバーのコマンドラインに表示される引数名の先頭のダッシュを削除してください。
value

string

必須。API サーバーのコマンドラインに渡される arg の値。

BareMetalAdminLoadBalancerConfig

BareMetalAdminLoadBalancerConfig でロードバランサの構成を指定します。

JSON 表現 
{
  "vipConfig": {
    object (BareMetalAdminVipConfig)
  },
  "portConfig": {
    object (BareMetalAdminPortConfig)
  },

  // Union field load_balancer_configuration can be only one of the following:
  "manualLbConfig": {
    object (BareMetalAdminManualLbConfig)
  }
  // End of list of possible types for union field load_balancer_configuration.
}
項目
vipConfig

object (BareMetalAdminVipConfig)

ロードバランサで使用される VIP。
portConfig

object (BareMetalAdminPortConfig)

ロードバランサがリッスンするポートを構成します。
共用体フィールド load_balancer_configuration。管理クラスタで使用するロードバランサの構成。load_balancer_configuration は次のいずれかになります。
manualLbConfig

object (BareMetalAdminManualLbConfig)

手動で構成したロードバランサ。

BareMetalAdminVipConfig

BareMetalAdminVipConfig: ベアメタル ロードバランサの構成。

JSON 表現 
{
  "controlPlaneVip": string
}
項目
controlPlaneVip

string

このベアメタル管理クラスタの Kubernetes API 用に前述で確保した VIP。

BareMetalAdminPortConfig

BareMetalAdminPortConfig は、ロードバランサ ポートの仕様です。

JSON 表現 
{
  "controlPlaneLoadBalancerPort": integer
}
項目
controlPlaneLoadBalancerPort

integer

コントロール プレーン ホスト型ロードバランサがリッスンするポート。

BareMetalAdminManualLbConfig

BareMetalAdminManualLbConfig は、手動ロードバランサの構成パラメータを表します。

JSON 表現 
{
  "enabled": boolean
}
項目
enabled

boolean

手動ロード バランシングが有効かどうか。

BareMetalAdminStorageConfig

BareMetalAdminStorageConfig には、クラスタ ストレージ構成を指定します。

JSON 表現 
{
  "lvpShareConfig": {
    object (BareMetalLvpShareConfig)
  },
  "lvpNodeMountsConfig": {
    object (BareMetalLvpConfig)
  }
}
フィールド
lvpShareConfig

object (BareMetalLvpShareConfig)

必須。共有ファイル システム内にサブディレクトリを基盤とするローカル PersistentVolume の構成を指定します。これらのサブディレクトリは、クラスタの作成時に自動的に作成されます。
lvpNodeMountsConfig

object (BareMetalLvpConfig)

必須。マウントされたノードディスクを基盤とするローカル PersistentVolume の構成を指定します。これらのディスクは、ユーザーがフォーマットしてマウントする必要があります。この操作は、クラスタの作成前でも作成後でも行うことができます。

BareMetalAdminClusterOperationsConfig

BareMetalAdminClusterOperationsConfig には、管理クラスタのオブザーバビリティ インフラストラクチャを指定します。

JSON 表現 
{
  "enableApplicationLogs": boolean
}
項目
enableApplicationLogs

boolean

アプリケーション ログ/指標の収集（システム ログ/指標に加えて）を有効にするかどうか。

BareMetalAdminMaintenanceConfig

BareMetalAdminMaintenanceConfig には、ベアメタル管理クラスタ CR ノードをメンテナンス状態にしたり、メンテナンス状態から解除したりするための構成を指定します。

JSON 表現 
{
  "maintenanceAddressCidrBlocks": [
    string
  ]
}
フィールド
maintenanceAddressCidrBlocks[]

string

必須。これらの範囲のすべての IPv4 アドレスはメンテナンス モードになります。メンテナンス モードのノードは、閉鎖されてドレインされます。これらの条件が両方とも満たされると、ノードリソースに「baremetal.cluster.gke.io/maintenance」アノテーションが設定されます。

BareMetalAdminMaintenanceStatus

BareMetalAdminMaintenanceStatus は、ベアメタル管理クラスタ CR のノードのメンテナンス ステータスを表します。

JSON 表現 
{
  "machineDrainStatus": {
    object (BareMetalAdminMachineDrainStatus)
  }
}
項目
machineDrainStatus

object (BareMetalAdminMachineDrainStatus)

ドレイン中とドレイン済みのマシンノードのステータスを表します。これは、クラスタのアップグレードの進行状況を示すために使用されます。

BareMetalAdminMachineDrainStatus

BareMetalAdminMachineDrainStatus は、ドレイン オペレーションを行っている Bare Metal ノードマシンのステータスを表します。

JSON 表現 
{
  "drainingMachines": [
    {
      object (BareMetalAdminDrainingMachine)
    }
  ],
  "drainedMachines": [
    {
      object (BareMetalAdminDrainedMachine)
    }
  ]
}
項目
drainingMachines[]

object (BareMetalAdminDrainingMachine)

ドレイン マシンのリスト。
drainedMachines[]

object (BareMetalAdminDrainedMachine)

ドレインされたマシンのリスト。

BareMetalAdminDrainingMachine

BareMetalAdminDrainingMachine は、現在ドレイン中のマシンを表します。

JSON 表現 
{
  "nodeIp": string,
  "podCount": integer
}
項目
nodeIp

string

ドレイン マシンの IP アドレス。
podCount

integer

ドレインされていない Pod の数。

BareMetalAdminDrainedMachine

BareMetalAdminDrainedMachine は、ドレインされたマシンを表します。

JSON 表現 
{
  "nodeIp": string
}
項目
nodeIp

string

ドレインされたマシンの IP アドレス。

BareMetalAdminWorkloadNodeConfig

BareMetalAdminWorkloadNodeConfig には、ワークロード ノードの構成を指定します。

JSON 表現 
{
  "maxPodsPerNode": string
}
項目
maxPodsPerNode

string (int64 format)

ノードで実行できる Pod の最大数。ノードに割り当てられる CIDR 範囲のサイズは、このパラメータから取得されます。デフォルトでは、ノードごとに 110 個の Pod が作成されます。HA 管理クラスタと非 HA 管理クラスタの両方で上限は 250 です。下限は、非 HA 管理クラスタの場合は 64、HA 管理クラスタの場合は 32 です。

BareMetalAdminProxyConfig

BareMetalAdminProxyConfig には、クラスタのプロキシ構成を指定します。

JSON 表現 
{
  "uri": string,
  "noProxy": [
    string
  ]
}
フィールド
uri

string

必須。プロキシ サーバーのアドレスを指定します。例: http://domain

警告: 認証情報を http://(username:password@)domain 形式で指定しないでください。サーバーで拒否されます。
noProxy[]

string

プロキシをスキップする IP、ホスト名、ドメインのリスト。例: ["127.0.0.1", "example.com", ".corp", "localhost"]。

BareMetalAdminSecurityConfig

ベアメタル管理クラスタのセキュリティ関連の設定を指定します。

JSON 表現 
{
  "authorization": {
    object (Authorization)
  }
}
項目
authorization

object (Authorization)

管理クラスタへのユーザー アクセスを構成します。

BareMetalAdminNodeAccessConfig

ベアメタル管理クラスタのノードアクセス関連の設定を指定します。

JSON 表現 
{
  "loginUser": string
}
フィールド
loginUser

string

必須。LoginUser は、ノードマシンへのアクセスに使用されるユーザー名です。設定しない場合、デフォルトは「root」です。

BareMetalAdminOsEnvironmentConfig

クラスタのプロビジョニングのオペレーティング システムの動作設定を指定します。

JSON 表現 
{
  "packageRepoExcluded": boolean
}
項目
packageRepoExcluded

boolean

ベアメタル マシンの初期化時にパッケージ リポジトリを追加するかどうか。

メソッド

create

 指定されたプロジェクトとロケーションに新しいベアメタル管理クラスタを作成します。

enroll

 特定のプロジェクトとロケーション内の既存の Bare Metal 管理クラスタを Anthos On-Prem API に登録します。

get

 1 つのベアメタル管理クラスタの詳細を取得します。

list

 指定されたプロジェクトとロケーションのベアメタル管理クラスタを一覧表示します。

patch

 単一のベアメタル管理クラスタのパラメータを更新します。

queryVersionConfig

 ベアメタル管理クラスタのバージョン構成をクエリします。