Merge lp:~jose/charms/precise/vsm/fix-readme into lp:~springfield-team/charms/precise/vsm/trunk

[José Antonio Rey]

I have fixed the README.md file to be in Markdown, in order for it to display properly on the Juju GUI.

=== modified file 'README.md'
--- README.md	2014-04-15 21:45:09 +0000
+++ README.md	2014-04-15 22:04:35 +0000
@@ -1,86 +1,72 @@
-<h2>Overview</h2>
+# Overview
 
-<p>There are two major components in a Cisco Nexus 1000V environment: 
+There are two major components in a Cisco Nexus 1000V environment: 
 VSM (Virtual Switch Supervisor) and VEM (Virtual Ethernet Module).
 VSM is a virtual machine on a baremetal server. VEM runs inside each host. 
-VSM, as the name goes, supervises and manages multiple VEMs. <br />
+VSM, as the name goes, supervises and manages multiple VEMs.
+
 In the OpenStack deployment environment, VSM prepares north 
 bound REST APIs that communicate with OpenStack Nova Cloud 
 Controller for network profile configuration, policy profile 
 notification, network creation, subnet creation, and virtual 
-machine workload administration.</p>
+machine workload administration.
 
-<p>VSM charm installs the Nexus 1000V virtual switch Supervisor 
+VSM charm installs the Nexus 1000V virtual switch Supervisor 
 Module virtual machine onto a MaaS cluster node. A cluster can 
 have up to 2 VSM in active/standby mode (generally in two different servers).
-When the active one fails, the standby will take over within bounded time.</p>
-
-<h2>Usage</h2>
-
-<p>In order to use Cisco Openstack solution we would need to install 
+When the active one fails, the standby will take over within bounded time.
+
+# Usage
+
+In order to use Cisco Openstack solution we would need to install 
 VSM on a cluster node as well as VEM module that goes into each 
 host. In order to provide High Availability for VSM you'll need
 to deploy two VSMs (one will be the primary and another the secondary)
-in two different hosts. </p>
+in two different hosts. 
 
-<p>In order to deploy the VSMs (both primary and secondary), you will 
+In order to deploy the VSMs (both primary and secondary), you will 
 need to create a configuration file where you need to provide specific
 configuration of your VSM. To differentiate the different primary 
 and secondary VSM configuration, we create separate sections for them
 on the configuration file and also you deploy as two different service
-names.</p>
-
-<p>For example, you create a myconfig.yaml configuration file with the 
-following info:</p>
-
-<p>vsm-primary:</p>
-
-<pre><code>n1kv-vsm-domain-id: 101
-
-n1kv-vsm-password: password
-
-n1kv-vsm-name: vsm-p
-
-n1kv-vsm-role: primary
-
-n1kv-vsm-mgmt-ip: 10.10.10.10
-
-n1kv-vsm-mgmt-netmask: 255.255.255.0
-
-n1kv-vsm-mgmt-gateway: 10.10.10.1
-
-.....
-</code></pre>
-
-<p>vsm-secondary:</p>
-
-<pre><code>n1kv-vsm-domain-id: 101
-
-n1kv-vsm-password: password
-
-n1kv-vsm-name: vsm-s
-
-n1kv-vsm-role: secondary
-
-.....
-</code></pre>
-
-<p>Then you deploy the primary VSM with the following command:</p>
-
-<p><code>juju deploy --config myconfig.yaml vsm vsm-primary</code></p>
-
-<p>Then you deploy the secondary VSM with the following command:</p>
-
-<p><code>juju deploy --config myconfig.yaml vsm vsm-secondary</code></p>
-
-<p>To put VEM into VSM supervision, you need to do the following:</p>
-
-<p><code>juju add-relation vsm vem</code></p>
-
-<h2>Contact Information</h2>
-
-<p>Author: Marga Millet <a href="&#x6D;&#x61;i&#x6C;&#116;o:&#x6D;&#105;&#108;&#x6C;&#101;&#x74;&#64;&#99;&#105;&#115;&#99;&#111;&#46;&#99;&#x6F;&#109;">&#x6D;&#105;&#108;&#x6C;&#101;&#x74;&#64;&#99;&#105;&#115;&#99;&#111;&#46;&#99;&#x6F;&#109;</a></p>
-
-<p>Report bugs at: http://bugs.launchpad.net/charms/+source/vsm</p>
-
-<p>Location: http://jujucharms.com/charms/distro/vsm</p>
+names.
+
+For example, you create a myconfig.yaml configuration file with the 
+following info:
+
+    vsm-primary:
+        n1kv-vsm-domain-id: 101
+        n1kv-vsm-password: password
+        n1kv-vsm-name: vsm-p
+        n1kv-vsm-role: primary
+        n1kv-vsm-mgmt-ip: 10.10.10.10
+        n1kv-vsm-mgmt-netmask: 255.255.255.0
+        n1kv-vsm-mgmt-gateway: 10.10.10.1
+        .....
+
+    vsm-secondary:
+        n1kv-vsm-domain-id: 101
+        n1kv-vsm-password: password
+        n1kv-vsm-name: vsm-s
+        n1kv-vsm-role: secondary
+        .....
+   
+
+Then you deploy the primary VSM with the following command:
+
+   juju deploy --config myconfig.yaml vsm vsm-primary
+
+Then you deploy the secondary VSM with the following command:
+
+   juju deploy --config myconfig.yaml vsm vsm-secondary
+
+To put VEM into VSM supervision, you need to do the following:
+
+   juju add-relation vsm vem
+
+   
+# Contact Information
+
+Author: Marga Millet <[e-mail]>  
+Report bugs at: http://bugs.launchpad.net/charms/+source/vsm  
+Location: http://jujucharms.com/