Major update to documentation
Added Test Plan and User Guide. Moved repository location to git.openstack.org Change-Id: I7a1b1e9c1248d263e087cff8ae777818c28785f2
This commit is contained in:
Bob Ball
parent
ed596452a3
commit
e68a139461
|
|
@ -28,9 +28,10 @@ Install prerequisites
|
|||
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.
|
||||
XenServer Fuel Plugin uses a forked Fuel Plugin Builder (FPB) to deploy a new OpenStack release during the installation of the plugin.
|
||||
This is achieved by adding a post-install script option to the version 2.0 plugin.
|
||||
|
||||
git clone https://github.com/citrix-openstack/fuel-plugins.git
|
||||
git clone https://git.openstack.org/openstack/fuel-plugin-xenserver
|
||||
sudo pip install fuel-plugins/fuel_plugin_builder/
|
||||
|
||||
|
||||
|
|
@ -38,6 +39,6 @@ XenServer Fuel Plugin uses a forked Fuel Plugin Builder (FPB) to deploy a new Op
|
|||
Build and Check
|
||||
---------------
|
||||
|
||||
git clone https://github.com/citrix-openstack/xenserver-fuel-plugin.git
|
||||
git clone https://git.openstack.org/openstack/fuel-plugin-xenserver.git
|
||||
fpb --check xenserver-fuel-plugin
|
||||
fpb --build xenserver-fuel-plugin
|
||||
|
|
|
|||
Binary file not shown.
|
|
@ -0,0 +1,43 @@
|
|||
XenServer Plugin for Fuel 6.1
|
||||
=============================
|
||||
|
||||
XenServer is an Open Source hypervisor with commercial support options
|
||||
provided by Citrix. This plugin provides a new Release definition in
|
||||
Mirantis OpenStack to allow easy installation of production
|
||||
environments based on XenServer with Fuel.
|
||||
|
||||
Requirements
|
||||
------------
|
||||
|
||||
========================= ===============
|
||||
Requirement Version/Comment
|
||||
========================= ===============
|
||||
Fuel 6.1
|
||||
XenServer 6.5 SP1
|
||||
XenServer plugin for Fuel 1.0.0
|
||||
========================= ===============
|
||||
|
||||
* This plugin will not install XenServer or configure the Virtual
|
||||
Machines used to run the OpenStack services. Installation of
|
||||
XenServer and configuration of these Virtual Machines must be
|
||||
performed manually.
|
||||
* Each hypervisor must have the same access credentials as Fuel
|
||||
does not support per-node settings.
|
||||
* One Virtual Machine, which will be used to run Nova (the compute
|
||||
node), must exist on each hypervisor. This must be created as an
|
||||
HVM guest (in XenCenter, use the "Other Install Media" template) and
|
||||
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.
|
||||
|
||||
|
|
@ -0,0 +1,45 @@
|
|||
Xenserver Fuel Plugin User Guide
|
||||
================================
|
||||
|
||||
Once the Fuel XenServer plugin has been installed (following
|
||||
`Installation Guide`_), you can create *OpenStack* environments that
|
||||
use XenServer as the underlying hypervisor
|
||||
|
||||
Select Environment
|
||||
------------------
|
||||
|
||||
#. 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.
|
||||
|
||||
.. image:: images/fmwizard00.png
|
||||
:width: 80%
|
||||
|
||||
#. Create new VMs in XenCenter for the compute nodes
|
||||
|
||||
#. Select all Compute virtual Machines, Right click on one of the
|
||||
Virtual Machines and select "Add Management Network"
|
||||
|
||||
#. Use the dialog to add the Host Internal Management
|
||||
Network to the compute virtual machines
|
||||
|
||||
.. image:: images/HIMN_dialog.jpg
|
||||
:width: 80%
|
||||
|
||||
#. Add new VMs to the new environment according to `Fuel User Guide <https://docs.mirantis.com/openstack/fuel/fuel-6.1/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.
|
||||
|
||||
#. 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.
|
||||
|
||||
.. image:: images/fmsetting00.png
|
||||
:width: 80%
|
||||
|
||||
|
||||
Finish environment configuration
|
||||
--------------------------------
|
||||
|
||||
#. Run `network verification check <https://docs.mirantis.com/openstack/fuel/fuel-6.1/user-guide.html#verify-networks>`_
|
||||
|
||||
#. Press `Deploy button <https://docs.mirantis.com/openstack/fuel/fuel-6.1/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.
|
||||
|
||||
.. image:: images/fmhorizon00.png
|
||||
:width: 80%
|
||||
|
|
@ -7,34 +7,36 @@ Install the Plugin
|
|||
|
||||
To install the XenServer Fuel plugin:
|
||||
|
||||
#. Download it from the `xensource download server`_
|
||||
#. Download it from the `Fuel Plugins Catalog`_
|
||||
#. 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
|
||||
[root@home ~]# scp xenserver-fuel-plugin-1.0-1.0.0-1.noarch.rpm root@fuel-master:/tmp
|
||||
|
||||
#. Log into Fuel Master node and install the plugin using the
|
||||
`Fuel CLI`_:
|
||||
`Fuel CLI <https://docs.mirantis.com/openstack/fuel/fuel-6.1/user-guide.html#using-fuel-cli>`_:
|
||||
|
||||
::
|
||||
|
||||
[root@fuel-master ~]# fuel plugins --install xenserver-fuel-plugin-0.4-0.4.0-1.noarch.rpm
|
||||
[root@fuel-master ~]# fuel plugins --install /tmp/xenserver-fuel-plugin-1.0-1.0.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 plugins
|
||||
id | name | version | package_version
|
||||
---|-----------------------|---------|----------------
|
||||
9 | xenserver-fuel-plugin | 1.0.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
|
||||
Add Management Network tool
|
||||
---------------------------
|
||||
|
||||
#. Download the HIMN tool `xencenter-himn-plugin <https://github.com/citrix-openstack/xencenter-himn-plugin>`_
|
||||
|
||||
.. _xensource download server: http://ca.downloads.xensource.com/OpenStack/Plugins/
|
||||
.. _Fuel CLI: https://docs.mirantis.com/openstack/fuel/fuel-6.1/user-guide.html#using-fuel-cli
|
||||
#. Stop XenCenter if it is running
|
||||
|
||||
#. Install the HIMN tool
|
||||
|
||||
#. Re-start XenCenter
|
||||
|
||||
.. _Fuel Plugins Catalog: https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins/
|
||||
|
|
|
|||
|
|
@ -1,32 +0,0 @@
|
|||
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.
|
||||
|
||||
.. image:: ../images/fmwizard00.png?raw=true
|
||||
:width: 100%
|
||||
|
||||
- Create new VMs in XenCenter for all roles and use `xencenter-himn-plugin <https://github.com/citrix-openstack/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 <https://docs.mirantis.com/openstack/fuel/fuel-6.1/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.
|
||||
|
||||
- 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.
|
||||
|
||||
.. image:: ../images/fmsetting00.png?raw=true
|
||||
:width: 100%
|
||||
|
||||
- Click "Deploy Changes" button
|
||||
|
||||
- After deployment is done, you will see in Horizon that all hypervisors are xen.
|
||||
|
||||
.. image:: ../images/fmhorizon00.png?raw=true
|
||||
:width: 100%
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 29 KiB |
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1,15 @@
|
|||
Guide to the XenServer Plugin for Fuel 6.1
|
||||
==========================================
|
||||
|
||||
Intro
|
||||
-----
|
||||
|
||||
This document will guide you through the steps of install, configure and use of the XenServer Plugin for Fuel
|
||||
|
||||
Sections
|
||||
--------
|
||||
.. include:: content/description.rst
|
||||
.. include:: content/terms.rst
|
||||
.. include:: content/installation.rst
|
||||
.. include:: content/guide.rst
|
||||
|
||||
|
|
@ -13,7 +13,7 @@ licenses: ['Apache License Version 2.0']
|
|||
# Specify author or company name
|
||||
authors: ['Citrix']
|
||||
# A link to the plugin's page
|
||||
homepage: 'https://github.com/citrix-openstack/xenserver-fuel-plugin'
|
||||
homepage: 'https://git.openstack.org/cgit/openstack/fuel-plugin-xenserver'
|
||||
# Specify a group which your plugin implements, possible options:
|
||||
# network, storage, storage::cinder, storage::glance, hypervisor
|
||||
groups: ['network','hypervisor']
|
||||
|
|
|
|||
Loading…
Reference in New Issue