Browse Source

Merge "Add plugin guide with spnix enabled"

tags/1.1.0
Jenkins 3 years ago
parent
commit
11df02fa3d

+ 216
- 0
doc/plugin_guide/Makefile View File

@@ -0,0 +1,216 @@
1
+# Makefile for Sphinx documentation
2
+#
3
+
4
+# You can set these variables from the command line.
5
+SPHINXOPTS    =
6
+SPHINXBUILD   = sphinx-build
7
+PAPER         =
8
+BUILDDIR      = build
9
+
10
+# User-friendly check for sphinx-build
11
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
12
+$(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/)
13
+endif
14
+
15
+# Internal variables.
16
+PAPEROPT_a4     = -D latex_paper_size=a4
17
+PAPEROPT_letter = -D latex_paper_size=letter
18
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
19
+# the i18n builder cannot share the environment and doctrees with the others
20
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
21
+
22
+.PHONY: help
23
+help:
24
+	@echo "Please use \`make <target>' where <target> is one of"
25
+	@echo "  html       to make standalone HTML files"
26
+	@echo "  dirhtml    to make HTML files named index.html in directories"
27
+	@echo "  singlehtml to make a single large HTML file"
28
+	@echo "  pickle     to make pickle files"
29
+	@echo "  json       to make JSON files"
30
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
31
+	@echo "  qthelp     to make HTML files and a qthelp project"
32
+	@echo "  applehelp  to make an Apple Help Book"
33
+	@echo "  devhelp    to make HTML files and a Devhelp project"
34
+	@echo "  epub       to make an epub"
35
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
36
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
37
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
38
+	@echo "  text       to make text files"
39
+	@echo "  man        to make manual pages"
40
+	@echo "  texinfo    to make Texinfo files"
41
+	@echo "  info       to make Texinfo files and run them through makeinfo"
42
+	@echo "  gettext    to make PO message catalogs"
43
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
44
+	@echo "  xml        to make Docutils-native XML files"
45
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
46
+	@echo "  linkcheck  to check all external links for integrity"
47
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
48
+	@echo "  coverage   to run coverage check of the documentation (if enabled)"
49
+
50
+.PHONY: clean
51
+clean:
52
+	rm -rf $(BUILDDIR)/*
53
+
54
+.PHONY: html
55
+html:
56
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
57
+	@echo
58
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
59
+
60
+.PHONY: dirhtml
61
+dirhtml:
62
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
63
+	@echo
64
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
65
+
66
+.PHONY: singlehtml
67
+singlehtml:
68
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
69
+	@echo
70
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
71
+
72
+.PHONY: pickle
73
+pickle:
74
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
75
+	@echo
76
+	@echo "Build finished; now you can process the pickle files."
77
+
78
+.PHONY: json
79
+json:
80
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
81
+	@echo
82
+	@echo "Build finished; now you can process the JSON files."
83
+
84
+.PHONY: htmlhelp
85
+htmlhelp:
86
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
87
+	@echo
88
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
89
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
90
+
91
+.PHONY: qthelp
92
+qthelp:
93
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
94
+	@echo
95
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
96
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
97
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/plumgrid_plugin_guide.qhcp"
98
+	@echo "To view the help file:"
99
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/plumgrid_plugin_guide.qhc"
100
+
101
+.PHONY: applehelp
102
+applehelp:
103
+	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
104
+	@echo
105
+	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
106
+	@echo "N.B. You won't be able to view it unless you put it in" \
107
+	      "~/Library/Documentation/Help or install it in your application" \
108
+	      "bundle."
109
+
110
+.PHONY: devhelp
111
+devhelp:
112
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
113
+	@echo
114
+	@echo "Build finished."
115
+	@echo "To view the help file:"
116
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/plumgrid_plugin_guide"
117
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/plumgrid_plugin_guide"
118
+	@echo "# devhelp"
119
+
120
+.PHONY: epub
121
+epub:
122
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
123
+	@echo
124
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
125
+
126
+.PHONY: latex
127
+latex:
128
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
129
+	@echo
130
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
131
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
132
+	      "(use \`make latexpdf' here to do that automatically)."
133
+
134
+.PHONY: latexpdf
135
+latexpdf:
136
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
137
+	@echo "Running LaTeX files through pdflatex..."
138
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
139
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
140
+
141
+.PHONY: latexpdfja
142
+latexpdfja:
143
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
144
+	@echo "Running LaTeX files through platex and dvipdfmx..."
145
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
146
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
147
+
148
+.PHONY: text
149
+text:
150
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
151
+	@echo
152
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
153
+
154
+.PHONY: man
155
+man:
156
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
157
+	@echo
158
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
159
+
160
+.PHONY: texinfo
161
+texinfo:
162
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
163
+	@echo
164
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
165
+	@echo "Run \`make' in that directory to run these through makeinfo" \
166
+	      "(use \`make info' here to do that automatically)."
167
+
168
+.PHONY: info
169
+info:
170
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
171
+	@echo "Running Texinfo files through makeinfo..."
172
+	make -C $(BUILDDIR)/texinfo info
173
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
174
+
175
+.PHONY: gettext
176
+gettext:
177
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
178
+	@echo
179
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
180
+
181
+.PHONY: changes
182
+changes:
183
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
184
+	@echo
185
+	@echo "The overview file is in $(BUILDDIR)/changes."
186
+
187
+.PHONY: linkcheck
188
+linkcheck:
189
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
190
+	@echo
191
+	@echo "Link check complete; look for any errors in the above output " \
192
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
193
+
194
+.PHONY: doctest
195
+doctest:
196
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
197
+	@echo "Testing of doctests in the sources finished, look at the " \
198
+	      "results in $(BUILDDIR)/doctest/output.txt."
199
+
200
+.PHONY: coverage
201
+coverage:
202
+	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
203
+	@echo "Testing of coverage in the sources finished, look at the " \
204
+	      "results in $(BUILDDIR)/coverage/python.txt."
205
+
206
+.PHONY: xml
207
+xml:
208
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
209
+	@echo
210
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
211
+
212
+.PHONY: pseudoxml
213
+pseudoxml:
214
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
215
+	@echo
216
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

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

@@ -0,0 +1,292 @@
1
+# -*- coding: utf-8 -*-
2
+#
3
+# plumgrid_plugin_guide documentation build configuration file, created by
4
+# sphinx-quickstart on Fri Mar 18 05:25:02 2016.
5
+#
6
+# This file is execfile()d with the current directory set to its
7
+# containing dir.
8
+#
9
+# Note that not all possible configuration values are present in this
10
+# autogenerated file.
11
+#
12
+# All configuration values have a default; values that are commented out
13
+# serve to show the default.
14
+
15
+import sys
16
+import os
17
+
18
+# If extensions (or modules to document with autodoc) are in another directory,
19
+# add these directories to sys.path here. If the directory is relative to the
20
+# documentation root, use os.path.abspath to make it absolute, like shown here.
21
+#sys.path.insert(0, os.path.abspath('.'))
22
+
23
+# -- General configuration ------------------------------------------------
24
+
25
+# If your documentation needs a minimal Sphinx version, state it here.
26
+#needs_sphinx = '1.0'
27
+
28
+# Add any Sphinx extension module names here, as strings. They can be
29
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
30
+# ones.
31
+extensions = [
32
+    'sphinx.ext.autodoc',
33
+    'sphinx.ext.intersphinx',
34
+    'sphinx.ext.ifconfig',
35
+    'sphinx.ext.viewcode',
36
+]
37
+
38
+# Add any paths that contain templates here, relative to this directory.
39
+templates_path = ['_templates']
40
+
41
+# The suffix(es) of source filenames.
42
+# You can specify multiple suffix as a list of string:
43
+# source_suffix = ['.rst', '.md']
44
+source_suffix = '.rst'
45
+
46
+# The encoding of source files.
47
+#source_encoding = 'utf-8-sig'
48
+
49
+# The master toctree document.
50
+master_doc = 'index'
51
+
52
+# General information about the project.
53
+project = u'plumgrid_plugin_guide'
54
+copyright = u'2016, Javeria Khan'
55
+author = u'Javeria Khan'
56
+
57
+# The version info for the project you're documenting, acts as replacement for
58
+# |version| and |release|, also used in various other places throughout the
59
+# built documents.
60
+#
61
+# The short X.Y version.
62
+version = u'1.0'
63
+# The full version, including alpha/beta/rc tags.
64
+release = u'1.0.1'
65
+
66
+# The language for content autogenerated by Sphinx. Refer to documentation
67
+# for a list of supported languages.
68
+#
69
+# This is also used if you do content translation via gettext catalogs.
70
+# Usually you set "language" from the command line for these cases.
71
+language = None
72
+
73
+# There are two options for replacing |today|: either, you set today to some
74
+# non-false value, then it is used:
75
+#today = ''
76
+# Else, today_fmt is used as the format for a strftime call.
77
+#today_fmt = '%B %d, %Y'
78
+
79
+# List of patterns, relative to source directory, that match files and
80
+# directories to ignore when looking for source files.
81
+exclude_patterns = []
82
+
83
+# The reST default role (used for this markup: `text`) to use for all
84
+# documents.
85
+#default_role = None
86
+
87
+# If true, '()' will be appended to :func: etc. cross-reference text.
88
+#add_function_parentheses = True
89
+
90
+# If true, the current module name will be prepended to all description
91
+# unit titles (such as .. function::).
92
+#add_module_names = True
93
+
94
+# If true, sectionauthor and moduleauthor directives will be shown in the
95
+# output. They are ignored by default.
96
+#show_authors = False
97
+
98
+# The name of the Pygments (syntax highlighting) style to use.
99
+pygments_style = 'sphinx'
100
+
101
+# A list of ignored prefixes for module index sorting.
102
+#modindex_common_prefix = []
103
+
104
+# If true, keep warnings as "system message" paragraphs in the built documents.
105
+#keep_warnings = False
106
+
107
+# If true, `todo` and `todoList` produce output, else they produce nothing.
108
+todo_include_todos = False
109
+
110
+
111
+# -- Options for HTML output ----------------------------------------------
112
+
113
+# The theme to use for HTML and HTML Help pages.  See the documentation for
114
+# a list of builtin themes.
115
+html_theme = 'alabaster'
116
+
117
+# Theme options are theme-specific and customize the look and feel of a theme
118
+# further.  For a list of options available for each theme, see the
119
+# documentation.
120
+#html_theme_options = {}
121
+
122
+# Add any paths that contain custom themes here, relative to this directory.
123
+#html_theme_path = []
124
+
125
+# The name for this set of Sphinx documents.  If None, it defaults to
126
+# "<project> v<release> documentation".
127
+#html_title = None
128
+
129
+# A shorter title for the navigation bar.  Default is the same as html_title.
130
+#html_short_title = None
131
+
132
+# The name of an image file (relative to this directory) to place at the top
133
+# of the sidebar.
134
+#html_logo = None
135
+
136
+# The name of an image file (relative to this directory) to use as a favicon of
137
+# the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
138
+# pixels large.
139
+#html_favicon = None
140
+
141
+# Add any paths that contain custom static files (such as style sheets) here,
142
+# relative to this directory. They are copied after the builtin static files,
143
+# so a file named "default.css" will overwrite the builtin "default.css".
144
+html_static_path = ['_static']
145
+
146
+# Add any extra paths that contain custom files (such as robots.txt or
147
+# .htaccess) here, relative to this directory. These files are copied
148
+# directly to the root of the documentation.
149
+#html_extra_path = []
150
+
151
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
152
+# using the given strftime format.
153
+#html_last_updated_fmt = '%b %d, %Y'
154
+
155
+# If true, SmartyPants will be used to convert quotes and dashes to
156
+# typographically correct entities.
157
+#html_use_smartypants = True
158
+
159
+# Custom sidebar templates, maps document names to template names.
160
+#html_sidebars = {}
161
+
162
+# Additional templates that should be rendered to pages, maps page names to
163
+# template names.
164
+#html_additional_pages = {}
165
+
166
+# If false, no module index is generated.
167
+#html_domain_indices = True
168
+
169
+# If false, no index is generated.
170
+#html_use_index = True
171
+
172
+# If true, the index is split into individual pages for each letter.
173
+#html_split_index = False
174
+
175
+# If true, links to the reST sources are added to the pages.
176
+#html_show_sourcelink = True
177
+
178
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
179
+#html_show_sphinx = True
180
+
181
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
182
+#html_show_copyright = True
183
+
184
+# If true, an OpenSearch description file will be output, and all pages will
185
+# contain a <link> tag referring to it.  The value of this option must be the
186
+# base URL from which the finished HTML is served.
187
+#html_use_opensearch = ''
188
+
189
+# This is the file name suffix for HTML files (e.g. ".xhtml").
190
+#html_file_suffix = None
191
+
192
+# Language to be used for generating the HTML full-text search index.
193
+# Sphinx supports the following languages:
194
+#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
195
+#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
196
+#html_search_language = 'en'
197
+
198
+# A dictionary with options for the search language support, empty by default.
199
+# Now only 'ja' uses this config value
200
+#html_search_options = {'type': 'default'}
201
+
202
+# The name of a javascript file (relative to the configuration directory) that
203
+# implements a search results scorer. If empty, the default will be used.
204
+#html_search_scorer = 'scorer.js'
205
+
206
+# Output file base name for HTML help builder.
207
+htmlhelp_basename = 'plumgrid_plugin_guidedoc'
208
+
209
+# -- Options for LaTeX output ---------------------------------------------
210
+
211
+latex_elements = {
212
+# The paper size ('letterpaper' or 'a4paper').
213
+#'papersize': 'letterpaper',
214
+
215
+# The font size ('10pt', '11pt' or '12pt').
216
+#'pointsize': '10pt',
217
+
218
+# Additional stuff for the LaTeX preamble.
219
+#'preamble': '',
220
+
221
+# Latex figure (float) alignment
222
+#'figure_align': 'htbp',
223
+}
224
+
225
+# Grouping the document tree into LaTeX files. List of tuples
226
+# (source start file, target name, title,
227
+#  author, documentclass [howto, manual, or own class]).
228
+latex_documents = [
229
+    (master_doc, 'plumgrid_plugin_guide.tex', u'plumgrid\\_plugin\\_guide Documentation',
230
+     u'Javeria Khan', 'manual'),
231
+]
232
+
233
+# The name of an image file (relative to this directory) to place at the top of
234
+# the title page.
235
+#latex_logo = None
236
+
237
+# For "manual" documents, if this is true, then toplevel headings are parts,
238
+# not chapters.
239
+#latex_use_parts = False
240
+
241
+# If true, show page references after internal links.
242
+#latex_show_pagerefs = False
243
+
244
+# If true, show URL addresses after external links.
245
+#latex_show_urls = False
246
+
247
+# Documents to append as an appendix to all manuals.
248
+#latex_appendices = []
249
+
250
+# If false, no module index is generated.
251
+#latex_domain_indices = True
252
+
253
+
254
+# -- Options for manual page output ---------------------------------------
255
+
256
+# One entry per manual page. List of tuples
257
+# (source start file, name, description, authors, manual section).
258
+man_pages = [
259
+    (master_doc, 'plumgrid_plugin_guide', u'plumgrid_plugin_guide Documentation',
260
+     [author], 1)
261
+]
262
+
263
+# If true, show URL addresses after external links.
264
+#man_show_urls = False
265
+
266
+
267
+# -- Options for Texinfo output -------------------------------------------
268
+
269
+# Grouping the document tree into Texinfo files. List of tuples
270
+# (source start file, target name, title, author,
271
+#  dir menu entry, description, category)
272
+texinfo_documents = [
273
+    (master_doc, 'plumgrid_plugin_guide', u'plumgrid_plugin_guide Documentation',
274
+     author, 'plumgrid_plugin_guide', 'One line description of project.',
275
+     'Miscellaneous'),
276
+]
277
+
278
+# Documents to append as an appendix to all manuals.
279
+#texinfo_appendices = []
280
+
281
+# If false, no module index is generated.
282
+#texinfo_domain_indices = True
283
+
284
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
285
+#texinfo_show_urls = 'footnote'
286
+
287
+# If true, do not generate a @detailmenu in the "Top" node's menu.
288
+#texinfo_no_detailmenu = False
289
+
290
+
291
+# Example configuration for intersphinx: refer to the Python standard library.
292
+intersphinx_mapping = {'https://docs.python.org/': None}

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


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


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


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


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


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


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


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


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


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


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


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

@@ -0,0 +1,16 @@
1
+.. plumgrid_plugin_guide documentation master file, created by
2
+   sphinx-quickstart on Fri Mar 18 05:25:02 2016.
3
+   You can adapt this file completely to your liking, but it should at least
4
+   contain the root `toctree` directive.
5
+
6
+=======================================================
7
+Guide to PLUMgrid Plugin ver. 1.0-1.0.1-1 for Fuel 7.0
8
+=======================================================
9
+
10
+.. toctree::
11
+   :maxdepth: 2
12
+   :numbered:
13
+
14
+    intro
15
+    requirements
16
+    install_guide

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

@@ -0,0 +1,133 @@
1
+Installation Guide
2
+==================
3
+
4
+Prerequisites
5
+-------------
6
+
7
+This document assumes that you have `installed Fuel <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html>`_
8
+and setup the target hosts with appropriate networking for the pxe, management, public and plumgrid-fabric networks. The nodes
9
+must be discovered and functional prior to doing the following steps.
10
+
11
+Obtain a PLUMgrid ONS license and access to packages or LCM image at info@plumgrid.com
12
+
13
+Installing Fuel PLUMgrid Plugin
14
+-------------------------------
15
+
16
+#. Download the PLUMgrid plugin from the `Fuel Plugins Catalog <https://software.mirantis.com/download-mirantis-openstack-fuel-plug-ins/>`_.
17
+#. Copy this file to the Fuel Master node with secure copy (scp):
18
+   ::
19
+
20
+      scp plumgrid-<x.x.x>.rpm root@:<the_Fuel_Master_node_IP address>:/tmp
21
+
22
+#. On the Fuel Master node, Install the PLUMgrid plugin with:
23
+   ::
24
+
25
+      cd /tmp
26
+      fuel plugins --install plumgrid-<x.x.x>.rpm
27
+
28
+   You should get the following output
29
+   ::
30
+
31
+      Plugin <plugin-name-version>.rpm was successfully installed
32
+
33
+#. Check that the correct version of the PLUMgrid plugin is installed in Fuel with:
34
+   ::
35
+
36
+      fuel plugins --list
37
+
38
+#. The plugin is now ready for use and can be enabled on the Settings tab, PLUMgrid Plugin section
39
+   of the Fuel web UI, as explained next.
40
+
41
+Configuring PLUmgrid Plugin
42
+---------------------------
43
+
44
+#. In Fuel UI `create environment <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#create-a-new-openstack-environment>`_.
45
+
46
+    .. image:: images/create_env.png
47
+       :width: 80%
48
+
49
+
50
+#. Select the appropiate KVM or QEMU hypervisor type for your environment.
51
+
52
+    .. image:: images/compute.png
53
+       :width: 80%
54
+
55
+
56
+#. Select Neutron with VLAN segmentation as Networking Setup.
57
+
58
+    .. image:: images/networking_setup.png
59
+       :width: 80%
60
+
61
+
62
+#. After creating the enviroment, navigate to Settings → Fuel PLUMgrid plugin. Check the Fuel PLUMgrid Pluginbox and fill in the appropiate values for the your enviroment.
63
+
64
+   .. image:: images/plumgrid_ui_setup.png
65
+       :width: 80%
66
+
67
+
68
+  * **Enter the username for PLUMgrid:** default is *plumgrid*
69
+
70
+  * **Enter the password for PLUMgrid:** default is *plumgrid*
71
+
72
+  * **PLUMgrid VIP on the management network to access the PLUMgrid console:**  The IP address for PLUMgrid console, make sure to select an unassigned IP on the management network.
73
+
74
+  * **Enter the PLUMgrid Fabric Network:** Enter the network that will be used by PLUMgrid Fabric.
75
+
76
+  * **Repository for PLUMgrid packages:** Enter IP address of a repo hosting PLUMgrid packages such as LCM.
77
+
78
+  * **Enter the zone name for PLUMgrid LCM:** If using an LCM enter the zone name specified during its configuration.
79
+
80
+  * **Enter the license for PLUMgrid:** Enter the PLUMgrid license string provided by PLUMgrid support.
81
+
82
+  * **Enter the interface(s) to be used by GW:** Enter the interfaces that will be used for external connectivity by the PLUMgrid Gateway comma separated for more than one.
83
+
84
+#. Navigate to Repositories tab and click Add Extra Repo and provide the following PLUMgrid repositories:
85
+   ::
86
+
87
+      plumgrid           deb http://<LCM-IP>:81/plumgrid plumgrid <component>         1200
88
+      plumgrid-images    deb http://<LCM-IP>:81/plumgrid-images plumgrid <component>  1250
89
+
90
+   .. image:: images/plumgrid_repos.png
91
+       :width: 80%
92
+
93
+#. Navigate to the Nodes tab to and click on Add nodes:
94
+
95
+   .. image:: images/add_nodes.png
96
+       :width: 80%
97
+
98
+
99
+Assign the unallocated nodes their respective roles. Select the role i.e. Controller/Compute/PLUMgrid-Gateway and select the node which will assume that role. This process must be repeated for each node individually:
100
+
101
+   .. image:: images/add_controllers.png
102
+       :width: 80%
103
+
104
+#. As described in the Requirements section, configure interfaces on nodes as shown in figure below:
105
+
106
+   .. image:: images/network_config.png
107
+       :width: 80%
108
+
109
+#. Navigate to Networks tab and set the appropiate Network Settings for the Public, Storage and Management Networks. Click Verify Networks to verify correct configuration.
110
+
111
+   .. image:: images/verify_network.png
112
+       :width: 80%
113
+
114
+
115
+#. Press **Deploy changes** to `deploy the environment <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#deploy-changes>`_.
116
+
117
+#. After a succesful deployment. The PLUMgrid UI will be accessible for the VIP entered in the PLUMgrid Settings
118
+   ::
119
+      https://<PG-VIP>
120
+
121
+   .. image:: images/pg_ui.png
122
+       :width: 80%
123
+
124
+#. As PLUMgrid provides the network backend; all standard neutron operations (create/delete networks, routers etc) can be performed to check the status of the plugin. SSH into any Controller node and run the following:
125
+   ::
126
+
127
+      source /root/openrc
128
+      neutron net-create net1
129
+      neutron router-create router1
130
+
131
+The newly created network and router should be visible in Horizon.
132
+
133
+#. For further details on usability & features, contact PLUMgrid at info@plumgrid.com to obtain official documentation.

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

@@ -0,0 +1,87 @@
1
+Introduction
2
+============
3
+
4
+This document contains instructions for installing and configuring the PLUMgrid plugin for Fuel.
5
+In order to use the PLUMgrid ONS Virtual Network Infrastructure for a Mirantis OpenStack Cloud.
6
+
7
+Key terms, acronyms and abbreviations
8
+-------------------------------------
9
+
10
+Given below are some commonly used terms across this document:
11
+
12
++--------------------+-------------------------------------------------------------------+
13
+| PLUMgrid ONS       | PLUMgrid Open Networking Suite (ONS) is a comprehensive software  |
14
+|                    | suite that provides a virtual network infrastructure based on     |
15
+|                    | IO Visor technology.                                              |
16
++--------------------+-------------------------------------------------------------------+
17
+| VNI                | Virtual Network Infrastructure                                    |
18
++--------------------+-------------------------------------------------------------------+
19
+| Virtual Domain     | A Virtual Domain is a logical data center. It can be created on   |
20
+|                    | demand to provide all the networking services (e.g. Routers,      |
21
+|                    | Switches, IPAM, DHCP, NAT, etc.) necessary to build a vitrual     |
22
+|                    | network for a tenant in OpenStack. Typically, each OpenStack      |
23
+|                    | tenant will map to a unique Virtual Domain in the PLUMgrid.       |
24
++--------------------+-------------------------------------------------------------------+
25
+| Zone               | Represents the physical deployment of PLUMgrid ONS. A Zone is     |
26
+|                    | primarily a collection of Edges & Gateways that are dependent on  |
27
+|                    | the same cluster of Directors in a single physical location. A    |
28
+|                    | data center can have multiple Zones.                              |
29
++--------------------+-------------------------------------------------------------------+
30
+| Director           | The control plane of PLUMgrid ONS. The configuration of the VNI   |
31
+|                    | for tenants is done through the Director. The PLUMgrid Directors  |
32
+|                    | are typically deployed in a cluster of three nodes to provide high|
33
+|                    | availability and scale. Directors are co-located on the OpenStack |
34
+|                    | Controller nodes.                                                 |
35
++--------------------+-------------------------------------------------------------------+
36
+| Edge               | An OpenStack Compute node running PLUMgrid IO Visor as a kernel   |
37
+|                    | module. It provides the data plane and network connectivity for   |
38
+|                    | the VMs of OpenStack tenants. Communication for VMs between Edges |
39
+|                    | is enabled by creating overlay tunnels using VXLAN encapsulation  |
40
++--------------------+-------------------------------------------------------------------+
41
+| Gateway            | Provides connectivity from virtual fabric (VXLAN based) to        |
42
+|                    | external IP networks (such as for internet access). Gateway(s)    |
43
+|                    | can be deployed as a pair in Active/Active mode for load balancing|
44
+|                    | of traffic and high availability of external connectivity.        |
45
++--------------------+-------------------------------------------------------------------+
46
+| LCM                | The Life Cycle Manager is a VM that is used to host the necessary |
47
+|                    | PLUMgrid packages needed to install (or update) a PLUMgrid Zone.  |
48
++--------------------+-------------------------------------------------------------------+
49
+
50
+The figure below depicts how all these components fit in a PLUMgrid Zone.
51
+
52
+    .. image:: images/pg_zone.png
53
+       :width: 80%
54
+
55
+
56
+Overview
57
+--------
58
+
59
+The PLUMgrid plugin for Fuel provides the capability to use PLUMgrid ONS for Mirantis OpenStack as the entire networking backend.
60
+It is configured through the Fuel UI.
61
+
62
+PLUMgrid Open Networking Suite (ONS) is a comprehensive software suite that provides terabits of scale out performance, production
63
+grade resiliency, and secure multi-tenancy for hybrid data centers. Built on PLUMgrid Platform and IO Visor technology, the software
64
+suite lets users create private Virtual Domains to provide isolation, security, and policy enforcement across tenants.
65
+
66
+PLUMgrid ONS features:
67
+
68
+*   Performance: Up to 40 Gbps per server; hardwarde Offload; terbytes of aggregate performance.
69
+
70
+*   Scalable: across virtual domains, workloads and multiple racks, geographies.
71
+
72
+*   Supports both hardware and software gateways in highly available configurations.
73
+
74
+*   Secure: end-to-end encryption within Virtual Domains and isolation across tenants.
75
+
76
+*   Operational tools: includes a comprehensive suite of powerful networking monitoring and troubleshooting tools.
77
+
78
+Licensing information
79
+---------------------
80
+
81
++----------------------+-----------------+
82
+| PLUMgrid ONS         | Commercial      |
83
++----------------------+-----------------+
84
+| Fuel PLUMgrid Plugin | Apache 2.0      |
85
++----------------------+-----------------+
86
+
87
+Contact PLUMgrid for an Installation pack (including Full/Trial License, PLUMgrid Packages, deployment documentation): info@plumgrid.com

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

@@ -0,0 +1,40 @@
1
+Requirements
2
+============
3
+
4
+In addition to the requirements set by a Mirantis 7.0 Installation. The PLUMgrid plugin also has the following requirements
5
+for software and hardware:
6
+
7
+Network Requirements
8
+--------------------
9
+
10
+Nodes within the PLUMgrid Zone are connected using the following two networks:
11
+
12
+#. **Management:** This network is mapped onto the Management network (br-mgmt) deployed within a Mirantis OpenStack Environment.
13
+
14
+#. **Fabric:** This network is mapped directly onto the untagged interface deployed within the Mirantis OpenStack Environment. The fabric network **cannot be bridged or tagged**, it is automatically created by the Fuel PLUMgrid plugin on the interface being used by br-mgmt. The network cidr is specified through the Fuel UI, as explained later. MTU for the entire fabric network is set to 1580 (this is the minimum value for PLUMgrid to work correctly, it will also function for higher values).
15
+
16
+Node Interface Requirements
17
++++++++++++++++++++++++++++
18
+
19
+Physical servers with two network interfaces are used as Controllers, Computes and Gateways. A PLUMgrid-Gateway node must also have an additional 1-2 interfaces for external connectivity (these are specified in the PLUMgrid Settings given in the install section). The interfaces configuration is the following:
20
+
21
+* First interface is used for PXE network
22
+* Second interface is used for Public, Management and Storage networks using tagged VLANs. The PLUMgrid fabric network is also created here automatically.
23
+
24
+  .. image:: images/network_config.png
25
+      :width: 80%
26
+
27
+
28
+PLUMgrid Repository
29
+-------------------
30
+
31
+Access to a url hosting PLUMgrid packages is required before deployment. A common way to obtain this is to use a LCM image and create the LCM VM, which will host the needed packages. This VM then becomes the source repo for installing and upgrading PLUMgrid. The VM can typically be created on the Infrastructure Server hosting the Fuel VM. It needs to be provided with management and fabric connectivity. Contact PLUMgrid to obtain an LCM image with pre-baked PLUMgrid packages and a license [info@plumgrid.com]
32
+
33
+Node Requirements
34
+-----------------
35
+
36
+You must have atleast the following nodes present to set up a minimal deployment:
37
+
38
+* 3 Controllers (or 1 Controller for non-HA deployment)
39
+* 1 Compute
40
+* 1 PLUMgrid-Gateway

Loading…
Cancel
Save