Merge "User Guide"

This commit is contained in:
Jenkins 2016-09-30 14:11:17 +00:00 committed by Gerrit Code Review
commit 77f2d77db4
17 changed files with 873 additions and 0 deletions

3
.gitignore vendored
View File

@ -30,3 +30,6 @@ local_settings.py
# Logs
sys_test.log
# Documentation build files
doc/user_guide/_build

225
doc/user_guide/Makefile Normal file
View File

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

View File

@ -0,0 +1,14 @@
Useful links
------------
Information about Mistral Fuel plugin:
* `Specification <https://github.com/openstack/fuel-plugin-mistral/blob/master/specs/spec.rst>`_
* `GitHub project <https://github.com/openstack/fuel-plugin-mistral>`_
* `Launchpad project <https://launchpad.net/fuel-plugin-mistral>`_
Information about OpenStack Mistral:
* `Mistral documentation <http://docs.openstack.org/developer/mistral/>`_
* `Launchpad project <https://launchpad.net/mistral>`_
* `GitHub project <https://github.com/openstack/mistral>`_

324
doc/user_guide/conf.py Normal file
View File

@ -0,0 +1,324 @@
# -*- 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.
# "<project> v<release> 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 <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
# 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 = {
'classoptions': ',openany,oneside', 'babel': '\\usepackage[english]{babel}'
}
# 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 Guide',
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

Binary file not shown.

After

Width:  |  Height:  |  Size: 69 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 87 KiB

34
doc/user_guide/index.rst Normal file
View File

@ -0,0 +1,34 @@
Mistral Fuel Plugin's User Guide
===============================================
Overview
~~~~~~~~~
.. toctree::
:maxdepth: 2
intro
requirements
prerequisites
limitations
release_notes
license
appendix
Installation and Usage
~~~~~~~~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 2
install
use
Troubleshooting
~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 2
troubleshoot

View File

@ -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 <https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins/>`__.
#. 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 <Fuel Master nodeip>:/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.

27
doc/user_guide/intro.rst Normal file
View File

@ -0,0 +1,27 @@
Introduction
------------
The purpose of this document is to describe how to install, configure, and use
Mistral Fuel plugin 1.0.0 for Fuel 9.0.
The plugin allows Fuel to deploy OpenStack with
Mistral installed and configured.
Key terms
--------
The table below lists the key terms, acronyms, and abbreviations that
are used in this document.
.. tabularcolumns:: |p{4cm}|p{12.5cm}|
====================== ========================================================
**Term/abbreviation** **Definition**
====================== ========================================================
Mistral `OpenStack workflow service <https://github.com/openstack/mistral>`__
Workflow `Set of tasks and relations between them <http://docs.openstack.org/developer/mistral/dsl/dsl_v2.html#workflows>`__. Mistral term.
====================== ========================================================
.. raw:: latex
\pagebreak

View File

@ -0,0 +1,9 @@
Licenses
--------
===================================== ============
**Component** **License**
===================================== ============
Mistral Fuel plugin Apache 2.0
Mistral Apache 2.0
===================================== ============

View File

@ -0,0 +1,4 @@
Limitations
===========
Current 1.0.0 version of Fuel Mistral Plugin has no known limitations.

17
doc/user_guide/make_pdf.sh Executable file
View File

@ -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 ''

View File

@ -0,0 +1,6 @@
.. _prerequisites:
Prerequisites
-------------
Before you install and start using Mistral Fuel plugin install and set up `Fuel 9.0 <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide.html>`__.

View File

@ -0,0 +1,6 @@
Release notes
-------------
Mistral Fuel plugin 1.0.0 provides:
* A possibility to deploy Mistral by Fuel.

View File

@ -0,0 +1,10 @@
Requirements
------------
Mistral Fuel plugin 1.0.0 has the following requirements:
* Fuel 9.0 with Mitaka support
Check `Planning Guide <https://docs.mirantis.com/openstack/fuel/fuel-9.0/mos-planning-guide.html>`__
and `Planning hardware for your OpenStack cluster: the answers to your questions <https://www.mirantis.com/blog/planning-hardware-for-your-openstack-cluster-the-answers-to-your-questions/>`__
for additional requirements to consider.

View File

@ -0,0 +1,51 @@
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
+----...---+------...-+-----...+--------+------...--+----...+----...+
| ID ... | Name ... | Proj...| Tags | Input... | Cre...| Upd...|
+----...---+------...-+-----...+--------+------...--+----...+----...+
| 9e2...bc | std.d... | <def...| <none> | insta...n | 201...| Non...|
| a80...63 | std.c... | <def...| <none> | name,... | 201...| Non...|
+----...---+------...-+-----...+--------+------...--+----...+----...+

100
doc/user_guide/use.rst Normal file
View File

@ -0,0 +1,100 @@
Considering HA
--------------
Mistral API service runs on every `Controller` node. Mistral API service HA
is reached if multiple `Controller` nodes are deployed in the environment.
Calls to Mistral API service instances are balanced via HAProxy.
Mistral Engine and Executor services run on `Mistral` nodes. Every Mistral node
runs one Mistral Engine instance and one Mistral Executor instance.
The services HA is reached by deploying multiple `Mistral` nodes.
.. _new_env:
Creating new environment with Mistral Fuel plugin
-------------------------------------------------
To create and configure a new environment with Mistral Fuel plugin
follow the steps below:
#. `Create a new OpenStack environment <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide.html>`__
in Fuel web UI.
#. Enable the Mistral Fuel plugin in `Additional services` tab:
.. image:: images/plugin.png
#. `Add nodes and assign them roles: <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/configure-environment/add-nodes.html>`__
* At least 1 Controller
* At least 1 Mistral node. The Mistral role can also be added to any other
node except Compute
#. Make additional `configuration adjustments <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/configure-environment.html>`__.
#. Proceed to the `environment deployment <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/deploy-environment.html>`__.
.. _hotplug:
Enabling Mistral 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: <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/configure-environment/add-nodes.html>`__
* At least 1 Mistral node. The Mistral role can also be added to any other
node except Compute
#. Proceed to the `environment deployment <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/deploy-environment.html>`__.
Getting `Mistral` service credentials
-------------------------------------
To call Mistral API `admin` Keystone user credentials can be used.
Mistral service also has it's own Keystone user.
The user name is `mistral`.
To get Keystone endpoint and `mistral` Keystone user password login
to the primary `Controller` node after the environment has been deployed
and run:
.. code-block:: console
# source openrc
# openstack endpoint show mistral
+--------------+-----------------------------------+
| Field | Value |
+--------------+-----------------------------------+
| adminurl | http://10.109.1.8:8989/v2 |
| enabled | True |
| id | 3023eac53843471fa70c96c081008daf |
| internalurl | http://10.109.1.8:8989/v2 |
| publicurl | https://public.fuel.local:8989/v2 |
| region | RegionOne |
| service_id | e136f06aab484b6e8a513604f72eb284 |
| service_name | mistral |
| service_type | workflowv2 |
+--------------+-----------------------------------+
# hiera -h fuel-plugin-mistral
{"db_password"=>"db_password",
"keystone_password"=>"mistral_user_keystone_password", <-- the password
"metadata"=>
{"class"=>"plugin",
"enabled"=>true,
"group"=>"other",
"hot_pluggable"=>true,
"label"=>"Fuel Mistral plugin",
"plugin_id"=>5,
"plugin_version"=>"1.0.0",
"toggleable"=>true,
"weight"=>70}}