Workflow Service for OpenStack.
Go to file
Jenkins 7dafe4488b Merge "Set the basepython for the venv tox environment" 2017-04-14 05:19:16 +00:00
api-ref/source Initial commit for mistral api-ref 2017-01-11 18:19:39 +05:30
devstack Copy _50_mistral.py file from enabled folder 2016-12-22 15:57:22 +08:00
doc Merge "Add documentation for the engine commands" 2017-04-13 14:00:22 +00:00
etc Role based resource access control - get workflows 2016-12-22 14:12:33 +13:00
functionaltests Some minor code optimization in post_test_hook.sh 2016-08-25 08:25:08 +00:00
mistral Fix a description of 'executor_thread_pool_size' option in Kombu RPC 2017-04-12 20:11:45 +07:00
mistral_tempest_tests Merge "Fix gate failure" 2017-04-10 09:57:42 +00:00
rally-jobs Refactor 'stress_test' to fit the current layout better 2016-12-22 18:38:17 +07:00
releasenotes Merge "Add Apache License Content in index.rst" 2017-04-12 07:53:40 +00:00
tools Fix cinder/heat base import 2017-03-21 23:15:35 +13:00
.coveragerc Exclude .tox folder from coverage report 2016-12-19 03:33:29 +00:00
.gitignore Initial commit for mistral api-ref 2017-01-11 18:19:39 +05:30
.gitreview Update .gitreview file for project rename 2015-06-12 23:12:30 +00:00
.testr.conf Allow users to set the test run concurrency 2017-03-07 15:02:10 +00:00
CONTRIBUTING.rst Improve the CONTRIBUTING.rst 2017-03-06 10:33:54 +00:00
HACKING.rst Add hacking for code style checks 2017-03-16 07:38:09 +00:00
LICENSE Adding license and authors file 2013-12-30 13:11:49 +07:00
README.rst Changed the README.rst and added debug guide 2017-04-12 10:32:28 +00:00
docker_image_build.sh Fixes the Mistral Docker image 2016-05-27 13:26:05 +02:00
requirements.txt Updated from global requirements 2017-04-12 04:13:58 +00:00
run_functional_tests.sh Removed mistral/tests/functional 2016-01-29 11:04:03 +09:00
run_tests.sh Removal of unneccessary directory in run_tests.sh 2016-10-20 16:03:39 +05:30
setup.cfg Add a Mistral lexer for pygments 2017-04-05 10:17:58 +01:00
setup.py Updated from global requirements 2017-03-03 10:17:44 +00:00
test-requirements.txt Add check for idempotent id in tempest tests 2017-04-03 09:42:16 +00:00
tox.ini Set the basepython for the venv tox environment 2017-04-11 16:11:39 +01:00

README.rst

Team and repository tags

image

Mistral

Workflow Service for OpenStack cloud. This project aims to provide a mechanism to define tasks and workflows without writing code, manage and execute them in the cloud environment.

Installation

The following are the steps to install Mistral on debian-based systems.

To install Mistral, you have to install the following prerequisites:

$ apt-get install python-dev python-setuptools libffi-dev libxslt1-dev libxml2-dev libyaml-dev libssl-dev

Mistral can be used without authentication at all or it can work with OpenStack.

In case of OpenStack, it works only with Keystone v3, make sure Keystone v3 is installed.

Install Mistral

First of all, clone the repo and go to the repo directory:

$ git clone https://git.openstack.org/openstack/mistral.git
$ cd mistral

Devstack installation

Information about how to install Mistral with devstack can be found here.

Configuring Mistral

