Skip to main content
Version: 1.4

MachineRegistration reference

The MachineRegistration resource is the responsible of defining a machine registration end point. Once created it generates a registration URL used by nodes to register so they are inventoried.

There are several keys that can be configured under a MachineRegistration resource spec.

MachineRegistration
apiVersion: elemental.cattle.io/v1beta1
kind: MachineRegistration
metadata:
name: my-nodes
namespace: fleet-default
spec:
machineName: name
machineInventoryLabels:
label: value
machineInventoryAnnotations:
annotation: value
config:
cloud-config:
...
elemental:
registration:
...
install:
...

config.cloud-config​

Contains the cloud-configuration to be injected in the node. See the Cloud Config Reference for full information.

config.elemental.registration​

Contains the configuration used for the connection and the initial registration to the Elemental Operator.

Supports the following values:

KeyTypeDefault valueDescription
urlstringemptyURL to connect to the Elemental Operator
ca-certstringemptyCA to validate the certificate provided by the server at 'url' (required if the certificate is not signed by a public CA)
no-smbiosboolfalseWhether SMBIOS data should be sent to the Elemental Operator (see the SMBIOS reference for more information)
warning

The following values are for development purposes only.

KeyTypeDefault valueDescription
authstringtpmAuthentication method to use during registration, one of tpm, mac or sys-uuid. See Authentication for more information
emulate-tpmboolfalseThis will use software emulation of the TPM (required for hosts without TPM hardware)
emulated-tpm-seedint641Fixed seed to use with 'emulate-tpm'. Set to -1 to get a random seed. See TPM for more information

config.elemental.install​

Contains the installation configuration that would be applied via elemental-register --install when booted from an ISO and passed to elemental install

Supports the following values:

KeyTypeDefault valueDescription
firmwarestringefiFirmware to install ('efi' or 'bios')
devicestringemptyDevice to install the system to
device-selectorstringemptyRules for picking device to install the system to
no-formatboolfalseDon’t format disks. It is implied that COS_STATE, COS_RECOVERY, COS_PERSISTENT, COS_OEM partitions are already existing on the target disk
config-urlslistemptyCloud-init config files locations
isostringemptyPerforms an installation from the ISO url instead of the running ISO
system-uristringemptySets the system image source and its type (e.g. 'docker:registry.org/image:tag') instead of using the running ISO
debugboolfalseEnable debug output
ttystringemptyAdd named tty to grub
poweroffboolfalseShutdown the system after install
rebootboolfalseReboot the system after install
eject-cdboolfalseTry to eject the cd on reboot
warning

In case of using both iso and system-uri the iso value takes precedence

It is only required to specify either the device or device-selector fields for a successful install, the rest of the parameters are all optional.

If both device and device-selector is specified the value of device is used and device-selector is ignored.

Example
apiVersion: elemental.cattle.io/v1beta1
kind: MachineRegistration
metadata:
name: my-nodes
namespace: fleet-default
spec:
config:
elemental:
install:
device: /dev/sda
debug: true
reboot: true
eject-cd: true
system-uri: registry.suse.com/suse/sle-micro/5.5:latest

config.elemental.install.device-selector​

The device-selector field can be used to dynamically pick device during installation. The field contains a list of rules that looks like the following:

Example device-selector based on device name
device-selector:
- key: Name
operator: In
values:
- /dev/sda
- /dev/vda
- /dev/nvme0
Example device-selector based on device size
device-selector:
- key: Size
operator: Lt
values:
- 100Gi
- key: Size
operator: Gt
values:
- 30Gi

The currently supported operators are:

OperatorDescription
InThe key matches one of the provided values
NotInThe key does not match any of the provided values
GtThe key is greater than a single provided value
LtThe key is lesser than a single provided value

The currently supported keys are:

KeyDescription
NameThe device name (eg. /dev/sda)
SizeThe device size (values can be specified using kubernetes resources, eg 100Gi)

The rules are AND:ed together, which means all rules must match the targeted device.

config.elemental.reset​

Contains the reset configuration that would be applied via elemental-register --reset, when booted from the recovery partition and passed to elemental reset

Supports the following values:

KeyTypeDefault valueDescription
enabledboolfalseMachineInventories created from this MachineRegistration will have reset functionality enabled
reset-persistentbooltrueFormat the COS_PERSISTENT partition
reset-oembooltrueFormat the COS_OEM partition
config-urlslistemptyCloud-init config files
system-uristringemptySets the system image source and its type (e.g. 'docker:registry.org/image:tag') instead of using the running ISO
debugboolfalseEnable debug output
poweroffboolfalseShutdown the system after reset
rebootbooltrueReboot the system after reset
Example
apiVersion: elemental.cattle.io/v1beta1
kind: MachineRegistration
metadata:
name: my-nodes
namespace: fleet-default
spec:
config:
elemental:
reset:
enabled: true
debug: true
reset-persistent: true
reset-oem: true
reboot: true
system-uri: registry.suse.com/suse/sle-micro/5.5:latest

machineName​

This refers to the name that will be set to the node and the kubernetes resources that require a hostname (rke2 deployed pods for example, they use the node hostname as part of the pod names) String type.

info

When elemental:registration:no-smbios is set to false (default), machineName is interpolated with SMBIOS data which allows you to store hardware information. See our SMBIOS docs for more information. If no machineName is specified, a default one in the form m-$UUID will be set. The UUID will be retrieved from the SMBIOS data if available, otherwise a random UUID will be generated.

Example
apiVersion: elemental.cattle.io/v1beta1
kind: MachineRegistration
metadata:
name: my-nodes
namespace: fleet-default
spec:
machineName: hostname-test-4

machineInventoryLabels​

Labels that will be set to the MachineInventory that is created from this MachineRegistration Key: value type. These labels will be used to establish a selection criteria in MachineInventorySelectorTemplate.

Elemental nodes will run elemental-register every 24 hours.
It is possible to update the machineInventoryLabels so that all registered nodes will apply the new labels on the next successfull registration update.

info

When elemental:registration:no-smbios is set to false (default), Labels are interpolated with SMBIOS data. This allows to store hardware information in custom labels. See our SMBIOS docs for more information.

Example
apiVersion: elemental.cattle.io/v1beta1
kind: MachineRegistration
metadata:
name: my-nodes
namespace: fleet-default
spec:
machineInventoryLabels:
my.prefix.io/element: fire
my.prefix.io/cpus: 32
my.prefix.io/manufacturer: "${System Information/Manufacturer}"
my.prefix.io/productName: "${System Information/Product Name}"
my.prefix.io/serialNumber: "${System Information/Serial Number}"
my.prefix.io/machineUUID: "${System Information/UUID}"

machineInventoryAnnotations​

Annotations that will be set to the MachineInventory that is created from this MachineRegistration Key: value type

Example
apiVersion: elemental.cattle.io/v1beta1
kind: MachineRegistration
metadata:
name: my-nodes
namespace: fleet-default
spec:
machineInventoryAnnotations:
owner: bob
version: 1.0.0