REST Resource: projects.locations.vmwareAdminClusters

リソース: VmwareAdminCluster

VMware 管理クラスタを表すリソース。

JSON 表現 
{
  "name": string,
  "description": string,
  "uid": string,
  "etag": string,
  "createTime": string,
  "updateTime": string,
  "annotations": {
    string: string,
    ...
  },
  "state": enum (State),
  "endpoint": string,
  "reconciling": boolean,
  "localName": string,
  "bootstrapClusterMembership": string,
  "onPremVersion": string,
  "fleet": {
    object (Fleet)
  },
  "imageType": string,
  "vcenter": {
    object (VmwareAdminVCenterConfig)
  },
  "networkConfig": {
    object (VmwareAdminNetworkConfig)
  },
  "loadBalancer": {
    object (VmwareAdminLoadBalancerConfig)
  },
  "controlPlaneNode": {
    object (VmwareAdminControlPlaneNodeConfig)
  },
  "addonNode": {
    object (VmwareAdminAddonNodeConfig)
  },
  "antiAffinityGroups": {
    object (VmwareAAGConfig)
  },
  "autoRepairConfig": {
    object (VmwareAutoRepairConfig)
  },
  "status": {
    object (ResourceStatus)
  },
  "platformConfig": {
    object (VmwarePlatformConfig)
  },
  "preparedSecrets": {
    object (VmwareAdminPreparedSecretsConfig)
  },
  "authorization": {
    object (VmwareAdminAuthorizationConfig)
  },
  "validationCheck": {
    object (ValidationCheck)
  }
}
フィールド
name

string

変更不可。VMware 管理クラスタのリソース名。
description

string

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

string

出力専用。VMware 管理クラスタの一意の識別子。
etag

string

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

string (Timestamp format)

出力専用。VMware 管理クラスタが作成された時刻。

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)

出力専用。VMware 管理クラスタが最後に更新された時刻。

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"。
annotations

map (key: string, value: string)

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

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

enum (State)

出力専用。VMware 管理クラスタの現在の状態。
endpoint

string

出力専用。VMware 管理クラスタの API サーバーの DNS 名。
reconciling

boolean

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

string

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

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

string

この VMware 管理クラスタが属するブートストラップ クラスタ。
onPremVersion

string

管理クラスタの Anthos clusters on VMware のバージョン。
fleet

object (Fleet)

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

string

VMware 管理クラスタの OS イメージタイプ。
vcenter

object (VmwareAdminVCenterConfig)

VMware 管理クラスタの VCenter 構成。
networkConfig

object (VmwareAdminNetworkConfig)

VMware 管理クラスタのネットワーク構成。
loadBalancer

object (VmwareAdminLoadBalancerConfig)

VMware 管理クラスタのロードバランサ構成。
controlPlaneNode

object (VmwareAdminControlPlaneNodeConfig)

VMware 管理クラスタのコントロール プレーン ノードの構成。
addonNode

object (VmwareAdminAddonNodeConfig)

VMware 管理クラスタのアドオンノード構成。
antiAffinityGroups

object (VmwareAAGConfig)

VMware 管理クラスタの反アフィニティ グループの構成。
autoRepairConfig

object (VmwareAutoRepairConfig)

VMware 管理クラスタの自動修復構成。
status

object (ResourceStatus)

出力専用。クラスタの詳細な状態を表す ResourceStatus。
platformConfig

object (VmwarePlatformConfig)

VMware プラットフォームの構成。
preparedSecrets

object (VmwareAdminPreparedSecretsConfig)

出力専用。VMware 管理クラスタが準備した Secret 構成。ユーザーが設定できるようにするのではなく、常に Central API によって有効にする必要があります。
authorization

object (VmwareAdminAuthorizationConfig)

VMware 管理クラスタの認可構成。
validationCheck

object (ValidationCheck)

出力専用。ValidationCheck は、プリフライト チェック ジョブの結果を表します。

州

VMware 管理クラスタのライフサイクルの状態。

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

VmwareAdminVCenterConfig

