Provide documentation for Fuel NSXv plugin

* Describe how to build documentation in README.md
* Documentation resides in doc/source
* Provide doc/requirements.txt with pip packages required to build
  documentation
* Provide specs/requirements.txt with pip packages required to build
  specification
* Switch both documentation and specification theme to 'oslosphinx'

Change-Id: I6ba49885b0535a6545968c57987206fee8ac83f4

README.md

@@ -4,32 +4,13 @@ Fuel NSXv plugin
 Fuel NSXv plugin enables OpenStack deployment which utilizes vCenter with
 installed and configured VMware NSXv network virtualization software.
 
-Supported features:
-- VM port provisioning
-- Security groups
+See doc/ directory for documentation.
 
-How to build plugin:
+To build HTML variant of documentation you need to install sphinx document
+generator, easiest way to do this is to use doc/requirements.txt.
 
-* Install fuel plugin builder:
+  $ pip install -r doc/requirements.txt
+  $ cd doc/source
+  $ make html
 
-..
-  pip install fuel-plugin-builder
-
-* Clone plugin source repository
-
-..
-  git clone https://github.com/stackforge/fuel-plugin-nsxv
-
-  cd fuel-plugin-nsxv/
-
-  fpb --build .
-
-Installation
-============
-
-* Upload the plugin to Fuel master node
-
-* Install the plugin using Fuel command line client:
-
-..
-  fuel plugins --install nsxv-1.0-1.0.0-1.noarch.rpm
+After that you can start exploring documentation in doc/source/_build/html/ directory.

doc/requirements.txt

@@ -0,0 +1,3 @@
+docutils==0.9.1
+oslosphinx
+sphinx>=1.1.2,!=1.2.0,<1.3

doc/source/Makefile

@@ -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."

doc/source/build.rst

@@ -0,0 +1,29 @@
+How to build the plugin
+=======================
+
+To build the plugin you first need to install fuel-plugin-build 3.0.0[1_]
+
+.. code-block:: bash
+
+  $ pip install fuel-plugin-builder==3.0.0
+
+After that you can build plugin:
+
+.. code-block:: bash
+
+  $ git clone https://github.com/stackforge/fuel-plugin-nsxv
+
+  $ cd fuel-plugin-nsxv/
+
+  $ 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 nsxv-*.rpm
+
+  nsxv-1.0-1.0.0-1.noarch.rpm
+
+.. [1] https://pypi.python.org/pypi/fuel-plugin-builder/3.0.0

doc/source/conf.py

@@ -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 = [ 'oslosphinx']
+
+# 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, Mirantis Inc.'
+
+# 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 = []
+
+# 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

doc/source/configuration.rst

