Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1331159174.5 KB
projects

Creates a new bare metal cluster in a given project and location.

post/v1/{+parent}/bareMetalClusters

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.

bareMetalClusterIdstring

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

localNamestring

Output only. The object name of the bare metal user cluster custom resource on the associated admin cluster. 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 name 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. When the local name and cluster name differ, the local name is used in the admin cluster controller logs. You use the cluster name when accessing the cluster using bmctl and kubectl.

localNamespacestring

Output only. The namespace of the cluster.

bareMetalVersionstring

Required. The Anthos clusters on bare metal version for your user cluster.

namestring

Immutable. The bare metal user cluster resource name.

annotationsobject

Annotations on the bare metal user 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.

etagstring

Output only. 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.

state'STATE_UNSPECIFIED' | 'PROVISIONING' | 'RUNNING' | 'RECONCILING' | 'STOPPING' | 'ERROR' | 'DEGRADED'

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

adminClusterNamestring

Output only. The resource name of the bare metal admin cluster managing this user cluster.

endpointstring

Output only. The IP address of the bare metal user cluster's API server.

updateTimestring google-datetime

Output only. The time when the bare metal user cluster was last updated.

deleteTimestring google-datetime

Output only. The time when the bare metal user cluster was deleted. If the resource is not deleted, this must be empty

createTimestring google-datetime

Output only. The time when the bare metal user cluster was created.

descriptionstring

A human readable description of this bare metal user cluster.

uidstring

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

reconcilingboolean

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

adminClusterMembershipstring

Required. The admin cluster this bare metal user cluster belongs to. This is the full resource name of the admin cluster's fleet membership.

Response

Successful response