bare_metal_node_pools

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

Overview

Name	bare_metal_node_pools
Type	Resource
Id	google.gkeonprem.bare_metal_node_pools

Fields

The following fields are returned by SELECT queries:

projects_locations_bare_metal_clusters_bare_metal_node_pools_get

Successful response

Name	Datatype	Description
name	string	Immutable. The bare metal node pool resource name.
annotations	object	Annotations on the bare metal node pool. 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.
createTime	string (google-datetime)	Output only. The time at which this bare metal node pool was created.
deleteTime	string (google-datetime)	Output only. The time at which this bare metal node pool was deleted. If the resource is not deleted, this must be empty
displayName	string	The display name for the bare metal node pool.
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.
nodePoolConfig	object	Required. Node pool configuration. (id: BareMetalNodePoolConfig)
reconciling	boolean	Output only. If set, there are currently changes in flight to the bare metal node pool.
state	string	Output only. The current state of the bare metal node pool.
status	object	Output only. ResourceStatus representing the detailed node pool status. (id: ResourceStatus)
uid	string	Output only. The unique identifier of the bare metal node pool.
updateTime	string (google-datetime)	Output only. The time at which this bare metal node pool was last updated.
upgradePolicy	object	The worker node pool upgrade policy. (id: BareMetalNodePoolUpgradePolicy)

projects_locations_bare_metal_clusters_bare_metal_node_pools_list

Successful response

Name	Datatype	Description
name	string	Immutable. The bare metal node pool resource name.
annotations	object	Annotations on the bare metal node pool. 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.
createTime	string (google-datetime)	Output only. The time at which this bare metal node pool was created.
deleteTime	string (google-datetime)	Output only. The time at which this bare metal node pool was deleted. If the resource is not deleted, this must be empty
displayName	string	The display name for the bare metal node pool.
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.
nodePoolConfig	object	Required. Node pool configuration. (id: BareMetalNodePoolConfig)
reconciling	boolean	Output only. If set, there are currently changes in flight to the bare metal node pool.
state	string	Output only. The current state of the bare metal node pool.
status	object	Output only. ResourceStatus representing the detailed node pool status. (id: ResourceStatus)
uid	string	Output only. The unique identifier of the bare metal node pool.
updateTime	string (google-datetime)	Output only. The time at which this bare metal node pool was last updated.
upgradePolicy	object	The worker node pool upgrade policy. (id: BareMetalNodePoolUpgradePolicy)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_bare_metal_clusters_bare_metal_node_pools_get	select	projectsId, locationsId, bareMetalClustersId, bareMetalNodePoolsId	view	Gets details of a single bare metal node pool.
projects_locations_bare_metal_clusters_bare_metal_node_pools_list	select	projectsId, locationsId, bareMetalClustersId	pageSize, pageToken, view	Lists bare metal node pools in a given project, location and bare metal cluster.
projects_locations_bare_metal_clusters_bare_metal_node_pools_create	insert	projectsId, locationsId, bareMetalClustersId	bareMetalNodePoolId, validateOnly	Creates a new bare metal node pool in a given project, location and Bare Metal cluster.
projects_locations_bare_metal_clusters_bare_metal_node_pools_patch	update	projectsId, locationsId, bareMetalClustersId, bareMetalNodePoolsId	updateMask, allowMissing, validateOnly	Updates the parameters of a single bare metal node pool.
projects_locations_bare_metal_clusters_bare_metal_node_pools_delete	delete	projectsId, locationsId, bareMetalClustersId, bareMetalNodePoolsId	etag, allowMissing, validateOnly, ignoreErrors	Deletes a single bare metal node pool.
projects_locations_bare_metal_clusters_bare_metal_node_pools_enroll	exec	projectsId, locationsId, bareMetalClustersId		Enrolls an existing bare metal node pool to the Anthos On-Prem API within a given project and location. Through enrollment, an existing node pool will become Anthos On-Prem API managed. The corresponding GCP resources will be created.
projects_locations_bare_metal_clusters_bare_metal_node_pools_unenroll	exec	projectsId, locationsId, bareMetalClustersId, bareMetalNodePoolsId	etag, allowMissing, validateOnly	Unenrolls a bare metal node pool from Anthos On-Prem API.

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
bareMetalClustersId	string
bareMetalNodePoolsId	string
locationsId	string
projectsId	string
allowMissing	boolean
bareMetalNodePoolId	string
etag	string
ignoreErrors	boolean
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)
validateOnly	boolean
view	string

SELECT examples

projects_locations_bare_metal_clusters_bare_metal_node_pools_get

Gets details of a single bare metal node pool.

