MachineRegistration reference

The MachineRegistration resource allows:

• to configure the registration process
• to provide OS installation parameters
• to define the Elemental services enabled for the registering machine Once created it generates the registration URL used by nodes to register and start the machine onboarding process.

The MachineRegistration has a Ready condition which turns to true when the Elemental Operator has successfully generated the registration URL and an associated ServiceAccount. From this point on the target host can connect to the registration URL to kick off the provisioning process.

An HTTP GET request against the registration URL returns the registration file: a .yaml file containing the registration data (i.e., the spec:config:elemental:registration section from the just created MachineRegistration). The registration file contains all the required data to allow the target host to perform self registration and start the Elemental provisioning.

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:

warning

The following values are for development purposes only.

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:

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/rancher/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:

The currently supported keys are:

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:

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/rancher/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