summaryrefslogtreecommitdiff
path: root/doc/rtd/topics/datasources
diff options
context:
space:
mode:
authorScott Moser <smoser@brickies.net>2017-01-17 11:00:35 -0500
committerScott Moser <smoser@brickies.net>2017-01-17 11:41:10 -0500
commit47680bd623b295857dd18962523dccb33861b4e3 (patch)
treec5c0c6a64aeace289b37db135d5b1208e18f587f /doc/rtd/topics/datasources
parent4cf53f1544f8f5629330eab3efef1a18255c277a (diff)
downloadvyos-cloud-init-47680bd623b295857dd18962523dccb33861b4e3.tar.gz
vyos-cloud-init-47680bd623b295857dd18962523dccb33861b4e3.zip
doc: add some documentation on OpenStack datasource.
This just fills out some of the documentation on the OpenStack datasource.
Diffstat (limited to 'doc/rtd/topics/datasources')
-rw-r--r--doc/rtd/topics/datasources/openstack.rst36
1 files changed, 35 insertions, 1 deletions
diff --git a/doc/rtd/topics/datasources/openstack.rst b/doc/rtd/topics/datasources/openstack.rst
index ea47ea85..164b0e0c 100644
--- a/doc/rtd/topics/datasources/openstack.rst
+++ b/doc/rtd/topics/datasources/openstack.rst
@@ -1,7 +1,41 @@
OpenStack
=========
-*TODO*
+This datasource supports reading data from the
+`OpenStack Metadata Service
+<http://docs.openstack.org/admin-guide/compute-networking-nova.html#metadata-service>`_.
+
+Configuration
+-------------
+The following configuration can be set for the datasource in system
+configuration (in `/etc/cloud/cloud.cfg` or `/etc/cloud/cloud.cfg.d/`).
+
+The settings that may be configured are:
+
+ * **metadata_urls**: This list of urls will be searched for an OpenStack
+ metadata service. The first entry that successfully returns a 200 response
+ for <url>/openstack will be selected. (default: ['http://169.254.169.254']).
+ * **max_wait**: the maximum amount of clock time in seconds that should be
+ spent searching metadata_urls. A value less than zero will result in only
+ one request being made, to the first in the list. (default: -1)
+ * **timeout**: the timeout value provided to urlopen for each individual http
+ request. This is used both when selecting a metadata_url and when crawling
+ the metadata service. (default: 10)
+ * **retries**: The number of retries that should be done for an http request.
+ This value is used only after metadata_url is selected. (default: 5)
+
+An example configuration with the default values is provided as example below:
+
+.. sourcecode:: yaml
+
+ #cloud-config
+ datasource:
+ OpenStack:
+ metadata_urls: ["http://169.254.169.254"]
+ max_wait: -1
+ timeout: 10
+ retries: 5
+
Vendor Data
-----------