Skip to main content
Version: latest

Edge Installer Configuration

The Edge Installer configuration user data accepts a parameter named stylus. In addition to the stylus parameter, the user data file also supports the use of cloud-init stages and other Kairos-supported parameters. The parameter is how you primarily configure the Edge host, but you can also use cloud-init stages to customize the installation. Refer to the Site Parameters for a list of all the parameters supported in the parameter block.


The #cloud-config value is a required cloud-init header required by the cloud-init standard.

User Data Parameters


The Edge Installer is configured with a set of default values.

PaletteEndpointapi.console.spectrocloud.comThe Palette API endpoint.
PrefixedgeThe default prefix to apply to the unique identifier.
RegistrationURLhttps://edge-registration-generic.vercel.appThe URL that operators should use when registering the Edge host with Palette.
disableAutoRegisterfalseSet to true if you want to disable auto registration. Refer to the Register Edge Host reference page to learn more about Edge host registrations.

The default values assume you are installing the Edge host in an environment without a network proxy, do not require remote access to the Edge host, and are using Palette SaaS. If you have requirements different from the default values, you must provide the Edge Installer with additional information.

You can provide the installer with additional configuration values in the user data configuration file. The following table contains all the supported user data parameters the installer accepts.

Debug Parameters

You can enable the debug and trace parameters when you need to troubleshoot Edge Installer issues.

debugEnable this parameter for debug output. Allowed values are true or false. Default value is false.
traceEnable this parameter to display trace output. Allowed values are true or false. Default value is false.
imageOverrideYou can specify a different Edge Installer image versus the default image.
debug: true
trace: true
imageOverride: ""

Install Mode

You can specify the mode the Edge Installer should prepare the installation for. The Edge Installer supports two different modes.

  • Connected: The site has internet connectivity and the installation is initiated through Palette.
  • Air-Gapped: The site does not have internet connectivity. The Installation is initiated through the Palette Edge CLI.
installationModeAllowed values are connected. Default value is connected.

installationMode: "connected"

External Registry

You can point the Edge Installer to a non-default registry to load content from another source. Use the registryCredentials parameter object to specify the registry configurations.

domainThe domain of the registry. You can use an IP address plus the port or a domain name.
usernameThe username to authenticate with the registry.
passwordThe password to authenticate with the registry.
insecureWhether to allow insecure connections to the registry. Default value is false.

username: ubuntu
password: <yourPassword>
insecure: true

Site Parameters

The blocks accept the following parameters.

paletteEndpointThe URL endpoint that points to Palette. Example:
edgeHostTokenA token created at the tenant scope that is required for auto registration.
projectUidThe id of the project the Edge host will belong to.
projectNameThe name of the project.
nameIf you do not specify an Edge hostname, the system will generate one from the serial number of the device. If Stylus is unable to identify the serial number, it will generate a random ID instead. In cases where the hardware does not have a serial number, we suggest that you specify a value so there is minimal chance of duplication. Use the value "$random" to generate a random ID. You can also use the DeviceUIDPaths to read in a value from a system file.
prefixThe system assigns a prefix value to the device UID generated by the Edge Installer. By default, this value is set to edge.
networkThe network configuration settings. Review the Site Network Parameters below for more details.
registrationURLThe URL that operators should use to register the Edge host with Palette.
insecureSkipVerifyThis controls whether or not a client verifies the server's certificate chain and host name.
caCertsThe Secure Sockets Layer (SSL) certificate authority (CA) certificates.
clusterIdThe id of the host cluster the edge host belongs to.
clusterNameThe name of the host cluster the edge host belongs to.
tagsA parameter object you use to provide optional key-value pairs. Refer to the Tags section to learn more.
tagsFromFileSpecify tags from a file. Refer to the Tags section to learn more.
tagsFromScriptUse a script to generate the tags. Refer to the Tags section to learn more.
deviceUIDPathsSpecify the file path for reading in product or board serial that can be used to set the device ID. The default file path is /sys/class/dmi/id/product_uuid. Refer to the Device ID (UID) Parameters section to learn more.

Site Network Parameters

Use the site network parameters to configure network settings so the edge host can communicate with Palette.

siteNetwork.httpProxyThe URL of the HTTP proxy endpoint.
siteNetwork.httpSProxyThe URL of the HTTPS proxy endpoint.
siteNetwork.noProxyThe list of IP addresses or CIDR ranges to exclude routing through the network proxy.
siteNetwork.interfacesThe network settings respective to the interfaces. Review the Network Parameters table below for more details.
siteNetwork.nameserverThe IP address of the global DNS nameserver that requests should be routed to.

Network Parameters

