From e43cf4559a1065d2a11288b92b798b2f1981a1ef Mon Sep 17 00:00:00 2001 From: hardikj Date: Tue, 10 Apr 2018 18:16:44 +0530 Subject: [PATCH] Fix DB connection url in config guide Change MySQL DB default driver to PyMySQL in config guide to align with Dockerfile. And some grammar fixes. Change-Id: Id4379c7c86e2f8b50341dcbd72f34af834f99261 Closes-Bug: 1762720 --- doc/source/configuration/config-guide.rst | 34 +++++++++++------------ 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/doc/source/configuration/config-guide.rst b/doc/source/configuration/config-guide.rst index 8d27a1b5a..635798cf6 100644 --- a/doc/source/configuration/config-guide.rst +++ b/doc/source/configuration/config-guide.rst @@ -1,10 +1,10 @@ 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. -**NOTE:** The most of the following operations should performed in mistral +**NOTE:** Most of the following operations should be performed in mistral directory. #. Generate *mistral.conf* (if it does not already exist):: @@ -19,25 +19,25 @@ directory. auth properties:: [keystone_authtoken] - auth_uri = http://:5000/v3 - identity_uri = http://:5000/v3 + identity_uri = http:// admin_password = admin_tenant_name = #. 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:: auth_type = keycloak-oidc [keycloak_oidc] - auth_url = https://:/auth + auth_url = https://:/auth - Property 'auth_type' is assigned to 'keystone' by default. - If SSL/TLS verification needs to be disabled then 'insecure = True' - should also be added under [keycloak_oidc] group. + Property ``auth_type`` is assigned to ``keystone`` by default. + If SSL/TLS verification needs to be disabled then ``insecure = True`` + should also be added under ``[keycloak_oidc]`` group. #. If you want to configure SSL for Mistral API server, provide following options in config file:: @@ -66,21 +66,21 @@ directory. $ openstack endpoint create workflowv2 internal $MISTRAL_URL $ openstack endpoint create workflowv2 admin $MISTRAL_URL -#. Configure transport properties in the [DEFAULT] section:: +#. Configure transport properties in the ``[DEFAULT]`` section:: [DEFAULT] transport_url = rabbit://:@:5672/ -#. Configure database. **SQLite can't be used in production**. Use *MySQL* or - *PostgreSQL* instead. Here are the steps how to connect *MySQL* DB to +#. Configure database. **SQLite can't be used in production; use MySQL or + PostgreSQL instead.** Here are the steps how to connect *MySQL* DB to 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). Install MySQL driver for python:: - $ pip install mysql-python + $ pip install PyMySQL Create the database and grant privileges:: @@ -100,10 +100,10 @@ directory. connection = postgresql://:@:5432/mistral #. **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 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 either single task executor or one task executor from group of task @@ -131,7 +131,7 @@ directory. For more details see `policy.json file `_. -#. 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:: $ mistral-server --config-file --server engine