Change client doc references to sahara
Partial-implements: blueprint savanna-renaming-client Change-Id: I72f943db56a9c9c85bad1cd10ea9cd34fddf471c
This commit is contained in:
Trevor McKay
parent
7691dcff6e
commit
b313382c0d
|
|
@ -1,12 +1,12 @@
|
|||
Savanna Style Commandments
|
||||
==========================
|
||||
Sahara Style Commandments
|
||||
=========================
|
||||
|
||||
- Step 1: Read the OpenStack Style Commandments
|
||||
http://docs.openstack.org/developer/hacking/
|
||||
- Step 2: Read on
|
||||
|
||||
Savanna Specific Commandments
|
||||
-----------------------------
|
||||
Sahara Specific Commandments
|
||||
----------------------------
|
||||
|
||||
None so far
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<h3>Useful Links</h3>
|
||||
<ul>
|
||||
<li><a href="https://wiki.openstack.org/wiki/Savanna">Savanna @ OpenStack Wiki</a></li>
|
||||
<li><a href="https://launchpad.net/savanna">Savanna @ Launchpad</a></li>
|
||||
<li><a href="https://wiki.openstack.org/wiki/Sahara">Sahara @ OpenStack Wiki</a></li>
|
||||
<li><a href="https://launchpad.net/sahara">Sahara @ Launchpad</a></li>
|
||||
</ul>
|
||||
|
||||
{% if READTHEDOCS %}
|
||||
|
|
|
|||
|
|
@ -1,24 +1,24 @@
|
|||
Savanna Client
|
||||
==============
|
||||
Sahara Client
|
||||
=============
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
Savanna Client provides a list of Python interfaces to communicate with the Savanna REST API.
|
||||
Savanna Client enables users to perform most of the existing operations like retrieving template lists,
|
||||
Sahara Client provides a list of Python interfaces to communicate with the Sahara REST API.
|
||||
Sahara Client enables users to perform most of the existing operations like retrieving template lists,
|
||||
creating Clusters, submitting EDP Jobs, etc.
|
||||
|
||||
|
||||
Instantiating a Client
|
||||
----------------------
|
||||
|
||||
To start using the Savanna Client users have to create an instance of the `Client` class.
|
||||
The client constructor has a list of parameters to authenticate and locate Savanna endpoint.
|
||||
To start using the Sahara Client users have to create an instance of the `Client` class.
|
||||
The client constructor has a list of parameters to authenticate and locate Sahara endpoint.
|
||||
|
||||
* auth_url - Keystone URL that will be used for authentication.
|
||||
* savanna_url - Savanna REST API URL to communicate with.
|
||||
* service_type - Savanna service name in Keystone catalog. (Default: data_processing)
|
||||
* endpoint_type - Desired Savanna endpoint type. (Default: publicURL)
|
||||
* sahara_url - Sahara REST API URL to communicate with.
|
||||
* service_type - Sahara service name in Keystone catalog. (Default: data_processing)
|
||||
* endpoint_type - Desired Sahara endpoint type. (Default: publicURL)
|
||||
* username - Username for Keystone authentication.
|
||||
* api_key - Password for Keystone authentication.
|
||||
* project_name - Keystone Tenant name.
|
||||
|
|
@ -27,7 +27,7 @@ The client constructor has a list of parameters to authenticate and locate Savan
|
|||
|
||||
**Important!**
|
||||
It is not a mandatory rule to provide all of the parameters above. The minimum number should be enough
|
||||
to determine Savanna endpoint, check user authentication and tenant to operate in.
|
||||
to determine Sahara endpoint, check user authentication and tenant to operate in.
|
||||
|
||||
Authentication check
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
|
@ -36,11 +36,11 @@ If a user already has a Keystone authentication token, it may be used in `input_
|
|||
|
||||
.. sourcecode:: python
|
||||
|
||||
from savannaclient.api.client import Client as savannaclient
|
||||
from saharaclient.api.client import Client as saharaclient
|
||||
|
||||
savanna = savannaclient(savanna_url="http://savanna:8386/v1.1",
|
||||
project_id="11111111-2222-3333-4444-555555555555",
|
||||
input_auth_token="66666666-7777-8888-9999-000000000000")
|
||||
sahara = saharaclient(sahara_url="http://sahara:8386/v1.1",
|
||||
project_id="11111111-2222-3333-4444-555555555555",
|
||||
input_auth_token="66666666-7777-8888-9999-000000000000")
|
||||
..
|
||||
|
||||
In this case no other authentication parameters are required and `input_auth_token` has a higher
|
||||
|
|
@ -53,47 +53,47 @@ priority than other parameters. Otherwise user has to provide:
|
|||
|
||||
.. sourcecode:: python
|
||||
|
||||
from savannaclient.api.client import Client as savannaclient
|
||||
from saharaclient.api.client import Client as saharaclient
|
||||
|
||||
savanna = savannaclient(auth_url="http://keystone:5000/v2.0",
|
||||
savanna_url="http://savanna:8386/v1.1",
|
||||
username="user",
|
||||
api_key="PaSsWoRd",
|
||||
project_name="demo-project")
|
||||
sahara = saharaclient(auth_url="http://keystone:5000/v2.0",
|
||||
sahara_url="http://sahara:8386/v1.1",
|
||||
username="user",
|
||||
api_key="PaSsWoRd",
|
||||
project_name="demo-project")
|
||||
..
|
||||
|
||||
|
||||
Savanna endpoint discovery
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Sahara endpoint discovery
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
If user has a direct URL pointing to Savanna REST API, it may be specified as `savanna_url`.
|
||||
If this parameter is missing, Savanna client will use Keystone Service Catalog to find the endpoint.
|
||||
If user has a direct URL pointing to Sahara REST API, it may be specified as `sahara_url`.
|
||||
If this parameter is missing, Sahara client will use Keystone Service Catalog to find the endpoint.
|
||||
There are two parameters: `service_type` and `endpoint_type` to configure endpoint search. Both parameters have
|
||||
default values.
|
||||
|
||||
.. sourcecode:: python
|
||||
|
||||
from savannaclient.api.client import Client as savannaclient
|
||||
from saharaclient.api.client import Client as saharaclient
|
||||
|
||||
savanna = savannaclient(auth_url="http://keystone:5000/v2.0",
|
||||
username="user",
|
||||
api_key="PaSsWoRd",
|
||||
project_name="demo-project",
|
||||
service_type="non-default-service-type",
|
||||
endpoint_type="internalURL")
|
||||
sahara = saharaclient(auth_url="http://keystone:5000/v2.0",
|
||||
username="user",
|
||||
api_key="PaSsWoRd",
|
||||
project_name="demo-project",
|
||||
service_type="non-default-service-type",
|
||||
endpoint_type="internalURL")
|
||||
..
|
||||
|
||||
|
||||
Tenant specification
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
All Savanna operations should be performed in one of OpenStack tenants.
|
||||
All Sahara operations should be performed in one of OpenStack tenants.
|
||||
There are two parameters: `project_name` and `project_id` which allow to specify a tenant.
|
||||
`project_id` parameter has a higher priority.
|
||||
|
||||
Object managers
|
||||
---------------
|
||||
Savanna Client has a list of fields to operate with:
|
||||
Sahara Client has a list of fields to operate with:
|
||||
|
||||
* plugins
|
||||
* clusters
|
||||
|
|
@ -127,7 +127,7 @@ Image Registry ops
|
|||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
* update_image(image_id, user_name, descr) - Create or update an Image in Image Registry.
|
||||
* unregister_image(image_id) - Remove an Image from Savanna Image Registry.
|
||||
* unregister_image(image_id) - Remove an Image from Sahara Image Registry.
|
||||
* update_tags(image_id, new_tags) - Updates Image tags. `new_tags` list will replace currently assigned tags.
|
||||
|
||||
Node Group Template ops
|
||||
|
|
|
|||
|
|
@ -1,19 +1,19 @@
|
|||
Python bindings to the OpenStack Savanna API
|
||||
============================================
|
||||
Python bindings to the OpenStack Sahara API
|
||||
===========================================
|
||||
|
||||
This is a client for OpenStack Savanna API. There's :doc:`a Python API
|
||||
<api>` (the :mod:`savannaclient` module), and a :doc:`command-line script
|
||||
<shell>` (installed as :program:`savanna`). Each implements the entire
|
||||
OpenStack Savanna API.
|
||||
This is a client for OpenStack Sahara API. There's :doc:`a Python API
|
||||
<api>` (the :mod:`saharaclient` module), and a :doc:`command-line script
|
||||
<shell>` (installed as :program:`sahara`). Each implements the entire
|
||||
OpenStack Sahara API.
|
||||
|
||||
You'll need credentials for an OpenStack cloud that implements the
|
||||
Data Processing API, in order to use the savanna client.
|
||||
Data Processing API, in order to use the sahara client.
|
||||
|
||||
You may want to read the `OpenStack Savanna Docs`__ -- the overview, at
|
||||
You may want to read the `OpenStack Sahara Docs`__ -- the overview, at
|
||||
least -- to get an idea of the concepts. By understanding the concepts
|
||||
this library should make more sense.
|
||||
|
||||
__ http://docs.openstack.org/developer/savanna/api/index.html
|
||||
__ http://docs.openstack.org/developer/sahara/api/index.html
|
||||
|
||||
Contents:
|
||||
|
||||
|
|
@ -26,14 +26,14 @@ Contributing
|
|||
============
|
||||
|
||||
Code is hosted in `review.o.o`_ and mirrored to `github`_ and `git.o.o`_ .
|
||||
Submit bugs to the Savanna project on `launchpad`_ and to the Savanna client on
|
||||
`launchpad_client`_. Submit code to the openstack/python-savannaclient project
|
||||
Submit bugs to the Sahara project on `launchpad`_ and to the Sahara client on
|
||||
`launchpad_client`_. Submit code to the openstack/python-saharaclient project
|
||||
using `gerrit`_.
|
||||
|
||||
.. _review.o.o: https://review.openstack.org
|
||||
.. _github: https://github.com/openstack/python-savannaclient
|
||||
.. _git.o.o: http://git.openstack.org/cgit/openstack/python-savannaclient
|
||||
.. _launchpad: https://launchpad.net/savanna
|
||||
.. _launchpad_client: https://launchpad.net/python-savannaclient
|
||||
.. _github: https://github.com/openstack/python-saharaclient
|
||||
.. _git.o.o: http://git.openstack.org/cgit/openstack/python-saharaclient
|
||||
.. _launchpad: https://launchpad.net/sahara
|
||||
.. _launchpad_client: https://launchpad.net/python-saharaclient
|
||||
.. _gerrit: http://wiki.openstack.org/GerritWorkflow
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue