Add Fuel NSXv plugin specification - v1.0.0
Change-Id: I58d0ae6415892a7b16bf9dc8b422e80b7d28a7ff
This commit is contained in:
1
.gitignore
vendored
Normal file
1
.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
||||
_build
|
||||
177
specs/Makefile
Normal file
177
specs/Makefile
Normal file
@@ -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/FuelNSXvplugin.qhcp"
|
||||
@echo "To view the help file:"
|
||||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/FuelNSXvplugin.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/FuelNSXvplugin"
|
||||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/FuelNSXvplugin"
|
||||
@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."
|
||||
11
specs/README.md
Normal file
11
specs/README.md
Normal file
@@ -0,0 +1,11 @@
|
||||
Fuel NSXv 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
|
||||
258
specs/conf.py
Normal file
258
specs/conf.py
Normal file
@@ -0,0 +1,258 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Fuel NSXv plugin documentation build configuration file, created by
|
||||
# sphinx-quickstart on Fri Aug 14 12:14:29 2015.
|
||||
#
|
||||
# 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 NSXv plugin'
|
||||
copyright = u'2015, Igor Zinovik'
|
||||
|
||||
# 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 = 'FuelNSXvplugindoc'
|
||||
|
||||
|
||||
# -- 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', 'FuelNSXvplugin.tex', u'Fuel NSXv plugin Documentation',
|
||||
u'Igor Zinovik', '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', 'fuelnsxvplugin', u'Fuel NSXv plugin Documentation',
|
||||
[u'Igor Zinovik'], 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', 'FuelNSXvplugin', u'Fuel NSXv plugin Documentation',
|
||||
u'Igor Zinovik', 'FuelNSXvplugin', '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
|
||||
19
specs/index.rst
Normal file
19
specs/index.rst
Normal file
@@ -0,0 +1,19 @@
|
||||
.. Fuel NSXv plugin documentation master file
|
||||
|
||||
Welcome to Fuel NSXv plugin's documentation!
|
||||
============================================
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
7
specs/requirements.txt
Normal file
7
specs/requirements.txt
Normal file
@@ -0,0 +1,7 @@
|
||||
docutils==0.9.1
|
||||
oslosphinx
|
||||
pbr>=0.6,!=0.7,<1.0
|
||||
sphinx>=1.1.2,!=1.2.0,<1.3
|
||||
testrepository>=0.0.18
|
||||
testtools>=0.9.34
|
||||
sphinxcontrib-httpdomain
|
||||
380
specs/spec-v1.0.0.rst
Normal file
380
specs/spec-v1.0.0.rst
Normal file
@@ -0,0 +1,380 @@
|
||||
..
|
||||
This work is licensed under a Creative Commons Attribution 3.0 Unported
|
||||
License.
|
||||
|
||||
http://creativecommons.org/licenses/by/3.0/legalcode
|
||||
|
||||
===========================================
|
||||
Fuel Plugin for VMware NSXv SDN integration
|
||||
===========================================
|
||||
|
||||
NSXv plugin for Fuel provides an ability to deploy OpenStack cluster that is
|
||||
utilizing vCenter computing clusters and NSXv network virtualization
|
||||
platform [1]_.
|
||||
|
||||
Problem description
|
||||
===================
|
||||
|
||||
Proposed change
|
||||
===============
|
||||
|
||||
Implement a Fuel plugin [2]_ which will deploy NSXv plugin for OpenStack networking
|
||||
service (Neutron) and configure it.
|
||||
|
||||
Plugin assumes that end user already has vCenter with NSXv up and running.
|
||||
|
||||
Starting from Fuel 6.1 it is possible to deploy dual-hypervisor cloud, e.g. it
|
||||
is possible to use VMware vCenter and KVM computes in single OpenStack
|
||||
environment. In OpenStack environment with NSXv plugin it will be not possible
|
||||
to use KVM/QEMU compute nodes, because NSXv networking platform is not
|
||||
supported by KVM hypervisor.
|
||||
|
||||
Plugin components will include:
|
||||
|
||||
- customized nova packages (python-nova)
|
||||
- task for generating appropriate data for Neutron deployment
|
||||
- puppet manifests for installation and configuration Neutron NSXv plugin
|
||||
|
||||
In Fuel 7.0 when user marks vCenter checkbox in 'Compute' step of 'Create a new
|
||||
OpenStack environment' wizard it leads to inability to select Neutron in
|
||||
'Networking setup' step, because in Fuel 7.0 the only available network backend
|
||||
for vCenter is nova-network.
|
||||
|
||||
Architecture diagram
|
||||
|
||||
::
|
||||
|
||||
+----------------------------+
|
||||
| Compute cluster |
|
||||
| |
|
||||
OpenStack | +---------------+ |
|
||||
Public network | | | |
|
||||
+----------------------+ + | | ESXi host | |
|
||||
| | | | | | |
|
||||
| OpenStack Controller | | | | +---------+ | |
|
||||
| | | | | | | | |
|
||||
| +----------------+ | +---------------+ vCenter | | |
|
||||
| | | | | | | | server | | |
|
||||
| | Neutron server | | | | | | | | |
|
||||
| | | | | | | +---------+ | |
|
||||
| | +--------+ | | | | | | |
|
||||
| | | | | | | | +---------------+ | VXLAN tunnels
|
||||
| | | NSXv | | +----------+ | | +
|
||||
| | | plugin | | | | | +--------------------+ | |
|
||||
| | | | | | | | | +-----+ | | |
|
||||
| | +--------+ | | | | | ESXi host | | | | |
|
||||
| | | | | | | | VM +-----------+
|
||||
| +----------------+ | | | | | | | | |
|
||||
+----------------------+ | | | +-----+ | | |
|
||||
| | +--------------------+ | |
|
||||
| | | |
|
||||
| | +--------------------+ | |
|
||||
| | | | | |
|
||||
| | | ESXi host +-----+ | | |
|
||||
| | | | | | | |
|
||||
| | | | VM +-----------+
|
||||
| | | | | | | |
|
||||
| | | +-----+ | | |
|
||||
| | +--------------------+ | |
|
||||
| +----------------------------+ |
|
||||
| |
|
||||
| +----------------------------+ |
|
||||
| | | |
|
||||
| | NSXv Management cluster | |
|
||||
| | | |
|
||||
+--------+ ESXi host | |
|
||||
| | +-----------+ | |
|
||||
| | | | | |
|
||||
| +-+ NSX ESG +--------------------+
|
||||
| | | | | |
|
||||
| | +-----------+ | |
|
||||
+ +----------------------------+ +
|
||||
|
||||
|
||||
|
||||
|
||||
VM creation workflow:
|
||||
|
||||
::
|
||||
|
||||
Neutron server
|
||||
Nova-api Nova-compute (NSXv plugin) NSXv Manager vCenter server
|
||||
+ + + + +
|
||||
| | | | |
|
||||
| | | | |
|
||||
| Create VM | | | |
|
||||
| | | | |
|
||||
| <--------> | Provision port | | |
|
||||
| | for VM | | |
|
||||
| | <-------------> | | |
|
||||
| | | Create port | |
|
||||
| | | <-----------> +---+ |
|
||||
| | | | | |
|
||||
| | | Port ready | | |
|
||||
| | Port with UUID N | <-----------> +---+ |
|
||||
| | ready | | |
|
||||
| | <-------------> | | |
|
||||
| | | | |
|
||||
| | | | |
|
||||
| | Create VM and attach to port with UUID N |
|
||||
| | <-------------------------------------------------> +--+
|
||||
| | | | | |
|
||||
| | VM is ready | | | |
|
||||
| | <-------------------------------------------------> +--+
|
||||
| | | | |
|
||||
+ + + + +
|
||||
|
||||
|
||||
Plugin work items in pre-deployment stage:
|
||||
|
||||
#. Generate data for Neutron:
|
||||
|
||||
- username
|
||||
- password
|
||||
- database connection
|
||||
|
||||
Plugin actions in post-deployment stage:
|
||||
|
||||
#. Stop nova-network pacemaker resource
|
||||
#. Remove nova-network service out of OpenStack database
|
||||
#. Deploy HA-proxy neutron
|
||||
#. Install neutron-server
|
||||
#. Configure neutron-server
|
||||
#. Install Neutron NSXv plugin
|
||||
#. Configure the plugin
|
||||
#. Start Neutron server under pacemaker supervision
|
||||
#. Install customized nova-python package
|
||||
#. Configure nova-compute to use Neutron as network provider
|
||||
#. Restart related nova services (nova-api-metadata, nova-compute)
|
||||
|
||||
#. Install Neutron NSXv plugin
|
||||
#. Configure the plugin
|
||||
#. Prepare DB for Neutron
|
||||
#. Setup Keystone account for Neutron
|
||||
#. Configure haproxy
|
||||
#. Install neutron-server package
|
||||
#. Configure nova-compute to Neutron as network API
|
||||
#. Restart Nova related services
|
||||
#. Stop nova-network service and remove it corosync database
|
||||
|
||||
|
||||
Deployment diagram:
|
||||
|
||||
::
|
||||
|
||||
NSXv manifests Nova-network Neutron-server
|
||||
|
||||
+ +
|
||||
| Install customized |
|
||||
| python-nova package |
|
||||
| |
|
||||
| Prepare data for Neutron |
|
||||
| deployment tasks |
|
||||
| |
|
||||
| Stop nova-network |
|
||||
| pacemaker resource |
|
||||
| +------------------------> +
|
||||
|
|
||||
| Remove nova-network entry
|
||||
| out of OpenStack DB
|
||||
|
|
||||
| Deploy ha-proxy
|
||||
|
|
||||
| Install neutron-server
|
||||
|
|
||||
| Install NSXv plugin
|
||||
|
|
||||
| Configure neutron-server with NSXv
|
||||
|
|
||||
| Start Neutron-server
|
||||
| +----------------------------------> +
|
||||
| |
|
||||
| |
|
||||
| |
|
||||
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
|
||||
|
||||
nsxv:
|
||||
nsxv_manager_ip:
|
||||
value: 172.16.0.249
|
||||
nsxv_user:
|
||||
value: admin
|
||||
nsxv_password:
|
||||
value: r00tme
|
||||
nsxv_datacenter_moid:
|
||||
value: datacenter-126
|
||||
nsxv_cluster_moid:
|
||||
value: domain-c133,domain-c134,domain-c138
|
||||
nsxv_resource_pool_id:
|
||||
value: resgroup-134
|
||||
nsxv_datastore_id:
|
||||
value: datastore-138
|
||||
nsxv_external_network:
|
||||
value: network-222
|
||||
nsxv_vdn_scope_id:
|
||||
value: vdnscope-1
|
||||
nsxv_dvs_id:
|
||||
value: dvs-141
|
||||
nsxv_backup_edge_pool:
|
||||
value: service:compact:1:2,vdr:compact:1:2
|
||||
|
||||
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.
|
||||
|
||||
User has to extract needed settings out of vCenter and enter these settings on
|
||||
the settings tab.
|
||||
|
||||
It does not matter at what interface end user will assign 'VM fixed' network
|
||||
(aka Private network) where VM traffic flows on Controller node, because all VM
|
||||
traffic including DHCP and L3 services is terminated inside vSphere
|
||||
infrastructure.
|
||||
|
||||
User experience will be awkward with NSXv plugin, user have to select
|
||||
nova-network backend when he creates new OpenStack environment in Fuel web UI.
|
||||
After enabling NSXv plugin for this environment Neutron will be deployed as
|
||||
network provider. From user perspective it looks awkward.
|
||||
|
||||
Performance Impact
|
||||
------------------
|
||||
|
||||
None.
|
||||
|
||||
Other deployer impact
|
||||
---------------------
|
||||
|
||||
None.
|
||||
|
||||
Developer impact
|
||||
----------------
|
||||
|
||||
Since it is not possible for user to select any Neutron option in 'Create a new
|
||||
OpenStack environment' wizard deployment serializer would not be able to
|
||||
generate network data for Neutron granular deployment tasks. This obstacle can
|
||||
be overcome with custom puppet class that will prepare nova-network
|
||||
parameters for neutron manifests. Only after that it will be possible to
|
||||
utilize neutron deployment tasks from fuel-library [3]_.
|
||||
|
||||
|
||||
Implementation
|
||||
==============
|
||||
|
||||
Assignee(s)
|
||||
-----------
|
||||
|
||||
Primary assignee:
|
||||
|
||||
- Igor Zinovik <izinovik@mirantis.com> - feature lead, developer
|
||||
|
||||
Other contributors:
|
||||
|
||||
- Artem Savinov <asavinov@mirantis.com> - developer
|
||||
|
||||
Project manager:
|
||||
|
||||
- Andrian Noga <anoga@mirantis.com>
|
||||
|
||||
Quality assurance:
|
||||
|
||||
- Andrey Setyaev <asetyaev@mirantis.com>
|
||||
|
||||
|
||||
Work Items
|
||||
----------
|
||||
|
||||
* Create pre-dev environment and manually deploy vCenter with NSXv
|
||||
|
||||
* Create Fuel plugin bundle, which contains deployments scripts, puppet
|
||||
modules and metadata
|
||||
|
||||
* Implement puppet module with the following functions:
|
||||
|
||||
- Install Neutron NSXv plugin on OpenStack controllers
|
||||
- Configure Neutron server to use NSXv 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
|
||||
|
||||
* VMware NSXv support in Nova
|
||||
https://blueprints.launchpad.net/nova/+spec/vmware-nsxv-support
|
||||
|
||||
* VMware NSXv plugin for Neutron
|
||||
|
||||
https://blueprints.launchpad.net/neutron/+spec/vmware-nsx-v
|
||||
|
||||
https://github.com/openstack/vmware-nsx
|
||||
|
||||
* NSXv support for Nova (Kilo)
|
||||
|
||||
https://review.openstack.org/#/c/209372/
|
||||
|
||||
https://review.openstack.org/#/c/209374/
|
||||
|
||||
Testing
|
||||
=======
|
||||
|
||||
* Sanity checks including plugin build
|
||||
* Syntax check
|
||||
* Functional testing
|
||||
* Non-functional testing
|
||||
* Destructive 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] NSX for vSphere getting started guide
|
||||
https://communities.vmware.com/servlet/JiveServlet/previewBody/27705-102-1-37093/NSXv-GSG.pdf
|
||||
.. [2] Fuel Plug-in Guide http://docs.mirantis.com/openstack/fuel/fuel-6.0/plugin-dev.html
|
||||
.. [3] https://github.com/stackforge/fuel-library
|
||||
Reference in New Issue
Block a user