From 444120e896dffd1d7d788da5bfaa98ef762fba35 Mon Sep 17 00:00:00 2001
From: Vlastimil Holer <vlastimil.holer@gmail.com>
Date: Wed, 20 Feb 2013 13:46:18 +0100
Subject: OpenNebula documentation tuning.
---
doc/sources/opennebula/README.rst | 46 ++++++++++++++++++++-------------------
1 file changed, 24 insertions(+), 22 deletions(-)
diff --git a/doc/sources/opennebula/README.rst b/doc/sources/opennebula/README.rst
index d4c3dc39..5cbc4366 100644
--- a/doc/sources/opennebula/README.rst
+++ b/doc/sources/opennebula/README.rst
@@ -1,14 +1,14 @@
-The `OpenNebula`_ DataSource supports the OpenNebula contextualization disk.
+The `OpenNebula`_ (ON) datasource supports the contextualization disk.
See `contextualization overview`_, `contextualizing VMs`_ and
`network configuration`_ in the public documentation for
more information.
OpenNebula's virtual machines are contextualized (parametrized) by
-CD-ROM image data, which contains a shell script *context.sh* with
+CD-ROM image, which contains a shell script *context.sh* with
custom variables defined on virtual machine start. There are no
fixed contextualization variables, but the datasource accepts
-many used and recommended across OpenNebula's documentation.
+many used and recommended across the documentation.
Datasource configuration
~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -32,7 +32,7 @@ The following criteria are required:
1. Must be formatted with `iso9660`_ fs. or have fs. label of **CDROM**
2. Must contain file *context.sh* with contextualization variables.
File is generated by OpenNebula, it has a KEY="VALUE" format and
- can be easily read by shell script.
+ can be easily read (via *source*) by shell
Contextualization variables
~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -74,7 +74,7 @@ Instance hostname.
If no hostname has been specified, cloud-init will try to create hostname
from instance's IP address in 'local' dsmode. In 'net' dsmode, cloud-init
-try to resolve one of its IP addresses to get hostname.
+tries to resolve one of its IP addresses to get hostname.
::
@@ -91,24 +91,26 @@ One or multiple SSH keys (separated by newlines) can be specified.
cloud-init user data.
-Example OpenNebula's Virtual Machine template
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Example VM's context section
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-CONTEXT=[
- PUBLIC_IP="$NIC[IP]",
- SSH_KEY="$USER[SSH_KEY]
-$USER[SSH_KEY1]
-$USER[SSH_KEY2] ",
- USER_DATA="#cloud-config
-# see https://help.ubuntu.com/community/CloudInit
-
-packages: []
-
-mounts:
-- [vdc,none,swap,sw,0,0]
-runcmd:
-- echo 'Instance has been configured by cloud-init.' | wall
-" ]
+::
+
+ CONTEXT=[
+ PUBLIC_IP="$NIC[IP]",
+ SSH_KEY="$USER[SSH_KEY]
+ $USER[SSH_KEY1]
+ $USER[SSH_KEY2] ",
+ USER_DATA="#cloud-config
+ # see https://help.ubuntu.com/community/CloudInit
+
+ packages: []
+
+ mounts:
+ - [vdc,none,swap,sw,0,0]
+ runcmd:
+ - echo 'Instance has been configured by cloud-init.' | wall
+ " ]
.. _OpenNebula: http://opennebula.org/
.. _contextualization overview: http://opennebula.org/documentation:documentation:context_overview
--
cgit v1.2.3