bare_metal_admin_clusters

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

Overview

Name	bare_metal_admin_clusters
Type	Resource
Id	google.gkeonprem.bare_metal_admin_clusters

Fields

The following fields are returned by SELECT queries:

projects_locations_bare_metal_admin_clusters_get

Successful response

Name	Datatype	Description
name	string	Immutable. The bare metal admin cluster resource name.
annotations	object	Annotations on the bare metal 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.
bareMetalVersion	string	The Anthos clusters on bare metal version for the bare metal admin cluster.
binaryAuthorization	object	Binary Authorization related configurations. (id: BinaryAuthorization)
clusterOperations	object	Cluster operations configuration. (id: BareMetalAdminClusterOperationsConfig)
controlPlane	object	Control plane configuration. (id: BareMetalAdminControlPlaneConfig)
createTime	string (google-datetime)	Output only. The time at which this bare metal admin cluster was created.
deleteTime	string (google-datetime)	Output only. The time at which this bare metal admin cluster was deleted. If the resource is not deleted, this must be empty
description	string	A human readable description of this bare metal admin cluster.
endpoint	string	Output only. The IP address name of bare metal 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)
loadBalancer	object	Load balancer configuration. (id: BareMetalAdminLoadBalancerConfig)
localName	string	Output only. The object name of the bare metal cluster 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.
maintenanceConfig	object	Maintenance configuration. (id: BareMetalAdminMaintenanceConfig)
maintenanceStatus	object	Output only. MaintenanceStatus representing state of maintenance. (id: BareMetalAdminMaintenanceStatus)
networkConfig	object	Network configuration. (id: BareMetalAdminNetworkConfig)
nodeAccessConfig	object	Node access related configurations. (id: BareMetalAdminNodeAccessConfig)
nodeConfig	object	Workload node configuration. (id: BareMetalAdminWorkloadNodeConfig)
osEnvironmentConfig	object	OS environment related configurations. (id: BareMetalAdminOsEnvironmentConfig)
proxy	object	Proxy configuration. (id: BareMetalAdminProxyConfig)
reconciling	boolean	Output only. If set, there are currently changes in flight to the bare metal Admin Cluster.
securityConfig	object	Security related configuration. (id: BareMetalAdminSecurityConfig)
state	string	Output only. The current state of the bare metal admin cluster.
status	object	Output only. ResourceStatus representing detailed cluster status. (id: ResourceStatus)
storage	object	Storage configuration. (id: BareMetalAdminStorageConfig)
uid	string	Output only. The unique identifier of the bare metal admin cluster.
updateTime	string (google-datetime)	Output only. The time at which this bare metal admin cluster was last updated.
validationCheck	object	Output only. ValidationCheck representing the result of the preflight check. (id: ValidationCheck)

projects_locations_bare_metal_admin_clusters_list

Successful response

