vmware_admin_clusters

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

Overview

Name	vmware_admin_clusters
Type	Resource
Id	google.gkeonprem.vmware_admin_clusters

Fields

The following fields are returned by SELECT queries:

projects_locations_vmware_admin_clusters_get

Successful response

Name	Datatype	Description
name	string	Immutable. The VMware admin cluster resource name.
addonNode	object	The VMware admin cluster addon node configuration. (id: VmwareAdminAddonNodeConfig)
annotations	object	Annotations on the VMware admin 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	The VMware admin cluster anti affinity group configuration. (id: VmwareAAGConfig)
authorization	object	The VMware admin cluster authorization configuration. (id: VmwareAdminAuthorizationConfig)
autoRepairConfig	object	The VMware admin cluster auto repair configuration. (id: VmwareAutoRepairConfig)
bootstrapClusterMembership	string	The bootstrap cluster this VMware admin cluster belongs to.
controlPlaneNode	object	The VMware admin cluster control plane node configuration. (id: VmwareAdminControlPlaneNodeConfig)
createTime	string (google-datetime)	Output only. The time at which VMware admin cluster was created.
description	string	A human readable description of this VMware admin cluster.
enableAdvancedCluster	boolean	Enable advanced cluster.
endpoint	string	Output only. The DNS name of VMware admin 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)
imageType	string	The OS image type for the VMware admin cluster.
loadBalancer	object	The VMware admin cluster load balancer configuration. (id: VmwareAdminLoadBalancerConfig)
localName	string	Output only. The object name of the VMware OnPremAdminCluster custom resource. 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 admin cluster network configuration. (id: VmwareAdminNetworkConfig)
onPremVersion	string	The Anthos clusters on the VMware version for the admin cluster.
platformConfig	object	The VMware platform configuration. (id: VmwarePlatformConfig)
preparedSecrets	object	Output only. The VMware admin cluster prepared secrets configuration. It should always be enabled by the Central API, instead of letting users set it. (id: VmwareAdminPreparedSecretsConfig)
privateRegistryConfig	object	Configuration for registry. (id: VmwareAdminPrivateRegistryConfig)
reconciling	boolean	Output only. If set, there are currently changes in flight to the VMware admin cluster.
state	string	Output only. The current state of VMware admin cluster.
status	object	Output only. ResourceStatus representing detailed cluster state. (id: ResourceStatus)
uid	string	Output only. The unique identifier of the VMware admin cluster.
updateTime	string (google-datetime)	Output only. The time at which VMware admin cluster was last updated.
validationCheck	object	Output only. ValidationCheck represents the result of the preflight check job. (id: ValidationCheck)
vcenter	object	The VMware admin cluster VCenter configuration. (id: VmwareAdminVCenterConfig)

projects_locations_vmware_admin_clusters_list

Successful response

