Update Plugin Guide

Change-Id: I1cc252d33c43bcac584d0b793a5b30176002d3fc
Signed-off-by: Javeria Khan <javeriak@plumgrid.com>
This commit is contained in:
Javeria Khan 2016-04-18 03:49:12 -07:00
parent 6480a3591b
commit 15e7c8a078
6 changed files with 59 additions and 31 deletions

View File

@ -61,7 +61,7 @@ author = u'Javeria Khan'
# The short X.Y version.
version = u'1.0'
# The full version, including alpha/beta/rc tags.
release = u'1.0.1'
release = u'1.0-1.0.1-1'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@ -250,6 +250,10 @@ latex_documents = [
# If false, no module index is generated.
#latex_domain_indices = True
# make latex stop printing blank pages between sections
# http://stackoverflow.com/questions/5422997/sphinx-docs-remove-blank-pages-from-generated-pdfs
latex_elements = { 'classoptions': ',openany,oneside', 'babel' : '\\usepackage[english]{babel}' }
# -- Options for manual page output ---------------------------------------
@ -287,6 +291,9 @@ texinfo_documents = [
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
# Insert footnotes where they are defined instead of
# at the end.
pdf_inline_footnotes = True
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None}

View File

@ -14,3 +14,4 @@ Guide to PLUMgrid Plugin ver. 1.0-1.0.1-1 for Fuel 7.0
intro
requirements
install_guide
troubleshooting

View File

@ -6,9 +6,9 @@ Prerequisites
This document assumes that you have `installed Fuel <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html>`_
and setup the target hosts with appropriate networking for the pxe, management, public and plumgrid-fabric networks. The nodes
must be discovered and functional prior to doing the following steps.
must be discovered and functional prior to performing the following steps.
Obtain a PLUMgrid ONS license and access to packages or LCM image by emailing Support at info@plumgrid.com.
Obtain a PLUMgrid ONS license and access to packages or LCM image by emailing PLUMgrid Support at info@plumgrid.com.
Installing Fuel PLUMgrid Plugin
-------------------------------
@ -17,9 +17,9 @@ Installing Fuel PLUMgrid Plugin
#. Copy this file to the Fuel Master node with secure copy (scp):
::
scp plumgrid-<x.x.x>.rpm root@:<the_Fuel_Master_node_IP address>:/tmp
scp plumgrid-<x.x.x>.rpm root@<Fuel_Master_node_IP address>:/tmp
#. On the Fuel Master node, Install the PLUMgrid plugin with:
#. On the Fuel Master node, install the PLUMgrid plugin with:
::
cd /tmp
@ -35,19 +35,19 @@ Installing Fuel PLUMgrid Plugin
fuel plugins --list
#. The plugin is now ready for use and can be enabled on the Settings tab, PLUMgrid Plugin section
of the Fuel web UI, as explained next.
#. The plugin is now ready for use and can be enabled in the Settings → PLUMgrid Plugin section of an OpenStack environment on the Fuel UI as explained next.
This part is visible after a new environment is created.
Configuring a New Environment
-----------------------------
#. In Fuel UI `create environment <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#create-a-new-openstack-environment>`_.
#. In Fuel UI `create a new environment <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#create-a-new-openstack-environment>`_.
.. image:: images/create_env.png
:width: 80%
#. Select the appropiate KVM or QEMU hypervisor type for your environment.
#. Select the appropriate KVM or QEMU hypervisor type for your environment.
.. image:: images/compute.png
:width: 80%
@ -61,7 +61,7 @@ Configuring a New Environment
Configuring PLUMgrid Plugin
---------------------------
#. After creating the enviroment, navigate to Settings → Fuel PLUMgrid plugin. Check the Fuel PLUMgrid Pluginbox and fill in the appropiate values for the enviroment.
#. After creating the enviroment, navigate to Settings → Fuel PLUMgrid plugin. Check the Fuel PLUMgrid Pluginbox and fill in the appropriate values for the enviroment.
.. image:: images/plumgrid_ui_setup.png
:width: 80%
@ -71,17 +71,17 @@ Configuring PLUMgrid Plugin
* **Enter the password for PLUMgrid:** default is *plumgrid*
* **PLUMgrid VIP on the management network to access the PLUMgrid console:**  The IP address for PLUMgrid console, make sure to select an unassigned IP on the management network.
* **PLUMgrid VIP on the management network to access the PLUMgrid console:**  The IP address for PLUMgrid console. Make sure to select an unassigned IP on the management network.
* **Enter the PLUMgrid Fabric Network:** Enter the network that will be used by PLUMgrid Fabric.
* **Enter the PLUMgrid Fabric Network:** Enter the network that will be used by PLUMgrid Fabric (without subnet mask).
* **Repository for PLUMgrid packages:** Enter IP address of a repo hosting PLUMgrid packages such as LCM.
* **Repository for PLUMgrid packages:** Enter IP address of a repo hosting PLUMgrid packages, for example the LCM.
* **Enter the zone name for PLUMgrid LCM:** If using an LCM enter the zone name specified during its configuration.
* **Enter the license for PLUMgrid:** Enter the PLUMgrid license string provided by PLUMgrid support.
* **Enter the license for PLUMgrid:** Enter the PLUMgrid license string provided by PLUMgrid Support.
* **Enter the interface(s) to be used by GW:** Enter the interfaces that will be used for external connectivity by the PLUMgrid Gateway, comma separated for more than one.
* **Enter the interface(s) to be used by GW:** Enter the interfaces that will be used for external connectivity by the PLUMgrid Gateway. Comma separated for more than one.
Deployment Settings
-------------------
@ -106,20 +106,20 @@ Deployment Settings
.. image:: images/add_controllers.png
:width: 80%
#. As described in the Requirements section, configure interfaces on nodes as shown in figure below:
#. As described in the Requirements section, configure interfaces on nodes as shown in figure below by clicking on the gear icon:
.. image:: images/network_config.png
:width: 80%
#. Navigate to Networks tab and set the appropiate Network Settings for the Public, Storage and Management Networks. Click Verify Networks to verify correct configuration.
#. Navigate to Networks tab and set the appropriate Network Settings for the Public, Storage and Management Networks. Click Verify Networks to verify correct configuration.
.. image:: images/verify_network.png
:width: 80%
#. Press **Deploy changes** to `deploy the environment <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#deploy-changes>`_.
#. Press **Deploy changes** in the Dashboard tab to `deploy the environment <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#deploy-changes>`_.
#. After a succesful deployment. The PLUMgrid UI will be accessible on the VIP entered in the PLUMgrid Settings.
#. After a succesful deployment, the PLUMgrid UI will be accessible on the VIP entered in the PLUMgrid Settings.
::
https://<PG-VIP>
@ -133,6 +133,6 @@ Deployment Settings
neutron net-create net1
neutron router-create router1
The newly created network and router should be visible in Horizon and the PLUMgrid UI
The newly created network and router should be visible in Horizon and the PLUMgrid UI.
#. For further details on usability & features, and to obtain official documentation, contact PLUMgrid at info@plumgrid.com.

View File

@ -18,9 +18,9 @@ Given below are some commonly used terms across this document:
+--------------------+-------------------------------------------------------------------+
| Virtual Domain | A Virtual Domain is a logical data center. It can be created on |
| | demand to provide all the networking services (e.g. Routers, |
| | Switches, IPAM, DHCP, NAT, etc.) necessary to build a vitrual |
| | network for a tenant in OpenStack. Typically, each OpenStack |
| | tenant will map to a unique Virtual Domain in the PLUMgrid. |
| | Switches, IPAM, DHCP, NAT, etc.) necessary to build a virtual |
| | network for a project in OpenStack. Typically, each OpenStack |
| | project will map to a unique Virtual Domain in the PLUMgrid. |
+--------------------+-------------------------------------------------------------------+
| Zone | Represents the physical deployment of PLUMgrid ONS. A Zone is |
| | primarily a collection of Edges & Gateways that are dependent on |
@ -65,7 +65,7 @@ suite lets users create private Virtual Domains to provide isolation, security,
PLUMgrid ONS features:
* Performance: Up to 40 Gbps per server; hardwarde Offload; terbytes of aggregate performance.
* Performance: Up to 40 Gbps per server; hardware offload; terabytes of aggregate performance.
* Scalable: across virtual domains, workloads and multiple racks, geographies.
@ -73,7 +73,7 @@ PLUMgrid ONS features:
* Secure: end-to-end encryption within Virtual Domains and isolation across tenants.
* Operational tools: includes a comprehensive suite of powerful networking monitoring and troubleshooting tools.
* Operational tools: includes a comprehensive suite of powerful networking, monitoring and troubleshooting tools.
Licensing information
---------------------