VmwareAdminVCenterConfig には、VMware 管理クラスタの vCenter 構成が含まれています。

JSON 表現 
{
  "resourcePool": string,
  "datastore": string,
  "datacenter": string,
  "cluster": string,
  "folder": string,
  "caCertData": string,
  "address": string,
  "dataDisk": string,
  "storagePolicyName": string
}
フィールド
resourcePool

string

管理クラスタの vCenter リソースプールの名前。
datastore

string

管理クラスタの vCenter データストアの名前。
datacenter

string

管理クラスタの vCenter データセンターの名前。
cluster

string

管理クラスタの vCenter クラスタの名前。
folder

string

管理クラスタの vCenter フォルダの名前。
caCertData

string

SSL 検証用の vCenter CA 証明書の公開鍵が含まれています。
address

string

vCenter の IP アドレス。
dataDisk

string

管理クラスタの仮想マシンディスク（VMDK）の名前。
storagePolicyName

string

ユーザー クラスタの vCenter ストレージ ポリシーの名前。

VmwareAdminNetworkConfig

VmwareAdminNetworkConfig には、VMware 管理クラスタのネットワーク構成が含まれています。

JSON 表現 
{
  "serviceAddressCidrBlocks": [
    string
  ],
  "podAddressCidrBlocks": [
    string
  ],
  "vcenterNetwork": string,
  "hostConfig": {
    object (VmwareHostConfig)
  },
  "haControlPlaneConfig": {
    object (VmwareAdminHAControlPlaneConfig)
  },

  // Union field ip_configuration can be only one of the following:
  "staticIpConfig": {
    object (VmwareStaticIpConfig)
  },
  "dhcpIpConfig": {
    object (VmwareDhcpIpConfig)
  }
  // End of list of possible types for union field ip_configuration.
}
フィールド
serviceAddressCidrBlocks[]

string

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

string

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

string

vcenterNetwork には、vCenter ネットワーク名を指定します。
hostConfig

object (VmwareHostConfig)

ホストの IP アドレスに関係なく、一般的なネットワーク設定を表します。
haControlPlaneConfig

object (VmwareAdminHAControlPlaneConfig)

HA 管理クラスタ コントロール プレーンの構成。
共用体フィールド ip_configuration。VMware 管理クラスタで使用される IP 構成のタイプ。ip_configuration は次のいずれかになります。
staticIpConfig

object (VmwareStaticIpConfig)

静的 IP 構成の構成設定。
dhcpIpConfig

object (VmwareDhcpIpConfig)

DHCP IP 構成の構成設定。

VmwareAdminHAControlPlaneConfig

HA 管理コントロール プレーンの構成を指定します。

JSON 表現 
{
  "controlPlaneIpBlock": {
    object (VmwareIpBlock)
  }
}
フィールド
controlPlaneIpBlock

object (VmwareIpBlock)

管理コントロール プレーン ノードの静的 IP アドレス。

VmwareAdminLoadBalancerConfig

VmwareAdminLoadBalancerConfig には、VMware 管理クラスタのロードバランサ構成が含まれています。

JSON 表現 
{
  "vipConfig": {
    object (VmwareAdminVipConfig)
  },

  // Union field load_balancer_configuration can be only one of the following:
  "f5Config": {
    object (VmwareAdminF5BigIpConfig)
  },
  "manualLbConfig": {
    object (VmwareAdminManualLbConfig)
  },
  "metalLbConfig": {
    object (VmwareAdminMetalLbConfig)
  },
  "seesawConfig": {
    object (VmwareAdminSeesawConfig)
  }
  // End of list of possible types for union field load_balancer_configuration.
}
フィールド
vipConfig

object (VmwareAdminVipConfig)

ロードバランサで使用される VIP。
共用体フィールド load_balancer_configuration。VMware 管理クラスタで使用するロードバランサ構成。load_balancer_configuration は次のいずれかになります。
f5Config

object (VmwareAdminF5BigIpConfig)

F5 Big IP タイプのロードバランサの構成。
manualLbConfig

