Immutable Infrastructure

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

Description
MachineInventoryPool is the Schema for the machineinventorypools 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

MachineInventoryPoolSpec declares which MachineInventory objects may back a particular KubeadmControlPlane / MachineDeployment. See design.md §“MachineInventoryPool”.

statusobject

MachineInventoryPoolStatus summarises pool capacity from the provider's allocation annotations plus the upstream MachineInventory.status.plan.

.spec

Description
MachineInventoryPoolSpec declares which MachineInventory objects may back a particular KubeadmControlPlane / MachineDeployment. See design.md §“MachineInventoryPool”.
Type
object
Required
clusterNamemachineInventories
PropertyTypeDescription
clusterNamestring

ClusterName binds this pool to a specific Cluster. A MachineInventory referenced here must not belong to another active pool.

machineInventoriesarray

MachineInventories enumerates the MachineInventory names allowed to back BaremetalMachines that reference this pool.

.spec.machineInventories

Description
MachineInventories enumerates the MachineInventory names allowed to back BaremetalMachines that reference this pool.
Type
array

.spec.machineInventories[]

Description
PoolInventoryRef references a MachineInventory and optionally overrides the hostname used when reprovisioning it.
Type
object
Required
name
PropertyTypeDescription
hostnamestring

Hostname is used as the node hostname when this inventory is selected. When empty, the MachineInventory name is used.

namestring

.status

Description
MachineInventoryPoolStatus summarises pool capacity from the provider's allocation annotations plus the upstream MachineInventory.status.plan.
Type
object
PropertyTypeDescription
allocatedinteger
availableinteger
conditionsarray
preparinginteger
reprovisioninginteger
totalinteger
unavailableinteger

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

API Endpoints

The following API endpoints are available:

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

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

HTTP method
DELETE
Description
delete collection of MachineInventoryPool
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
list objects of kind MachineInventoryPool
HTTP responses
HTTP codeResponse body
200 - OKMachineInventoryPoolList schema
401 - UnauthorizedEmpty
HTTP method
POST
Description
create a new MachineInventoryPool
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
bodyMachineInventoryPool schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKMachineInventoryPool schema
201 - CreatedMachineInventoryPool schema
202 - AcceptedMachineInventoryPool schema
401 - UnauthorizedEmpty

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

HTTP method
DELETE
Description
delete the specified MachineInventoryPool
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 MachineInventoryPool
HTTP responses
HTTP codeResponse body
200 - OKMachineInventoryPool schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update the specified MachineInventoryPool
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 - OKMachineInventoryPool schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace the specified MachineInventoryPool
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
bodyMachineInventoryPool schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKMachineInventoryPool schema
201 - CreatedMachineInventoryPool schema
401 - UnauthorizedEmpty

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

HTTP method
GET
Description
read status of the specified MachineInventoryPool
HTTP responses
HTTP codeResponse body
200 - OKMachineInventoryPool schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update status of the specified MachineInventoryPool
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 - OKMachineInventoryPool schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace status of the specified MachineInventoryPool
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
bodyMachineInventoryPool schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKMachineInventoryPool schema
201 - CreatedMachineInventoryPool schema
401 - UnauthorizedEmpty