@@ -0,0 +1,132 @@
+Configuration
+=============
+
+Switch to Settings tab of the Fuel web UI and click on NSXv plugin section,
+tick the plugin checkbox to enable it.
+
+.. image:: /image/nsxv-settings-filled.png
+   :scale: 60 %
+
+Several plugins input fields refer to MoRef ID (Managed Object Reference ID),
+these are object IDs can be obtained via Managed Object Browser which is
+located on the vCenter host, e.g. https://hostname.yourdomain.org/mob
+
+Plugin contains the following settings:
+
+#. NSX Manager hostname (or IP) -- if you are going to use hostname in this
+   textbox be sure that your OpenStack controller will be able to resolve it.
+   Add necessary DNS servers in *Host OS DNS Servers* section.  NSX Manager
+   must be connected to vCenter server which you specified on VMware tab.
+
+   OpenStack Controller must have L3 connectivity with NSX Manager through
+   Public network.
+
+#. NSX Manager user and password for access.
+
+#. Datacenter MoRef ID -- ID of Datacenter where NSX Edge nodes will be
+   deployed.
+
+#. Cluster MoRef IDs for OpenStack VMs -- list of comma separated IDs of
+   cluster where OpenStack VM instances will be launched.  You must obtain IDs
+   for clusters that you specified on VMware tab.
+
+   .. warning::
+
+      In this list you must also enumerate clusters that form Resource pool for
+      NSX Edge nodes (see next setting).  This must be done, because default
+      firewall rules that are applied to cluster allow DHCP traffic only within
+      this cluster.  Typically NSX Edges run in separate management cluster.
+      If you do not explicitly specify that cluster MoRef ID then virtual
+      machines would not have connectivity with DHCP service provided by NSX
+      Edge nodes.
+
+#. Resource pool MoRef ID -- resource pool for NSX Edge nodes deployment.
+
+#. Datastore MoRef ID -- datastore for NSX Edge nodes.
+
+#. External portgroup -- portgroup through which NSX Edge nodes get
+   connectivity with physical network
+
+#. Transport zone MoRef ID -- transport zone for VXLAN logical networks.
+
+   .. note::
+
+      This ID can be fetched using NSX Manager API
+      https://nsx-manager.yourdomain.org/api/2.0/vdn/scopes
+
+#. Distributed virtual switch MoRef ID -- ID of vswitch connected to Edge
+   cluster
+
+#. NSX backup Edge pool -- size of NSX Edge nodes and size of Edge pool, value
+   must follow format: <edge_type>:[edge_size]:<min_edges>:<max_edges>.
+
+   **edge_type** can take the following values: *service* or *vdr* (service and
+   distributed edge, respectively).
+
+   NSX *service* nodes provide such services as DHCP, DNS, firewall, NAT, VPN,
+   routing and load balancing.
+
+   NSX *vdr* nodes performs distributed routing and bridging.
+
+   **edge_size** can take following values: *compact*, *large* (default value if
+   omitted), *xlarge*, *quadlarge*.
+
+   **min_edges** and **max_edges** defines minimum and maximum amount of NSX
+   Edge nodes in pool.
+
+   Consider following table that describes NSX Edge types:
+
+   ========= ===================
+   Edge size Edge VM parameters
+   ========= ===================
+   compact   1 vCPU 512  MB vRAM
+   large     2 vCPU 2014 MB vRAM
+   xlarge    4 vCPU 1024 MB vRAM
+   quadlarge 6 vCPU 8192 MB vRAM
+   ========= ===================
+
+   Consider following example values:
+
+   ``service:compact:1:2,vdr:compact:1:3``
+
+   ``service:xlarge:2:6,service:large:4:10,vdr:large:2:4``
+
+#. Enable HA for NSX Edges -- if you enable this option NSX Edges will be
+   deployed in active/standby pair on different ESXi hosts.
+
+#. Bypass NSX Manager certificate verification -- disable this option if you
+   want Neutron NSX plugin to verify NSX Manager security certificate. *CA
+   certificate file* setting will appear providing an option to upload
+   CA certificate which emitted NSX Manager certificate.
+
+To enable Nova metadata service, set the following settings must be set:
+
+#. Metadata portgroup MoRef ID -- portgroup MoRef ID for metadata proxy service
+
+#. Metadata proxy IP addresses -- comma separated IP addresses used by Nova
+   metadata proxy service.
+
+#. Management network netmask -- management network netmask for metadata proxy
+   service.
+
+#. Management network default gateway -- management network gateway for
+   metadata proxy service.
+
+If you tick *Additional settings* checkbox following options will become
+available for configuration:
+
+#. Task status check interval -- asynchronous task status check interval,
+   default is 2000 (millisecond).
+
+#. Maximum tunnels per vnic -- specify maximum amount of tunnels per vnic,
+   possible range of values 1-110 (20 is used if no other value is provided).
+
+#. API retries -- maximum number of API retries (10 by default)
+
+#. Enable SpoofGuard -- option allows to control behaviour of port-security
+   feature that prevents traffic flow if IP address of VM that was reported by
+   VMware Tools does not match source IP address that is observed in outgoing
+   VM traffic (consider the case when VM was compromised).
+
+#. Tenant router types -- ordered list of preferred tenant router types (default
+   value is 'shared, distributed, exclusive').

doc/source/environment.rst

@@ -0,0 +1,68 @@
+OpenStack environment notes
+===========================
+
+Environment creation
+--------------------
+
+Before start actual deployment process please verify that you vSphere
+infrastructure (vCenter and NSXv) is configured and functions properly,
+Fuel NSXv plugin cannot deploy vSphere infrastructure, it must be up and
+running before OpenStack deployment.
+
+To use NSXv plugin create new OpenStack environment via the Fuel web UI follow
+these steps:
+
+#. On *Compute* configuration step tick 'vCenter' checkbox
+
+   .. image:: /image/wizard-step1.png
+      :scale: 70 %
+
+#. After plugin gets installed it updates Fuel and it will be possible to use
+   *Neutron with tunneling segmentation* at 'Networking Setup' step:
+
+   .. image:: /image/wizard-step2.png
+      :scale: 70 %
+
+   .. warning::
+
+      After Fuel database gets updated it is possible to enable Murano support
+      for cloud with NSX, but Murano functionality was not tested with NSX.
+
+#. Once you get environment created add one or more controller node.
+
+Pay attention on which interface you assign *Public* network, Controller must
+have connectivity with NSX Manager host through *Public* network since it is
+used as default route for packets.
+
+Is is worth to mention that it is not possible to use compute nodes in this
+type of cluster, because NSX switch is not available for Linux only for ESXi,
+so it is not possible to pass traffic inside compute node that runs Linux and
+KVM.  Also it does not matter on which network interface you assign 'VM fixed'
+traffic, because it does not flow through controllers.
+
+*Floating IP ranges* are not used, because Neutron L3 agent is not used on
+Controller.
+
+.. image:: /image/floating-ip.png
+   :scale: 70 %
+
+Pay attention that Neutron L2/L3 configuration on Settings tab does not have
+effect in OpenStack cluster that uses NSXv.  These settings contain settings
+for GRE tunneling which does not have an effect with NSXv.
+
+.. image:: /image/neutron-network-settings.png
+   :scale: 70 %
+
+Public network assignment
+-------------------------
+
+If you are going to use *Cinder proxy to VMware datastore* or *Compute VMware*
+roles in your environment then you have to assign public IP addresses to all
+nodes, because all communication between OpenStack services (Cinder and Nova in
+this case) and vCenter happens via Public network.
+
+You can achieve this by enabling following option (*Settings -> Public network
+assignment -> Assign public network to all nodes*):
+
+.. image:: /image/public-network-assignment.png
+   :scale: 70 %