object (VmwareAdminManualLbConfig)

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

object (VmwareAdminMetalLbConfig)

MetalLB ロードバランサ。
seesawConfig

object (VmwareAdminSeesawConfig)

出力専用。Seesaw タイプのロードバランサの構成。

VmwareAdminVipConfig

VMware ロードバランサ構成用の VmwareAdminVipConfig。

JSON 表現 
{
  "controlPlaneVip": string,
  "addonsVip": string
}
フィールド
controlPlaneVip

string

管理クラスタの Kubernetes API 用に以前に確保した VIP。
addonsVip

string

アドオンのロードバランサを構成する VIP。

VmwareAdminF5BigIpConfig

VmwareAdminF5BigIpConfig は、F5 BIG-IP ロードバランサの構成パラメータを表します。

JSON 表現 
{
  "address": string,
  "partition": string,
  "snatPool": string
}
フィールド
address

string

ロードバランサの IP アドレス。
partition

string

ロードバランサで使用される既存のパーティション。このパーティションは通常、管理クラスタ用に作成されます（例: my-f5-admin-partition）。
snatPool

string

プール名。SNAT を使用する場合にのみ必要です。

VmwareAdminManualLbConfig

JSON 表現 
{
  "ingressHttpNodePort": integer,
  "ingressHttpsNodePort": integer,
  "controlPlaneNodePort": integer,
  "konnectivityServerNodePort": integer,
  "addonsNodePort": integer
}
フィールド
ingressHttpNodePort

integer

Ingress Service の HTTP 用の NodePort。管理クラスタの Ingress サービスは、NodePort 型の Service として実装されます（例: 32527）。
ingressHttpsNodePort

integer

Ingress Service の https 用の NodePort。管理クラスタの Ingress サービスは、NodePort 型の Service として実装されます（例: 30139）。
controlPlaneNodePort

integer

コントロール プレーン サービス用の NodePort。管理クラスタの Kubernetes API サーバーは、NodePort タイプの Service として実装されます（例: 30968）。
konnectivityServerNodePort

integer

各 kube-apiserver Pod でサイドカーとして実行される konnectivity サーバー Service の NodePort（例: 30564）。
addonsNodePort

integer

管理クラスタ内のアドオン サーバーの NodePort。

VmwareAdminMetalLbConfig

VmwareAdminMetalLbConfig は、MetalLB ロードバランサの構成パラメータを表します。管理クラスタの場合、現在は構成は必要ありません。

JSON 表現 
{
  "enabled": boolean
}
フィールド
enabled

boolean

MetalLB が有効かどうか。

VmwareAdminSeesawConfig

VmwareSeesawConfig は、既存の Seesaw ロードバランサの構成パラメータを表します。

重要: Anthos On-Prem API は Seesaw 構成を生成または更新しません。既存の構成を新しいユーザー クラスタにバインドすることのみが可能です。

重要: 既存の Seesaw ロードバランサを使用してユーザー クラスタを作成する場合は、vmwareClusters.create API メソッドを呼び出す前に、いくつかの準備手順を行う必要があります。まず、kubectl を使用してユーザー クラスタの名前空間を作成する必要があります。Namespace には、競合の曖昧さを解消するために「VmwareCluster.local_name」を使用したかどうかに応じて、-gke-onprem-mgmt または -gke-onprem-mgmt の命名規則を使用する必要があります。詳細については、「VmwareCluster.local_name」のドキュメントをご覧ください。Namespace が作成されたら、kubectl を使用して Secret リソースを作成する必要があります。このシークレットには、Seesaw の認証情報のコピーが含まれます。Secret の名前は「user-cluster-creds」にする必要があります。また、Seesaw の SSH 認証情報と証明書認証情報を含める必要があります。認証情報は、「seesaw-ssh-private-key」、「seesaw-ssh-public-key」、「seesaw-ssh-ca-key」、「seesaw-ssh-ca-cert」という名前でキーにする必要があります。

