summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Hua <john.hua@citrix.com>2016-03-18 19:24:40 +0800
committerJohn Hua <john.hua@citrix.com>2016-03-24 19:48:12 +0800
commit2a2f949c3f9f22791c91ac04355d7b9bd0b50522 (patch)
tree85b6cda8c126c78d2ba07142ddea43fc16ff8fa8
parent644d88263a24ae76b24ae7d48b3de269ead970c1 (diff)
Modify documents up to MOS 8.0 and plugin 3.0
Notes
Notes (review): Code-Review+2: Bob Ball <bob.ball@citrix.com> Workflow+1: Bob Ball <bob.ball@citrix.com> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Thu, 24 Mar 2016 14:35:18 +0000 Reviewed-on: https://review.openstack.org/294529 Project: openstack/fuel-plugin-xenserver Branch: refs/heads/master
-rw-r--r--doc/TestPlanforXenServerFuelPluginver2.0.0.pdfbin221984 -> 0 bytes
-rw-r--r--doc/TestPlanforXenServerFuelPluginver3.0.0.pdfbin0 -> 249359 bytes
-rw-r--r--doc/TestReportfortheXenServerFuelPluginver2.0.0.pdfbin174199 -> 0 bytes
-rw-r--r--doc/TestReportfortheXenServerFuelPluginver3.0.0.pdfbin0 -> 148980 bytes
-rw-r--r--doc/build/latex/fuel-plugin-xenserver.pdfbin308963 -> 296837 bytes
-rw-r--r--doc/source/_static/fmsetting00.pngbin26630 -> 44792 bytes
-rw-r--r--doc/source/_static/fmwizard00.pngbin61717 -> 44443 bytes
-rw-r--r--doc/source/_static/topology00.pngbin25352 -> 63224 bytes
-rw-r--r--doc/source/conf.py4
-rw-r--r--doc/source/description.rst15
-rw-r--r--doc/source/guide.rst20
-rw-r--r--doc/source/index.rst2
-rw-r--r--doc/source/installation.rst8
-rw-r--r--specs/fuel-plugin-xenserver.rst12
14 files changed, 30 insertions, 31 deletions
diff --git a/doc/TestPlanforXenServerFuelPluginver2.0.0.pdf b/doc/TestPlanforXenServerFuelPluginver2.0.0.pdf
deleted file mode 100644
index ed2da14..0000000
--- a/doc/TestPlanforXenServerFuelPluginver2.0.0.pdf
+++ /dev/null
Binary files differ
diff --git a/doc/TestPlanforXenServerFuelPluginver3.0.0.pdf b/doc/TestPlanforXenServerFuelPluginver3.0.0.pdf
new file mode 100644
index 0000000..2d279d8
--- /dev/null
+++ b/doc/TestPlanforXenServerFuelPluginver3.0.0.pdf
Binary files differ
diff --git a/doc/TestReportfortheXenServerFuelPluginver2.0.0.pdf b/doc/TestReportfortheXenServerFuelPluginver2.0.0.pdf
deleted file mode 100644
index 7347e93..0000000
--- a/doc/TestReportfortheXenServerFuelPluginver2.0.0.pdf
+++ /dev/null
Binary files differ
diff --git a/doc/TestReportfortheXenServerFuelPluginver3.0.0.pdf b/doc/TestReportfortheXenServerFuelPluginver3.0.0.pdf
new file mode 100644
index 0000000..7181f82
--- /dev/null
+++ b/doc/TestReportfortheXenServerFuelPluginver3.0.0.pdf
Binary files differ
diff --git a/doc/build/latex/fuel-plugin-xenserver.pdf b/doc/build/latex/fuel-plugin-xenserver.pdf
index ecca62c..abf5a19 100644
--- a/doc/build/latex/fuel-plugin-xenserver.pdf
+++ b/doc/build/latex/fuel-plugin-xenserver.pdf
Binary files differ
diff --git a/doc/source/_static/fmsetting00.png b/doc/source/_static/fmsetting00.png
index 33a7170..6ec46e2 100644
--- a/doc/source/_static/fmsetting00.png
+++ b/doc/source/_static/fmsetting00.png
Binary files differ
diff --git a/doc/source/_static/fmwizard00.png b/doc/source/_static/fmwizard00.png
index 655772c..f2eaf8e 100644
--- a/doc/source/_static/fmwizard00.png
+++ b/doc/source/_static/fmwizard00.png
Binary files differ
diff --git a/doc/source/_static/topology00.png b/doc/source/_static/topology00.png
index 9216989..deccc83 100644
--- a/doc/source/_static/topology00.png
+++ b/doc/source/_static/topology00.png
Binary files differ
diff --git a/doc/source/conf.py b/doc/source/conf.py
index f61201b..0de450f 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -55,9 +55,9 @@ author = u'John Hua (john.hua@citrix.com)'
55# built documents. 55# built documents.
56# 56#
57# The short X.Y version. 57# The short X.Y version.
58version = '2.0' 58version = '3.0'
59# The full version, including alpha/beta/rc tags. 59# The full version, including alpha/beta/rc tags.
60release = '2.0-2.0.0-1' 60release = '3.0-3.0.0-1'
61 61
62# The language for content autogenerated by Sphinx. Refer to documentation 62# The language for content autogenerated by Sphinx. Refer to documentation
63# for a list of supported languages. 63# for a list of supported languages.
diff --git a/doc/source/description.rst b/doc/source/description.rst
index ddc0519..da464a9 100644
--- a/doc/source/description.rst
+++ b/doc/source/description.rst
@@ -1,4 +1,4 @@
1XenServer Plugin for Fuel 7.0 1XenServer Plugin for Fuel 8.0
2============================= 2=============================
3 3
4Requirements 4Requirements
@@ -7,9 +7,9 @@ Requirements
7========================= ============================ 7========================= ============================
8Requirement Version/Comment 8Requirement Version/Comment
9========================= ============================ 9========================= ============================
10Fuel 7.0 + Maintenance Update 1 10Fuel 8.0
11XenServer 6.5 SP1 + Hotfix XS65ESP1013 11XenServer 6.5 SP1 + Hotfix XS65ESP1013
12XenServer plugin for Fuel 2.0.0 12XenServer plugin for Fuel 3.0.0
13========================= ============================ 13========================= ============================
14 14
15* This plugin will not install XenServer or configure the Virtual 15* This plugin will not install XenServer or configure the Virtual
@@ -24,15 +24,12 @@ XenServer plugin for Fuel 2.0.0
24 configured to PXE boot from the PXE network used by Fuel. 24 configured to PXE boot from the PXE network used by Fuel.
25* XenCenter is expected to be used to configure VMs, and is required 25* XenCenter is expected to be used to configure VMs, and is required
26 by the HIMN tool in the installation steps 26 by the HIMN tool in the installation steps
27* Network 'br100' must exist on the XenServer hypervisors. This
28 network will be added automatically to Virtual Machines and the
29 compute nodes must have access to this network.
30 27
31Limitations 28Limitations
32----------- 29-----------
33 30
34* The plugin is **only** compatible with OpenStack environments deployed with 31* The plugin is **only** compatible with OpenStack environments deployed with
35 **Nova Network** as network configuration in the environment configuration 32 **Neutron with VLAN segmentation** as network configuration in the
36 options. The plugin will disable incompatible options when the XenServer 33 environment configuration options. The plugin will disable incompatible
37 Release is selected. 34 options when the XenServer Release is selected.
38 35
diff --git a/doc/source/guide.rst b/doc/source/guide.rst
index 020762d..a5c84c1 100644
--- a/doc/source/guide.rst
+++ b/doc/source/guide.rst
@@ -22,15 +22,15 @@ Prepare infrastructure
22 22
233. While many networking setups are expected to work, the following setup is known to work: 233. While many networking setups are expected to work, the following setup is known to work:
24 24
25 - Physical machines with two ethernet devices: 25 - Physical machines with three ethernet devices:
26 26
27 - eth0 / “Access network”: Used to access the XenServer hosts and Fuel Master during setup. 27 - eth0 / “Access network”: Used to access the XenServer hosts and the Fuel Master’s web interface
28 - eth1 / “VLAN network”: Carries all traffic during setup + use of OpenStack. Untagged packets are tagged at the switch to ensure isolation from eth0. 28 - 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.
29 - 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.
29 30
30 - Two virtual networks 31 - One virtual network
31 32
32 - VLAN 'A' on eth1 / “PXE network”: Used for node bootstrapping. 33 - VLAN 'pxe' on eth1 / “PXE network”: Used for node bootstrapping.
33 - VLAN 'B' on eth1 / "br100": Used to give connectivity between VM and router.
34 34
354. 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. 354. 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.
36One 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 36One 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"
42Select Environment 42Select Environment
43------------------ 43------------------
44 44
45#. 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. 45#. 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.
46 46
47 .. image:: _static/fmwizard00.png 47 .. image:: _static/fmwizard00.png
48 :width: 80% 48 :width: 80%
@@ -58,7 +58,7 @@ Select Environment
58 .. image:: _static/HIMN_dialog.jpg 58 .. image:: _static/HIMN_dialog.jpg
59 :width: 80% 59 :width: 80%
60 60
61#. 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. 61#. 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.
62 62
63#. 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. 63#. 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.
64 64
@@ -71,9 +71,9 @@ Select Environment
71Finish environment configuration 71Finish environment configuration
72-------------------------------- 72--------------------------------
73 73
74#. Run `network verification check <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#verify-networks>`_ 74#. Run `network verification check <https://docs.mirantis.com/openstack/fuel/fuel-8.0/user-guide.html#verify-networks>`_
75 75
76#. 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. 76#. 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.
77 77
78#. After deployment is done, you will see in Horizon that all hypervisors are xen. 78#. After deployment is done, you will see in Horizon that all hypervisors are xen.
79 79
diff --git a/doc/source/index.rst b/doc/source/index.rst
index be50143..791bc70 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -1,4 +1,4 @@
1Guide to the XenServer Plugin for Fuel 7.0 1Guide to the XenServer Plugin for Fuel 8.0
2========================================== 2==========================================
3 3
4Intro 4Intro
diff --git a/doc/source/installation.rst b/doc/source/installation.rst
index 7abe782..83db8e4 100644
--- a/doc/source/installation.rst
+++ b/doc/source/installation.rst
@@ -11,14 +11,14 @@ To install the XenServer Fuel plugin:
11#. Copy the *rpm* file to the Fuel Master node: 11#. Copy the *rpm* file to the Fuel Master node:
12 :: 12 ::
13 13
14 [root@home ~]# scp fuel-plugin-xenserver-2.0-2.0.0-1.noarch.rpm root@fuel-master:/tmp 14 [root@home ~]# scp fuel-plugin-xenserver-3.0-3.0.0-1.noarch.rpm root@fuel-master:/tmp
15 15
16#. Log into Fuel Master node and install the plugin using the 16#. Log into Fuel Master node and install the plugin using the
17 `Fuel CLI <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#using-fuel-cli>`_: 17 `Fuel CLI <https://docs.mirantis.com/openstack/fuel/fuel-8.0/user-guide.html#using-fuel-cli>`_:
18 18
19 :: 19 ::
20 20
21 [root@fuel-master ~]# fuel plugins --install /tmp/fuel-plugin-xenserver-2.0-2.0.0-1.noarch.rpm 21 [root@fuel-master ~]# fuel plugins --install /tmp/fuel-plugin-xenserver-3.0-3.0.0-1.noarch.rpm
22 22
23#. Verify that the plugin is installed correctly: 23#. Verify that the plugin is installed correctly:
24 :: 24 ::
@@ -26,7 +26,7 @@ To install the XenServer Fuel plugin:
26 [root@fuel-master ~]# fuel plugins 26 [root@fuel-master ~]# fuel plugins
27 id | name | version | package_version 27 id | name | version | package_version
28 ---|-----------------------|---------|---------------- 28 ---|-----------------------|---------|----------------
29 9 | fuel-plugin-xenserver | 2.0.0 | 3.0.0 29 9 | fuel-plugin-xenserver | 3.0.0 | 3.0.0
30 30
31Add Management Network tool 31Add Management Network tool
32--------------------------- 32---------------------------
diff --git a/specs/fuel-plugin-xenserver.rst b/specs/fuel-plugin-xenserver.rst
index 61fff34..1d5cd64 100644
--- a/specs/fuel-plugin-xenserver.rst
+++ b/specs/fuel-plugin-xenserver.rst
@@ -6,7 +6,7 @@ Fuel Plugin for Xenserver
6The XenServer plugin provides the ability to use Xenserver as the 6The XenServer plugin provides the ability to use Xenserver as the
7hypervisor for Mirantis OpenStack. 7hypervisor for Mirantis OpenStack.
8 8
9Compatible with Fuel version 7.0. 9Compatible with Fuel version 8.0.
10 10
11Problem description 11Problem description
12=================== 12===================
@@ -44,7 +44,7 @@ None.
44Upgrade impact 44Upgrade impact
45-------------- 45--------------
46 46
47When upgrading the Fuel Master node to Fuel Version higher than 7.0, 47When upgrading the Fuel Master node to Fuel Version higher than 8.0,
48plugin compatibility should be checked, and a new plugin installed if 48plugin compatibility should be checked, and a new plugin installed if
49necessary. 49necessary.
50 50
@@ -119,15 +119,17 @@ Assignee(s)
119----------- 119-----------
120 120
121Primary assignee: 121Primary assignee:
122 John Hua <john.hua@citrix.com> (developer) 122 Huan Xie <huan.xie@citrix.com> (developer)
123 123
124Other contributors: 124Other contributors:
125 Bob Ball <bob.ball@citrix.com> (developer, reviewer) 125 Bob Ball <bob.ball@citrix.com> (developer, reviewer)
126 Jianghua Wang <jianghua.wang@citrix.com> (developer)
127 John Hua <john.hua@citrix.com> (developer)
126 128
127Work Items 129Work Items
128---------- 130----------
129 131
130* Upgrade the XenServer Fuel 6.1 plugin to work with Fuel 7.0. 132* Upgrade the XenServer Fuel 7.0 plugin to work with Fuel 8.0.
131 133
132* Test XenServer plugin. 134* Test XenServer plugin.
133 135
@@ -136,7 +138,7 @@ Work Items
136Dependencies 138Dependencies
137============ 139============
138 140
139* Fuel 7.0 141* Fuel 8.0
140 142
141Testing 143Testing
142======= 144=======