summaryrefslogtreecommitdiff
path: root/doc/sources
diff options
context:
space:
mode:
authorDaniel Watkins <daniel.watkins@canonical.com>2015-04-01 12:11:29 +0100
committerDaniel Watkins <daniel.watkins@canonical.com>2015-04-01 12:11:29 +0100
commit09cf2e1caf628f6b61c35a454dbea6b6a8c2e7aa (patch)
treeed7efcd43dd4be8d188afa3aa9eadcfcc28d82ed /doc/sources
parent8165000c3975db07cb5b8b29410635dd6c9345bd (diff)
downloadvyos-cloud-init-09cf2e1caf628f6b61c35a454dbea6b6a8c2e7aa.tar.gz
vyos-cloud-init-09cf2e1caf628f6b61c35a454dbea6b6a8c2e7aa.zip
Add documentation about OpenStack vendor data handling.
Diffstat (limited to 'doc/sources')
-rw-r--r--doc/sources/openstack/README.rst24
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/sources/openstack/README.rst b/doc/sources/openstack/README.rst
new file mode 100644
index 00000000..8102597e
--- /dev/null
+++ b/doc/sources/openstack/README.rst
@@ -0,0 +1,24 @@
+*TODO*
+
+Vendor Data
+~~~~~~~~~~~
+
+The OpenStack metadata server can be configured to serve up vendor data
+which is available to all instances for consumption. OpenStack vendor
+data is, generally, a JSON object.
+
+cloud-init will look for configuration in the ``cloud-init`` attribute
+of the vendor data JSON object. cloud-init processes this configuration
+using the same handlers as user data, so any formats that work for user
+data should work for vendor data.
+
+For example, configuring the following as vendor data in OpenStack would
+upgrade packages and install ``htop`` on all instances:
+
+.. sourcecode:: json
+
+ {"cloud-init": "#cloud-config\npackage_upgrade: True\npackages:\n - htop"}
+
+For more general information about how cloud-init handles vendor data,
+including how it can be disabled by users on instances, see
+https://bazaar.launchpad.net/~cloud-init-dev/cloud-init/trunk/view/head:/doc/vendordata.txt