RTD infrasim-compute update - user guide

Bryan Fu · Bryan Fu · commit 395c11412541 · 2016-09-30T16:27:39.000+08:00
diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -6,7 +6,7 @@ Configuration
 Virtual Server Configuration file
 ------------------------------------------------
 
-There's one central virtual server configuration file which is /etc/infrasim/infrasim.yml (`source code <https://github.com/InfraSIM/infrasim-compute/blob/master/template/infrasim.yml>`_). All adjustable parameters are defined in this file. This is only one place if you want to customize or make adjustment on the virtual server node. While not all the options are explicitly listed in this file for purpose of simplicity. However there's one example configuration file - /etc/infrasim.full.yml.example (`source code <https://github.com/InfraSIM/infrasim-compute/blob/master/etc/infrasim.full.yml.example>`_) - listed all supported parameters and definitions. By referring content in example file, you can modify real file infrasim.yml and then restart infrasim-main service, new properties will take effect.
+There's one central virtual server configuration file which is **/etc/infrasim/infrasim.yml** (`source code <https://github.com/InfraSIM/infrasim-compute/blob/master/template/infrasim.yml>`_). All adjustable parameters are defined in this file. This is the only file to modify if you want to customize or make adjustment on the virtual server node. While not all supported options are explicitly listed in this file for purpose of simplicity. However there's one example configuration file - **/etc/infrasim.full.yml.example** (`source code <https://github.com/InfraSIM/infrasim-compute/blob/master/etc/infrasim.full.yml.example>`_) - listed all supported parameters and definitions. By referring content in example file, you can modify real file infrasim.yml and then restart infrasim-main service and then new properties will take effect.
 
 Here's full list of the example configuration file; every single key-value pair is supported to be add/modify in your real-in-use infrasim.yml::
 
@@ -95,7 +95,6 @@ Here's full list of the example configuration file; every single key-value pair
     serial_port: 9003
 
 
-
 Networking
 ------------------------------------------------
 
@@ -131,10 +130,13 @@ Networking
     .. image:: _static/networking_bridge_multiple.PNG
         :align: center
 
-Virtual Power Distribution Unit - Robert - Under construction
-------------------------------------------------
 
- Current Virtual PDU implementation only supports running entire virutal infrastructure on VMWare ESXi because it only supports functionality of simulating power control chassis through VMWare SDK.
+.. hide_content::
+
+            Virtual Power Distribution Unit - Robert - Under construction
+            ------------------------------------------------
+
+            Current Virtual PDU implementation only supports running entire virutal infrastructure on VMWare ESXi because it only supports functionality of simulating power control chassis through VMWare SDK.
 
- .. image:: _static/networkwithoutrackhd.png
-    :align: center
+            .. image:: _static/networkwithoutrackhd.png
+                :align: center
diff --git a/docs/dev_guide.rst b/docs/dev_guide.rst
@@ -62,7 +62,7 @@ If you put a review up, please be explicit with a vote (+1, -1, or +/-0) so we c
 QEMU
 ~~~~~~~~~~~~~~~~
 
-InfraSIM leverages QEMU in its implementation. It introduced tested, stable major release from official QEMU repository. There are also additional code changes kept at https://github.com/InfraSIM/qemu for purpose of better simulating servers. 
+InfraSIM leverages QEMU in its implementation. It introduced tested, stable major release from official QEMU repository. There are also additional code changes kept at `infrasim/qemu <https://github.com/InfraSIM/qemu>`_ for purpose of better simulating servers. 
 
 We always build QEMU on top of Ubuntu 64-bit 16.04 Linux and wrap it into one Debian package. This package is available at `InfraSIM QEMU Debian`_.  InfraSIM application will download and install it into system before starting its service.
 
@@ -72,7 +72,7 @@ We always build QEMU on top of Ubuntu 64-bit 16.04 Linux and wrap it into one De
 openipmi
 ~~~~~~~~~~~~~~~~
 
-InfraSIM leverages openipmi to simulate BMC properties and behavior. Similarly, there are also additional code changes kept at https://github.com/InfraSIM/openipmi for purpose of better simulating servers.
+InfraSIM leverages openipmi to simulate BMC properties and behavior. Similarly, there are also additional code changes kept at `infrasim/openipmi <https://github.com/InfraSIM/openipmi>`_ for purpose of better simulating servers.
 
 We always build openipmi on top of Ubuntu 64-bit 16.04 Linux and wrap it into one Debian package. This package is available at `InfraSIM OpenIpmi Debian`_.  InfraSIM application will download and install it into system before starting its service.
 
diff --git a/docs/get_start.rst b/docs/get_start.rst
@@ -31,7 +31,7 @@ Interface to access virtual server
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 #. Server graphic UI
-VNC viewer through port **5901**. If you can also port-forward guest VNC default port 5901 to host port (for example, 15901). So, you can access VNC service via host 15901 port. You can see the virtual monitor is already running and listing boot devices of virtual node. Through this booting devices, you can deploy hypervisor or operating system into virtual compute node.
+    VNC service is available through port **5901**. You can see the virtual monitor is already running and listing boot devices of virtual node. Through this booting devices, you can deploy hypervisor or operating system into virtual compute node just like operating on one physical server
 
 	  .. image:: _static/vnc.png
 
@@ -61,12 +61,20 @@ VNC viewer through port **5901**. If you can also port-forward guest VNC default
 		System Event     | Not Readable      | ns
         ...
 
+  #. Serial over LAN
 
+    It requires activate SoL through IPMI command and console running IPMI console will becomes serial console of virtual server. After InfraSIM services started, this command is to activate SoL::
 
-Virtual Power Distribution Unit - Robert - Under construction
-------------------------------------------------
+      sudo ipmitool -I lanplus -U admin -P admin -H localhost sol activate
+      [SOL Session operational.  Use ~? for help]
+
+
+.. hide_content::
+
+            Virtual Power Distribution Unit - Robert - Under construction
+            ------------------------------------------------
 
- Current Virtual PDU implementation only supports running entire virutal infrastructure on VMWare ESXi because it only supports functionality of simulating power control chassis through VMWare SDK.
+            Current Virtual PDU implementation only supports running entire virutal infrastructure on VMWare ESXi because it only supports functionality of simulating power control chassis through VMWare SDK.
 
 
 Setup a mini InfraSIM Virtual infrastructure on ESXi
diff --git a/docs/index.rst b/docs/index.rst
@@ -5,7 +5,7 @@
 
 
 .. image:: _static/theme/img/logo.png
-   :scale: 10%
+   :scale: 50%
    :align: center
 
 InfraSIM™
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -71,7 +71,10 @@ Virtual Server
         sudo pip install infrasim-compute
 
 
-Virtual Power Distribution Unit - **Robert - Under construction**
-------------------------------------------------
+.. hide_content::
+
+
+        Virtual Power Distribution Unit - **Robert - Under construction**
+        ------------------------------------------------
 
- Current Virtual PDU implementation only supports running entire virtual infrastructure on VMWare ESXi because it only supports functionality of simulating power control chassis through VMWare SDK.
+        Current Virtual PDU implementation only supports running entire virtual infrastructure on VMWare ESXi because it only supports functionality of simulating power control chassis through VMWare SDK.
diff --git a/docs/user_guide.rst b/docs/user_guide.rst
