summaryrefslogtreecommitdiff
path: root/doc/rtd/topics/datasources/altcloud.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/altcloud.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/altcloud.rst')
-rw-r--r--doc/rtd/topics/datasources/altcloud.rst91
1 files changed, 91 insertions, 0 deletions
diff --git a/doc/rtd/topics/datasources/altcloud.rst b/doc/rtd/topics/datasources/altcloud.rst
new file mode 100644
index 00000000..8646e77e
--- /dev/null
+++ b/doc/rtd/topics/datasources/altcloud.rst
@@ -0,0 +1,91 @@
+Alt Cloud
+=========
+
+The datasource altcloud will be used to pick up user data on `RHEVm`_ and `vSphere`_.
+
+RHEVm
+-----
+
+For `RHEVm`_ v3.0 the userdata is injected into the VM using floppy
+injection via the `RHEVm`_ dashboard "Custom Properties".
+
+The format of the Custom Properties entry must be:
+
+::
+
+ floppyinject=user-data.txt:<base64 encoded data>
+
+For example to pass a simple bash script:
+
+.. sourcecode:: sh
+
+ % cat simple_script.bash
+ #!/bin/bash
+ echo "Hello Joe!" >> /tmp/JJV_Joe_out.txt
+
+ % base64 < simple_script.bash
+ IyEvYmluL2Jhc2gKZWNobyAiSGVsbG8gSm9lISIgPj4gL3RtcC9KSlZfSm9lX291dC50eHQK
+
+To pass this example script to cloud-init running in a `RHEVm`_ v3.0 VM
+set the "Custom Properties" when creating the RHEMv v3.0 VM to:
+
+::
+
+ floppyinject=user-data.txt:IyEvYmluL2Jhc2gKZWNobyAiSGVsbG8gSm9lISIgPj4gL3RtcC9KSlZfSm9lX291dC50eHQK
+
+**NOTE:** The prefix with file name must be: ``floppyinject=user-data.txt:``
+
+It is also possible to launch a `RHEVm`_ v3.0 VM and pass optional user
+data to it using the Delta Cloud.
+
+For more information on Delta Cloud see: http://deltacloud.apache.org
+
+vSphere
+-------
+
+For VMWare's `vSphere`_ the userdata is injected into the VM as an ISO
+via the cdrom. This can be done using the `vSphere`_ dashboard
+by connecting an ISO image to the CD/DVD drive.
+
+To pass this example script to cloud-init running in a `vSphere`_ VM
+set the CD/DVD drive when creating the vSphere VM to point to an
+ISO on the data store.
+
+**Note:** The ISO must contain the user data.
+
+For example, to pass the same ``simple_script.bash`` to vSphere:
+
+Create the ISO
+^^^^^^^^^^^^^^
+
+.. sourcecode:: sh
+
+ % mkdir my-iso
+
+NOTE: The file name on the ISO must be: ``user-data.txt``
+
+.. sourcecode:: sh
+
+ % cp simple_scirpt.bash my-iso/user-data.txt
+ % genisoimage -o user-data.iso -r my-iso
+
+Verify the ISO
+^^^^^^^^^^^^^^
+
+.. sourcecode:: sh
+
+ % sudo mkdir /media/vsphere_iso
+ % sudo mount -o loop JoeV_CI_02.iso /media/vsphere_iso
+ % cat /media/vsphere_iso/user-data.txt
+ % sudo umount /media/vsphere_iso
+
+Then, launch the `vSphere`_ VM the ISO user-data.iso attached as a CDROM.
+
+It is also possible to launch a `vSphere`_ VM and pass optional user
+data to it using the Delta Cloud.
+
+For more information on Delta Cloud see: http://deltacloud.apache.org
+
+.. _RHEVm: https://www.redhat.com/virtualization/rhev/desktop/rhevm/
+.. _vSphere: https://www.vmware.com/products/datacenter-virtualization/vsphere/overview.html
+.. vi: textwidth=78