Files

Luigi Toscano 889cbb5613 Reorganize the documentation following the new structure

- move api as "reference" guide and reword as Python client;
- consolidate shell and cli as part of the "CLI" guide;
- remove the "how_to_participate" page and use part of
  the content from the old index for a minimal "contributor"
  guide which redirect to the sahara contributor guide
  (no need to duplicate the information);
- remove few references to doc/source/api from tox.ini and
  .gitignore (for some reason the directory was cleaned).

Change-Id: Iff049ab32a7695a7a58bd370a1517b1ed7d2f048

2017-09-04 18:43:22 +02:00

1.6 KiB

Raw Blame History

Introduction

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 <reference>.

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 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:

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>

1.6 KiB Raw Blame History

Introduction

Configuration

1.6 KiB

Raw Blame History