Name	Datatype	Description
name	string	Immutable. The VMware admin cluster resource name.
addonNode	object	The VMware admin cluster addon node configuration. (id: VmwareAdminAddonNodeConfig)
annotations	object	Annotations on the VMware admin 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	The VMware admin cluster anti affinity group configuration. (id: VmwareAAGConfig)
authorization	object	The VMware admin cluster authorization configuration. (id: VmwareAdminAuthorizationConfig)
autoRepairConfig	object	The VMware admin cluster auto repair configuration. (id: VmwareAutoRepairConfig)
bootstrapClusterMembership	string	The bootstrap cluster this VMware admin cluster belongs to.
controlPlaneNode	object	The VMware admin cluster control plane node configuration. (id: VmwareAdminControlPlaneNodeConfig)
createTime	string (google-datetime)	Output only. The time at which VMware admin cluster was created.
description	string	A human readable description of this VMware admin cluster.
enableAdvancedCluster	boolean	Enable advanced cluster.
endpoint	string	Output only. The DNS name of VMware admin 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)
imageType	string	The OS image type for the VMware admin cluster.
loadBalancer	object	The VMware admin cluster load balancer configuration. (id: VmwareAdminLoadBalancerConfig)
localName	string	Output only. The object name of the VMware OnPremAdminCluster custom resource. 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 admin cluster network configuration. (id: VmwareAdminNetworkConfig)
onPremVersion	string	The Anthos clusters on the VMware version for the admin cluster.
platformConfig	object	The VMware platform configuration. (id: VmwarePlatformConfig)
preparedSecrets	object	Output only. The VMware admin cluster prepared secrets configuration. It should always be enabled by the Central API, instead of letting users set it. (id: VmwareAdminPreparedSecretsConfig)
privateRegistryConfig	object	Configuration for registry. (id: VmwareAdminPrivateRegistryConfig)
reconciling	boolean	Output only. If set, there are currently changes in flight to the VMware admin cluster.
state	string	Output only. The current state of VMware admin cluster.
status	object	Output only. ResourceStatus representing detailed cluster state. (id: ResourceStatus)
uid	string	Output only. The unique identifier of the VMware admin cluster.
updateTime	string (google-datetime)	Output only. The time at which VMware admin cluster was last updated.
validationCheck	object	Output only. ValidationCheck represents the result of the preflight check job. (id: ValidationCheck)
vcenter	object	The VMware admin cluster VCenter configuration. (id: VmwareAdminVCenterConfig)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_vmware_admin_clusters_get	select	projectsId, locationsId, vmwareAdminClustersId	view, allowMissing	Gets details of a single VMware admin cluster.
projects_locations_vmware_admin_clusters_list	select	projectsId, locationsId	pageSize, pageToken, view, allowMissing	Lists VMware admin clusters in a given project and location.
projects_locations_vmware_admin_clusters_create	insert	projectsId, locationsId	vmwareAdminClusterId, validateOnly, allowPreflightFailure	Creates a new VMware admin cluster in a given project and location. The API needs to be combined with creating a bootstrap cluster to work.
projects_locations_vmware_admin_clusters_patch	update	projectsId, locationsId, vmwareAdminClustersId	updateMask, validateOnly	Updates the parameters of a single VMware admin cluster.
projects_locations_vmware_admin_clusters_enroll	exec	projectsId, locationsId		Enrolls an existing VMware admin cluster to the Anthos On-Prem API within a given project and location. Through enrollment, an existing admin cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster will be expected to be performed through the API.
projects_locations_vmware_admin_clusters_unenroll	exec	projectsId, locationsId, vmwareAdminClustersId	etag, allowMissing, validateOnly, ignoreErrors	Unenrolls an existing VMware admin cluster 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 will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or its clients.

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
vmwareAdminClustersId	string
allowMissing	boolean
allowPreflightFailure	boolean
etag	string
ignoreErrors	boolean
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)
validateOnly	boolean
view	string
vmwareAdminClusterId	string

SELECT examples

projects_locations_vmware_admin_clusters_get

Gets details of a single VMware admin cluster.

SELECT
name,
addonNode,
annotations,
antiAffinityGroups,
authorization,
autoRepairConfig,
bootstrapClusterMembership,
controlPlaneNode,
createTime,
description,
enableAdvancedCluster,
endpoint,
etag,
fleet,
imageType,
loadBalancer,
localName,
networkConfig,
onPremVersion,
platformConfig,
preparedSecrets,
privateRegistryConfig,
reconciling,
state,
status,
uid,
updateTime,
validationCheck,
vcenter
FROM google.gkeonprem.vmware_admin_clusters
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND vmwareAdminClustersId = '{{ vmwareAdminClustersId }}' -- required
AND view = '{{ view }}'
AND allowMissing = '{{ allowMissing }}';

projects_locations_vmware_admin_clusters_list

Lists VMware admin clusters in a given project and location.

SELECT
name,
addonNode,
annotations,
antiAffinityGroups,
authorization,
autoRepairConfig,
bootstrapClusterMembership,
controlPlaneNode,
createTime,
description,
enableAdvancedCluster,
endpoint,
etag,
fleet,
imageType,
loadBalancer,
localName,
networkConfig,
onPremVersion,
platformConfig,
preparedSecrets,
privateRegistryConfig,
reconciling,
state,
status,
uid,
updateTime,
validationCheck,
vcenter
FROM google.gkeonprem.vmware_admin_clusters
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND view = '{{ view }}'
AND allowMissing = '{{ allowMissing }}';

INSERT examples

projects_locations_vmware_admin_clusters_create

Creates a new VMware admin cluster in a given project and location. The API needs to be combined with creating a bootstrap cluster to work.

