New CLI docs now can be autogenerated, that prevents them from being outdated and excludes manual updates Partially implements: blueprint cli-as-openstackclient-plugin Change-Id: I11e6dadc7d19bd55777e748e7ada199311b20003
1.6 KiB
Sahara CLI
The Sahara shell utility now is part of the OpenStackClient, so all shell commands take the following form:
$ openstack dataprocessing <command> [arguments...]
To get a list of all possible commands you can run:
$ openstack help dataprocessing
To get detailed help for the command you can run:
$ openstack help dataprocessing <command>
For more information about commands and their parameters you can
refer to the Sahara CLI commands <cli>
.
For more information about abilities and features of OpenStackClient CLI you can refer to OpenStackClient documentation
Configuration
The CLI is configured via environment variables and command-line options which are described in http://docs.openstack.org/developer/python-openstackclient/authentication.html.
Authentication using username/password is most commonly used and can be provided with environment variables:
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:
--os-auth-url <url>
--os-project-name <project-name>
--os-username <username>
[--os-password <password>]
Additionally sahara
API url can be configured with
parameter:
--os-data-processing-url
or with environment variable:
export OS_DATA_PROCESSING_URL=<url-to-sahara-API>