Name	Datatype	Description
name	string	Immutable. The bare metal admin cluster resource name.
annotations	object	Annotations on the bare metal 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.
bareMetalVersion	string	The Anthos clusters on bare metal version for the bare metal admin cluster.
binaryAuthorization	object	Binary Authorization related configurations. (id: BinaryAuthorization)
clusterOperations	object	Cluster operations configuration. (id: BareMetalAdminClusterOperationsConfig)
controlPlane	object	Control plane configuration. (id: BareMetalAdminControlPlaneConfig)
createTime	string (google-datetime)	Output only. The time at which this bare metal admin cluster was created.
deleteTime	string (google-datetime)	Output only. The time at which this bare metal admin cluster was deleted. If the resource is not deleted, this must be empty
description	string	A human readable description of this bare metal admin cluster.
endpoint	string	Output only. The IP address name of bare metal 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)
loadBalancer	object	Load balancer configuration. (id: BareMetalAdminLoadBalancerConfig)
localName	string	Output only. The object name of the bare metal cluster 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.
maintenanceConfig	object	Maintenance configuration. (id: BareMetalAdminMaintenanceConfig)
maintenanceStatus	object	Output only. MaintenanceStatus representing state of maintenance. (id: BareMetalAdminMaintenanceStatus)
networkConfig	object	Network configuration. (id: BareMetalAdminNetworkConfig)
nodeAccessConfig	object	Node access related configurations. (id: BareMetalAdminNodeAccessConfig)
nodeConfig	object	Workload node configuration. (id: BareMetalAdminWorkloadNodeConfig)
osEnvironmentConfig	object	OS environment related configurations. (id: BareMetalAdminOsEnvironmentConfig)
proxy	object	Proxy configuration. (id: BareMetalAdminProxyConfig)
reconciling	boolean	Output only. If set, there are currently changes in flight to the bare metal Admin Cluster.
securityConfig	object	Security related configuration. (id: BareMetalAdminSecurityConfig)
state	string	Output only. The current state of the bare metal admin cluster.
status	object	Output only. ResourceStatus representing detailed cluster status. (id: ResourceStatus)
storage	object	Storage configuration. (id: BareMetalAdminStorageConfig)
uid	string	Output only. The unique identifier of the bare metal admin cluster.
updateTime	string (google-datetime)	Output only. The time at which this bare metal admin cluster was last updated.
validationCheck	object	Output only. ValidationCheck representing the result of the preflight check. (id: ValidationCheck)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_bare_metal_admin_clusters_get	select	projectsId, locationsId, bareMetalAdminClustersId	view, allowMissing	Gets details of a single bare metal admin cluster.
projects_locations_bare_metal_admin_clusters_list	select	projectsId, locationsId	pageSize, pageToken, view, allowMissing	Lists bare metal admin clusters in a given project and location.
projects_locations_bare_metal_admin_clusters_create	insert	projectsId, locationsId	bareMetalAdminClusterId, validateOnly, allowPreflightFailure	Creates a new bare metal admin cluster in a given project and location. The API needs to be combined with creating a bootstrap cluster to work. See: https://cloud.google.com/anthos/clusters/docs/bare-metal/latest/installing/creating-clusters/create-admin-cluster-api#prepare_bootstrap_environment
projects_locations_bare_metal_admin_clusters_patch	update	projectsId, locationsId, bareMetalAdminClustersId	updateMask, validateOnly	Updates the parameters of a single bare metal admin cluster.
projects_locations_bare_metal_admin_clusters_enroll	exec	projectsId, locationsId		Enrolls an existing bare metal 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_bare_metal_admin_clusters_unenroll	exec	projectsId, locationsId, bareMetalAdminClustersId	etag, allowMissing, validateOnly, ignoreErrors	Unenrolls an existing bare metal 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.
projects_locations_bare_metal_admin_clusters_query_version_config	exec	projectsId, locationsId	upgradeConfig.clusterName	Queries the bare metal admin 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
bareMetalAdminClustersId	string
locationsId	string
projectsId	string
allowMissing	boolean
allowPreflightFailure	boolean
bareMetalAdminClusterId	string
etag	string
ignoreErrors	boolean
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)
upgradeConfig.clusterName	string
validateOnly	boolean
view	string

SELECT examples

projects_locations_bare_metal_admin_clusters_get

Gets details of a single bare metal admin cluster.

SELECT
name,
annotations,
bareMetalVersion,
binaryAuthorization,
clusterOperations,
controlPlane,
createTime,
deleteTime,
description,
endpoint,
etag,
fleet,
loadBalancer,
localName,
maintenanceConfig,
maintenanceStatus,
networkConfig,
nodeAccessConfig,
nodeConfig,
osEnvironmentConfig,
proxy,
reconciling,
securityConfig,
state,
status,
storage,
uid,
updateTime,
validationCheck
FROM google.gkeonprem.bare_metal_admin_clusters
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND bareMetalAdminClustersId = '{{ bareMetalAdminClustersId }}' -- required
AND view = '{{ view }}'
AND allowMissing = '{{ allowMissing }}';

projects_locations_bare_metal_admin_clusters_list

Lists bare metal admin clusters in a given project and location.

SELECT
name,
annotations,
bareMetalVersion,
binaryAuthorization,
clusterOperations,
controlPlane,
createTime,
deleteTime,
description,
endpoint,
etag,
fleet,
loadBalancer,
localName,
maintenanceConfig,
maintenanceStatus,
networkConfig,
nodeAccessConfig,
nodeConfig,
osEnvironmentConfig,
proxy,
reconciling,
securityConfig,
state,
status,
storage,
uid,
updateTime,
validationCheck
FROM google.gkeonprem.bare_metal_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_bare_metal_admin_clusters_create

Creates a new bare metal admin cluster in a given project and location. The API needs to be combined with creating a bootstrap cluster to work. See: https://cloud.google.com/anthos/clusters/docs/bare-metal/latest/installing/creating-clusters/create-admin-cluster-api#prepare_bootstrap_environment

