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

Name	Datatype	Description
name	string	Immutable. The bare metal admin cluster resource name.
description	string	A human readable description of this bare metal admin cluster.
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	Configuration for Binary Authorization.
clusterOperations	object	BareMetalAdminClusterOperationsConfig specifies the admin cluster's observability infrastructure.
controlPlane	object	BareMetalAdminControlPlaneConfig specifies the control plane configuration.
createTime	string	Output only. The time at which this bare metal admin cluster was created.
deleteTime	string	Output only. The time at which this bare metal admin cluster was deleted. If the resource is not deleted, this must be empty
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	Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems. See Anthos Fleets for more details on Anthos multi-cluster capabilities using Fleets. ##
loadBalancer	object	BareMetalAdminLoadBalancerConfig specifies the load balancer configuration.
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	BareMetalAdminMaintenanceConfig specifies configurations to put bare metal Admin cluster CRs nodes in and out of maintenance.
maintenanceStatus	object	BareMetalAdminMaintenanceStatus represents the maintenance status for bare metal Admin cluster CR's nodes.
networkConfig	object	BareMetalAdminNetworkConfig specifies the cluster network configuration.
nodeAccessConfig	object	Specifies the node access related settings for the bare metal admin cluster.
nodeConfig	object	BareMetalAdminWorkloadNodeConfig specifies the workload node configurations.
osEnvironmentConfig	object	Specifies operating system operation settings for cluster provisioning.
proxy	object	BareMetalAdminProxyConfig specifies the cluster proxy configuration.
reconciling	boolean	Output only. If set, there are currently changes in flight to the bare metal Admin Cluster.
securityConfig	object	Specifies the security related settings for the bare metal admin cluster.
state	string	Output only. The current state of the bare metal admin cluster.
status	object	ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED).
storage	object	BareMetalAdminStorageConfig specifies the cluster storage configuration.
uid	string	Output only. The unique identifier of the bare metal admin cluster.
updateTime	string	Output only. The time at which this bare metal admin cluster was last updated.
validationCheck	object	ValidationCheck represents the result of preflight check.

Methods

Name	Accessible by	Required Params	Description
projects_locations_bare_metal_admin_clusters_get	SELECT	bareMetalAdminClustersId, locationsId, projectsId	Gets details of a single bare metal admin cluster.
projects_locations_bare_metal_admin_clusters_list	SELECT	locationsId, projectsId	Lists bare metal admin clusters in a given project and location.
projects_locations_bare_metal_admin_clusters_create	INSERT	locationsId, projectsId	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	bareMetalAdminClustersId, locationsId, projectsId	Updates the parameters of a single bare metal admin cluster.
projects_locations_bare_metal_admin_clusters_enroll	EXEC	locationsId, projectsId	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_query_version_config	EXEC	locationsId, projectsId	Queries the bare metal admin cluster version config.
projects_locations_bare_metal_admin_clusters_unenroll	EXEC	bareMetalAdminClustersId, locationsId, projectsId	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.

SELECT examples

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

