1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
|
Introduction
============
The Sahara shell utility now is part of the OpenStackClient, so all
shell commands take the following form:
.. code-block:: bash
$ openstack dataprocessing <command> [arguments...]
To get a list of all possible commands you can run:
.. code-block:: bash
$ openstack help dataprocessing
To get detailed help for the command you can run:
.. code-block:: bash
$ openstack help dataprocessing <command>
For more information about commands and their parameters you can refer to
:doc:`the Sahara CLI commands <reference>`.
For more information about abilities and features of OpenStackClient CLI you
can refer to `OpenStackClient documentation <https://docs.openstack.org/python-openstackclient/latest/>`_
Configuration
-------------
The CLI is configured via environment variables and command-line options which
are described in https://docs.openstack.org/python-openstackclient/latest/cli/authentication.html.
Authentication using username/password is most commonly used and can be
provided with environment variables:
.. code-block:: bash
export OS_AUTH_URL=<url-to-openstack-identity>
export OS_PROJECT_NAME=<project-name>
export OS_USERNAME=<username>
export OS_PASSWORD=<password> # (optional)
or command-line options:
.. code-block:: bash
--os-auth-url <url>
--os-project-name <project-name>
--os-username <username>
[--os-password <password>]
Additionally :program:`sahara` API url can be configured with parameter:
.. code-block:: bash
--os-data-processing-url
or with environment variable:
.. code-block:: bash
export OS_DATA_PROCESSING_URL=<url-to-sahara-API>
|