Browse Source

Merge "Add plugin guide with spnix enabled"

tags/1.1.0
Jenkins 4 years ago
committed by Gerrit Code Review
parent
commit
11df02fa3d
17 changed files with 784 additions and 0 deletions
  1. +216
    -0
      doc/plugin_guide/Makefile
  2. +292
    -0
      doc/plugin_guide/source/conf.py
  3. BIN
      doc/plugin_guide/source/images/add_controllers.png
  4. BIN
      doc/plugin_guide/source/images/add_nodes.png
  5. BIN
      doc/plugin_guide/source/images/compute.png
  6. BIN
      doc/plugin_guide/source/images/create_env.png
  7. BIN
      doc/plugin_guide/source/images/network_config.png
  8. BIN
      doc/plugin_guide/source/images/networking_setup.png
  9. BIN
      doc/plugin_guide/source/images/pg_ui.png
  10. BIN
      doc/plugin_guide/source/images/pg_zone.png
  11. BIN
      doc/plugin_guide/source/images/plumgrid_repos.png
  12. BIN
      doc/plugin_guide/source/images/plumgrid_ui_setup.png
  13. BIN
      doc/plugin_guide/source/images/verify_network.png
  14. +16
    -0
      doc/plugin_guide/source/index.rst
  15. +133
    -0
      doc/plugin_guide/source/install_guide.rst
  16. +87
    -0
      doc/plugin_guide/source/intro.rst
  17. +40
    -0
      doc/plugin_guide/source/requirements.rst

+ 216
- 0
doc/plugin_guide/Makefile View File

@@ -0,0 +1,216 @@
# Makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = build

# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif

# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source

.PHONY: help
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " applehelp to make an Apple Help Book"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " coverage to run coverage check of the documentation (if enabled)"

