summaryrefslogtreecommitdiff
path: root/doc/rtd/topics/datasources/vultr.rst
diff options
context:
space:
mode:
authorDavid Dymko <dymkod@gmail.com>2021-04-13 14:15:34 -0400
committerGitHub <noreply@github.com>2021-04-13 14:15:34 -0400
commit0ae0b1d4336acdcab12bd49e9bddb46922fb19c7 (patch)
tree11eca25e1c86dfeab2a80bcf027af9aebf2aec78 /doc/rtd/topics/datasources/vultr.rst
parent83f6bbfbe5b924be61a3c098f4202377d69c8947 (diff)
downloadvyos-cloud-init-0ae0b1d4336acdcab12bd49e9bddb46922fb19c7.tar.gz
vyos-cloud-init-0ae0b1d4336acdcab12bd49e9bddb46922fb19c7.zip
Add Vultr support (#827)
This PR adds in support so that cloud-init can run on instances deployed on Vultr cloud. This was originally brought up in #628. Co-authored-by: Eric Benner <ebenner@vultr.com>
Diffstat (limited to 'doc/rtd/topics/datasources/vultr.rst')
-rw-r--r--doc/rtd/topics/datasources/vultr.rst35
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/rtd/topics/datasources/vultr.rst b/doc/rtd/topics/datasources/vultr.rst
new file mode 100644
index 00000000..e73406a8
--- /dev/null
+++ b/doc/rtd/topics/datasources/vultr.rst
@@ -0,0 +1,35 @@
+.. _datasource_vultr:
+
+Vultr
+=====
+
+The `Vultr`_ datasource retrieves basic configuration values from the locally
+accessible `metadata service`_. All data is served over HTTP from the address
+169.254.169.254. The endpoints are documented in,
+`https://www.vultr.com/metadata/
+<https://www.vultr.com/metadata/>`_
+
+Configuration
+-------------
+
+Vultr's datasource can be configured as follows:
+
+ datasource:
+ Vultr:
+ url: 'http://169.254.169.254'
+ retries: 3
+ timeout: 2
+ wait: 2
+
+- *url*: The URL used to aquire the metadata configuration from
+- *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
+- *wait*: Determines the timeout in seconds to wait before retrying after
+ accessible failure
+
+.. _Vultr: https://www.vultr.com/
+.. _metadata service: https://www.vultr.com/metadata/
+
+.. vi: textwidth=78