Merge lp:~daniel-thewatkins/cloud-init/openstack-vendor-data-doc into lp:~cloud-init-dev/cloud-init/trunk

Proposed by Dan Watkins on 2015-05-28
Status: Merged
Merged at revision: 1110
Proposed branch: lp:~daniel-thewatkins/cloud-init/openstack-vendor-data-doc
Merge into: lp:~cloud-init-dev/cloud-init/trunk
Diff against target: 46 lines (+30/-0)
2 files modified
doc/rtd/topics/datasources.rst (+6/-0)
doc/sources/openstack/README.rst (+24/-0)
To merge this branch: bzr merge lp:~daniel-thewatkins/cloud-init/openstack-vendor-data-doc
Reviewer Review Type Date Requested Status
cloud-init commiters 2015-05-28 Pending
Review via email: mp+260463@code.launchpad.net
To post a comment you must log in.

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'doc/rtd/topics/datasources.rst'
2--- doc/rtd/topics/datasources.rst 2015-04-04 01:40:17 +0000
3+++ doc/rtd/topics/datasources.rst 2015-05-28 11:31:06 +0000
4@@ -177,6 +177,12 @@
5 For now see: https://bazaar.launchpad.net/~cloud-init-dev/cloud-init/trunk/files/head:/doc/sources/ovf/
6
7 ---------------------------
8+OpenStack
9+---------------------------
10+
11+.. include:: ../../sources/openstack/README.rst
12+
13+---------------------------
14 Fallback/None
15 ---------------------------
16
17
18=== added directory 'doc/sources/openstack'
19=== added file 'doc/sources/openstack/README.rst'
20--- doc/sources/openstack/README.rst 1970-01-01 00:00:00 +0000
21+++ doc/sources/openstack/README.rst 2015-05-28 11:31:06 +0000
22@@ -0,0 +1,24 @@
23+*TODO*
24+
25+Vendor Data
26+~~~~~~~~~~~
27+
28+The OpenStack metadata server can be configured to serve up vendor data
29+which is available to all instances for consumption. OpenStack vendor
30+data is, generally, a JSON object.
31+
32+cloud-init will look for configuration in the ``cloud-init`` attribute
33+of the vendor data JSON object. cloud-init processes this configuration
34+using the same handlers as user data, so any formats that work for user
35+data should work for vendor data.
36+
37+For example, configuring the following as vendor data in OpenStack would
38+upgrade packages and install ``htop`` on all instances:
39+
40+.. sourcecode:: json
41+
42+ {"cloud-init": "#cloud-config\npackage_upgrade: True\npackages:\n - htop"}
43+
44+For more general information about how cloud-init handles vendor data,
45+including how it can be disabled by users on instances, see
46+https://bazaar.launchpad.net/~cloud-init-dev/cloud-init/trunk/view/head:/doc/vendordata.txt