889cbb5613
- 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
168 lines
4.0 KiB
ReStructuredText
168 lines
4.0 KiB
ReStructuredText
Python Sahara client
|
|
====================
|
|
|
|
Overview
|
|
--------
|
|
|
|
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 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.
|
|
|
|
.. autoclass:: saharaclient.api.client.Client
|
|
:members:
|
|
|
|
**Important!**
|
|
It is not a mandatory rule to provide all of the parameters above. The minimum
|
|
number should be enough to determine Sahara endpoint, check user
|
|
authentication and tenant to operate in.
|
|
|
|
Authentication check
|
|
~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Passing authentication parameters to Sahara Client is deprecated. Keystone
|
|
Session object should be used for this purpose. For example:
|
|
|
|
.. sourcecode:: python
|
|
|
|
from keystoneauth1.identity import v2
|
|
from keystoneauth1 import session
|
|
from saharaclient import client
|
|
|
|
auth = v2.Password(auth_url=AUTH_URL,
|
|
username=USERNAME,
|
|
password=PASSWORD,
|
|
tenant_name=PROJECT_ID)
|
|
|
|
ses = session.Session(auth=auth)
|
|
|
|
sahara = client.Client('1.1', session=ses)
|
|
..
|
|
|
|
For more information about Keystone Sessions, see `Using Sessions`_.
|
|
|
|
.. _Using Sessions: https://docs.openstack.org/python-keystoneclient/latest/using-sessions.html
|
|
|
|
Sahara endpoint discovery
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
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 keystoneauth1.identity import v2
|
|
from keystoneauth1 import session
|
|
from saharaclient import client
|
|
|
|
auth = v2.Password(auth_url=AUTH_URL,
|
|
username=USERNAME,
|
|
password=PASSWORD,
|
|
tenant_name=PROJECT_ID)
|
|
|
|
ses = session.Session(auth=auth)
|
|
|
|
sahara = client.Client('1.1', session=ses,
|
|
service_type="non-default-service-type",
|
|
endpoint_type="internalURL")
|
|
..
|
|
|
|
Object managers
|
|
---------------
|
|
Sahara Client has a list of fields to operate with:
|
|
|
|
* plugins
|
|
* clusters
|
|
* cluster_templates
|
|
* node_group_templates
|
|
* images
|
|
* data_sources
|
|
* job_binaries
|
|
* job_binary_internals
|
|
* job_executions
|
|
* job_types
|
|
|
|
Each of this fields is a reference to a Manager for a corresponding group of
|
|
REST calls.
|
|
|
|
|
|
Supported operations
|
|
--------------------
|
|
|
|
Plugin ops
|
|
~~~~~~~~~~
|
|
|
|
.. autoclass:: saharaclient.api.plugins.PluginManager
|
|
:members:
|
|
|
|
Image Registry ops
|
|
~~~~~~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: saharaclient.api.images.ImageManager
|
|
:members:
|
|
|
|
Node Group Template ops
|
|
~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: saharaclient.api.node_group_templates.NodeGroupTemplateManager
|
|
:members:
|
|
|
|
Cluster Template ops
|
|
~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: saharaclient.api.cluster_templates.ClusterTemplateManager
|
|
:members:
|
|
|
|
Cluster ops
|
|
~~~~~~~~~~~
|
|
|
|
.. autoclass:: saharaclient.api.clusters.ClusterManager
|
|
:members:
|
|
|
|
Data Source ops
|
|
~~~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: saharaclient.api.data_sources.DataSourceManager
|
|
:members:
|
|
|
|
Job Binary Internal ops
|
|
~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: saharaclient.api.job_binary_internals.JobBinaryInternalsManager
|
|
:members: create, update
|
|
|
|
Job Binary ops
|
|
~~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: saharaclient.api.job_binaries.JobBinariesManager
|
|
:members:
|
|
|
|
Job ops
|
|
~~~~~~~
|
|
|
|
.. autoclass:: saharaclient.api.jobs.JobsManager
|
|
:members:
|
|
|
|
Job Execution ops
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: saharaclient.api.job_executions.JobExecutionsManager
|
|
:members:
|
|
|
|
Job Types ops
|
|
~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: saharaclient.api.job_types.JobTypesManager
|
|
:members:
|