summaryrefslogtreecommitdiff
path: root/doc/rtd/reference/datasources/digitalocean.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/rtd/reference/datasources/digitalocean.rst')
-rw-r--r--doc/rtd/reference/datasources/digitalocean.rst32
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/rtd/reference/datasources/digitalocean.rst b/doc/rtd/reference/datasources/digitalocean.rst
new file mode 100644
index 00000000..7283aac1
--- /dev/null
+++ b/doc/rtd/reference/datasources/digitalocean.rst
@@ -0,0 +1,32 @@
+.. _datasource_digital_ocean:
+
+DigitalOcean
+************
+
+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 in the DigitalOcean
+`metadata documentation`_.
+
+Configuration
+=============
+
+DigitalOcean's datasource can be configured as follows: ::
+
+ datasource:
+ DigitalOcean:
+ retries: 3
+ timeout: 2
+
+* ``retries``
+
+ Specifies the number of times to attempt connection to the metadata service.
+
+* ``timeout``
+
+ Specifies the timeout (in seconds) to wait for a response from the
+ metadata service.
+
+.. _DigitalOcean: http://digitalocean.com/
+.. _metadata documentation: https://developers.digitalocean.com/metadata/