summaryrefslogtreecommitdiff
path: root/doc/source/cli
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/cli')
-rw-r--r--doc/source/cli/index.rst9
-rw-r--r--doc/source/cli/intro.rst64
-rw-r--r--doc/source/cli/reference.rst64
3 files changed, 137 insertions, 0 deletions
diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst
new file mode 100644
index 0000000..100c8a6
--- /dev/null
+++ b/doc/source/cli/index.rst
@@ -0,0 +1,9 @@
+=================
+Sahara CLI client
+=================
+
+.. toctree::
+ :maxdepth: 2
+
+ intro
+ reference
diff --git a/doc/source/cli/intro.rst b/doc/source/cli/intro.rst
new file mode 100644
index 0000000..f2c1cf1
--- /dev/null
+++ b/doc/source/cli/intro.rst
@@ -0,0 +1,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 <http://docs.openstack.org/developer/python-openstackclient/>`_
+
+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:
+
+.. 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>
diff --git a/doc/source/cli/reference.rst b/doc/source/cli/reference.rst
new file mode 100644
index 0000000..203cf22
--- /dev/null
+++ b/doc/source/cli/reference.rst
@@ -0,0 +1,64 @@
+CLI Reference
+=============
+
+The following commands are currently supported by the Sahara CLI:
+
+Plugins
+-------
+
+.. cli::
+ :module: saharaclient.osc.v1.plugins
+
+Images
+------
+
+.. cli::
+ :module: saharaclient.osc.v1.images
+
+Node Group Templates
+--------------------
+
+.. cli::
+ :module: saharaclient.osc.v1.node_group_templates
+
+Cluster Templates
+-----------------
+
+.. cli::
+ :module: saharaclient.osc.v1.cluster_templates
+
+Clusters
+--------
+
+.. cli::
+ :module: saharaclient.osc.v1.clusters
+
+Data Sources
+------------
+
+.. cli::
+ :module: saharaclient.osc.v1.data_sources
+
+Job Binaries
+------------
+
+.. cli::
+ :module: saharaclient.osc.v1.job_binaries
+
+Job Types
+---------
+
+.. cli::
+ :module: saharaclient.osc.v1.job_types
+
+Job Templates
+-------------
+
+.. cli::
+ :module: saharaclient.osc.v1.job_templates
+
+Jobs
+----
+
+.. cli::
+ :module: saharaclient.osc.v1.jobs