Network settings specific to the network interface of the edge host. You can configure multiple interfaces.

networkInterface.ipAddressThe assigned IP address to the network interface.
networkInterface.maskThe network mask for the assigned IP address.
networkInterface.typeDefines how the IP address is assigned. Allowed values are dhcp or static. Defaults to dhcp.
networkInterface.gatewayThe network gateway IP address.
networkInterface.nameserverThe IP address of the DNS nameserver this interface should route requests to.

Device ID (UID) Parameters

The device ID is generated by a specific priority sequence. The below table outlines the priority order from top to bottom when generating a UID for the Edge host. The UID generation starts with priority one, the device name, followed by attributes within the deviceUIDPAths, and lastly generating a random UUID if all other methods are unsuccessful.

1nameThe device name is used as the primary identifier for the Edge host.
2deviceUIDPathsSpecifies the paths and associated regular expressions to extract the UID.
3"$random"Assigns a random UUID as the Edge host ID.

By default, the product UID path is set to /sys/class/dmi/id/product_uuid. To modify this path and use other attributes within the same folder, such as the product or board serial, use the regex parameter. For example, instead of the default path /sys/class/dmi/id/product_uuid, you can use the board Serial Number path /sys/class/dmi/id/board_serial by applying a regex parameter. Refer to the regex syntax reference guide to learn more.

nameThe path of the file containing the UID.
regexThe regular expression pattern to match the UID.

You can use the regex parameter to remove unsupported characters from attributes to Refer to the warning box below for a list of unsupported characters.

- name: /etc/palette/metadata-regex
regex: "edge.*"


The length of the UID truncates to a maximum allowed length of 128 characters. The following characters are unsupported:

/ ? # & + % , $ ~ ! @ * () {} | = ; : <> ' . ^ "


You can assign tags to the Edge host by specifying tags manually in the configuration file. The tags object accepts key-value pairs. The following example shows how to assign tags manually to the Edge host.

env: prod
department: engineering

You can also specify tags through alternative methods that are more dynamic, such as reading in tags from a file or from a script that returns a JSON object. You can combine the various methods to provide tags to the Edge host. The following sections describe the various methods you can use to provide tags dynamically to the Edge host.


The order of precedence for tags is as follows:

  1. Manually provided tags - tags.

  2. Tags from a script - tagsFromScript.

  3. Tags from a file - tagsFromFile.

Tags from higher priority orders override tags from lower priority. For example, if you specify a tag manually and also specify the same tag in a tagsFromFile, the tag from the tag object is what the Edge installer will use.

Tags From a File

You can specify tags from a file by using the tagsFromFile parameter object. The tagsFromFile parameter object accepts the following parameters.

ParameterDescriptionDefault Value
fileNameThe path to the file containing the tags.''
delimiterThe delimiter used to separate the key-value pairs.\n
separatorThe separator used to separate the key from the value.:

department: 'sales'
fileName: "/etc/palette/tags.txt"
delimiter: ";"
separator: ":"


You can specify different delimiters and separators to parse the content depending on how the content is formatted. Assume the file /etc/palette/tags.txt contains the following content.

Location:Mumbai,India; Latitude:48.856614; Longitude:2.352221; owner:p78125d

Tags From a Script

You can specify tags from a script by using the tagsFromScript parameter object. The script must be executable and return a JSON object that contains the tags in the following format.

"key": "value",


"department": "sales",
"owner": "p78125d"

The tagsFromScript parameter object accepts the following parameters.

ParameterDescriptionDefault Value
scriptNameThe path to the script that returns a JSON object.''
timeoutThe timeout value in seconds.60

department: 'sales'
scriptName: "/etc/palette/"
timeout: 60

Installer Example Configuration

The following example shows how user data configuration is used to customize the Edge host installation process.

edgeHostToken: yourEdgeRegistrationTokenHere
projectUid: 12345677788
env: east
terraform_managed: true
os: ubuntu
name: edge-59d3f182-35fe-4e10-b0a0-d7f761f1a142

type: static
type: dhcp
- |
- |


Check out the Prepare User Data resource for more examples.

Additional Configurations

The Edge Installer will honor other Kairos parameters, such as install, and options. To learn more about Kairos parameters, refer to the Kairos configuration page.

The following is an example Edge installer configuration that is using the install parameter block to power off the device upon completion of the installation process.

projectUid: yourProjectIdHere
edgeHostToken: yourEdgeRegistrationTokenHere
myTag: myValue
myOtherTag: myOtherValue
scriptName: /etc/palette/
timeout: 30
reboot: false

- users:
- sudo
passwd: palette

poweroff: true