summaryrefslogtreecommitdiff
path: root/doc/rtd/topics/datasources/digitalocean.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/rtd/topics/datasources/digitalocean.rst')
-rw-r--r--doc/rtd/topics/datasources/digitalocean.rst28
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/rtd/topics/datasources/digitalocean.rst b/doc/rtd/topics/datasources/digitalocean.rst
new file mode 100644
index 00000000..c6f5bc74
--- /dev/null
+++ b/doc/rtd/topics/datasources/digitalocean.rst
@@ -0,0 +1,28 @@
+Digital Ocean
+=============
+
+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/
+
+.. vi: textwidth=78