unistack-org/cloudinit
4
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

docs: quote everything

Browse Source 
I realize this is one of the selling points of YAML, but it causes far
too much confusion. Turns out typing is a good thing.
This commit is contained in:
Alex Crawford 2015-09-08 18:40:21 -07:00
parent f816819c6d
commit 4a25948b53
2 changed files with 53 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Documentation/cloud-config-oem.md
View File

@ -17,11 +17,11 @@ For example, the following cloud-config document...
#cloud-config #cloud-config
coreos: coreos:
oem: oem:
id: rackspace id: "rackspace"
name: Rackspace Cloud Servers name: "Rackspace Cloud Servers"
version-id: 168.0.0 version-id: "168.0.0"
home-url: https://www.rackspace.com/cloud/servers/ home-url: "https://www.rackspace.com/cloud/servers/"
bug-report-url: https://github.com/coreos/coreos-overlay bug-report-url: "https://github.com/coreos/coreos-overlay"
``` ```
...would be rendered to the following `/etc/oem-release`: ...would be rendered to the following `/etc/oem-release`:

96
Documentation/cloud-config.md
View File

@ -59,12 +59,12 @@ If the platform environment supports the templating feature of coreos-cloudinit
coreos: coreos:
etcd: etcd:
name: node001 name: "node001"
# generate a new token for each unique cluster from https://discovery.etcd.io/new # generate a new token for each unique cluster from https://discovery.etcd.io/new
discovery: https://discovery.etcd.io/<token> discovery: "https://discovery.etcd.io/<token>"
# multi-region and multi-cloud deployments need to use $public_ipv4 # multi-region and multi-cloud deployments need to use $public_ipv4
addr: $public_ipv4:4001 addr: "$public_ipv4:4001"
peer-addr: $private_ipv4:7001 peer-addr: "$private_ipv4:7001"
``` ```
...will generate a systemd unit drop-in for etcd.service with the following contents: ...will generate a systemd unit drop-in for etcd.service with the following contents:
@ -96,14 +96,14 @@ For example, the following cloud-config document...
coreos: coreos:
etcd2: etcd2:
# generate a new token for each unique cluster from https://discovery.etcd.io/new?size=3 # generate a new token for each unique cluster from https://discovery.etcd.io/new?size=3
discovery: https://discovery.etcd.io/<token> discovery: "https://discovery.etcd.io/<token>"
# multi-region and multi-cloud deployments need to use $public_ipv4 # multi-region and multi-cloud deployments need to use $public_ipv4
advertise-client-urls: http://$public_ipv4:2379 advertise-client-urls: "http://$public_ipv4:2379"
initial-advertise-peer-urls: http://$private_ipv4:2380 initial-advertise-peer-urls: "http://$private_ipv4:2380"
# listen on both the official ports and the legacy ports # listen on both the official ports and the legacy ports
# legacy ports can be omitted if your application doesn't depend on them # legacy ports can be omitted if your application doesn't depend on them
listen-client-urls: http://0.0.0.0:2379,http://0.0.0.0:4001 listen-client-urls: "http://0.0.0.0:2379,http://0.0.0.0:4001"
listen-peer-urls: http://$private_ipv4:2380,http://$private_ipv4:7001 listen-peer-urls: "http://$private_ipv4:2380,http://$private_ipv4:7001"
``` ```
...will generate a systemd unit drop-in for etcd2.service with the following contents: ...will generate a systemd unit drop-in for etcd2.service with the following contents:
@ -132,8 +132,8 @@ The `coreos.fleet.*` parameters work very similarly to `coreos.etcd2.*`, and all
coreos: coreos:
fleet: fleet:
public-ip: $public_ipv4 public-ip: "$public_ipv4"
metadata: region=us-west metadata: "region=us-west"
``` ```
...will generate a systemd unit drop-in like this: ...will generate a systemd unit drop-in like this:
@ -159,7 +159,7 @@ flanneld. For example, the following cloud-config...
coreos: coreos:
flannel: flannel:
etcd_prefix: /coreos.com/network2 etcd_prefix: "/coreos.com/network2"
``` ```
...will generate a systemd unit drop-in like so: ...will generate a systemd unit drop-in like so:
@ -193,7 +193,7 @@ for locksmith. For example, the following cloud-config...
coreos: coreos:
locksmith: locksmith:
endpoint: http://example.com:2379 endpoint: "http://example.com:2379"
``` ```
...will generate a systemd unit drop-in like so: ...will generate a systemd unit drop-in like so:
@ -233,7 +233,7 @@ The `reboot-strategy` parameter also affects the behaviour of [locksmith](https:
#cloud-config #cloud-config
coreos: coreos:
update: update:
reboot-strategy: etcd-lock reboot-strategy: "etcd-lock"
``` ```
#### units #### units
@ -264,8 +264,8 @@ Write a unit to disk, automatically starting it.
coreos: coreos:
units: units:
- name: docker-redis.service - name: "docker-redis.service"
command: start command: "start"
content: | content: |
[Unit] [Unit]
Description=Redis container Description=Redis container
@ -285,9 +285,9 @@ Add the DOCKER_OPTS environment variable to docker.service.
coreos: coreos:
units: units:
- name: docker.service - name: "docker.service"
drop-ins: drop-ins:
- name: 50-insecure-registry.conf - name: "50-insecure-registry.conf"
content: | content: |
[Service] [Service]
Environment=DOCKER_OPTS='--insecure-registry="10.0.1.0/24"' Environment=DOCKER_OPTS='--insecure-registry="10.0.1.0/24"'
@ -300,10 +300,10 @@ Start the built-in `etcd2` and `fleet` services:
coreos: coreos:
units: units:
- name: etcd2.service - name: "etcd2.service"
command: start command: "start"
- name: fleet.service - name: "fleet.service"
command: start command: "start"
``` ```
### ssh_authorized_keys ### ssh_authorized_keys
@ -317,7 +317,7 @@ Override this by using the `--ssh-key-name` flag when calling `coreos-cloudinit`
#cloud-config #cloud-config
ssh_authorized_keys: ssh_authorized_keys:
- ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC0g+ZTxC7weoIJLUafOgrm+h... - "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC0g+ZTxC7weoIJLUafOgrm+h..."
``` ```
### hostname ### hostname
@ -328,7 +328,7 @@ This is the local part of a fully-qualified domain name (i.e. `foo` in `foo.exam
```yaml ```yaml
#cloud-config #cloud-config
hostname: coreos1 hostname: "coreos1"
``` ```
### users ### users
@ -364,13 +364,13 @@ The following fields are not yet implemented:
#cloud-config #cloud-config
users: users:
- name: elroy - name: "elroy"
passwd: $6$5s2u6/jR$un0AvWnqilcgaNB3Mkxd5yYv6mTlWfOoCYHZmfi3LDKVltj.E8XNKEcwWm... passwd: "$6$5s2u6/jR$un0AvWnqilcgaNB3Mkxd5yYv6mTlWfOoCYHZmfi3LDKVltj.E8XNKEcwWm..."
groups: groups:
- sudo - "sudo"
- docker - "docker"
ssh-authorized-keys: ssh-authorized-keys:
- ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC0g+ZTxC7weoIJLUafOgrm+h... - "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC0g+ZTxC7weoIJLUafOgrm+h..."
``` ```
#### Generating a password hash #### Generating a password hash
@ -411,32 +411,32 @@ Each item in the list may have the following keys:
```yaml ```yaml
#cloud-config #cloud-config
write_files: write_files:
- path: /etc/resolv.conf - path: "/etc/resolv.conf"
permissions: 0644 permissions: "0644"
owner: root owner: "root"
content: | content: |
nameserver 8.8.8.8 nameserver 8.8.8.8
- path: /etc/motd - path: "/etc/motd"
permissions: 0644 permissions: "0644"
owner: root owner: "root"
content: | content: |
Good news, everyone! Good news, everyone!
- path: /tmp/like_this - path: "/tmp/like_this"
permissions: 0644 permissions: "0644"
owner: root owner: "root"
encoding: gzip encoding: "gzip"
content: !!binary | content: !!binary |
H4sIAKgdh1QAAwtITM5WyK1USMqvUCjPLMlQSMssS1VIya9KzVPIySwszS9SyCpNLwYARQFQ5CcAAAA= H4sIAKgdh1QAAwtITM5WyK1USMqvUCjPLMlQSMssS1VIya9KzVPIySwszS9SyCpNLwYARQFQ5CcAAAA=
- path: /tmp/or_like_this - path: "/tmp/or_like_this"
permissions: 0644 permissions: "0644"
owner: root owner: "root"
encoding: gzip+base64 encoding: "gzip+base64"
content: | content: |
H4sIAKgdh1QAAwtITM5WyK1USMqvUCjPLMlQSMssS1VIya9KzVPIySwszS9SyCpNLwYARQFQ5CcAAAA= H4sIAKgdh1QAAwtITM5WyK1USMqvUCjPLMlQSMssS1VIya9KzVPIySwszS9SyCpNLwYARQFQ5CcAAAA=
- path: /tmp/todolist - path: "/tmp/todolist"
permissions: 0644 permissions: "0644"
owner: root owner: "root"
encoding: base64 encoding: "base64"
content: | content: |
UGFjayBteSBib3ggd2l0aCBmaXZlIGRvemVuIGxpcXVvciBqdWdz UGFjayBteSBib3ggd2l0aCBmaXZlIGRvemVuIGxpcXVvciBqdWdz
``` ```
@ -451,5 +451,5 @@ infrastructure in place to resolve its own hostname, for example, when using Vag
```yaml ```yaml
#cloud-config #cloud-config
manage_etc_hosts: localhost manage_etc_hosts: "localhost"
``` ```