summaryrefslogtreecommitdiff
path: root/doc/rtd/topics/datasources/cloudsigma.rst
diff options
context:
space:
mode:
authorScott Moser <smoser@brickies.net>2016-11-10 16:42:43 -0500
committerScott Moser <smoser@brickies.net>2016-11-10 16:48:58 -0500
commit127f0f5076bf8e5c53dd538899199455ebc08fbc (patch)
treeb749345cefd3c003a8e7960af32d50ea98fa2de3 /doc/rtd/topics/datasources/cloudsigma.rst
parent25c218e5659445ecf64febe03c08c6fd9ca016e6 (diff)
downloadvyos-cloud-init-127f0f5076bf8e5c53dd538899199455ebc08fbc.tar.gz
vyos-cloud-init-127f0f5076bf8e5c53dd538899199455ebc08fbc.zip
doc: make the RST files consistently formated and other improvements.
The biggest things here are: * move doc/sources/*/README.rst to doc/rtd/topics/datasources This gives each datasource a page in the rtd docs, which make it easier to read. * consistently use the same header style throughout. As suggested at http://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html use: # with overline, for parts * with overline, for chapters =, for sections -, for subsections ^, for subsubsections “, for paragraphs Also, move and re-format vendor-data documentation to rtd.
Diffstat (limited to 'doc/rtd/topics/datasources/cloudsigma.rst')
-rw-r--r--doc/rtd/topics/datasources/cloudsigma.rst40
1 files changed, 40 insertions, 0 deletions
diff --git a/doc/rtd/topics/datasources/cloudsigma.rst b/doc/rtd/topics/datasources/cloudsigma.rst
new file mode 100644
index 00000000..54963f61
--- /dev/null
+++ b/doc/rtd/topics/datasources/cloudsigma.rst
@@ -0,0 +1,40 @@
+CloudSigma
+==========
+
+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`_.
+
+You have the option to encode your user-data using Base64. In order to do that
+you have to add the ``cloudinit-user-data`` field to the ``base64_fields``.
+The latter is a comma-separated field with all the meta fields whit base64
+encoded values.
+
+If your user-data does not need an internet connection you can create a `meta
+field`_ in the `server context`_ ``cloudinit-dsmode`` and set "local" as
+value. If this field does not exist the default value is "net".
+
+
+.. _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
+.. vi: textwidth=78