.PHONY: clean
clean:
rm -rf $(BUILDDIR)/*

.PHONY: html
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

.PHONY: dirhtml
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."

.PHONY: singlehtml
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."

.PHONY: pickle
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."

.PHONY: json
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."

.PHONY: htmlhelp
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."

.PHONY: qthelp
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/plumgrid_plugin_guide.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/plumgrid_plugin_guide.qhc"

.PHONY: applehelp
applehelp:
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
@echo
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
@echo "N.B. You won't be able to view it unless you put it in" \
"~/Library/Documentation/Help or install it in your application" \
"bundle."

.PHONY: devhelp
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/plumgrid_plugin_guide"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/plumgrid_plugin_guide"
@echo "# devhelp"

.PHONY: epub
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."

.PHONY: latex
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."

.PHONY: latexpdf
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."

.PHONY: latexpdfja
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."

.PHONY: text
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."

.PHONY: man
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."

.PHONY: texinfo
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."

.PHONY: info
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."

.PHONY: gettext
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."

.PHONY: changes
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."

.PHONY: linkcheck
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."

.PHONY: doctest
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."

.PHONY: coverage
coverage:
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
@echo "Testing of coverage in the sources finished, look at the " \
"results in $(BUILDDIR)/coverage/python.txt."

.PHONY: xml
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."

.PHONY: pseudoxml
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

+ 292
- 0
doc/plugin_guide/source/conf.py View File

@@ -0,0 +1,292 @@
# -*- coding: utf-8 -*-
#
# plumgrid_plugin_guide documentation build configuration file, created by
# sphinx-quickstart on Fri Mar 18 05:25:02 2016.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys
import os

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))

# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'

# The encoding of source files.
#source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'plumgrid_plugin_guide'
copyright = u'2016, Javeria Khan'
author = u'Javeria Khan'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = u'1.0'
# The full version, including alpha/beta/rc tags.
release = u'1.0.1'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = []

# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []

# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False


# -- Options for HTML output ----------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'alabaster'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}

# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None

# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None

# The name of an image file (relative to this directory) to use as a favicon of
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}

# If false, no module index is generated.
#html_domain_indices = True

# If false, no index is generated.
#html_use_index = True

# If true, the index is split into individual pages for each letter.
#html_split_index = False

# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None

# Language to be used for generating the HTML full-text search index.
# Sphinx supports the following languages:
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
#html_search_language = 'en'

# A dictionary with options for the search language support, empty by default.
# Now only 'ja' uses this config value
#html_search_options = {'type': 'default'}

# The name of a javascript file (relative to the configuration directory) that
# implements a search results scorer. If empty, the default will be used.
#html_search_scorer = 'scorer.js'

# Output file base name for HTML help builder.
htmlhelp_basename = 'plumgrid_plugin_guidedoc'

# -- Options for LaTeX output ---------------------------------------------

latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
#'preamble': '',

# Latex figure (float) alignment
#'figure_align': 'htbp',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'plumgrid_plugin_guide.tex', u'plumgrid\\_plugin\\_guide Documentation',
u'Javeria Khan', 'manual'),
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False

# If true, show page references after internal links.
#latex_show_pagerefs = False

# If true, show URL addresses after external links.
#latex_show_urls = False

# Documents to append as an appendix to all manuals.
#latex_appendices = []

# If false, no module index is generated.
#latex_domain_indices = True


# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'plumgrid_plugin_guide', u'plumgrid_plugin_guide Documentation',
[author], 1)
]

# If true, show URL addresses after external links.
#man_show_urls = False


# -- Options for Texinfo output -------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'plumgrid_plugin_guide', u'plumgrid_plugin_guide Documentation',
author, 'plumgrid_plugin_guide', 'One line description of project.',
'Miscellaneous'),
]

# Documents to append as an appendix to all manuals.
#texinfo_appendices = []

# If false, no module index is generated.
#texinfo_domain_indices = True

# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'

# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False


# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None}

BIN
doc/plugin_guide/source/images/add_controllers.png View File

Before After
Width: 581  |  Height: 666  |  Size: 46 KiB

BIN
doc/plugin_guide/source/images/add_nodes.png View File

Before After
Width: 1082  |  Height: 203  |  Size: 26 KiB

BIN
doc/plugin_guide/source/images/compute.png View File

Before After
Width: 656  |  Height: 348  |  Size: 20 KiB

BIN
doc/plugin_guide/source/images/create_env.png View File

Before After
Width: 653  |  Height: 352  |  Size: 26 KiB

BIN
doc/plugin_guide/source/images/network_config.png View File

Before After
Width: 1059  |  Height: 530  |  Size: 55 KiB

BIN
doc/plugin_guide/source/images/networking_setup.png View File

Before After
Width: 662  |  Height: 352  |  Size: 37 KiB

BIN
doc/plugin_guide/source/images/pg_ui.png View File

Before After
Width: 852  |  Height: 594  |  Size: 48 KiB

BIN
doc/plugin_guide/source/images/pg_zone.png View File

Before After
Width: 642  |  Height: 467  |  Size: 51 KiB

BIN
doc/plugin_guide/source/images/plumgrid_repos.png View File

Before After
Width: 850  |  Height: 577  |  Size: 78 KiB

BIN
doc/plugin_guide/source/images/plumgrid_ui_setup.png View File

Before After
Width: 859  |  Height: 596  |  Size: 72 KiB

BIN
doc/plugin_guide/source/images/verify_network.png View File

Before After
Width: 876  |  Height: 318  |  Size: 36 KiB

+ 16
- 0
doc/plugin_guide/source/index.rst View File

@@ -0,0 +1,16 @@
.. plumgrid_plugin_guide documentation master file, created by
sphinx-quickstart on Fri Mar 18 05:25:02 2016.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

=======================================================
Guide to PLUMgrid Plugin ver. 1.0-1.0.1-1 for Fuel 7.0
=======================================================

.. toctree::
:maxdepth: 2
:numbered:

intro
requirements
install_guide

+ 133
- 0
doc/plugin_guide/source/install_guide.rst View File

@@ -0,0 +1,133 @@
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.

+ 87
- 0
doc/plugin_guide/source/intro.rst View File

@@ -0,0 +1,87 @@
Introduction
============

This document contains instructions for installing and configuring the PLUMgrid plugin for Fuel.
In order to use the PLUMgrid ONS Virtual Network Infrastructure for a Mirantis OpenStack Cloud.

Key terms, acronyms and abbreviations
-------------------------------------

Given below are some commonly used terms across this document:

+--------------------+-------------------------------------------------------------------+
| PLUMgrid ONS | PLUMgrid Open Networking Suite (ONS) is a comprehensive software |
| | suite that provides a virtual network infrastructure based on |
| | IO Visor technology. |
+--------------------+-------------------------------------------------------------------+
| VNI | Virtual Network Infrastructure |
+--------------------+-------------------------------------------------------------------+
| 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. |
+--------------------+-------------------------------------------------------------------+
| Zone | Represents the physical deployment of PLUMgrid ONS. A Zone is |
| | primarily a collection of Edges & Gateways that are dependent on |
| | the same cluster of Directors in a single physical location. A |
| | data center can have multiple Zones. |
+--------------------+-------------------------------------------------------------------+
| Director | The control plane of PLUMgrid ONS. The configuration of the VNI |
| | for tenants is done through the Director. The PLUMgrid Directors |
| | are typically deployed in a cluster of three nodes to provide high|
| | availability and scale. Directors are co-located on the OpenStack |
| | Controller nodes. |
+--------------------+-------------------------------------------------------------------+
| Edge | An OpenStack Compute node running PLUMgrid IO Visor as a kernel |
| | module. It provides the data plane and network connectivity for |
| | the VMs of OpenStack tenants. Communication for VMs between Edges |
| | is enabled by creating overlay tunnels using VXLAN encapsulation |
+--------------------+-------------------------------------------------------------------+
| Gateway | Provides connectivity from virtual fabric (VXLAN based) to |
| | external IP networks (such as for internet access). Gateway(s) |
| | can be deployed as a pair in Active/Active mode for load balancing|
| | of traffic and high availability of external connectivity. |
+--------------------+-------------------------------------------------------------------+
| LCM | The Life Cycle Manager is a VM that is used to host the necessary |
| | PLUMgrid packages needed to install (or update) a PLUMgrid Zone. |
+--------------------+-------------------------------------------------------------------+

The figure below depicts how all these components fit in a PLUMgrid Zone.

.. image:: images/pg_zone.png
:width: 80%


Overview
--------

The PLUMgrid plugin for Fuel provides the capability to use PLUMgrid ONS for Mirantis OpenStack as the entire networking backend.
It is configured through the Fuel UI.

PLUMgrid Open Networking Suite (ONS) is a comprehensive software suite that provides terabits of scale out performance, production
grade resiliency, and secure multi-tenancy for hybrid data centers. Built on PLUMgrid Platform and IO Visor technology, the software
suite lets users create private Virtual Domains to provide isolation, security, and policy enforcement across tenants.

PLUMgrid ONS features:

* Performance: Up to 40 Gbps per server; hardwarde Offload; terbytes of aggregate performance.

* Scalable: across virtual domains, workloads and multiple racks, geographies.

* Supports both hardware and software gateways in highly available configurations.

* 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.

Licensing information
---------------------

+----------------------+-----------------+
| PLUMgrid ONS | Commercial |
+----------------------+-----------------+
| Fuel PLUMgrid Plugin | Apache 2.0 |
+----------------------+-----------------+

Contact PLUMgrid for an Installation pack (including Full/Trial License, PLUMgrid Packages, deployment documentation): info@plumgrid.com

+ 40
- 0
doc/plugin_guide/source/requirements.rst View File

@@ -0,0 +1,40 @@
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:

Network Requirements
--------------------

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).

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:

* 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
:width: 80%


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]

Node Requirements
-----------------

You must have atleast the following nodes present to set up a minimal deployment:

* 3 Controllers (or 1 Controller for non-HA deployment)
* 1 Compute
* 1 PLUMgrid-Gateway

Loading…
Cancel
Save