summaryrefslogtreecommitdiff
path: root/doc/sources/cloudsigma
diff options
context:
space:
mode:
authorScott Moser <smoser@ubuntu.com>2014-02-12 16:53:05 -0500
committerScott Moser <smoser@ubuntu.com>2014-02-12 16:53:05 -0500
commit0b0bb4721c61015e3fce9b4030bcb69b9da5c368 (patch)
tree5cda2535587b0c8e357ab4ed0fce920d2be3939f /doc/sources/cloudsigma
parent20305aea1eac724069e0bfaaf976ec5caa8c2439 (diff)
parent5d2a31bd66fc5fc10901e30a2b9c79c7f4d1a172 (diff)
downloadvyos-cloud-init-0b0bb4721c61015e3fce9b4030bcb69b9da5c368.tar.gz
vyos-cloud-init-0b0bb4721c61015e3fce9b4030bcb69b9da5c368.zip
merge from trunk
Diffstat (limited to 'doc/sources/cloudsigma')
-rw-r--r--doc/sources/cloudsigma/README.rst34
1 files changed, 34 insertions, 0 deletions
diff --git a/doc/sources/cloudsigma/README.rst b/doc/sources/cloudsigma/README.rst
new file mode 100644
index 00000000..8cb2b0fe
--- /dev/null
+++ b/doc/sources/cloudsigma/README.rst
@@ -0,0 +1,34 @@
+=====================
+CloudSigma Datasource
+=====================
+
+This datasource finds metadata and user-data from the `CloudSigma`_ cloud platform.
+Data transfer occurs through a virtual serial port of the `CloudSigma`_'s VM and the
+presence of network adapter is **NOT** a requirement,
+
+ See `server context`_ in the public documentation for more information.
+
+
+Setting a hostname
+~~~~~~~~~~~~~~~~~~
+
+By default the name of the server will be applied as a hostname on the first boot.
+
+
+Providing user-data
+~~~~~~~~~~~~~~~~~~~
+
+You can provide user-data to the VM using the dedicated `meta field`_ in the `server context`_
+``cloudinit-user-data``. By default *cloud-config* format is expected there and the ``#cloud-config``
+header could be omitted. However since this is a raw-text field you could provide any of the valid
+`config formats`_.
+
+If your user-data needs an internet connection you have to create a `meta field`_ in the `server context`_
+``cloudinit-dsmode`` and set "net" as value. If this field does not exist the default value is "local".
+
+
+
+.. _CloudSigma: http://cloudsigma.com/
+.. _server context: http://cloudsigma-docs.readthedocs.org/en/latest/server_context.html
+.. _meta field: http://cloudsigma-docs.readthedocs.org/en/latest/meta.html
+.. _config formats: http://cloudinit.readthedocs.org/en/latest/topics/format.html