nuageinit(7)

NAME

nuageinit – initialize a cloud-init environment

DESCRIPTION

The nuageinit program is used to initialize instances in a cloud environment. nuageinit runs at the first boot after the system installation. It is composed of three rc(8) scripts:

nuageinit

This script detects the type of cloud environment and gathers the configuration data accordingly. The following cloud environments are supported right now:

ondisk

A cloud agnostic environment where the disk is provided to the system with the configuration data on it. The disk must be formatted using one of the following filesystems: cd9660(4) or msdosfs(4) and be labelled (via filesystem label) either config-2 or cidata.

OpenStack

The system is running in an OpenStack environment: https://www.openstack.org/. It is detected via the smbios.system.product smbios(4) description available in kenv(2).

Depending on the cloud environment above, nuageinit will attempt to configure the instance. This script executes early after all the local filesystem are mounted but before the network is configured.

nuageinit_post_net

This script is responsible for processing the configurations that are network dependent:

dealing with packages
dealing with users (which can depend on shell provided by packages)

nuageinit_user_data_script

This script is responsible for executing everything which would have been passed via the configuration to be executed, via the configuration or because the user_data provided is a script.

The default user for nuageinit is a user named freebsd with a password set to freebsd and a login shell set to /bin/sh.

CONFIGURATION

The configuration of nuageinit is typically provided as metadata by the cloud provider. The metadata is presented to nuageinit in different forms depending on the provider:

nocloud

If the data is provided via a disk labelled cidata, then the metadata is provided in the form of a file named meta-data in YAML format. nuageinit will configure the hostname of the instance according to the value of the following variables local-hostname or hostname.

config-2

If the data is provided via a disk labelled config-2 or if it is fetched from OpenStack, the metadata is expected in two json files:

The meta_data.json file supports the following keys:

hostname

Set the hostname of the instance.

public_keys

Append each entry of the array to nuageinit default user which will be created.

The network_data.json file supports the following keys:

links: Array of network interfaces to be configured.
networks: Array of network configurations to be set.
services: Array of service configurations to be set (e.g: DNS).

Along with the metadata, a user data file is provided, either named user_data or user-data. If this file starts with a "#!", it will be executed at the end of the boot via nuageinit_user_data_script. If this file starts with "#cloud-config", it will be parsed as a YAML configuration file. All other cases will be ignored.

The "#cloud-config" configuration entries supported by nuageinit:

fqdn

Specify a fully qualified domain name for the instance.

hostname

Specify the hostname of the instance if "fqdn" is not set.

manage_etc_hosts

Boolean which determines whether the hostname should be added to /etc/hosts on the "127.0.0.1" and "::1" localhost lines. Defaults to true. Set to false to skip this behaviour.

mounts

A list of mount points to configure. Each entry is written to /etc/fstab and the mount point directory is created.

Each entry can be specified as a list:

[ device, mountpoint, fstype ]

or as an object:

{ device: "...", mountpoint: "...", type: "...", options: "..." }

The following keys are recognized:

device (or name, spec): The device to mount.
mountpoint (or mount_point): The mount point directory.
type (or fstype, filesystem): The filesystem type.
options (or opts): The mount options, defaults to "rw".
dump: The dump frequency for dump(8), defaults to 0.
passno: The pass number for fsck(8), defaults to 0.

resolv_conf

An object configuring the content of /etc/resolv.conf.

The following keys are recognized:

nameservers: A list of IP addresses for DNS name servers.
searchdomains: A list of search domains.
domain: A single domain name.
sortlist: A list of IP/netmask sortlist entries.
options: A dictionary of resolver options.

locale

Set the system locale by appending "export" statements to /etc/profile.

If the value is a string, it is used as the “LANG” value. If the value is an object mapping, each key-value pair is exported.

keyboard

An object configuring the keyboard layout.

Sets the keymap variable in /etc/rc.conf.d/keymap.

The following keys are recognized:

layout: The keyboard layout (e.g., "fr", "de", "us").
variant: The keyboard variant (e.g., "acc", "nodeadkeys").

ssh_authkey_fingerprints

Boolean which determines whether fingerprints of SSH host keys should be logged to the console. Defaults to false.

ntp

An object configuring the NTP daemon by writing /etc/ntp.conf.

The following keys are recognized:

servers

A list of NTP server addresses.

pools

A list of NTP pool addresses.

enabled

Boolean, defaults to true. Set to false to skip NTP configuration.

Alternatively, ntp can be a list of server addresses (legacy format).

ca_certs

An object managing CA certificates.

The following keys are recognized:

trusted: A list of PEM-encoded CA certificates to add to the system trust store. Certificates are written to /usr/share/certs/trusted/ and certctl(8) rehash is executed.
remove_defaults: Boolean, if true, remove the default CA certificates.

timezone

Sets the system timezone based on the value provided.

EXAMPLES

Here is an example of a YAML configuration for nuageinit:

#cloud-config
bootcmd:
  - kldload if_bridge
fqdn: myhost.mynetwork.tld
users:
  - default
  - name: user
    gecos: Foo B. Bar
    sudo: ALL=(ALL) NOPASSWD:ALL
    ssh_authorized_keys:
      - ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAr...
packages:
  - neovim
  - git-lite
  - sudo
package_update: true
package_upgrade: true
runcmd:
  - logger -t nuageinit "boot finished"
ssh_deletekeys: true
disable_root: true
ssh_keys:
  ed25519_private: |
    -----BEGIN OPENSSH PRIVATE KEY-----
    blabla
    ...
    -----END OPENSSH PRIVATE KEY-----
  ed25519_public: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIK+MH4E8KO32N5CXRvXVqvyZVl0+6ue4DobdhU0FqFd+
network:
  ethernets:
    vtnet0:
      addresses:
        - 192.168.8.2/24
      gateway4: 192.168.8.1

STANDARDS

nuageinit is believed to conform to the Cloud Init: https://cloud-init.io/ specification.

HISTORY

nuageinit appeared in FreeBSD 14.1

NAME

DESCRIPTION

CONFIGURATION

EXAMPLES

SEE ALSO

STANDARDS

HISTORY

History