INSERT INTO google.gkeonprem.bare_metal_admin_clusters (
data__name,
data__description,
data__bareMetalVersion,
data__etag,
data__annotations,
data__networkConfig,
data__controlPlane,
data__loadBalancer,
data__storage,
data__clusterOperations,
data__maintenanceConfig,
data__nodeConfig,
data__proxy,
data__securityConfig,
data__nodeAccessConfig,
data__osEnvironmentConfig,
data__binaryAuthorization,
projectsId,
locationsId,
bareMetalAdminClusterId,
validateOnly,
allowPreflightFailure
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ bareMetalVersion }}',
'{{ etag }}',
'{{ annotations }}',
'{{ networkConfig }}',
'{{ controlPlane }}',
'{{ loadBalancer }}',
'{{ storage }}',
'{{ clusterOperations }}',
'{{ maintenanceConfig }}',
'{{ nodeConfig }}',
'{{ proxy }}',
'{{ securityConfig }}',
'{{ nodeAccessConfig }}',
'{{ osEnvironmentConfig }}',
'{{ binaryAuthorization }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ bareMetalAdminClusterId }}',
'{{ validateOnly }}',
'{{ allowPreflightFailure }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: bare_metal_admin_clusters
  props:
    - name: projectsId
      value: string
      description: Required parameter for the bare_metal_admin_clusters resource.
    - name: locationsId
      value: string
      description: Required parameter for the bare_metal_admin_clusters resource.
    - name: name
      value: string
      description: >
        Immutable. The bare metal admin cluster resource name.
        
    - name: description
      value: string
      description: >
        A human readable description of this bare metal admin cluster.
        
    - name: bareMetalVersion
      value: string
      description: >
        The Anthos clusters on bare metal version for the bare metal 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 bare metal 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: networkConfig
      value: object
      description: >
        Network configuration.
        
    - name: controlPlane
      value: object
      description: >
        Control plane configuration.
        
    - name: loadBalancer
      value: object
      description: >
        Load balancer configuration.
        
    - name: storage
      value: object
      description: >
        Storage configuration.
        
    - name: clusterOperations
      value: object
      description: >
        Cluster operations configuration.
        
    - name: maintenanceConfig
      value: object
      description: >
        Maintenance configuration.
        
    - name: nodeConfig
      value: object
      description: >
        Workload node configuration.
        
    - name: proxy
      value: object
      description: >
        Proxy configuration.
        
    - name: securityConfig
      value: object
      description: >
        Security related configuration.
        
    - name: nodeAccessConfig
      value: object
      description: >
        Node access related configurations.
        
    - name: osEnvironmentConfig
      value: object
      description: >
        OS environment related configurations.
        
    - name: binaryAuthorization
      value: object
      description: >
        Binary Authorization related configurations.
        
    - name: bareMetalAdminClusterId
      value: string
    - name: validateOnly
      value: boolean
    - name: allowPreflightFailure
      value: boolean

UPDATE examples

projects_locations_bare_metal_admin_clusters_patch

Updates the parameters of a single bare metal admin cluster.

UPDATE google.gkeonprem.bare_metal_admin_clusters
SET 
data__name = '{{ name }}',
data__description = '{{ description }}',
data__bareMetalVersion = '{{ bareMetalVersion }}',
data__etag = '{{ etag }}',
data__annotations = '{{ annotations }}',
data__networkConfig = '{{ networkConfig }}',
data__controlPlane = '{{ controlPlane }}',
data__loadBalancer = '{{ loadBalancer }}',
data__storage = '{{ storage }}',
data__clusterOperations = '{{ clusterOperations }}',
data__maintenanceConfig = '{{ maintenanceConfig }}',
data__nodeConfig = '{{ nodeConfig }}',
data__proxy = '{{ proxy }}',
data__securityConfig = '{{ securityConfig }}',
data__nodeAccessConfig = '{{ nodeAccessConfig }}',
data__osEnvironmentConfig = '{{ osEnvironmentConfig }}',
data__binaryAuthorization = '{{ binaryAuthorization }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND bareMetalAdminClustersId = '{{ bareMetalAdminClustersId }}' --required
AND updateMask = '{{ updateMask}}'
AND validateOnly = {{ validateOnly}}
RETURNING
name,
done,
error,
metadata,
response;

Lifecycle Methods

projects_locations_bare_metal_admin_clusters_enroll

Enrolls an existing bare metal 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.bare_metal_admin_clusters.projects_locations_bare_metal_admin_clusters_enroll 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required 
@@json=
'{
"bareMetalAdminClusterId": "{{ bareMetalAdminClusterId }}", 
"membership": "{{ membership }}"
}';

projects_locations_bare_metal_admin_clusters_unenroll

Unenrolls an existing bare metal 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.bare_metal_admin_clusters.projects_locations_bare_metal_admin_clusters_unenroll 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@bareMetalAdminClustersId='{{ bareMetalAdminClustersId }}' --required, 
@etag='{{ etag }}', 
@allowMissing={{ allowMissing }}, 
@validateOnly={{ validateOnly }}, 
@ignoreErrors={{ ignoreErrors }};

projects_locations_bare_metal_admin_clusters_query_version_config

Queries the bare metal admin cluster version config.

EXEC google.gkeonprem.bare_metal_admin_clusters.projects_locations_bare_metal_admin_clusters_query_version_config 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@upgradeConfig.clusterName='{{ upgradeConfig.clusterName }}';