Browse Source

Update fuel plugin repo with Plugin Installation Document

Change-Id: I39fa8c7d2811c5c9290a5d4ab8f1d350d964c321
Co-Authored-By: Chaithanya Kopparthi<chaithanyak@biarca.com>
changes/75/391775/1
Pradip Rawat 2 years ago
parent
commit
cd5a191270

+ 224
- 0
doc/plugin guide/Makefile View File

@@ -0,0 +1,224 @@
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 "  pdf        to make pdf with rst2pdf"
37
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
38
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
39
+	@echo "  text       to make text files"
40
+	@echo "  man        to make manual pages"
41
+	@echo "  texinfo    to make Texinfo files"
42
+	@echo "  info       to make Texinfo files and run them through makeinfo"
43
+	@echo "  gettext    to make PO message catalogs"
44
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
45
+	@echo "  xml        to make Docutils-native XML files"
46
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
47
+	@echo "  linkcheck  to check all external links for integrity"
48
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
49
+	@echo "  coverage   to run coverage check of the documentation (if enabled)"
50
+
51
+.PHONY: clean
52
+clean:
53
+	rm -rf $(BUILDDIR)/*
54
+
55
+.PHONY: html
56
+html:
57
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
58
+	@echo
59
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
60
+
61
+.PHONY: dirhtml
62
+dirhtml:
63
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
64
+	@echo
65
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
66
+
67
+.PHONY: singlehtml
68
+singlehtml:
69
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
70
+	@echo
71
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
72
+
73
+.PHONY: pickle
74
+pickle:
75
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
76
+	@echo
77
+	@echo "Build finished; now you can process the pickle files."
78
+
79
+.PHONY: json
80
+json:
81
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
82
+	@echo
83
+	@echo "Build finished; now you can process the JSON files."
84
+
85
+.PHONY: htmlhelp
86
+htmlhelp:
87
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
88
+	@echo
89
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
90
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
91
+
92
+.PHONY: qthelp
93
+qthelp:
94
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
95
+	@echo
96
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
97
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
98
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/DetachRabbitMQpluginforFuel.qhcp"
99
+	@echo "To view the help file:"
100
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/DetachRabbitMQpluginforFuel.qhc"
101
+
102
+.PHONY: applehelp
103
+applehelp:
104
+	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
105
+	@echo
106
+	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
107
+	@echo "N.B. You won't be able to view it unless you put it in" \
108
+	      "~/Library/Documentation/Help or install it in your application" \
109
+	      "bundle."
110
+
111
+.PHONY: devhelp
112
+devhelp:
113
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
114
+	@echo
115
+	@echo "Build finished."
116
+	@echo "To view the help file:"
117
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/DetachRabbitMQpluginforFuel"
118
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/DetachRabbitMQpluginforFuel"
119
+	@echo "# devhelp"
120
+
121
+.PHONY: epub
122
+epub:
123
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
124
+	@echo
125
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
126
+
127
+.PHONY: latex
128
+latex:
129
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
130
+	@echo
131
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
132
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
133
+	      "(use \`make latexpdf' here to do that automatically)."
134
+
135
+.PHONY: pdf
136
+pdf:
137
+	$(SPHINXBUILD) -b pdf $(ALLSPHINXOPTS) $(BUILDDIR)/pdf
138
+	@echo
139
+	@echo "Build finished. The PDFs are in $(BUILDDIR)/pdf."
140
+
141
+
142
+.PHONY: latexpdf
143
+latexpdf:
144
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
145
+	@echo "Running LaTeX files through pdflatex..."
146
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
147
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
148
+
149
+.PHONY: latexpdfja
150
+latexpdfja:
151
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
152
+	@echo "Running LaTeX files through platex and dvipdfmx..."
153
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
154
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
155
+
156
+.PHONY: text
157
+text:
158
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
159
+	@echo
160
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
161
+
162
+.PHONY: man
163
+man:
164
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
165
+	@echo
166
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
167
+
168
+.PHONY: texinfo
169
+texinfo:
170
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
171
+	@echo
172
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
173
+	@echo "Run \`make' in that directory to run these through makeinfo" \
174
+	      "(use \`make info' here to do that automatically)."
175
+
176
+.PHONY: info
177
+info:
178
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
179
+	@echo "Running Texinfo files through makeinfo..."
180
+	make -C $(BUILDDIR)/texinfo info
181
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
182
+
183
+.PHONY: gettext
184
+gettext:
185
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
186
+	@echo
187
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
188
+
189
+.PHONY: changes
190
+changes:
191
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
192
+	@echo
193
+	@echo "The overview file is in $(BUILDDIR)/changes."
194
+
195
+.PHONY: linkcheck
196
+linkcheck:
197
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
198
+	@echo
199
+	@echo "Link check complete; look for any errors in the above output " \
200
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
201
+
202
+.PHONY: doctest
203
+doctest:
204
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
205
+	@echo "Testing of doctests in the sources finished, look at the " \
206
+	      "results in $(BUILDDIR)/doctest/output.txt."
207
+
208
+.PHONY: coverage
209
+coverage:
210
+	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
211
+	@echo "Testing of coverage in the sources finished, look at the " \
212
+	      "results in $(BUILDDIR)/coverage/python.txt."
213
+
214
+.PHONY: xml
215
+xml:
216
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
217
+	@echo
218
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
219
+
220
+.PHONY: pseudoxml
221
+pseudoxml:
222
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
223
+	@echo
224
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

+ 263
- 0
doc/plugin guide/source/conf.py View File

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

+ 12
- 0
doc/plugin guide/source/configure.rst View File

@@ -0,0 +1,12 @@
1
+.. _pg-configure:
2
+
3
+Configure Kaiminario Cinder Plugin
4
+==================================
5
+
6
+Configuring the Kaminario plugin. 
7
+
8
+**To configure  Kaiminario Cinder Plugin:**
9
+
10
+#. Create an OpenStack environment as described in the `Fuel User Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/create-environment.html>`_:
11
+
12
+#. Configure Kaminario K2 All Flash arrays

+ 29
- 0
doc/plugin guide/source/description.rst View File

@@ -0,0 +1,29 @@
1
+.. _overview:
2
+
3
+Overview of the Kaminario Cinder plugin
4
+=======================================
5
+
6
+The Kaminario cinder fuel plugin helps in configuring Kaminario iSCSI and FC cinder drivers for Kaminario K2 All-Flash arrays in Mirantis Fuel OpenStack setup.It allows to configure and scale multiple Kaminario backends.It installs the “krest” python library on cinder-volume node which is prerequisite for Kaminario iSCSI and FC cinder drivers.It allows to configure various cinder and Kaminario specific option.
7
+
8
+Software prerequisites 
9
+----------------------
10
+
11
+To use the Kaminario Cinder plugin, verify that your environment meets the following prerequisites:
12
+
13
+============================  ======================================
14
+Prerequisites                 Version/Comment
15
+============================  ======================================
16
+Fuel                          9.0
17
+Kaminario K2 All Flash Array  K2 rest api version should be >= 2.2.0
18
+============================  ======================================
19
+
20
+
21
+* The Kaminario K2 All-Flash array should be configured with data and management path to the cinder volume nodes and data path to the nova compute nodes.
22
+
23
+* For replication, replication peer should be configured
24
+
25
+Limitations
26
+-----------
27
+
28
+No limitaitions
29
+

BIN
doc/plugin guide/source/images/basic_options.png View File


BIN
doc/plugin guide/source/images/create_volume_type.png View File


BIN
doc/plugin guide/source/images/new_backend.png View File


BIN
doc/plugin guide/source/images/new_openstack_environment.png View File


BIN
doc/plugin guide/source/images/openstack_settings.png View File


BIN
doc/plugin guide/source/images/options.png View File


BIN
doc/plugin guide/source/images/replication.png View File


+ 19
- 0
doc/plugin guide/source/index.rst View File

@@ -0,0 +1,19 @@
1
+
2
+.. <PLUGIN NAME> plugin for Fuel documentation master file, created by
3
+   sphinx-quickstart on Wed Feb 17 20:38:48 2016.
4
+   You can adapt this file completely to your liking, but it should at least
5
+   contain the root `toctree` directive.
6
+
7
+Guide to the <PLUGIN NAME> plugin ver. <6-digit format>
8
+=======================================================
9
+
10
+Contents:
11
+
12
+.. toctree::
13
+   :maxdepth: 2
14
+
15
+   description
16
+   installation
17
+   plugin_configuration
18
+   guide
19
+

+ 37
- 0
doc/plugin guide/source/installation.rst View File

@@ -0,0 +1,37 @@
1
+
2
+
3
+Install Kaminario Cinder Plugin
4
+===============================
5
+
6
+Before you install Kaminario Cinder Plugin. You must have the Fuel Master node installed and configured before you can install the plugin. Typically, you install a Fuel plugin before you deploy an OpenStack environment.   
7
+
8
+**To install Kaminario Cinder Plugin:**
9
+
10
+#. Download  from the `Fuel Plugins Catalog`_.
11
+
12
+#. Copy the plugin ``.rpm`` package to the Fuel Master node:
13
+
14
+   **Example:**
15
+   
16
+   .. code-block:: console
17
+
18
+      # scp cinder_kaminario-1.0-1.0.0-1.noarch.rpm root@fuel-master:/tmp
19
+
20
+#. Log into Fuel Master node CLI as root.
21
+#. Install the plugin by typing:
22
+
23
+   .. code-block:: console
24
+   
25
+      # fuel plugins --install cinder_kaminario-1.0-1.0.0-1.noarch.rpm
26
+
27
+#. Verify that the plugin is installed correctly:
28
+
29
+   .. code-block:: console
30
+   
31
+     # fuel plugins
32
+     id | name                                           | version | package_version
33
+     ---|------------------------------------------------|---------|----------------
34
+     1  | cinder_kaminario-1.0-1.0.0-1.noarch.rpm        | 1.0.0   | 4.0.0
35
+
36
+
37
+.. _Fuel Plugins Catalog: https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins/

+ 94
- 0
doc/plugin guide/source/plugin_configuration.rst View File

@@ -0,0 +1,94 @@
1
+
2
+Plugin configuration
3
+--------------------
4
+
5
+**To configure Kaminario Cinder plugin:**
6
+
7
+* create environment in Fuel web UI by enabling kaminario option which is in Storage Backends tab.
8
+
9
+   .. image:: ./images/new_openstack_environment.png
10
+      :width: 400pt
11
+      :alt: New Openstack Environment
12
+   
13
+
14
+* To configure the plugin go to settings tab and click on storage tab. 
15
+
16
+   .. image:: ./images/openstack_settings.png
17
+      :width: 400pt
18
+      :alt: OpenStack Settings
19
+
20
+* Following  are the basic options to configure the Kaminario Cinder Fuel Plugin 
21
+
22
+   .. image:: ./images/basic_options.png
23
+      :width: 400pt
24
+      :alt: Basic Settings
25
+
26
+*Storage Protocol*: Select ‘ISCSI‘ for Kaminario K2 All-Flash iSCSI array and ‘FC‘ forKaminario K2 All-Flash FC array
27
+
28
+*Cinder Node*: Specify the name of the cinder node to configure Kaminario backend
29
+
30
+*Kaminario storage IP*: Management IP for the Kaminario K2 All-Flash array
31
+
32
+*Backend Name*: Specify the name for the Kaminario backend
33
+
34
+*Username*: Specify the username for the Kaminario K2 All-Flash array
35
+
36
+*Password*: Specify the corresponding password for the user
37
+
38
+* To add details of replication peer, check ‘Enable Replication‘ box and fill the following details
39
+
40
+   .. image:: ./images/replication.png
41
+      :width: 400pt
42
+      :alt: Replication
43
+
44
+*IP address*: Specify the IP address for the replication peer
45
+
46
+*Username*: Specify the username for the replication peer
47
+
48
+*Password*: Specify the corresponding password for the user
49
+
50
+*RPO*: Specify RPO value for replication, it should either 60 sec or multiples of 300 secs.
51
+
52
+* To create a volume type check the ‘Create Volume Type‘ box and fill the following details
53
+
54
+   .. image:: ./images/create_volume_type.png
55
+      :width: 400pt
56
+      :alt: Create volume type
57
+
58
+*Volume Type Name*: Specify a name for the volume type
59
+
60
+*Advanced options*: To enable advanced functionalities like replication and nodedup check any one of three options
61
+
62
+   .. image:: ./images/options.png
63
+      :width: 400pt
64
+      :alt: Options
65
+
66
+*Default Type*: Check If the above-created volume type should be default volume type
67
+
68
+*Enable Multipath*: Check this box in order to use multipath in cinder and nova
69
+
70
+*Suppress logs*: Check this box in order to suppress python ‘requests‘ library warnings.
71
+
72
+*Filter function*: Specify Filter function(optional)
73
+
74
+*goodness function*: Specify goodness function(optional)
75
+
76
+*Oversubscription Ratio*: If this is checked kaminario driver will calculate dynamically "max_over_subscription_ratio".
77
+
78
+*Scheduler filters*: In order to enable scheduler filters explicitly, specify filter name separated by comma
79
+
80
+*Scheduler weighers*: In order to enable scheduler weigher explicitly, specify weigher name separated by comma
81
+
82
+*RPC Timeout*: Specify the rpc timeout, the default timeout is 60 sec
83
+
84
+   .. image:: ./images/new_backend.png
85
+      :width: 400pt
86
+      :alt: New backend
87
+
88
+Check this option to add a new ‘Kaminario K2 All-Flash array‘ as a new backend or to scale the existing backend.
89
+
90
+* Specify new ‘volume_backend_name‘ to add a new backend 
91
+
92
+* Use same ‘volume_backend_name‘ if scale an existing backend. This plugin supports the addition of 5 extra backends.
93
+
94
+This plugin is hot pluggable.One can deploy it again without disturbing the existing backends or existing setup.

Loading…
Cancel
Save