python-mistralclient/doc/source/cli_usage_without_auth.rst
Sharat Sharma d27f91ac61 Initial commit for python-mistralclient document
This is the first document from the client side of mistral.
Taking this as a starting point, client side documentation can
be done.

Change-Id: I5a787e00bade0636da791cd7f3b3f045cdbc511a
Partial-Implements: blueprint mistral-python-client-docs
2016-12-19 12:25:59 +00:00

43 lines
1.6 KiB
ReStructuredText

Using Mistral without Authentication
====================================
It is possible to execute a workflow on any arbitrary cloud without additional
configuration on the Mistral server side. If authentication is turned off in
the Mistral server (Pecan's `auth_enable = False` option in `mistral.conf`),
there is no need to set the `keystone_authtoken` section. It is possible to
have Mistral use an external OpenStack cloud even when it isn't deployed in
an OpenStack environment (i.e. no Keystone integration).
This setup is particularly useful when Mistral is used in standalone mode,
where the Mistral service is not part of the OpenStack cloud and runs
separately.
To enable this operation, the user can use ``--os-target-username``,
``--os-target-password``, ``--os-target-tenant-id``,
``--os-target-tenant-name``, ``--os-target-auth-token``,
``--os-target-auth-url``, ``--os-target_cacert``, and
``--os-target-region-name`` parameters.
For example, the user can return the heat stack list with this setup as shown
below:
.. code-block:: shell
$ mistral \
--os-target-auth-url=http://keystone2.example.com:5000/v3 \
--os-target-username=testuser \
--os-target-tenant=testtenant \
--os-target-password="MistralRuleZ" \
--os-mistral-url=http://mistral.example.com:8989/v2 \
run-action heat.stacks_list
The OS-TARGET-* parameters can be set in environment variables as:
.. code-block:: shell
$ export OS_TARGET_AUTH_URL=http://keystone2.example.com:5000/v3
$ export OS_TARGET_USERNAME=admin
$ export OS_TARGET_TENANT_NAME=tenant
$ export OS_TARGET_PASSWORD=secret
$ export OS_TARGET_REGION_NAME=region