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

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	Output only. The time at which this bare metal node pool was created.
deleteTime	string	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	BareMetalNodePoolConfig describes the configuration of all nodes within a given bare metal node pool.
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	ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED).
uid	string	Output only. The unique identifier of the bare metal node pool.
updateTime	string	Output only. The time at which this bare metal node pool was last updated.
upgradePolicy	object	BareMetalNodePoolUpgradePolicy defines the node pool upgrade policy.

Methods

Name	Accessible by	Required Params	Description
projects_locations_bare_metal_clusters_bare_metal_node_pools_get	SELECT	bareMetalClustersId, bareMetalNodePoolsId, locationsId, projectsId	Gets details of a single bare metal node pool.
projects_locations_bare_metal_clusters_bare_metal_node_pools_list	SELECT	bareMetalClustersId, locationsId, projectsId	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	bareMetalClustersId, locationsId, projectsId	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_delete	DELETE	bareMetalClustersId, bareMetalNodePoolsId, locationsId, projectsId	Deletes a single bare metal node pool.
projects_locations_bare_metal_clusters_bare_metal_node_pools_patch	UPDATE	bareMetalClustersId, bareMetalNodePoolsId, locationsId, projectsId	Updates the parameters of a single bare metal node pool.
projects_locations_bare_metal_clusters_bare_metal_node_pools_enroll	EXEC	bareMetalClustersId, locationsId, projectsId	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	bareMetalClustersId, bareMetalNodePoolsId, locationsId, projectsId	Unenrolls a bare metal node pool from Anthos On-Prem API.

SELECT examples

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 bareMetalClustersId = '{{ bareMetalClustersId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new bare_metal_node_pools resource.

All Properties

/*+ create */
INSERT INTO google.gkeonprem.bare_metal_node_pools (
bareMetalClustersId,
locationsId,
projectsId,
name,
displayName,
etag,
annotations,
nodePoolConfig,
upgradePolicy
)
SELECT 
'{{ bareMetalClustersId }}',
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ displayName }}',
'{{ etag }}',
'{{ annotations }}',
'{{ nodePoolConfig }}',
'{{ upgradePolicy }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: displayName
      value: string
    - name: uid
      value: string
    - name: state
      value: string
    - name: reconciling
      value: boolean
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: deleteTime
      value: string
    - name: etag
      value: string
    - name: annotations
      value: object
    - name: nodePoolConfig
      value:
        - name: nodeConfigs
          value:
            - - name: nodeIp
                value: string
              - name: labels
                value: object
        - name: operatingSystem
          value: string
        - name: taints
          value:
            - - name: key
                value: string
              - name: value
                value: string
              - name: effect
                value: string
        - name: labels
          value: object
        - name: kubeletConfig
          value:
            - name: registryPullQps
              value: integer
            - name: registryBurst
              value: integer
            - name: serializeImagePullsDisabled
              value: boolean
    - name: status
      value:
        - name: errorMessage
          value: string
        - name: conditions
          value:
            - - name: type
                value: string
              - name: reason
                value: string
              - name: message
                value: string
              - name: lastTransitionTime
                value: string
              - name: state
                value: string
        - name: version
          value: string
        - name: versions
          value:
            - name: versions
              value:
                - - name: version
                    value: string
                  - name: count
                    value: string
    - name: upgradePolicy
      value:
        - name: parallelUpgradeConfig
          value:
            - name: concurrentNodes
              value: integer
            - name: minimumAvailableNodes
              value: integer

UPDATE example

Updates a bare_metal_node_pools resource.

/*+ update */
UPDATE google.gkeonprem.bare_metal_node_pools
SET 
name = '{{ name }}',
displayName = '{{ displayName }}',
etag = '{{ etag }}',
annotations = '{{ annotations }}',
nodePoolConfig = '{{ nodePoolConfig }}',
upgradePolicy = '{{ upgradePolicy }}'
WHERE 
bareMetalClustersId = '{{ bareMetalClustersId }}'
AND bareMetalNodePoolsId = '{{ bareMetalNodePoolsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified bare_metal_node_pools resource.

/*+ delete */
DELETE FROM google.gkeonprem.bare_metal_node_pools
WHERE bareMetalClustersId = '{{ bareMetalClustersId }}'
AND bareMetalNodePoolsId = '{{ bareMetalNodePoolsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';