Merge ~smoser/cloud-init:doc/add-some-openstack-ds-doc into cloud-init:master

Proposed by Scott Moser
Status: Merged
Merged at revision: 47680bd623b295857dd18962523dccb33861b4e3
Proposed branch: ~smoser/cloud-init:doc/add-some-openstack-ds-doc
Merge into: cloud-init:master
Diff against target: 47 lines (+35/-1)
1 file modified
doc/rtd/topics/datasources/openstack.rst (+35/-1)
Reviewer Review Type Date Requested Status
Lars Kellogg-Stedman (community) Approve
cloud-init Commiters Pending
Review via email: mp+314926@code.launchpad.net

Commit message

doc: add some documentation on OpenStack datasource.

Fill out some of the documentation on the OpenStack datasource.

To post a comment you must log in.
Revision history for this message
Lars Kellogg-Stedman (larsks) wrote :

Looks good to me.

review: Approve

There was an error fetching revisions from git servers. Please try again in a few minutes. If the problem persists, contact Launchpad support.

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1diff --git a/doc/rtd/topics/datasources/openstack.rst b/doc/rtd/topics/datasources/openstack.rst
2index ea47ea8..164b0e0 100644
3--- a/doc/rtd/topics/datasources/openstack.rst
4+++ b/doc/rtd/topics/datasources/openstack.rst
5@@ -1,7 +1,41 @@
6 OpenStack
7 =========
8
9-*TODO*
10+This datasource supports reading data from the
11+`OpenStack Metadata Service
12+<http://docs.openstack.org/admin-guide/compute-networking-nova.html#metadata-service>`_.
13+
14+Configuration
15+-------------
16+The following configuration can be set for the datasource in system
17+configuration (in `/etc/cloud/cloud.cfg` or `/etc/cloud/cloud.cfg.d/`).
18+
19+The settings that may be configured are:
20+
21+ * **metadata_urls**: This list of urls will be searched for an OpenStack
22+ metadata service. The first entry that successfully returns a 200 response
23+ for <url>/openstack will be selected. (default: ['http://169.254.169.254']).
24+ * **max_wait**: the maximum amount of clock time in seconds that should be
25+ spent searching metadata_urls. A value less than zero will result in only
26+ one request being made, to the first in the list. (default: -1)
27+ * **timeout**: the timeout value provided to urlopen for each individual http
28+ request. This is used both when selecting a metadata_url and when crawling
29+ the metadata service. (default: 10)
30+ * **retries**: The number of retries that should be done for an http request.
31+ This value is used only after metadata_url is selected. (default: 5)
32+
33+An example configuration with the default values is provided as example below:
34+
35+.. sourcecode:: yaml
36+
37+ #cloud-config
38+ datasource:
39+ OpenStack:
40+ metadata_urls: ["http://169.254.169.254"]
41+ max_wait: -1
42+ timeout: 10
43+ retries: 5
44+
45
46 Vendor Data
47 -----------

Subscribers

People subscribed via source and target branches