From 5593408be8af97670f3ec2d9c0f59d99c9cc9a4e Mon Sep 17 00:00:00 2001 From: Benjamin Campbell Date: Thu, 24 Jul 2014 11:22:08 -0600 Subject: [PATCH 1/2] docs(quick-start): Clarified use of fields in cloud config Updated the language to illustrate that fields in a cloud config is not supported in all environments. This is expressed explicitly in PXE and install to disk pages. The quick start lacked this information and is inconsistent. --- Documentation/cloud-config.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Documentation/cloud-config.md b/Documentation/cloud-config.md index b13874b..4fae82f 100644 --- a/Documentation/cloud-config.md +++ b/Documentation/cloud-config.md @@ -40,7 +40,9 @@ CoreOS tries to conform to each platform's native method to provide user data. E #### etcd The `coreos.etcd.*` parameters will be translated to a partial systemd unit acting as an etcd configuration file. -We can use the templating feature of coreos-cloudinit to automate etcd configuration with the `$private_ipv4` and `$public_ipv4` fields. For example, the following cloud-config document... +If the platform environment supports the templating feature of coreos-cloudinit it is possible to automate etcd configuration with the `$private_ipv4` and `$public_ipv4` fields. For example, the following cloud-config document... + +Note: The $private_ipv4 and $public_ipv4 substitution variables referenced in other documents are not supported on PXE or disk installation systems. ```yaml #cloud-config From 7913f7435134f59f6e3b754304f1d556c2f1dadc Mon Sep 17 00:00:00 2001 From: Benjamin Campbell Date: Thu, 24 Jul 2014 11:54:31 -0600 Subject: [PATCH 2/2] docs(quick-start) Enumerated supported platforms Following suggestion a list of platforms that *do* support cloud config variables. In addition minor mark up formatting is added. --- Documentation/cloud-config.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/cloud-config.md b/Documentation/cloud-config.md index 4fae82f..b3e329b 100644 --- a/Documentation/cloud-config.md +++ b/Documentation/cloud-config.md @@ -42,8 +42,6 @@ CoreOS tries to conform to each platform's native method to provide user data. E The `coreos.etcd.*` parameters will be translated to a partial systemd unit acting as an etcd configuration file. If the platform environment supports the templating feature of coreos-cloudinit it is possible to automate etcd configuration with the `$private_ipv4` and `$public_ipv4` fields. For example, the following cloud-config document... -Note: The $private_ipv4 and $public_ipv4 substitution variables referenced in other documents are not supported on PXE or disk installation systems. - ```yaml #cloud-config @@ -70,6 +68,8 @@ Environment="ETCD_PEER_ADDR=192.0.2.13:7001" For more information about the available configuration parameters, see the [etcd documentation][etcd-config]. Note that hyphens in the coreos.etcd.* keys are mapped to underscores. +_Note: The `$private_ipv4` and `$public_ipv4` substitution variables referenced in other documents are only supported on Amazon EC2, Google Compute Engine, OpenStack, Rackspace, and Vagrant._ + [etcd-config]: https://github.com/coreos/etcd/blob/master/Documentation/configuration.md #### fleet