vmware_clusters

Creates, updates, deletes, gets or lists a vmware_clusters resource.

Overview

Name	vmware_clusters
Type	Resource
Id	google.gkeonprem.vmware_clusters

Fields

The following fields are returned by SELECT queries:

projects_locations_vmware_clusters_get

Successful response

Name	Datatype	Description
name	string	Immutable. The VMware user cluster resource name.
adminClusterMembership	string	Required. 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.
adminClusterName	string	Output only. The resource name of the VMware admin cluster hosting this user cluster.
annotations	object	Annotations 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.
antiAffinityGroups	object	AAGConfig specifies whether to spread VMware user cluster nodes across at least three physical hosts in the datacenter. (id: VmwareAAGConfig)
authorization	object	RBAC policy that will be applied and managed by the Anthos On-Prem API. (id: Authorization)
autoRepairConfig	object	Configuration for auto repairing. (id: VmwareAutoRepairConfig)
binaryAuthorization	object	Binary Authorization related configurations. (id: BinaryAuthorization)
controlPlaneNode	object	VMware user cluster control plane nodes must have either 1 or 3 replicas. (id: VmwareControlPlaneNodeConfig)
createTime	string (google-datetime)	Output only. The time at which VMware user cluster was created.
dataplaneV2	object	VmwareDataplaneV2Config specifies configuration for Dataplane V2. (id: VmwareDataplaneV2Config)
deleteTime	string (google-datetime)	Output only. The time at which VMware user cluster was deleted.
description	string	A human readable description of this VMware user cluster.
disableBundledIngress	boolean	Disable bundled ingress.
enableAdvancedCluster	boolean	Enable advanced cluster.
enableControlPlaneV2	boolean	Enable control plane V2. Default to false.
endpoint	string	Output only. The DNS name of VMware user cluster's API server.
etag	string	This 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.
fleet	object	Output only. Fleet configuration for the cluster. (id: Fleet)
loadBalancer	object	Load balancer configuration. (id: VmwareLoadBalancerConfig)
localName	string	Output 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.
networkConfig	object	The VMware user cluster network configuration. (id: VmwareNetworkConfig)
onPremVersion	string	Required. The Anthos clusters on the VMware version for your user cluster.
reconciling	boolean	Output only. If set, there are currently changes in flight to the VMware user cluster.
state	string	Output only. The current state of VMware user cluster.
status	object	Output only. ResourceStatus representing detailed cluster state. (id: ResourceStatus)
storage	object	Storage configuration. (id: VmwareStorageConfig)
uid	string	Output only. The unique identifier of the VMware user cluster.
updateTime	string (google-datetime)	Output only. The time at which VMware user cluster was last updated.
upgradePolicy	object	Specifies upgrade policy for the cluster. (id: VmwareClusterUpgradePolicy)
validationCheck	object	Output only. ValidationCheck represents the result of the preflight check job. (id: ValidationCheck)
vcenter	object	VmwareVCenterConfig specifies vCenter config for the user cluster. If unspecified, it is inherited from the admin cluster. (id: VmwareVCenterConfig)
vmTrackingEnabled	boolean	Enable VM tracking.

projects_locations_vmware_clusters_list

Successful response