INSERT INTO google.gkeonprem.vmware_admin_clusters (
data__name,
data__description,
data__etag,
data__annotations,
data__bootstrapClusterMembership,
data__onPremVersion,
data__imageType,
data__vcenter,
data__networkConfig,
data__loadBalancer,
data__controlPlaneNode,
data__addonNode,
data__antiAffinityGroups,
data__autoRepairConfig,
data__platformConfig,
data__authorization,
data__enableAdvancedCluster,
data__privateRegistryConfig,
projectsId,
locationsId,
vmwareAdminClusterId,
validateOnly,
allowPreflightFailure
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ etag }}',
'{{ annotations }}',
'{{ bootstrapClusterMembership }}',
'{{ onPremVersion }}',
'{{ imageType }}',
'{{ vcenter }}',
'{{ networkConfig }}',
'{{ loadBalancer }}',
'{{ controlPlaneNode }}',
'{{ addonNode }}',
'{{ antiAffinityGroups }}',
'{{ autoRepairConfig }}',
'{{ platformConfig }}',
'{{ authorization }}',
{{ enableAdvancedCluster }},
'{{ privateRegistryConfig }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ vmwareAdminClusterId }}',
'{{ validateOnly }}',
'{{ allowPreflightFailure }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: vmware_admin_clusters
  props:
    - name: projectsId
      value: string
      description: Required parameter for the vmware_admin_clusters resource.
    - name: locationsId
      value: string
      description: Required parameter for the vmware_admin_clusters resource.
    - name: name
      value: string
      description: >
        Immutable. The VMware admin cluster resource name.
        
    - name: description
      value: string
      description: >
        A human readable description of this VMware admin 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 admin 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: bootstrapClusterMembership
      value: string
      description: >
        The bootstrap cluster this VMware admin cluster belongs to.
        
    - name: onPremVersion
      value: string
      description: >
        The Anthos clusters on the VMware version for the admin cluster.
        
    - name: imageType
      value: string
      description: >
        The OS image type for the VMware admin cluster.
        
    - name: vcenter
      value: object
      description: >
        The VMware admin cluster VCenter configuration.
        
    - name: networkConfig
      value: object
      description: >
        The VMware admin cluster network configuration.
        
    - name: loadBalancer
      value: object
      description: >
        The VMware admin cluster load balancer configuration.
        
    - name: controlPlaneNode
      value: object
      description: >
        The VMware admin cluster control plane node configuration.
        
    - name: addonNode
      value: object
      description: >
        The VMware admin cluster addon node configuration.
        
    - name: antiAffinityGroups
      value: object
      description: >
        The VMware admin cluster anti affinity group configuration.
        
    - name: autoRepairConfig
      value: object
      description: >
        The VMware admin cluster auto repair configuration.
        
    - name: platformConfig
      value: object
      description: >
        The VMware platform configuration.
        
    - name: authorization
      value: object
      description: >
        The VMware admin cluster authorization configuration.
        
    - name: enableAdvancedCluster
      value: boolean
      description: >
        Enable advanced cluster.
        
    - name: privateRegistryConfig
      value: object
      description: >
        Configuration for registry.
        
    - name: vmwareAdminClusterId
      value: string
    - name: validateOnly
      value: boolean
    - name: allowPreflightFailure
      value: boolean

UPDATE examples

projects_locations_vmware_admin_clusters_patch

Updates the parameters of a single VMware admin cluster.

UPDATE google.gkeonprem.vmware_admin_clusters
SET 
data__name = '{{ name }}',
data__description = '{{ description }}',
data__etag = '{{ etag }}',
data__annotations = '{{ annotations }}',
data__bootstrapClusterMembership = '{{ bootstrapClusterMembership }}',
data__onPremVersion = '{{ onPremVersion }}',
data__imageType = '{{ imageType }}',
data__vcenter = '{{ vcenter }}',
data__networkConfig = '{{ networkConfig }}',
data__loadBalancer = '{{ loadBalancer }}',
data__controlPlaneNode = '{{ controlPlaneNode }}',
data__addonNode = '{{ addonNode }}',
data__antiAffinityGroups = '{{ antiAffinityGroups }}',
data__autoRepairConfig = '{{ autoRepairConfig }}',
data__platformConfig = '{{ platformConfig }}',
data__authorization = '{{ authorization }}',
data__enableAdvancedCluster = {{ enableAdvancedCluster }},
data__privateRegistryConfig = '{{ privateRegistryConfig }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND vmwareAdminClustersId = '{{ vmwareAdminClustersId }}' --required
AND updateMask = '{{ updateMask}}'
AND validateOnly = {{ validateOnly}}
RETURNING
name,
done,
error,
metadata,
response;

Lifecycle Methods

projects_locations_vmware_admin_clusters_enroll

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

EXEC google.gkeonprem.vmware_admin_clusters.projects_locations_vmware_admin_clusters_enroll 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required 
@@json=
'{
"vmwareAdminClusterId": "{{ vmwareAdminClusterId }}", 
"membership": "{{ membership }}"
}';

projects_locations_vmware_admin_clusters_unenroll

Unenrolls an existing VMware admin cluster 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 will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or its clients.

EXEC google.gkeonprem.vmware_admin_clusters.projects_locations_vmware_admin_clusters_unenroll 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@vmwareAdminClustersId='{{ vmwareAdminClustersId }}' --required, 
@etag='{{ etag }}', 
@allowMissing={{ allowMissing }}, 
@validateOnly={{ validateOnly }}, 
@ignoreErrors={{ ignoreErrors }};