Modify documents up to MOS 8.0 and plugin 3.0

Change-Id: I5e906f095b1df2bb1f09e12cc022fd301ac3bd2e

doc/source/conf.py

@@ -55,9 +55,9 @@ author = u'John Hua (john.hua@citrix.com)'
 # built documents.
 #
 # The short X.Y version.
-version = '2.0'
+version = '3.0'
 # The full version, including alpha/beta/rc tags.
-release = '2.0-2.0.0-1'
+release = '3.0-3.0.0-1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

doc/source/description.rst

@@ -1,4 +1,4 @@
-XenServer Plugin for Fuel 7.0
+XenServer Plugin for Fuel 8.0
 =============================
 
 Requirements
@@ -7,9 +7,9 @@ Requirements
 ========================= ============================
 Requirement               Version/Comment
 ========================= ============================
-Fuel                      7.0 + Maintenance Update 1
+Fuel                      8.0
 XenServer                 6.5 SP1 + Hotfix XS65ESP1013
-XenServer plugin for Fuel 2.0.0
+XenServer plugin for Fuel 3.0.0
 ========================= ============================
 
 * This plugin will not install XenServer or configure the Virtual
@@ -24,15 +24,12 @@ XenServer plugin for Fuel 2.0.0
   configured to PXE boot from the PXE network used by Fuel.
 * XenCenter is expected to be used to configure VMs, and is required
   by the HIMN tool in the installation steps
-* Network 'br100' must exist on the XenServer hypervisors.  This
-  network will be added automatically to Virtual Machines and the
-  compute nodes must have access to this network.
 
 Limitations
 -----------
 
 * The plugin is **only** compatible with OpenStack environments deployed with
-  **Nova Network** as network configuration in the environment configuration
-  options. The plugin will disable incompatible options when the XenServer
-  Release is selected.
+  **Neutron with VLAN segmentation** as network configuration in the
+  environment configuration options. The plugin will disable incompatible
+  options when the XenServer Release is selected.
 

doc/source/guide.rst

@@ -22,15 +22,15 @@ Prepare infrastructure
 
 3. While many networking setups are expected to work, the following setup is known to work:
 
-   - Physical machines with two ethernet devices:
+   - Physical machines with three ethernet devices:
 
-    - eth0 / “Access network”: Used to access the XenServer hosts and Fuel Master during setup.
-    - eth1 / “VLAN network”: Carries all traffic during setup + use of OpenStack.  Untagged packets are tagged at the switch to ensure isolation from eth0.
+    - eth0 / “Access network”: Used to access the XenServer hosts and the Fuel Master’s web interface
+    - eth1 / “Control network”: OpenStack control plane (management and storage), the PXE network, private network and the public network; all separated by VLAN tags.  The public network is also on this network, and if a VLAN is required this is applied by the switch for untagged traffic.
+    - eth2 / “Private”: This version of the plugin only supports VLAN segmentation for Neutron networking.  This device carries all of the VLANs to be used by Neutron for VM traffic.
 
-   - Two virtual networks
+   - One virtual network
 
-    - VLAN 'A' on eth1 / “PXE network”: Used for node bootstrapping.
-    - VLAN 'B' on eth1 / "br100": Used to give connectivity between VM and router.
+    - VLAN 'pxe' on eth1 / “PXE network”: Used for node bootstrapping.
 
 4. To simplify the setup, the fuel master can also be installed on the XenServer hosts (so XenServer hosts can fully control the network setup), but this is not required.
 One example deployment, shown below, makes use of VLAN 19 for the "PXE network" and provides an isolated network for eth1 by tagging any untagged traffic at the switch with VLAN 237
@@ -42,7 +42,7 @@ One example deployment, shown below, makes use of VLAN 19 for the "PXE network"
 Select Environment
 ------------------
 
-#. Create a new environment with the Fuel UI wizard. Select "Kilo+Citrix XenServer on Ubuntu 14.04" from OpenStack Release dropdown list. At the moment you will see most of options are disabled in the wizard.
+#. Create a new environment with the Fuel UI wizard. Select "Liberty+Citrix XenServer on Ubuntu 14.04" from OpenStack Release dropdown list. At the moment you will see most of options are disabled in the wizard.
 
    .. image:: _static/fmwizard00.png
       :width: 80%
@@ -58,7 +58,7 @@ Select Environment
     .. image:: _static/HIMN_dialog.jpg
       :width: 80%
 
