summaryrefslogtreecommitdiff
path: root/doc/rtd/reference/datasources/upcloud.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/rtd/reference/datasources/upcloud.rst')
-rw-r--r--doc/rtd/reference/datasources/upcloud.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/rtd/reference/datasources/upcloud.rst b/doc/rtd/reference/datasources/upcloud.rst
new file mode 100644
index 00000000..21b95922
--- /dev/null
+++ b/doc/rtd/reference/datasources/upcloud.rst
@@ -0,0 +1,22 @@
+.. _datasource_upcloud:
+
+UpCloud
+*******
+
+The `UpCloud`_ datasource consumes information from UpCloud's `metadata
+service`_. This metadata service serves information about the
+running server via HTTP over the address ``169.254.169.254`` available in
+every DHCP-configured interface. The metadata API endpoints are fully
+described in `UpCloud API documentation`_.
+
+Providing user data
+===================
+
+When creating a server, user data is provided by specifying it as
+``user_data`` in the API or via the server creation tool in the control panel.
+User data is immutable during the server's lifetime, and can be removed by
+deleting the server.
+
+.. _UpCloud: https://upcloud.com/
+.. _metadata service: https://upcloud.com/community/tutorials/upcloud-metadata-service/
+.. _UpCloud API documentation: https://developers.upcloud.com/1.3/8-servers/#metadata-service