Add spec and doc and update to README
Change-Id: Id3fd8541da9e29e7344f89981a28922f09540c68
This commit is contained in:
Kanzhe Jiang
parent
ec0604dbb2
commit
05c5cf6d24
140
README.md
140
README.md
|
|
@ -1,139 +1,17 @@
|
|||
fuel-plugin-bigswitch
|
||||
============
|
||||
====================
|
||||
|
||||
Fuel BigSwitch plugin enables OpenStack deployment with BigSwitch Big Cloud Fabric SDN
|
||||
networking fabric
|
||||
|
||||
cd fuel-plugin-bigswitch/
|
||||
See doc/ directory for documentation.
|
||||
|
||||
fpb --build .
|
||||
To build HTML variant of documentation you need to install sphinx document generator, easiest way to do this is to use doc/requirements.txt.
|
||||
|
||||
Check if file fuel-plugin-bigswitch-1.0-1.0.0-1.noarch.rpm was created.
|
||||
$ pip install -r doc/requirements.txt
|
||||
|
||||
Overview
|
||||
--------
|
||||
$ cd doc/user
|
||||
|
||||
This is Big Switch Cloud Fabric (BCF) fuel plugin. It deploys Big Switch Neutron drivers and
|
||||
plugins in a Fuel environment.
|
||||
$ make html
|
||||
|
||||
Requirements
|
||||
------------
|
||||
|
||||
| Requirement | Version/Comment |
|
||||
|----------------------------------|-----------------|
|
||||
| Mirantis OpenStack compatibility | 7.0 |
|
||||
| Big Switch Big Cloud Fabric | 3.5 |
|
||||
|
||||
Recommendations
|
||||
---------------
|
||||
|
||||
None.
|
||||
|
||||
Limitations
|
||||
-----------
|
||||
|
||||
None.
|
||||
|
||||
Installation Guide
|
||||
==================
|
||||
|
||||
BigSwitch plugin installation
|
||||
----------------------------------------
|
||||
|
||||
1. Download Switch Light virtual package from Big Switch Networks for
|
||||
the deployed operating system. The downloaded package must be
|
||||
saved on the Fuel master node under directory, "/tmp/repositories"
|
||||
|
||||
2. Clone the fuel-plugin-bigswitch repo from github:
|
||||
|
||||
git clone https://github.com/openstack/fuel-plugin-bigswitch
|
||||
|
||||
3. Install the Fuel Plugin Builder:
|
||||
|
||||
pip install fuel-plugin-builder
|
||||
|
||||
4. Build Openvswitch Fuel plugin:
|
||||
|
||||
fpb --build fuel-plugin-bigswitch/
|
||||
|
||||
5. The *fuel-plugin-bigswitch-[x.x.x].rpm* plugin package will be created in the plugin folder.
|
||||
|
||||
6. Move this file to the Fuel Master node with secure copy (scp):
|
||||
|
||||
scp fuel-plugin-bigswitch-[x.x.x].rpm root@<the_Fuel_Master_node_IP address>:/tmp
|
||||
|
||||
7. While logged in Fuel Master install the BigSwitch plugin:
|
||||
|
||||
fuel plugins --install fuel-plugin-bigswitch-[x.x.x].rpm
|
||||
|
||||
8. Check if the plugin was installed successfully:
|
||||
|
||||
fuel plugins
|
||||
|
||||
id | name | version | package_version
|
||||
---|-----------------------|---------|----------------
|
||||
1 | fuel-plugin-bigswitch | 1.0.0 | 3.0.0
|
||||
|
||||
8. Plugin is ready to use and can be enabled on the Settings tab of the Fuel web UI.
|
||||
|
||||
|
||||
User Guide
|
||||
==========
|
||||
|
||||
BigSwitch plugin configuration
|
||||
---------------------------------------------
|
||||
|
||||
1. Create a new environment with the Fuel UI wizard.
|
||||
2. Click on the Settings tab of the Fuel web UI.
|
||||
3. Scroll down the page, select the plugin checkbox.
|
||||
|
||||
|
||||
Build options
|
||||
-------------
|
||||
|
||||
It is possible to modify process of building plugin by setting environment variables. Look into [pre_build_hook file](pre_build_hook) for more details.
|
||||
|
||||
Testing
|
||||
-------
|
||||
|
||||
None.
|
||||
|
||||
Known issues
|
||||
------------
|
||||
|
||||
None.
|
||||
|
||||
Release Notes
|
||||
-------------
|
||||
|
||||
**1.0.0**
|
||||
|
||||
* Initial release of the plugin. This is a beta version.
|
||||
|
||||
|
||||
Development
|
||||
===========
|
||||
|
||||
The *OpenStack Development Mailing List* is the preferred way to communicate,
|
||||
emails should be sent to `openstack-dev@lists.openstack.org` with the subject
|
||||
prefixed by `[fuel][plugins][bigswitch]`.
|
||||
|
||||
Reporting Bugs
|
||||
--------------
|
||||
|
||||
Bugs should be filled on the [Launchpad fuel-plugins project](
|
||||
https://bugs.launchpad.net/fuel-plugins) (not GitHub) with the tag `bigswitch`.
|
||||
|
||||
|
||||
Contributing
|
||||
------------
|
||||
|
||||
If you would like to contribute to the development of this Fuel plugin you must
|
||||
follow the [OpenStack development workflow](
|
||||
http://docs.openstack.org/infra/manual/developers.html#development-workflow).
|
||||
|
||||
Patch reviews take place on the [OpenStack gerrit](
|
||||
https://review.openstack.org/#/q/status:open+project:openstack/fuel-plugin-bigswitch,n,z)
|
||||
system.
|
||||
|
||||
Contributors
|
||||
------------
|
||||
* kanzhe.jiang@bigswitch.com
|
||||
After that you can start exploring documentation in doc/user/source/_build/html/ directory.
|
||||
|
|
|
|||
Binary file not shown.
|
After Width: | Height: | Size: 149 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 203 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 201 KiB |
|
|
@ -0,0 +1,2 @@
|
|||
docutils==0.9.1
|
||||
sphinx>=1.1.2,!=1.2.0,<1.3
|
||||
|
|
@ -0,0 +1,177 @@
|
|||
# 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) .
|
||||
# the i18n builder cannot share the environment and doctrees with the others
|
||||
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||||
|
||||
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
|
||||
|
||||
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 " 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)"
|
||||
|
||||
clean:
|
||||
rm -rf $(BUILDDIR)/*
|
||||
|
||||
html:
|
||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||||
|
||||
dirhtml:
|
||||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
||||
|
||||
singlehtml:
|
||||
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
||||
|
||||
pickle:
|
||||
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
||||
@echo
|
||||
@echo "Build finished; now you can process the pickle files."
|
||||
|
||||
json:
|
||||
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
||||
@echo
|
||||
@echo "Build finished; now you can process the JSON files."
|
||||
|
||||
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."
|
||||
|
||||
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/FuelBigSwitchplugin.qhcp"
|
||||
@echo "To view the help file:"
|
||||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/FuelBigSwitchplugin.qhc"
|
||||
|
||||
devhelp:
|
||||
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
||||
@echo
|
||||
@echo "Build finished."
|
||||
@echo "To view the help file:"
|
||||
@echo "# mkdir -p $$HOME/.local/share/devhelp/FuelBigSwitchplugin"
|
||||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/FuelBigSwitchplugin"
|
||||
@echo "# devhelp"
|
||||
|
||||
epub:
|
||||
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
||||
@echo
|
||||
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
||||
|
||||
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)."
|
||||
|
||||
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."
|
||||
|
||||
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."
|
||||
|
||||
text:
|
||||
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
||||
@echo
|
||||
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
||||
|
||||
man:
|
||||
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
||||
@echo
|
||||
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
||||
|
||||
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)."
|
||||
|
||||
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."
|
||||
|
||||
gettext:
|
||||
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
||||
@echo
|
||||
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
||||
|
||||
changes:
|
||||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
||||
@echo
|
||||
@echo "The overview file is in $(BUILDDIR)/changes."
|
||||
|
||||
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."
|
||||
|
||||
doctest:
|
||||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
||||
@echo "Testing of doctests in the sources finished, look at the " \
|
||||
"results in $(BUILDDIR)/doctest/output.txt."
|
||||
|
||||
xml:
|
||||
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
|
||||
@echo
|
||||
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
|
||||
|
||||
pseudoxml:
|
||||
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
|
||||
@echo
|
||||
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
|
||||
|
|
@ -0,0 +1,258 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Fuel BigSwitch plugin documentation build configuration file, created by
|
||||
# sphinx-quickstart on Sun Feb 21 03:14:36 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 = []
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The suffix of source filenames.
|
||||
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'Fuel BigSwitch plugin'
|
||||
copyright = u'2016, Big Switch Networks'
|
||||
|
||||
# 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 = '1.0.0'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '1.0.0'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#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 = ['_build']
|
||||
|
||||
# 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
|
||||
|
||||
|
||||
# -- 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 = 'default'
|
||||
|
||||
# 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 (within the static path) to use as 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
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'FuelBigSwitchplugindoc'
|
||||
|
||||
|
||||
# -- 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': '',
|
||||
}
|
||||
|
||||
# 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 = [
|
||||
('index', 'FuelBigSwitchplugin.tex', u'Fuel BigSwitch plugin Documentation',
|
||||
u'Kanzhe Jiang', '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 = [
|
||||
('index', 'fuelbigswitchplugin', u'Fuel BigSwitch plugin Documentation',
|
||||
[u'Kanzhe Jiang'], 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 = [
|
||||
('index', 'FuelBigSwitchplugin', u'Fuel BigSwitch plugin Documentation',
|
||||
u'Kanzhe Jiang', 'FuelBigSwitchplugin', '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
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 148 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 149 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 203 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 201 KiB |
|
|
@ -0,0 +1,43 @@
|
|||
.. Fuel BigSwitch plugin documentation master file, created by
|
||||
sphinx-quickstart on Sun Feb 21 03:14:36 2016.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to Fuel BigSwitch plugin's documentation!
|
||||
=================================================
|
||||
|
||||
Fuel BigSwitch plugin allows you to deploy Openstack cluster with BigSwitch's
|
||||
BCF SND networking fabric.
|
||||
|
||||
In P-Only mode, plugin installs Neutron BigSwitch ML2 mechanism driver for
|
||||
vlan segmentation.
|
||||
|
||||
In P+V mode, in addition to the BigSwitch ML2 mechanism driver, plugin also installs
|
||||
L3 service plugin which allows routers to be created in BCF.
|
||||
|
||||
Plugin can work with BCF 3.5.
|
||||
|
||||
Plugin versions:
|
||||
|
||||
* 1.x.x series is compatible with Fuel 7.0.
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
source/build
|
||||
source/installation
|
||||
source/environment
|
||||
source/configuration
|
||||
source/usage
|
||||
source/release-notes
|
||||
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
|
|
@ -0,0 +1,41 @@
|
|||
How to build the plugin
|
||||
=======================
|
||||
|
||||
To build the plugin you first need to install fuel-plugin-build 4.0.0[1_]
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ pip install fuel-plugin-builder==4.0.0
|
||||
|
||||
After that you can build the plugin:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ git clone https://git.openstack.org/openstack/fuel-plugin-bigswitch
|
||||
|
||||
$ cd fuel-plugin-bigswitch/
|
||||
|
||||
puppet-librarian_ ruby package is required to installed. It is used to fetch
|
||||
upstream fuel-library_ puppet modules that plugin use. It can be installed via
|
||||
gem package manager:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ gem install puppet-librarian
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ fpb --build .
|
||||
|
||||
fuel-plugin-builder will produce .rpm package of the plugin which you need to
|
||||
upload to Fuel master node:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ ls fuel-plugin-bigswitch-*.rpm
|
||||
|
||||
fuel-plugin-bigswitch-1.0-1.0.0-1.noarch.rpm
|
||||
|
||||
.. [1] https://pypi.python.org/pypi/fuel-plugin-builder/4.0.0
|
||||
.. _puppet-librarian: https://librarian-puppet.com
|
||||
.. _fuel-library: https://github.com/openstack/fuel-library
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
Configuration
|
||||
=============
|
||||
|
||||
Switch to Settings tab of the Fuel web UI and click on "BigSwitch Networking Plugin"
|
||||
section, tick the plugin checkbox to enable it.
|
||||
|
||||
.. image:: /image/bsn-plugin-configuration-page.png
|
||||
:scale: 60 %
|
||||
|
||||
Plugin contains the following settings:
|
||||
|
||||
#. Fabric Mode -- Big Switch Big Cloud Fabric can be deployed as a p-only
|
||||
(physical-only) fabric, which manages all the physical switches, or p+v
|
||||
(physical and virtual) fabric, which manages all the physical and virtual
|
||||
switches.
|
||||
In P-only mode, BCF is a L2-only fabric in VLAN mode. L3-agent will provide
|
||||
the routing function.
|
||||
In P+V mode, BCF is a L2-and-L3 fabric in VLAN mode. All compute nodes will
|
||||
install SL-v (Switch Light virtual) switches. All the SL-v switches and
|
||||
physical switches will be managed by BCF SDN controller cluster. In P+V mode,
|
||||
fuel bigswitch plugin will automatically un-install OVS and install SL-v
|
||||
switches on all compute nodes.
|
||||
|
||||
|
||||
#. BCF Controller1 -- This is the IP address of the first BCF controller in the
|
||||
controller cluster. This is a required field. If the controller cluster only
|
||||
has one controller, this is the place to enter the controller IP address.
|
||||
|
||||
#. BCF Controller2 -- This is the IP address of the second BCF controller in the
|
||||
controller cluster. This is an optional field. If it is empty, then BCF
|
||||
controller is in standalone mode.
|
||||
|
||||
#. BCF Controller Username -- The username to access BCF controller's REST APIs
|
||||
|
||||
#. BCF Controller Password -- The password to access BCF controller's REST APIs
|
||||
|
||||
#. Openstack Instance ID -- The ID of the Openstack instance. Mulitple cloud
|
||||
orchestration systems can share the same BCF fabric. This field is to identify
|
||||
the orchestration system.
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
OpenStack environment notes
|
||||
===========================
|
||||
|
||||
Environment creation
|
||||
--------------------
|
||||
|
||||
For every new deployment environment, please maually create logical
|
||||
networks for pxe, public, management, and storage network. The VLAN
|
||||
assignment for the above network must match the membership
|
||||
configuration of the corresponding BCF logical networks.
|
||||
|
||||
.. image:: /image/BCF_prep.png
|
||||
:scale: 70 %
|
||||
|
||||
#. In the environment setup wizard, Network setup step, make sure to
|
||||
select "Neutron with VLAN segmentation".
|
||||
|
||||
.. image:: /image/Vlan-segmentation.png
|
||||
:scale: 70 %
|
||||
|
||||
#. After adding each node, if the node's pnics are bonded, LACP mode
|
||||
is recommended. The node can be controller, storage, or compute.
|
||||
|
||||
.. image:: /image/interface-bond.png
|
||||
:scale: 70 %
|
||||
|
||||
|
||||
Pay attention on which interface you assign *Public* network, OpenStack
|
||||
controllers must have connectivity with BigSwitch BCF controllers through
|
||||
public network since it is used as default route for packets.
|
||||
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
Installation
|
||||
============
|
||||
|
||||
#. Download plugin .rpm package
|
||||
|
||||
#. Upload package to Fuel master node.
|
||||
|
||||
#. Install the plugin with *fuel* command line tool:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
[root@nailgun ~] fuel plugins --install fuel-plugin-bigswitch-1.0-1.0.0-1.noarch.rpm
|
||||
|
||||
|
||||
#. Verify that the plugin is installed successfully:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
[root@nailgun ~] fuel plugins
|
||||
id | name | version | package_version
|
||||
---|-----------------------|---------|----------------
|
||||
1 | fuel-plugin-bigswitch | 1.0.0 | 3.0.0
|
||||
|
||||
After installation plugin can be used for new OpenStack clusters, it is not
|
||||
possible to enable plugin on deployed clusters.
|
||||
|
||||
Uninstallation
|
||||
--------------
|
||||
|
||||
Before uninstalling plugin be sure that there no environments left that use the
|
||||
plugin, otherwise it is not possible to uninstall it.
|
||||
|
||||
To uninstall plugin run following:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
[root@nailgun ~] fuel plugins --remove fuel-plugin-bigswitch==1.0.0
|
||||
|
||||
.. _Fuel plugin catalog: https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
Release notes
|
||||
=============
|
||||
|
||||
Release notes for Fuel BigSwitch plugin 1.0.0:
|
||||
|
||||
* Plugin is compatible with Fuel 7.0.
|
||||
* Support for Neutron server Kilo release.
|
||||
* The release only supports p-only mode. P+V mode will be available in the next release.
|
||||
|
|
@ -0,0 +1,177 @@
|
|||
# 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) .
|
||||
# the i18n builder cannot share the environment and doctrees with the others
|
||||
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||||
|
||||
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
|
||||
|
||||
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 " 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)"
|
||||
|
||||
clean:
|
||||
rm -rf $(BUILDDIR)/*
|
||||
|
||||
html:
|
||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||||
|
||||
dirhtml:
|
||||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
||||
|
||||
singlehtml:
|
||||
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
||||
|
||||
pickle:
|
||||
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
||||
@echo
|
||||
@echo "Build finished; now you can process the pickle files."
|
||||
|
||||
json:
|
||||
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
||||
@echo
|
||||
@echo "Build finished; now you can process the JSON files."
|
||||
|
||||
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."
|
||||
|
||||
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/FuelBigSwitchPlugin.qhcp"
|
||||
@echo "To view the help file:"
|
||||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/FuelBigSwitchPlugin.qhc"
|
||||
|
||||
devhelp:
|
||||
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
||||
@echo
|
||||
@echo "Build finished."
|
||||
@echo "To view the help file:"
|
||||
@echo "# mkdir -p $$HOME/.local/share/devhelp/FuelBigSwitchPlugin"
|
||||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/FuelBigSwitchPlugin"
|
||||
@echo "# devhelp"
|
||||
|
||||
epub:
|
||||
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
||||
@echo
|
||||
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
||||
|
||||
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)."
|
||||
|
||||
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."
|
||||
|
||||
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."
|
||||
|
||||
text:
|
||||
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
||||
@echo
|
||||
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
||||
|
||||
man:
|
||||
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
||||
@echo
|
||||
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
||||
|
||||
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)."
|
||||
|
||||
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."
|
||||
|
||||
gettext:
|
||||
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
||||
@echo
|
||||
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
||||
|
||||
changes:
|
||||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
||||
@echo
|
||||
@echo "The overview file is in $(BUILDDIR)/changes."
|
||||
|
||||
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."
|
||||
|
||||
doctest:
|
||||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
||||
@echo "Testing of doctests in the sources finished, look at the " \
|
||||
"results in $(BUILDDIR)/doctest/output.txt."
|
||||
|
||||
xml:
|
||||
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
|
||||
@echo
|
||||
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
|
||||
|
||||
pseudoxml:
|
||||
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
|
||||
@echo
|
||||
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
Fuel BigSwitch plugin documentation
|
||||
===================================
|
||||
|
||||
If you want to build HTML variant of plugin specification first install
|
||||
necessary sphinx requirements:
|
||||
|
||||
# pip install -r requirements.txt
|
||||
|
||||
Then you can build specification with `make' tool:
|
||||
|
||||
# make html
|
||||
|
|
@ -0,0 +1,265 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# FuelBigSwitchPlugin documentation build configuration file, created by
|
||||
# sphinx-quickstart on Sun Feb 21 02:28:59 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.intersphinx',
|
||||
'sphinx.ext.todo',
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The suffix of source filenames.
|
||||
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'FuelBigSwitchPlugin'
|
||||
copyright = u'2016, Big Switch Networks'
|
||||
|
||||
# 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 = '1.0.0'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '1.0.0'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#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 = ['_build']
|
||||
|
||||
# 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
|
||||
|
||||
|
||||
# -- 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 = 'default'
|
||||
|
||||
# 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 (within the static path) to use as 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
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'FuelBigSwitchPlugindoc'
|
||||
|
||||
|
||||
# -- 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': '',
|
||||
}
|
||||
|
||||
# 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 = [
|
||||
('index', 'FuelBigSwitchPlugin.tex', u'Fuel BigSwitch Plugin Documentation',
|
||||
u'Kanzhe Jiang', '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 = [
|
||||
('index', 'fuelbigswitchplugin', u'Fuel BigSwitch Plugin Documentation',
|
||||
[u'Kanzhe Jiang'], 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 = [
|
||||
('index', 'FuelBigSwitchPlugin', u'Fuel BigSwitch Plugin Documentation',
|
||||
u'Kanzhe Jiang', 'FuelBigSwitchPlugin', '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 = {'http://docs.python.org/': None}
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
.. FuelBigSwitchPlugin documentation master file, created by
|
||||
sphinx-quickstart on Sun Feb 21 02:28:59 2016.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to FuelBigSwitchPlugin's documentation!
|
||||
===============================================
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
|
||||
plugin-1.0.0spec
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
|
|
@ -0,0 +1,259 @@
|
|||
..
|
||||
This work is licensed under a Creative Commons Attribution 3.0 Unported
|
||||
License.
|
||||
|
||||
http://creativecommons.org/licenses/by/3.0/legalcode
|
||||
|
||||
===========================================================
|
||||
Fuel Plugin v1.0.0 for BigSwitch BCF SDN Fabric integration
|
||||
===========================================================
|
||||
|
||||
BigSwitch plugin for Fuel provides an ability to deploy OpenStack cluster that is
|
||||
utilizing BigSwitch Big Cloud Fabric network virtualization platform.
|
||||
|
||||
Problem description
|
||||
===================
|
||||
|
||||
Proposed change
|
||||
===============
|
||||
|
||||
Implement a Fuel plugin [1]_ which will deploy BigSwitch plugin as a P-only fabric
|
||||
for OpenStack networking service (Neutron) and configure it.
|
||||
|
||||
Plugin assumes that end user already has BigSwitch Big Cloud Fabric running
|
||||
|
||||
Plugin components will include:
|
||||
|
||||
- puppet manifests for installation and configuration Neutron BigSwitch plugin
|
||||
|
||||
Architecture diagram
|
||||
|
||||
::
|
||||
|
||||
+----------------------------+
|
||||
| Compute cluster |
|
||||
| |
|
||||
OpenStack | +--------------------+ |
|
||||
Public network | | | | VLAN Segment
|
||||
+----------------------+ + | | KVM host +-----+ | | +
|
||||
| | | | | | | | | |
|
||||
| OpenStack Controller | | | | | VM +-----------+
|
||||
| | | | | | | | | |
|
||||
| +------------------+ | | | | +-----+ | | |
|
||||
| | | | | | +--------------------+ | |
|
||||
| | Neutron server | | | | | |
|
||||
| | | | | | | |
|
||||
| | +-----------+ | | | | | |
|
||||
| | | | | | | | | |
|
||||
| | | BigSwitch | | +----------+ | | |
|
||||
| | | plugin | | | | | +--------------------+ | |
|
||||
| | | | | | | | | +-----+ | | |
|
||||
| | +-----------+ | | | | | KVM host | | | | |
|
||||
| | | | | | | | VM +-----------+
|
||||
| +------------------+ | | | | | | | | |
|
||||
+----------------------+ | | | +-----+ | | |
|
||||
| | +--------------------+ | |
|
||||
| | | |
|
||||
| | +--------------------+ | |
|
||||
| | | | | |
|
||||
| | | KVM host +-----+ | | |
|
||||
| | | | | | | |
|
||||
| | | | VM +-----------+
|
||||
| | | | | | | |
|
||||
| | | +-----+ | | |
|
||||
| | +--------------------+ | |
|
||||
| +----------------------------+ |
|
||||
| |
|
||||
| +----------------------------+ |
|
||||
| | | |
|
||||
+--------+ BigSwitch BCF Controller | |
|
||||
| | Cluster | |
|
||||
| | | |
|
||||
+ +----------------------------+ +
|
||||
|
||||
|
||||
|
||||
|
||||
VM creation workflow:
|
||||
|
||||
::
|
||||
|
||||
Neutron server
|
||||
Nova-api Nova-compute (BigSwitch plugin) BigSwitch Controller
|
||||
+ + + +
|
||||
| | | |
|
||||
| | | |
|
||||
| Create VM | | |
|
||||
| | | |
|
||||
| <--------> | Provision port | |
|
||||
| | for VM | |
|
||||
| | <-------------> | |
|
||||
| | | Create port |
|
||||
| | | <-----------> +---+
|
||||
| | | | |
|
||||
| | | Port ready | |
|
||||
| | Port with UUID N | <-----------> +---+
|
||||
| | ready | |
|
||||
| | <-------------> | |
|
||||
| | | |
|
||||
| | | |
|
||||
| | Create VM and attach to port with UUID N
|
||||
| | <-------------------------------> |
|
||||
| | | | |
|
||||
+ + + + +
|
||||
|
||||
|
||||
Plugin work items in pre-deployment stage:
|
||||
|
||||
- Install lldp daemon to form LACP lag groups for openstack controllers and compute nodes
|
||||
|
||||
Plugin actions in post-deployment stage:
|
||||
|
||||
#. Stop nova-network pacemaker resource
|
||||
#. Configure neutron-server with notification
|
||||
#. Configure keystone with notification
|
||||
#. Install Neutron BigSwitch plugin
|
||||
#. Configure the plugin
|
||||
#. Start Neutron server
|
||||
|
||||
Deployment diagram:
|
||||
|
||||
::
|
||||
|
||||
BigSwitch manifests Neutron-server
|
||||
|
||||
+ +
|
||||
| Configure LLDP Daemons on |
|
||||
| Controllers and Computes |
|
||||
| |
|
||||
| Prepare data for Neutron |
|
||||
| deployment tasks |
|
||||
| |
|
||||
| Stop Neutron agents |
|
||||
| pacemaker resource |
|
||||
| +------------------------> +
|
||||
|
|
||||
| Install BigSwitch plugin
|
||||
|
|
||||
| Configure neutron-server with BigSwitch
|
||||
|
|
||||
| Start Neutron-server
|
||||
| +------------------------->+
|
||||
| |
|
||||
| Start Neutron agents |
|
||||
| pacemaker resource |
|
||||
| |
|
||||
| |
|
||||
v v
|
||||
|
||||
|
||||
Plugin will be compatible with Fuel 7.0.
|
||||
|
||||
|
||||
Alternatives
|
||||
------------
|
||||
|
||||
None.
|
||||
|
||||
Data model impact
|
||||
-----------------
|
||||
|
||||
Plugin will produce following array of settings into astute.yaml:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
bigswitch
|
||||
|
||||
REST API impact
|
||||
---------------
|
||||
|
||||
None.
|
||||
|
||||
Upgrade impact
|
||||
--------------
|
||||
|
||||
None.
|
||||
|
||||
Security impact
|
||||
---------------
|
||||
|
||||
None.
|
||||
|
||||
Notifications impact
|
||||
--------------------
|
||||
|
||||
None.
|
||||
|
||||
Other end user impact
|
||||
---------------------
|
||||
|
||||
Plugin settings are available via the Settings tab on Fuel web UI.
|
||||
|
||||
Performance Impact
|
||||
------------------
|
||||
|
||||
None.
|
||||
|
||||
Other deployer impact
|
||||
---------------------
|
||||
|
||||
None.
|
||||
|
||||
Developer impact
|
||||
----------------
|
||||
|
||||
Implementation
|
||||
==============
|
||||
|
||||
Assignee(s)
|
||||
-----------
|
||||
|
||||
Primary assignee:
|
||||
|
||||
- Kanzhe Jiang <kanzhe.jiang@bigswitch.com> - developer
|
||||
|
||||
|
||||
Work Items
|
||||
----------
|
||||
|
||||
* Create pre-dev environment and manually deploy BCF
|
||||
|
||||
* Create Fuel plugin bundle, which contains deployments scripts, puppet
|
||||
modules and metadata
|
||||
|
||||
* Implement puppet module with the following functions:
|
||||
|
||||
- Install Neutron BigSwitch plugin on OpenStack controllers
|
||||
- Configure Neutron server to use BigSwitch plugin and reload its configuration
|
||||
- Create needed networks for OpenStack testing framework (OSTF)
|
||||
|
||||
* Create system test for the plugin
|
||||
|
||||
* Write documentation
|
||||
|
||||
|
||||
Dependencies
|
||||
============
|
||||
|
||||
* Fuel 7.0
|
||||
|
||||
Testing
|
||||
=======
|
||||
|
||||
* Sanity checks including plugin build
|
||||
* Syntax check
|
||||
* Functional testing
|
||||
|
||||
Documentation Impact
|
||||
====================
|
||||
|
||||
* Deployment Guide (how to prepare an env for installation, how to
|
||||
install the plugin, how to deploy OpenStack env with the plugin)
|
||||
* User Guide (which features the plugin provides, how to use them in
|
||||
the deployed OS env)
|
||||
|
||||
References
|
||||
==========
|
||||
|
||||
.. [1] Fuel Plug-in Guide http://docs.mirantis.com/openstack/fuel/fuel-7.0/plugin-dev.html
|
||||
.. [2] https://github.com/openstack/fuel-library
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
docutils==0.9.1
|
||||
oslosphinx
|
||||
sphinx>=1.1.2,!=1.2.0,<1.3
|
||||
Loading…
Reference in New Issue