Immutable Infrastructure

BaremetalMachine [infrastructure.cluster.x-k8s.io/v1beta1]

Description
BaremetalMachine is the Schema for the baremetalmachines API.
Type
object

Specification

PropertyTypeDescription
apiVersionstring

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kindstring

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadataObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

specobject

BaremetalMachineSpec follows design-doc/api/resource-model.md §8. Role / version / upgrade image deliberately absent: role is inferred from the owning KubeadmControlPlane / MachineDeployment, version comes from the owner Machine, and the elemental upgrade image is resolved at reprovision time via the provider image catalog.

statusobject

BaremetalMachineStatus tracks provider-internal allocation and the reprovision pipeline.

.spec

Description
BaremetalMachineSpec follows design-doc/api/resource-model.md §8. Role / version / upgrade image deliberately absent: role is inferred from the owning KubeadmControlPlane / MachineDeployment, version comes from the owner Machine, and the elemental upgrade image is resolved at reprovision time via the provider image catalog.
Type
object
Required
machineInventoryPoolRef
PropertyTypeDescription
machineInventoryPoolRefobject

MachineInventoryPoolRef pins which pool this machine draws from. The field is immutable once set (see webhook).

providerIDstring

ProviderID is the CAPI contract field populated once the node is bound to a MachineInventory. Format: baremetal:///

.spec.machineInventoryPoolRef

Description
MachineInventoryPoolRef pins which pool this machine draws from. The field is immutable once set (see webhook).
Type
object
Required
name
PropertyTypeDescription
namestring

.status

Description
BaremetalMachineStatus tracks provider-internal allocation and the reprovision pipeline.
Type
object
PropertyTypeDescription
addressesarray

Addresses surfaces addresses reported by the MachineInventory (Phase 1: unused).

conditionsarray
failureMessagestring

FailureMessage is a CAPI-contract human-readable message.

failureReasonstring

FailureReason is a CAPI-contract terse reason for a terminal failure.

lastAppliedBootstrapHashstring

LastAppliedBootstrapHash tracks the sha256 of the bootstrap user-data that was last rendered into a reprovision plan. It prevents redundant patches.

lastAppliedPlanChecksumstring

LastAppliedPlanChecksum tracks the sha256 of the last plan body we wrote, used to detect Applied/Failed transitions from MachineInventory.status.plan.

machineInventoryRefobject

MachineInventoryRef is the inventory selected from the pool.

phasestring

Phase is the coarse state; see BaremetalMachinePhase constants.

planSecretRefobject

PlanSecretRef is the elemental plan secret currently driven by the provider.

readyboolean

Ready indicates CAPI-contract readiness (node joined and healthy).

.status.addresses

Description
Addresses surfaces addresses reported by the MachineInventory (Phase 1: unused).
Type
array

.status.addresses[]

Description
NodeAddress contains information for the node's address.
Type
object
Required
addresstype
PropertyTypeDescription
addressstring

The node address.

typestring

Node address type, one of Hostname, ExternalIP or InternalIP.

.status.conditions

Type
array

.status.conditions[]

Description
Condition contains details for one aspect of the current state of this API Resource.
Type
object
Required
lastTransitionTimemessagereasonstatustype
PropertyTypeDescription
lastTransitionTimestring

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

messagestring

message is a human readable message indicating details about the transition. This may be an empty string.

observedGenerationinteger

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

reasonstring

reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

statusstring

status of the condition, one of True, False, Unknown.

typestring

type of condition in CamelCase or in foo.example.com/CamelCase.

.status.machineInventoryRef

Description
MachineInventoryRef is the inventory selected from the pool.
Type
object
Required
name
PropertyTypeDescription
namestring

.status.planSecretRef

Description
PlanSecretRef is the elemental plan secret currently driven by the provider.
Type
object
Required
name
PropertyTypeDescription
namestring

API Endpoints

The following API endpoints are available:

  • /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/baremetalmachines
    • DELETE: delete collection of BaremetalMachine
    • GET: list objects of kind BaremetalMachine
    • POST: create a new BaremetalMachine
  • /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/baremetalmachines/{name}
    • DELETE: delete the specified BaremetalMachine
    • GET: read the specified BaremetalMachine
    • PATCH: partially update the specified BaremetalMachine
    • PUT: replace the specified BaremetalMachine
  • /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/baremetalmachines/{name}/status
    • GET: read status of the specified BaremetalMachine
    • PATCH: partially update status of the specified BaremetalMachine
    • PUT: replace status of the specified BaremetalMachine

/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/baremetalmachines

HTTP method
DELETE
Description
delete collection of BaremetalMachine
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
list objects of kind BaremetalMachine
HTTP responses
HTTP codeResponse body
200 - OKBaremetalMachineList schema
401 - UnauthorizedEmpty
HTTP method
POST
Description
create a new BaremetalMachine
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyBaremetalMachine schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKBaremetalMachine schema
201 - CreatedBaremetalMachine schema
202 - AcceptedBaremetalMachine schema
401 - UnauthorizedEmpty

/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/baremetalmachines/{name}

HTTP method
DELETE
Description
delete the specified BaremetalMachine
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
read the specified BaremetalMachine
HTTP responses
HTTP codeResponse body
200 - OKBaremetalMachine schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update the specified BaremetalMachine
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
HTTP responses
HTTP codeResponse body
200 - OKBaremetalMachine schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace the specified BaremetalMachine
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyBaremetalMachine schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKBaremetalMachine schema
201 - CreatedBaremetalMachine schema
401 - UnauthorizedEmpty

/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/baremetalmachines/{name}/status

HTTP method
GET
Description
read status of the specified BaremetalMachine
HTTP responses
HTTP codeResponse body
200 - OKBaremetalMachine schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update status of the specified BaremetalMachine
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
HTTP responses
HTTP codeResponse body
200 - OKBaremetalMachine schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace status of the specified BaremetalMachine
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyBaremetalMachine schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKBaremetalMachine schema
201 - CreatedBaremetalMachine schema
401 - UnauthorizedEmpty