diff --git a/.gitignore b/.gitignore index 0abef89..e070707 100644 --- a/.gitignore +++ b/.gitignore @@ -30,3 +30,6 @@ local_settings.py # Logs sys_test.log + +# Documentation build files +doc/user_guide/_build diff --git a/doc/user_guide/Makefile b/doc/user_guide/Makefile new file mode 100644 index 0000000..55297ea --- /dev/null +++ b/doc/user_guide/Makefile @@ -0,0 +1,225 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# 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 +help: + @echo "Please use \`make ' where 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 " applehelp to make an Apple Help Book" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " epub3 to make an epub3" + @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)" + @echo " coverage to run coverage check of the documentation (if enabled)" + @echo " dummy to check syntax errors of document sources" + +.PHONY: clean +clean: + rm -rf $(BUILDDIR)/* + +.PHONY: html +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +.PHONY: dirhtml +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +.PHONY: singlehtml +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +.PHONY: pickle +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +.PHONY: json +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +.PHONY: htmlhelp +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." + +.PHONY: qthelp +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/MistralFuelPlugin.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/MistralFuelPlugin.qhc" + +.PHONY: applehelp +applehelp: + $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp + @echo + @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." + @echo "N.B. You won't be able to view it unless you put it in" \ + "~/Library/Documentation/Help or install it in your application" \ + "bundle." + +.PHONY: devhelp +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/MistralFuelPlugin" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/MistralFuelPlugin" + @echo "# devhelp" + +.PHONY: epub +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +.PHONY: epub3 +epub3: + $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3 + @echo + @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3." + +.PHONY: latex +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)." + +.PHONY: latexpdf +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." + +.PHONY: latexpdfja +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." + +.PHONY: text +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +.PHONY: man +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +.PHONY: texinfo +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)." + +.PHONY: info +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." + +.PHONY: gettext +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +.PHONY: changes +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +.PHONY: linkcheck +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." + +.PHONY: doctest +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +.PHONY: coverage +coverage: + $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage + @echo "Testing of coverage in the sources finished, look at the " \ + "results in $(BUILDDIR)/coverage/python.txt." + +.PHONY: xml +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +.PHONY: pseudoxml +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." + +.PHONY: dummy +dummy: + $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy + @echo + @echo "Build finished. Dummy builder generates no files." diff --git a/doc/user_guide/appendix.rst b/doc/user_guide/appendix.rst new file mode 100644 index 0000000..7aabec3 --- /dev/null +++ b/doc/user_guide/appendix.rst @@ -0,0 +1,14 @@ +Useful links +------------ + +Information about Mistral Fuel plugin: + +* `Specification `_ +* `GitHub project `_ +* `Launchpad project `_ + +Information about Openstack Mistral: + +* `Mistral documentation `_ +* `Launchpad project `_ +* `Github project `_ diff --git a/doc/user_guide/conf.py b/doc/user_guide/conf.py new file mode 100644 index 0000000..08c88ea --- /dev/null +++ b/doc/user_guide/conf.py @@ -0,0 +1,338 @@ +# -*- coding: utf-8 -*- +# +# Mistral Fuel Plugin documentation build configuration file, created by +# sphinx-quickstart on Tue Sep 27 11:58:25 2016. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# 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. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +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'Mistral Fuel Plugin' +copyright = u'2016, Mirantis Inc.' +author = u'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 = u'1.0.0' +# The full version, including alpha/beta/rc tags. +release = u'1.0-1.0.0-0' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +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. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# 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 + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = 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 = 'alabaster' + +# 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. +# " v documentation" by default. +# +# html_title = u'Mistral Fuel Plugin v1.0-1.0.0-0' + +# 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 (relative to this directory) to use as a 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 None, a 'Last updated on:' timestamp is inserted at every page +# bottom, using the given strftime format. +# The empty string is equivalent to '%b %d, %Y'. +# +# html_last_updated_fmt = None + +# 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 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 + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh' +# +# html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# 'ja' uses this config value. +# 'zh' user can custom change `jieba` dictionary path. +# +# html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +# +# html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'MistralFuelPlugindoc' + +# -- 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': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# 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 = [ + (master_doc, 'MistralFuelPlugin.tex', u'Mistral Fuel Plugin Documentation', + u'Mirantis Inc.', '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 = [] + +# It false, will not define \strong, \code, itleref, \crossref ... but only +# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added +# packages. +# +# latex_keep_old_macro_names = True + +# 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 = [ + (master_doc, 'mistralfuelplugin', u'Mistral Fuel Plugin Documentation', + [author], 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 = [ + (master_doc, 'MistralFuelPlugin', u'Mistral Fuel Plugin Documentation', + author, 'MistralFuelPlugin', '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 diff --git a/doc/user_guide/images/enable.png b/doc/user_guide/images/enable.png new file mode 100644 index 0000000..666c1b2 Binary files /dev/null and b/doc/user_guide/images/enable.png differ diff --git a/doc/user_guide/images/plugin.png b/doc/user_guide/images/plugin.png new file mode 100644 index 0000000..7df8d8b Binary files /dev/null and b/doc/user_guide/images/plugin.png differ diff --git a/doc/user_guide/index.rst b/doc/user_guide/index.rst new file mode 100644 index 0000000..5929f4d --- /dev/null +++ b/doc/user_guide/index.rst @@ -0,0 +1,32 @@ +Mistral Fuel Plugin's User Guide +=============================================== + +Overview +~~~~~~~~~ + +.. toctree:: + :maxdepth: 2 + + intro + requirements + limitations + license + appendix + +Installation and Usage +~~~~~~~~~~~~~~~~~~~~~~ + +.. toctree:: + :maxdepth: 2 + + install + use + +Troubleshoting +~~~~~~~~~~~~~~ + +.. toctree:: + :maxdepth: 2 + + troubleshoot + diff --git a/doc/user_guide/install.rst b/doc/user_guide/install.rst new file mode 100644 index 0000000..8ebbf84 --- /dev/null +++ b/doc/user_guide/install.rst @@ -0,0 +1,43 @@ +.. _install: + +Install Mistral Fuel plugin +--------------------------- + +Before you proceed with Mistral Fuel plugin installation, please verify next: + +#. You have completed steps from :ref:`prerequisites` section. + +#. All the nodes of your future environment are *DISCOVERED* + by the Fuel Master node if :ref:`new_env`. + At least one node is *DISCOVERED* if :ref:`hotplug`. + +**To install the Mistral plugin:** + +#. Download Mistral Fuel plugin from the + `Fuel Plugin Catalog `__. + +#. Copy the plugin ``.rpm`` package to the Fuel Master node: + + .. code-block:: console + + $ scp fuel-plugin-mistral-1.0-1.0.0-1.noarch.rpm :/tmp + +#. Log in to the Fuel Master node CLI as root. + +#. Install the plugin: + + .. code-block:: console + + # fuel plugins --install /tmp/fuel-plugin-mistral-1.0-1.0.0-1.noarch.rpm + +#. Verify that the plugin was installed successfully: + + .. code-block:: console + + # fuel plugins + + id | name | version | package_version | releases + ---+---------------------+---------+-----------------+-------------------- + 5 | fuel-plugin-mistral | 1.0.0 | 4.0.0 | ubuntu (mitaka-9.0) + +#. Proceed to :ref:`new_env` or :ref:`hotplug` section. diff --git a/doc/user_guide/intro.rst b/doc/user_guide/intro.rst new file mode 100644 index 0000000..d7ea932 --- /dev/null +++ b/doc/user_guide/intro.rst @@ -0,0 +1,32 @@ +Introduction +------------ + +The following documentation contains instructions for installation and usage of Mistral plugin for Fuel + ++-------------------------------------------------------------------------------------------------+ +|**Key terms, acronyms and abbreviations** | ++---------------------+---------------------------------------------------------------------------+ +|Workflow |Series of activities that are necessary to complete a task | ++---------------------+---------------------------------------------------------------------------+ +|Mistral |Cloud workflow service | ++---------------------+---------------------------------------------------------------------------+ + +Overview +-------- + +Mistral plugin for Fuel adds a Workflow Service to Mirantis OpenStack, as a a mechanism to execute +tasks and workflows without writing code. + +**Use Cases** + ++---------------------+---------------------------------------------------------------------------+ +|Cloud Cron: cloud administrator can schedule cloud tasks for periodical execution | ++---------------------+---------------------------------------------------------------------------+ +|Cloud Environment Deployment: Create Mistral workflow resource using Heat | ++---------------------+---------------------------------------------------------------------------+ +|Live Migration: run specific migration workflows | ++-------------------------------------------------------------------------------------------------+ +|Long-term Business Processes | ++-------------------------------------------------------------------------------------------------+ +| Big Data Analysis & Reporting | ++-------------------------------------------------------------------------------------------------+ diff --git a/doc/user_guide/license.rst b/doc/user_guide/license.rst new file mode 100644 index 0000000..0ec5e4e --- /dev/null +++ b/doc/user_guide/license.rst @@ -0,0 +1,10 @@ +Licenses +-------- + +===================================== ============ +**Component** **License** +===================================== ============ +Mistral Fuel plugin Apache 2.0 +Mistral Apache 2.0 +python-ironc-inspector-client Apache 2.0 +===================================== ============ diff --git a/doc/user_guide/limitations.rst b/doc/user_guide/limitations.rst new file mode 100644 index 0000000..94fbcfb --- /dev/null +++ b/doc/user_guide/limitations.rst @@ -0,0 +1,4 @@ +Limitations +=========== + +Current 1.0.0 verion of Fuel Mistral Plugin has no known limitations, however no thorough testing was conducted yet. diff --git a/doc/user_guide/make_pdf.sh b/doc/user_guide/make_pdf.sh new file mode 100755 index 0000000..7da8430 --- /dev/null +++ b/doc/user_guide/make_pdf.sh @@ -0,0 +1,17 @@ +#!/bin/bash + +lsb_release -a 2>/dev/null | grep 'Distributor ID:' | grep -q Ubuntu || \ + { echo 'Not an Ubuntu'; exit 1; } + +apt-cache policy texlive-latex-extra | grep 'Installed:' | grep -q '(none)' && \ + { echo 'Please install texlive-latex-extra package'; exit 1; } + +rm -rf _build + +make latexpdf + +echo -e -n '\nCreated pdf : ' + +find _build/ | grep -e '.*\.pdf' + +echo '' diff --git a/doc/user_guide/requirements.rst b/doc/user_guide/requirements.rst new file mode 100644 index 0000000..8bc0263 --- /dev/null +++ b/doc/user_guide/requirements.rst @@ -0,0 +1,10 @@ +Requirements +------------ + +Mistral Fuel plugin 1.0.0 has the following requirements: + +* Fuel 9.0 with Mitaka support + +Check `Planning Guide `__ +and `Planning hardware for your OpenStack cluster: the answers to your questions `__ +for additional requirements to consider. diff --git a/doc/user_guide/troubleshoot.rst b/doc/user_guide/troubleshoot.rst new file mode 100644 index 0000000..b2d092e --- /dev/null +++ b/doc/user_guide/troubleshoot.rst @@ -0,0 +1,47 @@ +Troubleshooting +--------------- + +This section contains a guidance on verifying and troubleshooting Mistral Fuel +Plugin and Mistral deployed by the plugin. + +*Mistral* role is not available +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If *Mistral* role is not available in Fuel UI when adding new node verify the +plugin is installed and enabled. To verify in Fuel UI navigate to +`Settings` tab -> `Other` section + + .. image:: images/enable.png + +The plugin must be present and enabled. +If not present check :ref:`install`. + +Mistral configuration files and logs +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Mistral API service runs on Controller nodes. +Mistral Executor and Engine services run on Mistral nodes. + +Mistral configuration files are located in `/etc/mistral` on Controller and +Mistral nodes. `/etc/mistral/mistral.conf` is the main configuration file. + +Logs can be found in `/var/log/mistral` directory. + +Verifying Mistral operation +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +#. Login to primary Contraller node + +#. Source .openrc + + .. code-block:: console + + # source .openrc + +#. Verify Mistral + + .. code-block:: console + + # openstack workflow list + + # openstack workflow execution create XXX diff --git a/doc/user_guide/use.rst b/doc/user_guide/use.rst new file mode 100644 index 0000000..ecf8a43 --- /dev/null +++ b/doc/user_guide/use.rst @@ -0,0 +1,48 @@ +.. _new_env: + +Creating new environment with Misral Fuel plugin +------------------------------------------------ + +To create and configure a new environment with Mistral Fuel plugin +follow the steps below: + +#. `Create a new OpenStack environment `__ + in Fuel web UI. + +#. Enable the Google Cloud Storage Fuel plugin in `Additional services` tab: + + .. image:: images/plugin.png + +#. `Add nodes and assign them roles: `__ + + * At least 1 Controller + * Desired number of Compute nodes + * At least 1 Cinder node. The Cinder role can also be added to Compute or + Controller node + * At least 1 Mistral node. The Mistral role can also be added to any other + node except Compute + +#. Make additional `configuration adjustments `__. + +#. Proceed to the `environment deployment `__. + +.. _hotplug: + +Enabling Misral Fuel plugin for a deployed environment +------------------------------------------------------ + +Mistral Fuel plugin is hotpluggable and can be enabled for an already deployed +environment. The enable the plugin follow the steps below: + +#. Navigate to the `Settings` tab -> `Other` section and enable the plugin + + .. image:: images/enable.png + +#. Press `Save Settings` button. + +#. `Add Mistral node: `__ + + * At least 1 Mistral node. The Mistral role can also be added to any other + node except Compute + +#. Proceed to the `environment deployment `__.