SELECT
name,
annotations,
createTime,
deleteTime,
displayName,
etag,
nodePoolConfig,
reconciling,
state,
status,
uid,
updateTime,
upgradePolicy
FROM google.gkeonprem.bare_metal_node_pools
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND bareMetalClustersId = '{{ bareMetalClustersId }}' -- required
AND bareMetalNodePoolsId = '{{ bareMetalNodePoolsId }}' -- required
AND view = '{{ view }}';

projects_locations_bare_metal_clusters_bare_metal_node_pools_list

Lists bare metal node pools in a given project, location and bare metal cluster.

SELECT
name,
annotations,
createTime,
deleteTime,
displayName,
etag,
nodePoolConfig,
reconciling,
state,
status,
uid,
updateTime,
upgradePolicy
FROM google.gkeonprem.bare_metal_node_pools
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND bareMetalClustersId = '{{ bareMetalClustersId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND view = '{{ view }}';

INSERT examples

projects_locations_bare_metal_clusters_bare_metal_node_pools_create

Creates a new bare metal node pool in a given project, location and Bare Metal cluster.

INSERT INTO google.gkeonprem.bare_metal_node_pools (
data__name,
data__displayName,
data__etag,
data__annotations,
data__nodePoolConfig,
data__upgradePolicy,
projectsId,
locationsId,
bareMetalClustersId,
bareMetalNodePoolId,
validateOnly
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ etag }}',
'{{ annotations }}',
'{{ nodePoolConfig }}',
'{{ upgradePolicy }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ bareMetalClustersId }}',
'{{ bareMetalNodePoolId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: bare_metal_node_pools
  props:
    - name: projectsId
      value: string
      description: Required parameter for the bare_metal_node_pools resource.
    - name: locationsId
      value: string
      description: Required parameter for the bare_metal_node_pools resource.
    - name: bareMetalClustersId
      value: string
      description: Required parameter for the bare_metal_node_pools resource.
    - name: name
      value: string
      description: >
        Immutable. The bare metal node pool resource name.
        
    - name: displayName
      value: string
      description: >
        The display name for the bare metal node pool.
        
    - 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 node pool. 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: nodePoolConfig
      value: object
      description: >
        Required. Node pool configuration.
        
    - name: upgradePolicy
      value: object
      description: >
        The worker node pool upgrade policy.
        
    - name: bareMetalNodePoolId
      value: string
    - name: validateOnly
      value: boolean

UPDATE examples

projects_locations_bare_metal_clusters_bare_metal_node_pools_patch

Updates the parameters of a single bare metal node pool.

UPDATE google.gkeonprem.bare_metal_node_pools
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__etag = '{{ etag }}',
data__annotations = '{{ annotations }}',
data__nodePoolConfig = '{{ nodePoolConfig }}',
data__upgradePolicy = '{{ upgradePolicy }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND bareMetalClustersId = '{{ bareMetalClustersId }}' --required
AND bareMetalNodePoolsId = '{{ bareMetalNodePoolsId }}' --required
AND updateMask = '{{ updateMask}}'
AND allowMissing = {{ allowMissing}}
AND validateOnly = {{ validateOnly}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

projects_locations_bare_metal_clusters_bare_metal_node_pools_delete

Deletes a single bare metal node pool.

DELETE FROM google.gkeonprem.bare_metal_node_pools
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND bareMetalClustersId = '{{ bareMetalClustersId }}' --required
AND bareMetalNodePoolsId = '{{ bareMetalNodePoolsId }}' --required
AND etag = '{{ etag }}'
AND allowMissing = '{{ allowMissing }}'
AND validateOnly = '{{ validateOnly }}'
AND ignoreErrors = '{{ ignoreErrors }}';

Lifecycle Methods

projects_locations_bare_metal_clusters_bare_metal_node_pools_enroll

Enrolls an existing bare metal node pool to the Anthos On-Prem API within a given project and location. Through enrollment, an existing node pool will become Anthos On-Prem API managed. The corresponding GCP resources will be created.

EXEC google.gkeonprem.bare_metal_node_pools.projects_locations_bare_metal_clusters_bare_metal_node_pools_enroll 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@bareMetalClustersId='{{ bareMetalClustersId }}' --required 
@@json=
'{
"bareMetalNodePoolId": "{{ bareMetalNodePoolId }}", 
"validateOnly": {{ validateOnly }}
}';

projects_locations_bare_metal_clusters_bare_metal_node_pools_unenroll

Unenrolls a bare metal node pool from Anthos On-Prem API.

EXEC google.gkeonprem.bare_metal_node_pools.projects_locations_bare_metal_clusters_bare_metal_node_pools_unenroll 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@bareMetalClustersId='{{ bareMetalClustersId }}' --required, 
@bareMetalNodePoolsId='{{ bareMetalNodePoolsId }}' --required, 
@etag='{{ etag }}', 
@allowMissing={{ allowMissing }}, 
@validateOnly={{ validateOnly }};