-#. Add new VMs to the new environment according to `Fuel User Guide <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#add-nodes-to-the-environment>`_ and configure them properly. A typical topology of 1 controller node + 3 compute nodes + 1 storage node is recommended.
+#. Add new VMs to the new environment according to `Fuel User Guide <https://docs.mirantis.com/openstack/fuel/fuel-8.0/user-guide.html#add-nodes-to-the-environment>`_ and configure them properly. A typical topology of 3 controller node2 + 3 compute nodes + 1 storage node is recommended.
 
 #. Go to Settings tab and scroll down to "XenServer Plugin" section. You need to input the common access credentials to all XenServers that previously are used to create new VMs.
 
@@ -71,9 +71,9 @@ Select Environment
 Finish environment configuration
 --------------------------------
 
-#. Run `network verification check <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#verify-networks>`_
+#. Run `network verification check <https://docs.mirantis.com/openstack/fuel/fuel-8.0/user-guide.html#verify-networks>`_
 
-#. Press `Deploy button <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#deploy-changes>`_ to once you are done with environment configuration.
+#. Press `Deploy button <https://docs.mirantis.com/openstack/fuel/fuel-8.0/user-guide.html#deploy-changes>`_ to once you are done with environment configuration.
 
 #. After deployment is done, you will see in Horizon that all hypervisors are xen.
 

doc/source/index.rst

@@ -1,4 +1,4 @@
-Guide to the XenServer Plugin for Fuel 7.0
+Guide to the XenServer Plugin for Fuel 8.0
 ==========================================
 
 Intro

doc/source/installation.rst

@@ -11,14 +11,14 @@ To install the XenServer Fuel plugin:
 #. Copy the *rpm* file to the Fuel Master node:
    ::
 
-      [root@home ~]# scp fuel-plugin-xenserver-2.0-2.0.0-1.noarch.rpm root@fuel-master:/tmp
+      [root@home ~]# scp fuel-plugin-xenserver-3.0-3.0.0-1.noarch.rpm root@fuel-master:/tmp
 
 #. Log into Fuel Master node and install the plugin using the
-   `Fuel CLI <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#using-fuel-cli>`_:
+   `Fuel CLI <https://docs.mirantis.com/openstack/fuel/fuel-8.0/user-guide.html#using-fuel-cli>`_:
 
    ::
 
-      [root@fuel-master ~]# fuel plugins --install /tmp/fuel-plugin-xenserver-2.0-2.0.0-1.noarch.rpm
+      [root@fuel-master ~]# fuel plugins --install /tmp/fuel-plugin-xenserver-3.0-3.0.0-1.noarch.rpm
 
 #. Verify that the plugin is installed correctly:
    ::
@@ -26,7 +26,7 @@ To install the XenServer Fuel plugin:
      [root@fuel-master ~]# fuel plugins
      id | name                  | version | package_version
      ---|-----------------------|---------|----------------
-     9  | fuel-plugin-xenserver | 2.0.0   | 3.0.0
+     9  | fuel-plugin-xenserver | 3.0.0   | 3.0.0
 
 Add Management Network tool
 ---------------------------

specs/fuel-plugin-xenserver.rst

@@ -6,7 +6,7 @@ Fuel Plugin for Xenserver
 The XenServer plugin provides the ability to use Xenserver as the
 hypervisor for Mirantis OpenStack.
 
-Compatible with Fuel version 7.0.
+Compatible with Fuel version 8.0.
 
 Problem description
 ===================
@@ -44,7 +44,7 @@ None.
 Upgrade impact
 --------------
 
-When upgrading the Fuel Master node to Fuel Version higher than 7.0,
+When upgrading the Fuel Master node to Fuel Version higher than 8.0,
 plugin compatibility should be checked, and a new plugin installed if
 necessary.
 
@@ -119,15 +119,17 @@ Assignee(s)
 -----------
 
 Primary assignee:
-  John Hua <john.hua@citrix.com> (developer)
+  Huan Xie <huan.xie@citrix.com> (developer)
 
 Other contributors:
   Bob Ball <bob.ball@citrix.com> (developer, reviewer)
+  Jianghua Wang <jianghua.wang@citrix.com> (developer)
+  John Hua <john.hua@citrix.com> (developer)
 
 Work Items
 ----------
 
-* Upgrade the XenServer Fuel 6.1 plugin to work with Fuel 7.0.
+* Upgrade the XenServer Fuel 7.0 plugin to work with Fuel 8.0.
 
 * Test XenServer plugin.
 
@@ -136,7 +138,7 @@ Work Items
 Dependencies
 ============
 
-* Fuel 7.0
+* Fuel 8.0
 
 Testing
 =======