Name	Datatype	Description
name	string	Immutable. The VMware user cluster resource name.
adminClusterMembership	string	Required. 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.
adminClusterName	string	Output only. The resource name of the VMware admin cluster hosting this user cluster.
annotations	object	Annotations 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.
antiAffinityGroups	object	AAGConfig specifies whether to spread VMware user cluster nodes across at least three physical hosts in the datacenter. (id: VmwareAAGConfig)
authorization	object	RBAC policy that will be applied and managed by the Anthos On-Prem API. (id: Authorization)
autoRepairConfig	object	Configuration for auto repairing. (id: VmwareAutoRepairConfig)
binaryAuthorization	object	Binary Authorization related configurations. (id: BinaryAuthorization)
controlPlaneNode	object	VMware user cluster control plane nodes must have either 1 or 3 replicas. (id: VmwareControlPlaneNodeConfig)
createTime	string (google-datetime)	Output only. The time at which VMware user cluster was created.
dataplaneV2	object	VmwareDataplaneV2Config specifies configuration for Dataplane V2. (id: VmwareDataplaneV2Config)
deleteTime	string (google-datetime)	Output only. The time at which VMware user cluster was deleted.
description	string	A human readable description of this VMware user cluster.
disableBundledIngress	boolean	Disable bundled ingress.
enableAdvancedCluster	boolean	Enable advanced cluster.
enableControlPlaneV2	boolean	Enable control plane V2. Default to false.
endpoint	string	Output only. The DNS name of VMware user cluster's API server.
etag	string	This 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.
fleet	object	Output only. Fleet configuration for the cluster. (id: Fleet)
loadBalancer	object	Load balancer configuration. (id: VmwareLoadBalancerConfig)
localName	string	Output 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.
networkConfig	object	The VMware user cluster network configuration. (id: VmwareNetworkConfig)
onPremVersion	string	Required. The Anthos clusters on the VMware version for your user cluster.
reconciling	boolean	Output only. If set, there are currently changes in flight to the VMware user cluster.
state	string	Output only. The current state of VMware user cluster.
status	object	Output only. ResourceStatus representing detailed cluster state. (id: ResourceStatus)
storage	object	Storage configuration. (id: VmwareStorageConfig)
uid	string	Output only. The unique identifier of the VMware user cluster.
updateTime	string (google-datetime)	Output only. The time at which VMware user cluster was last updated.
upgradePolicy	object	Specifies upgrade policy for the cluster. (id: VmwareClusterUpgradePolicy)
validationCheck	object	Output only. ValidationCheck represents the result of the preflight check job. (id: ValidationCheck)
vcenter	object	VmwareVCenterConfig specifies vCenter config for the user cluster. If unspecified, it is inherited from the admin cluster. (id: VmwareVCenterConfig)
vmTrackingEnabled	boolean	Enable VM tracking.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_vmware_clusters_get	select	projectsId, locationsId, vmwareClustersId	view, allowMissing	Gets details of a single VMware Cluster.
projects_locations_vmware_clusters_list	select	projectsId, locationsId	pageSize, pageToken, filter, view, allowMissing	Lists VMware Clusters in a given project and location.
projects_locations_vmware_clusters_create	insert	projectsId, locationsId	vmwareClusterId, validateOnly, allowPreflightFailure	Creates a new VMware user cluster in a given project and location.
projects_locations_vmware_clusters_patch	update	projectsId, locationsId, vmwareClustersId	updateMask, validateOnly	Updates the parameters of a single VMware cluster.
projects_locations_vmware_clusters_delete	delete	projectsId, locationsId, vmwareClustersId	etag, allowMissing, validateOnly, force, ignoreErrors	Deletes a single VMware Cluster.
projects_locations_vmware_clusters_enroll	exec	projectsId, locationsId		Enrolls an existing VMware user cluster and its node pools to the Anthos On-Prem API within a given project and location. Through enrollment, an existing cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster and/or its node pools will be expected to be performed through the API.
projects_locations_vmware_clusters_unenroll	exec	projectsId, locationsId, vmwareClustersId	etag, allowMissing, validateOnly, force	Unenrolls an existing VMware user cluster and its node pools from the Anthos On-Prem API within a given project and location. Unenrollment removes the Cloud reference to the cluster without modifying the underlying OnPrem Resources. Clusters and node pools will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or UI.
projects_locations_vmware_clusters_query_version_config	exec	projectsId, locationsId	createConfig.adminClusterMembership, createConfig.adminClusterName, upgradeConfig.clusterName	Queries the VMware user cluster version config.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
projectsId	string
vmwareClustersId	string
allowMissing	boolean
allowPreflightFailure	boolean
createConfig.adminClusterMembership	string
createConfig.adminClusterName	string
etag	string
filter	string
force	boolean
ignoreErrors	boolean
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)
upgradeConfig.clusterName	string
validateOnly	boolean
view	string
vmwareClusterId	string

SELECT examples

projects_locations_vmware_clusters_get

Gets details of a single VMware Cluster.

SELECT
name,
adminClusterMembership,
adminClusterName,
annotations,
antiAffinityGroups,
authorization,
autoRepairConfig,
binaryAuthorization,
controlPlaneNode,
createTime,
dataplaneV2,
deleteTime,
description,
disableBundledIngress,
enableAdvancedCluster,
enableControlPlaneV2,
endpoint,
etag,
fleet,
loadBalancer,
localName,
networkConfig,
onPremVersion,
reconciling,
state,
status,
storage,
uid,
updateTime,
upgradePolicy,
validationCheck,
vcenter,
vmTrackingEnabled
FROM google.gkeonprem.vmware_clusters
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND vmwareClustersId = '{{ vmwareClustersId }}' -- required
AND view = '{{ view }}'
AND allowMissing = '{{ allowMissing }}';