JSON 表現 
{
  "group": string,
  "masterIp": string,
  "ipBlocks": [
    {
      object (VmwareIpBlock)
    }
  ],
  "enableHa": boolean,
  "vms": [
    string
  ],
  "stackdriverName": string
}
フィールド
group

string

通常、Seesaw グループ名には seesaw-for-[clusterName] の形式を使用します。
masterIp

string

MasterIP は、Seesaw グループのマスターによって通知される IP です。
ipBlocks[]

object (VmwareIpBlock)

Seesaw ロードバランサで使用される IP ブロック
enableHa

boolean

2 つのロードバランサ VM を有効にして、高可用性 Seesaw ロードバランサを実現します。
vms[]

string

この Seesaw グループ用に作成された VM の名前。
stackdriverName

string

Stackdriver で使用される名前。

VmwareAdminControlPlaneNodeConfig

VmwareAdminControlPlaneNodeConfig には、VMware 管理クラスタのコントロール プレーン ノードの構成が含まれています。

JSON 表現 
{
  "cpus": string,
  "memory": string,
  "replicas": string
}
フィールド
cpus

string (int64 format)

管理クラスタのコントロール プレーン ノードの vCPU 数。
memory

string (int64 format)

管理クラスタのコントロール プレーン ノードのメモリ容量（メビバイト）。
replicas

string (int64 format)

この VMware 管理クラスタのコントロール プレーン ノードの数。（デフォルト: 1 つのレプリカ）。

VmwareAdminAddonNodeConfig

VmwareAdminAddonNodeConfig には、VMware 管理クラスタのアドオンノード構成が含まれています。

JSON 表現 
{
  "autoResizeConfig": {
    object (VmwareAutoResizeConfig)
  }
}
フィールド
autoResizeConfig

object (VmwareAutoResizeConfig)

VmwareAutoResizeConfig 構成で自動サイズ変更構成を指定します。

VmwarePlatformConfig

VmwarePlatformConfig は、VMware プラットフォームの構成を表します。

JSON 表現 
{
  "requiredPlatformVersion": string,
  "platformVersion": string,
  "bundles": [
    {
      object (VmwareBundleConfig)
    }
  ],
  "status": {
    object (ResourceStatus)
  }
}
フィールド
requiredPlatformVersion

string

入力のみの必要なプラットフォーム バージョン（例: 1.13.1）。現在のプラットフォーム バージョンが対象バージョンより低い場合、プラットフォーム バージョンは対象バージョンに更新されます。ターゲット バージョンがプラットフォームにインストールされていない場合（バンドル バージョン）、ターゲット バージョンのバンドルをダウンロードします。
platformVersion

string

出力専用。プラットフォーム バージョン（例: 1.13.2）。
bundles[]

object (VmwareBundleConfig)

出力専用。管理クラスタにインストールされているバンドルのリスト。
status

object (ResourceStatus)

出力専用。プラットフォームのリソース ステータス。

VmwareBundleConfig

VmwareBundleConfig は、バンドルの構成を表します。

JSON 表現 
{
  "version": string,
  "status": {
    object (ResourceStatus)
  }
}
フィールド
version

string

バンドルのバージョン。
status

object (ResourceStatus)

出力専用。バンドルのリソース ステータス。

VmwareAdminPreparedSecretsConfig

VmwareAdminPreparedSecretsConfig は、管理クラスタで準備された Secret の構成を表します。

JSON 表現 
{
  "enabled": boolean
}
フィールド
enabled

boolean

準備済み Secret が有効かどうか。

VmwareAdminAuthorizationConfig

VmwareAdminAuthorizationConfig は、管理クラスタの認可の構成を表します。

JSON 表現 
{
  "viewerUsers": [
    {
      object (ClusterUser)
    }
  ]
}
フィールド
viewerUsers[]

object (ClusterUser)

VMware 管理クラスタの場合、ユーザーにはクラスタに対するクラスタ閲覧者ロールが付与されます。

メソッド

create

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

enroll

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

get

 1 つの VMware 管理クラスタの詳細を取得します。

list

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

patch

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