View File

@ -1,8 +1,7 @@
Requirements
============
In addition to the requirements set by a Mirantis 7.0 Installation. The PLUMgrid plugin also has the following requirements
for software and hardware:
In addition to the requirements set by a Mirantis 7.0 Installation. The PLUMgrid plugin also has the following software and hardware requirements:
Network Requirements
--------------------
@ -11,14 +10,14 @@ Nodes within the PLUMgrid Zone are connected using the following two networks:
#. **Management:** This network is mapped onto the Management network (br-mgmt) deployed within a Mirantis OpenStack Environment.
#. **Fabric:** This network is mapped directly onto the untagged interface deployed within the Mirantis OpenStack Environment. The fabric network **cannot be bridged or tagged**, it is automatically created by the Fuel PLUMgrid plugin on the interface being used by br-mgmt. The network cidr is specified through the Fuel UI, as explained later. MTU for the entire fabric network is set to 1580 (this is the minimum value for PLUMgrid to work correctly, it will also function for higher values).
#. **Fabric:** This network is mapped directly onto the untagged interface deployed within the Mirantis OpenStack Environment. The fabric network **cannot be bridged or tagged**, it is automatically created by the Fuel PLUMgrid plugin on the interface being used by br-mgmt. The network cidr is specified through the Fuel UI, as explained later. MTU for the fabric network is set to 1580 (this is the minimum value for PLUMgrid to work correctly, it will also function for higher values).
Node Interface Requirements
+++++++++++++++++++++++++++
Physical servers with two network interfaces are used as Controllers, Computes and Gateways. A PLUMgrid-Gateway node must also have an additional 1-2 interfaces for external connectivity (these are specified in the PLUMgrid Settings given in the install section). The interfaces configuration is the following:
Physical servers with two network interfaces are used as Controllers, Computes and A PLUMgrid-Gateways. A PLUMgrid-Gateway node must also have an additional 1-2 interfaces for external connectivity (these are specified in the PLUMgrid Settings given in the install section). The interfaces configuration is the following:
* First interface is used for PXE network
* First interface is used for PXE network.
* Second interface is used for Public, Management and Storage networks using tagged VLANs. The PLUMgrid fabric network is also created here automatically.
.. image:: images/network_config.png
@ -28,7 +27,7 @@ Physical servers with two network interfaces are used as Controllers, Computes a
PLUMgrid Repository
-------------------
Access to a url hosting PLUMgrid packages is required before deployment. A common way to obtain this is to use a LCM image and create the LCM VM, which will host the needed packages. This VM then becomes the source repo for installing and upgrading PLUMgrid. The VM can typically be created on the Infrastructure Server hosting the Fuel VM. It needs to be provided with management and fabric connectivity. Contact PLUMgrid to obtain an LCM image with pre-baked PLUMgrid packages and a license [info@plumgrid.com]
Access to a url hosting PLUMgrid packages is required before deployment. A common way to obtain this is to use a LCM image to create the LCM VM, which will host the required packages. This VM then becomes the source repo for installing and upgrading PLUMgrid. The VM can typically be created on the Infrastructure Server hosting the Fuel VM. It needs to be provided with management and fabric connectivity. Contact PLUMgrid to obtain an LCM image with pre-baked PLUMgrid packages and a license [info@plumgrid.com].
Node Requirements
-----------------

View File

@ -0,0 +1,21 @@
Troubleshootig
==============
#. When PLUMgrid tasks fail during deployment.
**Solution**
Determine what node it failed on from the Fuel Astute Logs. Login to that node (SSH through the Fuel Master node),
and check the logs under /var/log/plumgrid .
#. A node is not visible in the PLUMgrid UI, Zone View > Zone Inventory.
**Solution**
Login to that node (SSH through the Fuel Master node) and check PLUMgrid services. Start if stopped:
::
service plumgrid status
service plumgrid start