MachineRegistration [elemental.cattle.io/v1beta1]

MachineRegistration is owned by elemental-operator and is created once per workload cluster. The bare-metal provider does not mutate it, but operators must author it because its config block is baked into the registration ISO and replayed by elemental-register on first boot — it carries the registration URL, MachineInventoryLabels, and the cloud-init that turns a freshly imaged host into a usable MachineInventory.

Type: object

Specification

Property	Type	Description
`apiVersion`	`string`	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
`kind`	`string`	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
`metadata`	`ObjectMeta`	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
`spec`	`object`
`status`	`object`

.spec

Type: object

Property	Type	Description
`config`	`object`	Config the cloud config that will be used to provision the node.
`machineInventoryAnnotations`	`object`	MachineInventoryAnnotations annotations to be added to the created MachineInventory object.
`machineInventoryLabels`	`object`	MachineInventoryLabels label to be added to the created MachineInventory object.
`machineName`	`string`

.spec.config

Description: Config the cloud config that will be used to provision the node.
Type: object

Property	Type	Description
`cloud-config`
`elemental`	`object`
`network`	`object`	NetworkTemplate contains a map of IPAddressPools and a schemaless network config template.

.spec.config.elemental

Type: object

Property	Type	Description
`install`	`object`
`registration`	`object`
`reset`	`object`
`system-agent`	`object`

.spec.config.elemental.install

Type: object

Property	Type	Description
`config-dir`	`string`
`config-urls`	`array`
`debug`	`boolean`
`device`	`string`
`device-selector`	`array`
`disable-boot-entry`	`boolean`
`eject-cd`	`boolean`
`firmware`	`string`
`iso`	`string`
`no-format`	`boolean`
`poweroff`	`boolean`
`reboot`	`boolean`
`snapshotter`	`object`
`system-uri`	`string`
`tty`	`string`

.spec.config.elemental.install.config-urls

Type: array

.spec.config.elemental.install.config-urls[]

Type: string

.spec.config.elemental.install.device-selector

Type: array

.spec.config.elemental.install.device-selector[]

Type: object
Required: keyoperator

Property	Type	Description
`key`	`string`
`operator`	`string`
`values`	`array`

.spec.config.elemental.install.device-selector[].values

Type: array

.spec.config.elemental.install.device-selector[].values[]

Type: string

.spec.config.elemental.install.snapshotter

Type: object

Property	Type	Description
`maxSnaps`	`integer`	MaxSnaps sets the maximum amount of snapshots to keep
`type`	`string`	Type sets the snapshotter type for a new installation, available options are 'loopdevice' and 'btrfs'

.spec.config.elemental.registration

Type: object

Property	Type	Description
`auth`	`string`
`ca-cert`	`string`
`emulate-tpm`	`boolean`
`emulated-tpm-seed`	`integer`
`no-smbios`	`boolean`
`no-toolkit`	`boolean`
`url`	`string`

.spec.config.elemental.reset

Type: object

Property	Type	Description
`config-urls`	`array`
`debug`	`boolean`
`disable-boot-entry`	`boolean`
`enabled`	`boolean`
`poweroff`	`boolean`
`reboot`	`boolean`
`reset-oem`	`boolean`
`reset-persistent`	`boolean`
`system-uri`	`string`

.spec.config.elemental.reset.config-urls

Type: array

.spec.config.elemental.reset.config-urls[]

Type: string

.spec.config.elemental.system-agent

Type: object

Property	Type	Description
`secret-name`	`string`
`secret-namespace`	`string`
`strictTLSMode`	`boolean`
`token`	`string`
`url`	`string`

.spec.config.network

Description: NetworkTemplate contains a map of IPAddressPools and a schemaless network config template.
Type: object

Property	Type	Description
`config`		Config contains the network config template (nmc, nmstate, or nmconnections formats)
`configurator`	`string`	Configurator
`ipAddresses`	`object`	IPAddresses contains a map of IPPools references

.spec.config.network.ipAddresses

Description: IPAddresses contains a map of IPPools references
Type: object

.spec.machineInventoryAnnotations

Description: MachineInventoryAnnotations annotations to be added to the created MachineInventory object.
Type: object

.spec.machineInventoryLabels

Description: MachineInventoryLabels label to be added to the created MachineInventory object.
Type: object

.status

Type: object

Property	Type	Description
`conditions`	`array`	Conditions describe the state of the machine registration object.
`registrationToken`	`string`	RegistrationToken a token for registering a machine.
`registrationURL`	`string`	RegistrationURL is the URL for registering a new machine.
`serviceAccountRef`	`object`	ServiceAccountRef a reference to the service account created by the machine registration.

.status.conditions

Description: Conditions describe the state of the machine registration object.
Type: array

.status.conditions[]

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

Property	Type	Description
`lastTransitionTime`	`string`	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.
`message`	`string`	message is a human readable message indicating details about the transition. This may be an empty string.
`observedGeneration`	`integer`	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.
`reason`	`string`	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.
`status`	`string`	status of the condition, one of True, False, Unknown.
`type`	`string`	type of condition in CamelCase or in foo.example.com/CamelCase.

