Skip to content

Commit

Permalink
Add info doc for cloud-init.
Browse files Browse the repository at this point in the history
  • Loading branch information
mnlipp committed Feb 18, 2024
1 parent d19d2c4 commit 0f687b6
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions controller.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,22 @@ second one based on Alpine (`ghcr.io/mnlipp/org.jdrupes.vmoperator.runner.qemu-a
Starting with release 1.0, all versions of runner images and managers
that have the same major release number are guaranteed to be compatible.

## Generating cloud-init data

*Added in version 2.3*

The optional object `.spec.cloudInit` with sub-objects `.cloudInit.metaData`
and `.cloudInit.userData` can be used to provide data for
[cloud-init](https://cloudinit.readthedocs.io/en/latest/index.html).
The data from the CRD will be made available to the VM by the runner
as a vfat formatted disk (see the description of
[NoCloud](https://cloudinit.readthedocs.io/en/latest/reference/datasources/nocloud.html)).

If `.metaData.instance-id` is not defined, the controller automatically
generates it from the CRD's `resourceVersion`. If `.metaData.local-hostname`
is not defined, the controller adds this property using the value from
`metadata.name`.

## Further reading

For a detailed description of the available configuration options see the
Expand Down

0 comments on commit 0f687b6

Please sign in to comment.