doc/source/index.rst

@@ -0,0 +1,32 @@
+.. Fuel NSXv plugin documentation master file
+
+Welcome to Fuel NSXv plugin's documentation!
+============================================
+
+Fuel NSXv plugin allows you to deploy OpenStack cluster which can use
+pre-existing vSphere infrastructure with NSX network virtualization platform.
+
+Plugin installs Neutron NSX core plugin and allows logical network equipment
+(routers, networks) to be created as NSX entities.
+
+Plugin version 1.0.0 is compatible with Fuel 7.0.
+
+Plugin can work with VMware NSX 6.1.3, 6.1.4.
+
+Through documentation we use term "NSX" and "NSXv" interchangeably, both of
+these term refer to `VMware NSX virtualized network platform
+<https://www.vmware.com/products/nsx>`_.
+
+Documentation contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   build
+   installation
+   environment
+   configuration
+   usage
+
+Pre-built package of the plugin you can find in
+`Fuel Plugin Catalog <https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins>`_.

doc/source/installation.rst

@@ -0,0 +1,41 @@
+Installation
+============
+
+#. Download plugin .rpm package from the Fuel Plugin Catalog.
+
+#. Upload package to Fuel master node.
+
+#. Install the plugin with *fuel* command line tool:
+
+   .. code-block:: bash
+
+    [root@nailgun ~] fuel plugins --install nsxv-1.0-1.0.0-1.noarch.rpm
+
+
+   Installation process may take up to 1-2 minutes depending on hardware
+   specification of your Fuel Master node, because plugin has to update database
+   and restart docker containers.
+
+#. Verify that the plugin is installed successfully:
+
+  .. code-block:: bash
+
+    [root@nailgun ~] fuel plugins
+    id | name | version | package_version
+    ---|------|---------|----------------
+    1  | nsxv | 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 nsxv==1.0.0

doc/source/usage.rst

@@ -0,0 +1,57 @@
+Usage
+=====
+
+VXLAN MTU considerations
+------------------------
+
+The VXLAN protocol is used for L2 logical switching across ESXi hosts. VXLAN
+adds additional data to the packet, please consider to increase MTU size on
+network equipment that is connected to ESXi hosts.
+
+Consider following calculation when settings MTU size:
+
+Outer IPv4 header    == 20 bytes
+
+Outer UDP header     == 8 bytes
+
+VXLAN header         == 8 bytes
+
+Inner Ethernet frame == 1518 (14 bytes header, 4 bytes 802.1q header, 1500 Payload)
+
+Summarizing all of these we get 1554 bytes.  Consider increasing MTU on network
+hardware up to 1600 bytes (default MTU value when you are configuring VXLAN on
+ESXi hosts during *Host Preparation* step).
+
+Instances usage notes
+---------------------
+
+Instances that you run in OpenStack cluster with vCenter and NSXv must have
+VMware Tools installed, otherwise there will be no connectivity and security
+groups functionality.
+
+
+Neutron usage notes
+-------------------
+
+The only way to create Distributed Router is to use neutron CLI tool:
+
+.. code-block:: bash
+
+  $ neutron router-create dvr --distributed True
+
+Creation of exclusive tenant router is not supported in OpenStack dashboard
+(Horizon).  You can create exclusive router using Neutron CLI tool:
+
+.. code-block:: bash
+
+  $ neutron router-create DbTierRouter-exclusive --router_type exclusive
+
+During creation of external network for tenants you must specify physical
+network (``--provider:physical_network`` parameter) that will be used to carry
+VM traffic into physical network segment.  For Neutron with NSX plugin this
+parameter must be set to MoRef ID of portgroup which provides connectivity to
+NSX Edge nodes.
+
+.. code-block:: bash
+
+  $ neutron net-create External --router:external --provider:physical_network network-222

specs/conf.py

@@ -28,7 +28,7 @@ import os
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = []
+extensions = [ 'oslosphinx' ]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

specs/requirements.txt

@@ -1,7 +1,3 @@
 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