.status.serviceAccountRef

Description: ServiceAccountRef a reference to the service account created by the machine registration.
Type: object

Property	Type	Description
`apiVersion`	`string`	API version of the referent.
`fieldPath`	`string`	If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
`kind`	`string`	Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`name`	`string`	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
`namespace`	`string`	Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
`resourceVersion`	`string`	Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
`uid`	`string`	UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

API Endpoints

The following API endpoints are available:

/apis/elemental.cattle.io/v1beta1/namespaces/{namespace}/machineregistrations
- DELETE: delete collection of MachineRegistration
- GET: list objects of kind MachineRegistration
- POST: create a new MachineRegistration
/apis/elemental.cattle.io/v1beta1/namespaces/{namespace}/machineregistrations/{name}
- DELETE: delete the specified MachineRegistration
- GET: read the specified MachineRegistration
- PATCH: partially update the specified MachineRegistration
- PUT: replace the specified MachineRegistration
/apis/elemental.cattle.io/v1beta1/namespaces/{namespace}/machineregistrations/{name}/status
- GET: read status of the specified MachineRegistration
- PATCH: partially update status of the specified MachineRegistration
- PUT: replace status of the specified MachineRegistration

/apis/elemental.cattle.io/v1beta1/namespaces/{namespace}/machineregistrations

HTTP method: DELETE
Description: delete collection of MachineRegistration
HTTP responses

HTTP code	Response body
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: list objects of kind MachineRegistration
HTTP responses

HTTP code	Response body
200 - OK	`MachineRegistrationList` schema
401 - Unauthorized	Empty

HTTP method: POST
Description: create a new MachineRegistration

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When 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
`fieldValidation`	`string`	fieldValidation 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

Parameter	Type	Description
`body`	`MachineRegistration` schema	`application/json` formatted

HTTP responses

HTTP code	Response body
200 - OK	`MachineRegistration` schema
201 - Created	`MachineRegistration` schema
202 - Accepted	`MachineRegistration` schema
401 - Unauthorized	Empty

/apis/elemental.cattle.io/v1beta1/namespaces/{namespace}/machineregistrations/{name}

HTTP method: DELETE
Description: delete the specified MachineRegistration

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When 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 code	Response body
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified MachineRegistration
HTTP responses

HTTP code	Response body
200 - OK	`MachineRegistration` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified MachineRegistration

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When 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
`fieldValidation`	`string`	fieldValidation 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 code	Response body
200 - OK	`MachineRegistration` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified MachineRegistration

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When 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
`fieldValidation`	`string`	fieldValidation 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

Parameter	Type	Description
`body`	`MachineRegistration` schema	`application/json` formatted

HTTP responses

HTTP code	Response body
200 - OK	`MachineRegistration` schema
201 - Created	`MachineRegistration` schema
401 - Unauthorized	Empty

/apis/elemental.cattle.io/v1beta1/namespaces/{namespace}/machineregistrations/{name}/status

HTTP method: GET
Description: read status of the specified MachineRegistration
HTTP responses

HTTP code	Response body
200 - OK	`MachineRegistration` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update status of the specified MachineRegistration

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When 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
`fieldValidation`	`string`	fieldValidation 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 code	Response body
200 - OK	`MachineRegistration` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace status of the specified MachineRegistration

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When 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
`fieldValidation`	`string`	fieldValidation 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

Parameter	Type	Description
`body`	`MachineRegistration` schema	`application/json` formatted

HTTP responses

HTTP code	Response body
200 - OK	`MachineRegistration` schema
201 - Created	`MachineRegistration` schema
401 - Unauthorized	Empty

#MachineRegistration [elemental.cattle.io/v1beta1]

Specification#

.spec#

.spec.config#

.spec.config.elemental#

.spec.config.elemental.install#

.spec.config.elemental.install.config-urls#

.spec.config.elemental.install.config-urls[]#

.spec.config.elemental.install.device-selector#

.spec.config.elemental.install.device-selector[]#

.spec.config.elemental.install.device-selector[].values#

.spec.config.elemental.install.device-selector[].values[]#

.spec.config.elemental.install.snapshotter#

.spec.config.elemental.registration#

.spec.config.elemental.reset#

.spec.config.elemental.reset.config-urls#

.spec.config.elemental.reset.config-urls[]#

.spec.config.elemental.system-agent#

.spec.config.network#

.spec.config.network.ipAddresses#

.spec.machineInventoryAnnotations#

.spec.machineInventoryLabels#

.status#

.status.conditions#

.status.conditions[]#

.status.serviceAccountRef#

API Endpoints#

/apis/elemental.cattle.io/v1beta1/namespaces/{namespace}/machineregistrations#

/apis/elemental.cattle.io/v1beta1/namespaces/{namespace}/machineregistrations/{name}#

/apis/elemental.cattle.io/v1beta1/namespaces/{namespace}/machineregistrations/{name}/status#