openstack/mistral
Code Issues Proposed changes

Merge "Fix DB connection url in config guide"

Browse Source
This commit is contained in:
Zuul 2018-04-16 08:32:20 +00:00 committed by Gerrit Code Review
commit 40a1620959
1 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
doc/source/configuration/config-guide.rst
View File

@ -1,10 +1,10 @@
Mistral Configuration Guide Mistral Configuration Guide
=========================== ===========================
Mistral configuration is needed for getting it work correctly Mistral configuration is needed for getting Mistral work correctly
either with real OpenStack environment or without OpenStack environment. either with real OpenStack environment or without OpenStack environment.
**NOTE:** The most of the following operations should performed in mistral **NOTE:** Most of the following operations should be performed in mistral
directory. directory.
#. Generate *mistral.conf* (if it does not already exist):: #. Generate *mistral.conf* (if it does not already exist)::
@ -19,25 +19,25 @@ directory.
auth properties:: auth properties::
[keystone_authtoken] [keystone_authtoken]
auth_uri = http://<Keystone-host>:5000/v3 auth_uri = http://<keystone-host>:5000/v3
identity_uri = http://<Keystone-host:35357 identity_uri = http://<keystone-host:35357
auth_version = v3 auth_version = v3
admin_user = <user> admin_user = <user>
admin_password = <password> admin_password = <password>
admin_tenant_name = <tenant> admin_tenant_name = <tenant>
#. Mistral can be also configured to authenticate with Keycloak server #. Mistral can be also configured to authenticate with Keycloak server
via OpenID Connect protocol. In order to enable Keycloak authentication via OpenID Connect protocol. In order to enable Keycloak authentication,
the following section should be in the config file:: the following section should be in the config file::
auth_type = keycloak-oidc auth_type = keycloak-oidc
[keycloak_oidc] [keycloak_oidc]
auth_url = https://<Keycloak-server-host>:<Keycloak-server-port>/auth auth_url = https://<keycloak-server-host>:<keycloak-server-port>/auth
Property 'auth_type' is assigned to 'keystone' by default. Property ``auth_type`` is assigned to ``keystone`` by default.
If SSL/TLS verification needs to be disabled then 'insecure = True' If SSL/TLS verification needs to be disabled then ``insecure = True``
should also be added under [keycloak_oidc] group. should also be added under ``[keycloak_oidc]`` group.
#. If you want to configure SSL for Mistral API server, provide following #. If you want to configure SSL for Mistral API server, provide following
options in config file:: options in config file::
@ -66,21 +66,21 @@ directory.
$ openstack endpoint create workflowv2 internal $MISTRAL_URL $ openstack endpoint create workflowv2 internal $MISTRAL_URL
$ openstack endpoint create workflowv2 admin $MISTRAL_URL $ openstack endpoint create workflowv2 admin $MISTRAL_URL
#. Configure transport properties in the [DEFAULT] section:: #. Configure transport properties in the ``[DEFAULT]`` section::
[DEFAULT] [DEFAULT]
transport_url = rabbit://<user_id>:<password>@<host>:5672/ transport_url = rabbit://<user_id>:<password>@<host>:5672/
#. Configure database. **SQLite can't be used in production**. Use *MySQL* or #. Configure database. **SQLite can't be used in production; use MySQL or
*PostgreSQL* instead. Here are the steps how to connect *MySQL* DB to PostgreSQL instead.** Here are the steps how to connect *MySQL* DB to
Mistral: Mistral:
Make sure you have installed **mysql-server** package on your database Make sure you have installed ``mysql-server`` package on your database
machine (it can be your Mistral machine as well). machine (it can be your Mistral machine as well).
Install MySQL driver for python:: Install MySQL driver for python::
$ pip install mysql-python $ pip install PyMySQL
Create the database and grant privileges:: Create the database and grant privileges::
@ -100,10 +100,10 @@ directory.
connection = postgresql://<user>:<password>@<database-host>:5432/mistral connection = postgresql://<user>:<password>@<database-host>:5432/mistral
#. **If you are not using OpenStack, skip this item.** #. **If you are not using OpenStack, skip this item.**
Update mistral/actions/openstack/mapping.json file which contains all Update ``mistral/actions/openstack/mapping.json`` file which contains all
allowed OpenStack actions, according to the specific client versions allowed OpenStack actions, according to the specific client versions
of OpenStack projects in your deployment. Please find more detailed of OpenStack projects in your deployment. Please find more detailed
information in tools/get_action_list.py script. information in ``tools/get_action_list.py`` script.
#. Configure Task affinity feature if needed. It is needed for distinguishing #. Configure Task affinity feature if needed. It is needed for distinguishing
either single task executor or one task executor from group of task either single task executor or one task executor from group of task
@ -131,7 +131,7 @@ directory.
For more details see `policy.json file For more details see `policy.json file
<https://docs.openstack.org/oslo.policy/latest/admin/policy-json-file.html>`_. <https://docs.openstack.org/oslo.policy/latest/admin/policy-json-file.html>`_.
#. After that try to run mistral engine and see it is running without #. Finally, try to run mistral engine and verify that it is running without
any error:: any error::
$ mistral-server --config-file <path-to-config> --server engine $ mistral-server --config-file <path-to-config> --server engine