SELECT
name,
description,
annotations,
bareMetalVersion,
binaryAuthorization,
clusterOperations,
controlPlane,
createTime,
deleteTime,
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 locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO google.gkeonprem.bare_metal_admin_clusters (
locationsId,
projectsId,
name,
description,
bareMetalVersion,
etag,
annotations,
networkConfig,
controlPlane,
loadBalancer,
storage,
clusterOperations,
maintenanceConfig,
nodeConfig,
proxy,
securityConfig,
nodeAccessConfig,
osEnvironmentConfig,
binaryAuthorization
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ description }}',
'{{ bareMetalVersion }}',
'{{ etag }}',
'{{ annotations }}',
'{{ networkConfig }}',
'{{ controlPlane }}',
'{{ loadBalancer }}',
'{{ storage }}',
'{{ clusterOperations }}',
'{{ maintenanceConfig }}',
'{{ nodeConfig }}',
'{{ proxy }}',
'{{ securityConfig }}',
'{{ nodeAccessConfig }}',
'{{ osEnvironmentConfig }}',
'{{ binaryAuthorization }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: description
      value: string
    - name: uid
      value: string
    - name: bareMetalVersion
      value: string
    - name: state
      value: string
    - name: endpoint
      value: string
    - name: reconciling
      value: boolean
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: deleteTime
      value: string
    - name: localName
      value: string
    - name: etag
      value: string
    - name: annotations
      value: object
    - name: networkConfig
      value:
        - name: islandModeCidr
          value:
            - name: serviceAddressCidrBlocks
              value:
                - string
            - name: podAddressCidrBlocks
              value:
                - string
    - name: controlPlane
      value:
        - name: controlPlaneNodePoolConfig
          value:
            - 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: apiServerArgs
          value:
            - - name: argument
                value: string
              - name: value
                value: string
    - name: loadBalancer
      value:
        - name: vipConfig
          value:
            - name: controlPlaneVip
              value: string
        - name: portConfig
          value:
            - name: controlPlaneLoadBalancerPort
              value: integer
        - name: manualLbConfig
          value:
            - name: enabled
              value: boolean
    - name: storage
      value:
        - name: lvpShareConfig
          value:
            - name: lvpConfig
              value:
                - name: path
                  value: string
                - name: storageClass
                  value: string
            - name: sharedPathPvCount
              value: integer
    - name: fleet
      value:
        - name: membership
          value: string
    - name: clusterOperations
      value:
        - name: enableApplicationLogs
          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: maintenanceConfig
      value:
        - name: maintenanceAddressCidrBlocks
          value:
            - string
    - name: maintenanceStatus
      value:
        - name: machineDrainStatus
          value:
            - name: drainingMachines
              value:
                - - name: nodeIp
                    value: string
                  - name: podCount
                    value: integer
            - name: drainedMachines
              value:
                - - name: nodeIp
                    value: string
    - name: validationCheck
      value:
        - name: option
          value: string
        - name: status
          value:
            - name: result
              value:
                - - name: state
                    value: string
                  - name: description
                    value: string
                  - name: category
                    value: string
                  - name: reason
                    value: string
                  - name: details
                    value: string
        - name: scenario
          value: string
    - name: nodeConfig
      value:
        - name: maxPodsPerNode
          value: string
    - name: proxy
      value:
        - name: uri
          value: string
        - name: noProxy
          value:
            - string
    - name: securityConfig
      value:
        - name: authorization
          value:
            - name: adminUsers
              value:
                - - name: username
                    value: string
    - name: nodeAccessConfig
      value:
        - name: loginUser
          value: string
    - name: osEnvironmentConfig
      value:
        - name: packageRepoExcluded
          value: boolean
    - name: binaryAuthorization
      value:
        - name: evaluationMode
          value: string

UPDATE example

Updates a bare_metal_admin_clusters resource.

/*+ update */
UPDATE google.gkeonprem.bare_metal_admin_clusters
SET 
name = '{{ name }}',
description = '{{ description }}',
bareMetalVersion = '{{ bareMetalVersion }}',
etag = '{{ etag }}',
annotations = '{{ annotations }}',
networkConfig = '{{ networkConfig }}',
controlPlane = '{{ controlPlane }}',
loadBalancer = '{{ loadBalancer }}',
storage = '{{ storage }}',
clusterOperations = '{{ clusterOperations }}',
maintenanceConfig = '{{ maintenanceConfig }}',
nodeConfig = '{{ nodeConfig }}',
proxy = '{{ proxy }}',
securityConfig = '{{ securityConfig }}',
nodeAccessConfig = '{{ nodeAccessConfig }}',
osEnvironmentConfig = '{{ osEnvironmentConfig }}',
binaryAuthorization = '{{ binaryAuthorization }}'
WHERE 
bareMetalAdminClustersId = '{{ bareMetalAdminClustersId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';