projects_locations_vmware_clusters_list

Lists VMware Clusters in a given project and location.

SELECT
name,
adminClusterMembership,
adminClusterName,
annotations,
antiAffinityGroups,
authorization,
autoRepairConfig,
binaryAuthorization,
controlPlaneNode,
createTime,
dataplaneV2,
deleteTime,
description,
disableBundledIngress,
enableAdvancedCluster,
enableControlPlaneV2,
endpoint,
etag,
fleet,
loadBalancer,
localName,
networkConfig,
onPremVersion,
reconciling,
state,
status,
storage,
uid,
updateTime,
upgradePolicy,
validationCheck,
vcenter,
vmTrackingEnabled
FROM google.gkeonprem.vmware_clusters
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND view = '{{ view }}'
AND allowMissing = '{{ allowMissing }}';

INSERT examples

projects_locations_vmware_clusters_create

Creates a new VMware user cluster in a given project and location.

INSERT INTO google.gkeonprem.vmware_clusters (
data__name,
data__adminClusterMembership,
data__description,
data__onPremVersion,
data__etag,
data__annotations,
data__controlPlaneNode,
data__antiAffinityGroups,
data__storage,
data__networkConfig,
data__loadBalancer,
data__vcenter,
data__dataplaneV2,
data__vmTrackingEnabled,
data__autoRepairConfig,
data__authorization,
data__enableControlPlaneV2,
data__binaryAuthorization,
data__upgradePolicy,
data__disableBundledIngress,
data__enableAdvancedCluster,
projectsId,
locationsId,
vmwareClusterId,
validateOnly,
allowPreflightFailure
)
SELECT 
'{{ name }}',
'{{ adminClusterMembership }}',
'{{ description }}',
'{{ onPremVersion }}',
'{{ etag }}',
'{{ annotations }}',
'{{ controlPlaneNode }}',
'{{ antiAffinityGroups }}',
'{{ storage }}',
'{{ networkConfig }}',
'{{ loadBalancer }}',
'{{ vcenter }}',
'{{ dataplaneV2 }}',
{{ vmTrackingEnabled }},
'{{ autoRepairConfig }}',
'{{ authorization }}',
{{ enableControlPlaneV2 }},
'{{ binaryAuthorization }}',
'{{ upgradePolicy }}',
{{ disableBundledIngress }},
{{ enableAdvancedCluster }},
'{{ projectsId }}',
'{{ locationsId }}',
'{{ vmwareClusterId }}',
'{{ validateOnly }}',
'{{ allowPreflightFailure }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: vmware_clusters
  props:
    - name: projectsId
      value: string
      description: Required parameter for the vmware_clusters resource.
    - name: locationsId
      value: string
      description: Required parameter for the vmware_clusters resource.
    - name: name
      value: string
      description: >
        Immutable. The VMware user cluster resource name.
        
    - name: adminClusterMembership
      value: string
      description: >
        Required. 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.
        
    - name: description
      value: string
      description: >
        A human readable description of this VMware user cluster.
        
    - name: onPremVersion
      value: string
      description: >
        Required. The Anthos clusters on the VMware version for your user cluster.
        
    - name: etag
      value: string
      description: >
        This 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.
        
    - name: annotations
      value: object
      description: >
        Annotations 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.
        
    - name: controlPlaneNode
      value: object
      description: >
        VMware user cluster control plane nodes must have either 1 or 3 replicas.
        
    - name: antiAffinityGroups
      value: object
      description: >
        AAGConfig specifies whether to spread VMware user cluster nodes across at least three physical hosts in the datacenter.
        
    - name: storage
      value: object
      description: >
        Storage configuration.
        
    - name: networkConfig
      value: object
      description: >
        The VMware user cluster network configuration.
        
    - name: loadBalancer
      value: object
      description: >
        Load balancer configuration.
        
    - name: vcenter
      value: object
      description: >
        VmwareVCenterConfig specifies vCenter config for the user cluster. If unspecified, it is inherited from the admin cluster.
        
    - name: dataplaneV2
      value: object
      description: >
        VmwareDataplaneV2Config specifies configuration for Dataplane V2.
        
    - name: vmTrackingEnabled
      value: boolean
      description: >
        Enable VM tracking.
        
    - name: autoRepairConfig
      value: object
      description: >
        Configuration for auto repairing.
        
    - name: authorization
      value: object
      description: >
        RBAC policy that will be applied and managed by the Anthos On-Prem API.
        
    - name: enableControlPlaneV2
      value: boolean
      description: >
        Enable control plane V2. Default to false.
        
    - name: binaryAuthorization
      value: object
      description: >
        Binary Authorization related configurations.
        
    - name: upgradePolicy
      value: object
      description: >
        Specifies upgrade policy for the cluster.
        
    - name: disableBundledIngress
      value: boolean
      description: >
        Disable bundled ingress.
        
    - name: enableAdvancedCluster
      value: boolean
      description: >
        Enable advanced cluster.
        
    - name: vmwareClusterId
      value: string
    - name: validateOnly
      value: boolean
    - name: allowPreflightFailure
      value: boolean

