x/cloud-init
Code Issues Proposed changes

Add documentation for DigitalOcean datasource

Browse Source
This commit is contained in:
Neal Shrader 2014-10-17 16:28:09 -04:00
parent 59da3d8472
commit 09e2762387
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/sources/digitalocean/README.rst Normal file
View File

@ -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/