summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNeal Shrader <neal@digitalocean.com>2014-10-17 16:28:09 -0400
committerNeal Shrader <neal@digitalocean.com>2014-10-17 16:28:09 -0400
commit8479f44090df3ec53357d7faee0c0e4ccd5127c4 (patch)
treee038ae59d5db3a5ded60508359f8f41c7adff82b
parentfdef6a9f84c5720bbd37f3eb98c9b7c58913bbfd (diff)
downloadvyos-cloud-init-8479f44090df3ec53357d7faee0c0e4ccd5127c4.tar.gz
vyos-cloud-init-8479f44090df3ec53357d7faee0c0e4ccd5127c4.zip
Add documentation for DigitalOcean datasource
-rw-r--r--doc/sources/digitalocean/README.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/sources/digitalocean/README.rst b/doc/sources/digitalocean/README.rst
new file mode 100644
index 00000000..1bb89fe1
--- /dev/null
+++ b/doc/sources/digitalocean/README.rst
@@ -0,0 +1,21 @@
+ The `DigitalOcean`_ datasource consumes the content served from DigitalOcean's `metadata service`_. This
+metadata service serves information about the running droplet via HTTP over the link local address
+169.254.169.254. The metadata API endpoints are fully described at
+`https://developers.digitalocean.com/metadata/ <https://developers.digitalocean.com/metadata/>`_.
+
+Configuration
+~~~~~~~~~~~~~
+
+DigitalOcean's datasource can be configured as follows:
+
+ datasource:
+ DigitalOcean:
+ retries: 3
+ timeout: 2
+
+- *retries*: Determines the number of times to attempt to connect to the metadata service
+- *timeout*: Determines the timeout in seconds to wait for a response from the metadata service
+
+.. _DigitalOcean: http://digitalocean.com/
+.. _metadata service: https://developers.digitalocean.com/metadata/
+.. _Full documentation: https://developers.digitalocean.com/metadata/