fuel-plugin-plumgrid/doc/plugin_guide/source/install_guide.rst

134 lines
4.9 KiB
ReStructuredText
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Installation Guide
==================
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.
Obtain a PLUMgrid ONS license and access to packages or LCM image at info@plumgrid.com
Installing Fuel PLUMgrid Plugin
-------------------------------
#. Download the PLUMgrid plugin from the `Fuel Plugins Catalog <https://software.mirantis.com/download-mirantis-openstack-fuel-plug-ins/>`_.
#. 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
#. On the Fuel Master node, Install the PLUMgrid plugin with:
::
cd /tmp
fuel plugins --install plumgrid-<x.x.x>.rpm
You should get the following output
::
Plugin <plugin-name-version>.rpm was successfully installed
#. Check that the correct version of the PLUMgrid plugin is installed in Fuel with:
::
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.
Configuring PLUmgrid Plugin
---------------------------
#. In Fuel UI `create 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.
.. image:: images/compute.png
:width: 80%
#. Select Neutron with VLAN segmentation as Networking Setup.
.. image:: images/networking_setup.png
:width: 80%
#. After creating the enviroment, navigate to Settings → Fuel PLUMgrid plugin. Check the Fuel PLUMgrid Pluginbox and fill in the appropiate values for the your enviroment.
.. image:: images/plumgrid_ui_setup.png
:width: 80%
* **Enter the username for PLUMgrid:** default is *plumgrid*
* **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.
* **Enter the PLUMgrid Fabric Network:** Enter the network that will be used by PLUMgrid Fabric.
* **Repository for PLUMgrid packages:** Enter IP address of a repo hosting PLUMgrid packages such as 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 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.
#. Navigate to Repositories tab and click Add Extra Repo and provide the following PLUMgrid repositories:
::
plumgrid deb http://<LCM-IP>:81/plumgrid plumgrid <component> 1200
plumgrid-images deb http://<LCM-IP>:81/plumgrid-images plumgrid <component> 1250
.. image:: images/plumgrid_repos.png
:width: 80%
#. Navigate to the Nodes tab to and click on Add nodes:
.. image:: images/add_nodes.png
:width: 80%
Assign the unallocated nodes their respective roles. Select the role i.e. Controller/Compute/PLUMgrid-Gateway and select the node which will assume that role. This process must be repeated for each node individually:
.. image:: images/add_controllers.png
:width: 80%
#. As described in the Requirements section, configure interfaces on nodes as shown in figure below:
.. 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.
.. 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>`_.
#. After a succesful deployment. The PLUMgrid UI will be accessible for the VIP entered in the PLUMgrid Settings
::
https://<PG-VIP>
.. image:: images/pg_ui.png
:width: 80%
#. As PLUMgrid provides the network backend; all standard neutron operations (create/delete networks, routers etc) can be performed to check the status of the plugin. SSH into any Controller node and run the following:
::
source /root/openrc
neutron net-create net1
neutron router-create router1
The newly created network and router should be visible in Horizon.
#. For further details on usability & features, contact PLUMgrid at info@plumgrid.com to obtain official documentation.