Post v1+parentbaremetaladminclusters — gkeonprem

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1331159174.5 KB

projects

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

post/v1/{+parent}/bareMetalAdminClusters

Path parameters

parentstring required

Required. The parent of the project and location where the cluster is created in. Format: "projects/{project}/locations/{location}"

Query parameters

allowPreflightFailureboolean

Optional. If set to true, CLM will force CCFE to persist the cluster resource in RMS when the creation fails during standalone preflight checks. In that case the subsequent create call will fail with "cluster already exists" error and hence a update cluster is required to fix the cluster.

bareMetalAdminClusterIdstring

Required. User provided identifier that is used as part of the resource name; must conform to RFC-1034 and additionally restrict to lower-cased letters. This comes out roughly to: /^a-z+[a-z0-9]$/

validateOnlyboolean

Validate the request without actually doing any updates.

Request body

deleteTimestring 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

createTimestring google-datetime

Output only. The time at which this bare metal admin cluster was created.

namestring

Immutable. The bare metal admin cluster resource name.

annotationsobject

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.

localNamestring

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.

bareMetalVersionstring

The Anthos clusters on bare metal version for the bare metal admin cluster.

Output only. The current state of the bare metal admin cluster.

endpointstring

Output only. The IP address name of bare metal admin cluster's API server.

updateTimestring google-datetime

Output only. The time at which this bare metal admin cluster was last updated.

etagstring

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.

reconcilingboolean

Output only. If set, there are currently changes in flight to the bare metal Admin Cluster.

descriptionstring

A human readable description of this bare metal admin cluster.

uidstring

Output only. The unique identifier of the bare metal admin cluster.

Response

Successful response