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 管理员集群的操作系统映像类型。
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

VmwareAdminVipConfig，适用于 VMware 负载平衡器配置。

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 服务 http 的 NodePort。管理员集群中的入站服务实现为 NodePort 类型的 Service（例如 32527）。
ingressHttpsNodePort

integer

用于 ingress 服务的 https 的 NodePort。管理员集群中的入站服务实现为 NodePort 类型的 Service（例如 30139）。
controlPlaneNodePort

integer

用于控制平面服务的 NodePort。管理员集群中的 Kubernetes API 服务器实现为 NodePort 类型的 Service（例如 30968）。
konnectivityServerNodePort

integer

用于在每个 kube-apiserver Pod 中作为 Sidecar 运行的 konnectivity 服务器服务的 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 创建用户集群的命名空间。命名空间需要使用以下命名惯例：-gke-onprem-mgmt 或 -gke-onprem-mgmt，具体取决于您是否使用了“VmwareCluster.local_name”来消除冲突歧义；如需了解更多背景信息，请参阅“VmwareCluster.local_name”的文档。创建命名空间后，您需要通过 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

启用两个负载平衡器虚拟机，以实现高可用性 Seesaw 负载平衡器。
vms[]

string

为此 Seesaw 群组创建的虚拟机的名称。
stackdriverName

string

Stackdriver 要使用的名称。

VmwareAdminControlPlaneNodeConfig

VmwareAdminControlPlaneNodeConfig 包含 VMware 管理员集群的控制平面节点配置。

JSON 表示法 
{
  "cpus": string,
  "memory": string,
  "replicas": string
}
字段
cpus

string (int64 format)

管理员集群的控制平面节点的 vCPU 数量。
memory

string (int64 format)

管理员集群的控制平面节点的内存大小（以 MiB 为单位）。
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

bundle 的版本。
status

object (ResourceStatus)

仅限输出。软件包的资源状态。

VmwareAdminPreparedSecretsConfig

VmwareAdminPreparedSecretsConfig 表示管理员集群准备好的 Secret 的配置。

JSON 表示法 
{
  "enabled": boolean
}
字段
enabled

boolean

是否启用了准备好的 Secret。

VmwareAdminAuthorizationConfig

VmwareAdminAuthorizationConfig 表示管理员集群授权的配置。

JSON 表示法 
{
  "viewerUsers": [
    {
      object (ClusterUser)
    }
  ]
}
字段
viewerUsers[]

object (ClusterUser)

对于 VMware 管理员集群，用户会获得集群的 cluster-viewer 角色。

方法

create

 在给定的项目和位置中创建新的 VMware 管理员集群。

enroll

 将现有 VMware 管理员集群注册到给定项目和位置中的 Anthos On-Prem API。

get

 获取单个 VMware 管理员集群的详细信息。

list

 列出给定项目和位置中的 VMware 管理员集群。

patch

 更新单个 VMware 管理员集群的参数。