From 6ae612d10fe0b220f897ccb2a4aaf36e4e27a670 Mon Sep 17 00:00:00 2001 From: John Hua Date: Wed, 16 Sep 2015 14:25:07 +0800 Subject: [PATCH] Add installation/user guide --- README.md | 55 ++++++++++++++++++++++-------------- doc/content/installation.rst | 40 ++++++++++++++++++++++++++ doc/content/user-guide.rst | 23 +++++++++++++++ 3 files changed, 97 insertions(+), 21 deletions(-) create mode 100644 doc/content/installation.rst create mode 100644 doc/content/user-guide.rst diff --git a/README.md b/README.md index ba91714..6a09c14 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,43 @@ -xenserver-fuel-plugin -============ +XenServer Fuel Plugin +===================== -Prerequisites -------------- +Intro +===== - [user@local ~]# apt-get install createrepo rpm dpkg-dev python-pip sshpass -y \ +XenServer Fuel Plugin will help to deploy Mirantis OpenStack over XenServer hosts and make sure they work as xenapi rather than qemu. + + +Usage +===== + +Please look at the [install guide](doc/content/installation.rst) +and [user guide](doc/content/user-guide.rst). + + +How to build plugin +=================== + + +Install prerequisites +--------------------- + + apt-get install createrepo rpm dpkg-dev python-pip sshpass -y \ || yum install createrepo rpm rpm-build dpkg-devel python-pip sshpass -y -Environment Setup ------------------ - [user@local ~]# git clone https://github.com/citrix-openstack/fuel-plugins.git - [user@local ~]# sudo pip install fuel-plugins/fuel_plugin_builder/ - [user@local ~]# git clone https://github.com/citrix-openstack/xenserver-fuel-plugin.git +Clone Citrix FPB +------------------ + +XenServer Fuel Plugin uses a forked Fuel Plugin Builder (FPB) to deploy a new OpenStack release as well as the fuel plugin part itself. + + git clone https://github.com/citrix-openstack/fuel-plugins.git + sudo pip install fuel-plugins/fuel_plugin_builder/ -Build ------ - [user@local ~]# fpb --check xenserver-fuel-plugin - [user@local ~]# fpb --build xenserver-fuel-plugin +Build and Check +--------------- - -Installation ------------- - - [user@local ~]# scp xenserver-fuel-plugin/xenserver-fuel-plugin*.noarch.rpm root@Fuel_Master_IP:/tmp - - [root@fuel tmp]# fuel plugins --install xenserver-fuel-plugin*.noarch.rpm + git clone https://github.com/citrix-openstack/xenserver-fuel-plugin.git + fpb --check xenserver-fuel-plugin + fpb --build xenserver-fuel-plugin diff --git a/doc/content/installation.rst b/doc/content/installation.rst new file mode 100644 index 0000000..4cb3679 --- /dev/null +++ b/doc/content/installation.rst @@ -0,0 +1,40 @@ + +Installation Guide +================== + +Install the Plugin +------------------ + +To install the XenServer Fuel plugin: + +#. Download it from the `xensource download server`_ +#. Copy the *rpm* file to the Fuel Master node: + :: + + [root@home ~]# scp xenserver-fuel-plugin-0.4-0.4.0-1.noarch.rpm root@fuel-master:/tmp + +#. Log into Fuel Master node and install the plugin using the + `Fuel CLI`_: + + :: + + [root@fuel-master ~]# fuel plugins --install xenserver-fuel-plugin-0.4-0.4.0-1.noarch.rpm + +#. Verify that the plugin is installed correctly: + :: + + [root@fuel-master ~]# fuel plugins + id | name | version | package_version + ---|---------|---------|---------------- + 2 | xenserver-fuel-plugin | 0.4.0 | 2.0.0 + + [root@fuel-master ~]# fuel rel + id | name | state | operating_system | version + ---|-----------------------------------------|-----------|------------------|------------- + 2 | Juno on Ubuntu 14.04.1 | available | Ubuntu | 2014.2.2-6.1 + 9 | Juno+Citrix XenServer on Ubuntu 14.04.1 | available | Ubuntu | 2014.2.2-6.1 + 1 | Juno on CentOS 6.5 | available | CentOS | 2014.2.2-6.1 + + +.. _xensource download server: http://ca.downloads.xensource.com/OpenStack/Mirantis/ +.. _Fuel CLI: https://docs.mirantis.com/openstack/fuel/fuel-6.1/user-guide.html#using-fuel-cli \ No newline at end of file diff --git a/doc/content/user-guide.rst b/doc/content/user-guide.rst new file mode 100644 index 0000000..3e515da --- /dev/null +++ b/doc/content/user-guide.rst @@ -0,0 +1,23 @@ +User Guide +========== + +Intro +----- + +XenServer Fuel Plugin will help to deploy Mirantis OpenStack over XenServer hosts and make sure they work as xenapi rather than qemu. + + +Usage +----- + +- Create a new environment with the Fuel UI wizard. Select "Juno+Citrix XenServer on Ubuntu 14.04.1" from OpenStack Release dropdown list. At the moment you will see most of options are disabled in the wizard. + +- Create new VMs in XenCenter for all roles and use `xencenter-himn-plugin `_ to add management network to those supposed to run as Compute Nodes. + +- Add new VMs to the new environment according to `Fuel User Guide `_ and configure them properly. A typical topology of 1 controller node + 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. + +- Click "Deploy Changes" button + +- After deployment is done, you will see in Horizon that all hypervisors are xen. \ No newline at end of file