Added cloud-config headers explanation

This commit is contained in:
kayrus 2015-09-01 13:51:34 +02:00
parent 9c4aca6c9a
commit dfc5f2627f

View File

@ -26,7 +26,7 @@ We've designed our implementation to allow the same cloud-config file to work ac
The cloud-config file uses the [YAML][yaml] file format, which uses whitespace and new-lines to delimit lists, associative arrays, and values. The cloud-config file uses the [YAML][yaml] file format, which uses whitespace and new-lines to delimit lists, associative arrays, and values.
A cloud-config file must contain `#cloud-config`, followed by an associative array which has zero or more of the following keys: A cloud-config file must contain a header: either `#cloud-config` for processing as cloud-config (suggested) or `#!` for processing as a shell script (advanced). If cloud-config has #cloud-config header, it should followed by an associative array which has zero or more of the following keys:
- `coreos` - `coreos`
- `ssh_authorized_keys` - `ssh_authorized_keys`
@ -37,6 +37,8 @@ A cloud-config file must contain `#cloud-config`, followed by an associative arr
The expected values for these keys are defined in the rest of this document. The expected values for these keys are defined in the rest of this document.
If cloud-config header starts on `#!` then coreos-cloudinit will recognize it as shell script which is interpreted by bash and run it as transient systemd service.
[yaml]: https://en.wikipedia.org/wiki/YAML [yaml]: https://en.wikipedia.org/wiki/YAML
### Providing Cloud-Config with Config-Drive ### Providing Cloud-Config with Config-Drive