UPDATE examples

projects_locations_vmware_clusters_patch

Updates the parameters of a single VMware cluster.

UPDATE google.gkeonprem.vmware_clusters
SET 
data__name = '{{ name }}',
data__adminClusterMembership = '{{ adminClusterMembership }}',
data__description = '{{ description }}',
data__onPremVersion = '{{ onPremVersion }}',
data__etag = '{{ etag }}',
data__annotations = '{{ annotations }}',
data__controlPlaneNode = '{{ controlPlaneNode }}',
data__antiAffinityGroups = '{{ antiAffinityGroups }}',
data__storage = '{{ storage }}',
data__networkConfig = '{{ networkConfig }}',
data__loadBalancer = '{{ loadBalancer }}',
data__vcenter = '{{ vcenter }}',
data__dataplaneV2 = '{{ dataplaneV2 }}',
data__vmTrackingEnabled = {{ vmTrackingEnabled }},
data__autoRepairConfig = '{{ autoRepairConfig }}',
data__authorization = '{{ authorization }}',
data__enableControlPlaneV2 = {{ enableControlPlaneV2 }},
data__binaryAuthorization = '{{ binaryAuthorization }}',
data__upgradePolicy = '{{ upgradePolicy }}',
data__disableBundledIngress = {{ disableBundledIngress }},
data__enableAdvancedCluster = {{ enableAdvancedCluster }}
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND vmwareClustersId = '{{ vmwareClustersId }}' --required
AND updateMask = '{{ updateMask}}'
AND validateOnly = {{ validateOnly}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

projects_locations_vmware_clusters_delete

Deletes a single VMware Cluster.

DELETE FROM google.gkeonprem.vmware_clusters
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND vmwareClustersId = '{{ vmwareClustersId }}' --required
AND etag = '{{ etag }}'
AND allowMissing = '{{ allowMissing }}'
AND validateOnly = '{{ validateOnly }}'
AND force = '{{ force }}'
AND ignoreErrors = '{{ ignoreErrors }}';

Lifecycle Methods

projects_locations_vmware_clusters_enroll

Enrolls an existing VMware user cluster and its node pools to the Anthos On-Prem API within a given project and location. Through enrollment, an existing cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster and/or its node pools will be expected to be performed through the API.

EXEC google.gkeonprem.vmware_clusters.projects_locations_vmware_clusters_enroll 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required 
@@json=
'{
"vmwareClusterId": "{{ vmwareClusterId }}", 
"localName": "{{ localName }}", 
"adminClusterMembership": "{{ adminClusterMembership }}", 
"validateOnly": {{ validateOnly }}
}';

projects_locations_vmware_clusters_unenroll

Unenrolls an existing VMware user cluster and its node pools from the Anthos On-Prem API within a given project and location. Unenrollment removes the Cloud reference to the cluster without modifying the underlying OnPrem Resources. Clusters and node pools will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or UI.

EXEC google.gkeonprem.vmware_clusters.projects_locations_vmware_clusters_unenroll 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@vmwareClustersId='{{ vmwareClustersId }}' --required, 
@etag='{{ etag }}', 
@allowMissing={{ allowMissing }}, 
@validateOnly={{ validateOnly }}, 
@force={{ force }};

projects_locations_vmware_clusters_query_version_config

Queries the VMware user cluster version config.

EXEC google.gkeonprem.vmware_clusters.projects_locations_vmware_clusters_query_version_config 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@createConfig.adminClusterMembership='{{ createConfig.adminClusterMembership }}', 
@createConfig.adminClusterName='{{ createConfig.adminClusterName }}', 
@upgradeConfig.clusterName='{{ upgradeConfig.clusterName }}';