Mistral configuration is needed for getting it work correctly with and without an OpenStack environment.

  1. Install and configure a database which can be MySQL or PostgreSQL (SQLite can't be used in production.). Here are the steps to connect Mistral to a MySQL database.

    • Make sure you have installed mysql-server package on your Mistral machine.

    • Install MySQL driver for python:

      $ pip install mysql-python

      or, if you work in virtualenv, run:

      $ tox -evenv -- pip install mysql-python

      NOTE: If you're using Python 3 then you need to install mysqlclient instead of mysql-python.

    • Create the database and grant privileges:

      $ mysql -u root -p

      CREATE DATABASE mistral; USE mistral GRANT ALL ON mistral.* TO 'root'@'localhost';

  2. Generate mistral.conf file:

    $ oslo-config-generator \
      --config-file tools/config/config-generator.mistral.conf \
      --output-file etc/mistral.conf.sample
  3. Copy service configuration files:

    $ sudo mkdir /etc/mistral
    $ sudo chown `whoami` /etc/mistral
    $ cp etc/event_definitionas.yml.sample /etc/mistral/event_definitions.yml
    $ cp etc/logging.conf.sample /etc/mistral/logging.conf
    $ cp etc/policy.json /etc/mistral/policy.json
    $ cp etc/wf_trace_logging.conf.sample /etc/mistral/wf_trace_logging.conf
    $ cp etc/mistral.conf.sample /etc/mistral/mistral.conf
  4. Edit file /etc/mistral/mistral.conf according to your setup. Pay attention to the following sections and options:

    [oslo_messaging_rabbit]
    rabbit_host = <RABBIT_HOST>
    rabbit_userid = <RABBIT_USERID>
    rabbit_password = <RABBIT_PASSWORD>
    
    [database]
    # Use the following line if *PostgreSQL* is used
    # connection = postgresql://<DB_USER>:<DB_PASSWORD>@localhost:5432/mistral
    connection = mysql://<DB_USER>:<DB_PASSWORD>@localhost:3306/mistral
  5. If you are not using OpenStack, add the following entry to the /etc/mistral/mistral.conf file and skip the following steps:

    [pecan]
    auth_enable = False
  6. Provide valid keystone auth properties:

    [keystone_authtoken]
    auth_uri = http://<Keystone-host>/identity_v2_admin/v3
    identity_uri = http://<Keystone-host/identity_v2_admin
    auth_version = v3
    admin_user = <user>
    admin_password = <password>
    admin_tenant_name = <tenant>
  7. Register Mistral service and Mistral endpoints on Keystone:

    $ MISTRAL_URL="http://[host]:[port]/v2"
    $ openstack service create --name mistral workflowv2
    $ openstack endpoint create mistral public $MISTRAL_URL
    $ openstack endpoint create mistral internal $MISTRAL_URL
    $ openstack endpoint create mistral admin $MISTRAL_URL
  8. Update the mistral/actions/openstack/mapping.json file which contains all available OpenStack actions, according to the specific client versions of OpenStack projects in your deployment. Please find more detailed information in the tools/get_action_list.py script.

Before the First Run

After local installation you will find the commands mistral-server and mistral-db-manage available in your environment. The mistral-db-manage command can be used for migrating database schema versions. If Mistral is not installed in system then this script can be found at mistral/db/sqlalchemy/migration/cli.py, it can be executed using Python command line.

To update the database schema to the latest revision, type:

$ mistral-db-manage --config-file <path_to_config> upgrade head
To populate the database with standard actions and workflows, type::

$ mistral-db-manage --config-file <path_to_config> populate

For more detailed information about mistral-db-manage script please check file mistral/db/sqlalchemy/migration/alembic_migrations/README.md.

Running Mistral API server

To run Mistral API server:

$ tox -evenv -- python mistral/cmd/launch.py \
    --server api --config-file <path_to_config>

Running Mistral Engines

To run Mistral Engine:

$ tox -evenv -- python mistral/cmd/launch.py \
    --server engine --config-file <path_to_config>

Running Mistral Task Executors

To run Mistral Task Executor instance:

$ tox -evenv -- python mistral/cmd/launch.py \
    --server executor --config-file <path_to_config>

Note that at least one Engine instance and one Executor instance should be running in order for workflow tasks to be processed by Mistral.

If you want to run some tasks on specific executor, the task affinity feature can be used to send these tasks directly to a specific executor. You can edit the following property in your mistral configuration file for this purpose:

[executor]
host = my_favorite_executor

After changing this option, you will need to start (restart) the executor. Use the target property of a task to specify the executor:

... Workflow YAML ...
task1:
  ...
  target: my_favorite_executor
... Workflow YAML ...

Running Multiple Mistral Servers Under the Same Process

To run more than one server (API, Engine, or Task Executor) on the same process:

$ tox -evenv -- python mistral/cmd/launch.py \
    --server api,engine --config-file <path_to_config>

The value for the --server option can be a comma-delimited list. The valid options are all (which is the default if not specified) or any combination of api, engine, and executor.

It's important to note that the fake transport for the rpc_backend defined in the configuration file should only be used if all Mistral servers are launched on the same process. Otherwise, messages do not get delivered because the fake transport is using an in-process queue.

Project Resources