illumos Metadata Agent

This agent runs early in boot to configure an illumos virtual machine using the metadata provided by the hypervisor or cloud environment. The agent supports the configuration of:

• networking (IP addresses, DNS servers, and the default gateway)
• credentials (SSH keys)
• hostname
• swap space
• expansion of the ZFS pool to fill the provisioned root device
• regeneration of ZFS pool unique ID (zpool reguid) in the image
• optional execution of a user-provided script

At present, the following hypervisors or cloud environments are supported on some level:

• Joyent SmartOS (including Triton environments)
• DigitalOcean
• Amazon EC2
• Generic QEMU/KVM; e.g., under libvirtd

Building and Usage

This software must be built with Rust and Cargo.

$ cargo build --release

The built artefact, target/release/metadata, is intended to be installed as /usr/lib/metadata. In addition, userscript.sh is intended to be installed as /usr/lib/userscript.sh and made executable.

Finally, SMF service manifests are provided for both the metadata service (metadata.xml) and the service which executes a user-provided script (userscript.xml), and are intended to be included in the image in /lib/svc/manifest/system.

It is desirable to include these services in the SMF seed repository for an image so that they are already imported when the image first boots in the guest. The services include dependent relationships with several early boot networking and identity services in an attempt to ensure the metadata agent runs before network services are completely online.