VMware Cluster (GKE On-Prem)

A VMware Cluster in GKE On-Prem is a group of VMware-based nodes managed by Google Kubernetes Engine running in an on-premises environment. It provides the infrastructure for deploying and managing Kubernetes workloads locally while maintaining compatibility with Google Cloud services. This setup allows organizations to run containerized applications with consistent tooling, security, and policy management across hybrid environments.

gcp.gkeonprem_vmware_cluster

Fields

TitleIDTypeData TypeDescription
_keycorestring
admin_cluster_membershipcorestringRequired. The admin cluster this VMware user cluster belongs to. This is the full resource name of the admin cluster's fleet membership. In the future, references to other resource types might be allowed if admin clusters are modeled as their own resources.
admin_cluster_namecorestringOutput only. The resource name of the VMware admin cluster hosting this user cluster.
ancestorscorearray<string>
annotationscorehstoreAnnotations on the VMware user cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.
anti_affinity_groupscorejsonAAGConfig specifies whether to spread VMware user cluster nodes across at least three physical hosts in the datacenter.
authorizationcorejsonRBAC policy that will be applied and managed by the Anthos On-Prem API.
auto_repair_configcorejsonConfiguration for auto repairing.
binary_authorizationcorejsonBinary Authorization related configurations.
control_plane_nodecorejsonVMware user cluster control plane nodes must have either 1 or 3 replicas.
create_timecoretimestampOutput only. The time at which VMware user cluster was created.
datadog_display_namecorestring
dataplane_v2corejsonVmwareDataplaneV2Config specifies configuration for Dataplane V2.
delete_timecoretimestampOutput only. The time at which VMware user cluster was deleted.
descriptioncorestringA human readable description of this VMware user cluster.
disable_bundled_ingresscoreboolDisable bundled ingress.
enable_advanced_clustercoreboolEnable advanced cluster.
enable_control_plane_v2coreboolEnable control plane V2. Default to false.
endpointcorestringOutput only. The DNS name of VMware user cluster's API server.
etagcorestringThis checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Allows clients to perform consistent read-modify-writes through optimistic concurrency control.
fleetcorejsonOutput only. Fleet configuration for the cluster.
gcp_statuscorejsonOutput only. ResourceStatus representing detailed cluster state.
labelscorearray<string>
load_balancercorejsonLoad balancer configuration.
local_namecorestringOutput only. The object name of the VMware OnPremUserCluster custom resource on the associated admin cluster. This field is used to support conflicting names when enrolling existing clusters to the API. When used as a part of cluster enrollment, this field will differ from the ID in the resource name. For new clusters, this field will match the user provided cluster name and be visible in the last component of the resource name. It is not modifiable. All users should use this name to access their cluster using gkectl or kubectl and should expect to see the local name when viewing admin cluster controller logs.
namecorestringImmutable. The VMware user cluster resource name.
network_configcorejsonThe VMware user cluster network configuration.
on_prem_versioncorestringRequired. The Anthos clusters on the VMware version for your user cluster.
organization_idcorestring
parentcorestring
project_idcorestring
project_numbercorestring
reconcilingcoreboolOutput only. If set, there are currently changes in flight to the VMware user cluster.
region_idcorestring
resource_namecorestring
statecorestringOutput only. The current state of VMware user cluster.
storagecorejsonStorage configuration.
tagscorehstore_csv
uidcorestringOutput only. The unique identifier of the VMware user cluster.
update_timecoretimestampOutput only. The time at which VMware user cluster was last updated.
upgrade_policycorejsonSpecifies upgrade policy for the cluster.
validation_checkcorejsonOutput only. ValidationCheck represents the result of the preflight check job.
vcentercorejsonVmwareVCenterConfig specifies vCenter config for the user cluster. If unspecified, it is inherited from the admin cluster.
vm_tracking_enabledcoreboolEnable VM tracking.
zone_idcorestring