--- name: "sahara" section: "1" platform: "linux" package: "python-saharaclient" version: "2.0.0-2.1" release: "Debian 10 (Buster)" platforms: ["linux"] url: "https://new.carta.tech/sahara" --- # sahara(1) Sahara Client This is a client for OpenStack Sahara API. There's a Python API client (the saharaclient module), and a command-line utility (installed as an OpenStackClient plugin). 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 sahara client. 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. Contents: ## NAME saharaclient - Sahara Client This is a client for OpenStack Sahara API. There's a Python API client (the **saharaclient** module), and a command-line utility (installed as an OpenStackClient plugin). 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 sahara client. 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. Contents: ## REFERENCE GUIDE ### 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. - **class saharaclient.api.client.Client(session=None, sahara\_url=None, endpoint\_type='publicURL', service\_type='data-processing', region\_name=None, \*\*kwargs)** - **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: ``` 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*. ### 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. ``` 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 - **class saharaclient.api.plugins.PluginManagerV1(api)** - **convert\_to\_cluster\_template(plugin\_name, hadoop\_version, template\_name, filecontent)** Convert to cluster template Create Cluster Template directly, avoiding Cluster Template mechanism. - **get(plugin\_name)** Get information about a Plugin. - **get\_version\_details(plugin\_name, hadoop\_version)** Get version details Get the list of Services and Service Parameters for a specified Plugin and Plugin Version. - **list(search\_opts=None)** Get a list of Plugins. - **update(plugin\_name, values)** Update plugin and then return updated result to user ### Image Registry ops - **class saharaclient.api.images.ImageManagerV1(api)** - **get(id)** Get information about an image - **list(search\_opts=None)** Get a list of registered images. - **unregister\_image(image\_id)** Remove an Image from Sahara Image Registry. - **update\_image(image\_id, user\_name, desc=None)** Create or update an Image in Image Registry. - **update\_tags(image\_id, new\_tags)** Update an Image tags. - **Parameters** **new\_tags** -- list of tags that will replace currently assigned tags ### Node Group Template ops - **class saharaclient.api.node\_group\_templates.NodeGroupTemplateManagerV1(api)** - **create(name, plugin\_name, hadoop\_version, flavor\_id, description=None, volumes\_per\_node=None, volumes\_size=None, node\_processes=None, node\_configs=None, floating\_ip\_pool=None, security\_groups=None, auto\_security\_group=None, availability\_zone=None, volumes\_availability\_zone=None, volume\_type=None, image\_id=None, is\_proxy\_gateway=None, volume\_local\_to\_instance=None, use\_autoconfig=None, shares=None, is\_public=None, is\_protected=None, volume\_mount\_prefix=None)** Create a Node Group Template. - **delete(ng\_template\_id)** Delete a Node Group Template. - **export(ng\_template\_id)** Export a Node Group Template. - **get(ng\_template\_id)** Get information about a Node Group Template. - **list(search\_opts=None, marker=None, limit=None, sort\_by=None, reverse=None)** Get a list of Node Group Templates. - **update(ng\_template\_id, name=NotUpdated, plugin\_name=NotUpdated, hadoop\_version=NotUpdated, flavor\_id=NotUpdated, description=NotUpdated, volumes\_per\_node=NotUpdated, volumes\_size=NotUpdated, node\_processes=NotUpdated, node\_configs=NotUpdated, floating\_ip\_pool=NotUpdated, security\_groups=NotUpdated, auto\_security\_group=NotUpdated, availability\_zone=NotUpdated, volumes\_availability\_zone=NotUpdated, volume\_type=NotUpdated, image\_id=NotUpdated, is\_proxy\_gateway=NotUpdated, volume\_local\_to\_instance=NotUpdated, use\_autoconfig=NotUpdated, shares=NotUpdated, is\_public=NotUpdated, is\_protected=NotUpdated, volume\_mount\_prefix=NotUpdated)** Update a Node Group Template. ### Cluster Template ops - **class saharaclient.api.cluster\_templates.ClusterTemplateManagerV1(api)** - **create(name, plugin\_name, hadoop\_version, description=None, cluster\_configs=None, node\_groups=None, anti\_affinity=None, net\_id=None, default\_image\_id=None, use\_autoconfig=None, shares=None, is\_public=None, is\_protected=None, domain\_name=None)** Create a Cluster Template. - **delete(cluster\_template\_id)** Delete a Cluster Template. - **export(cluster\_template\_id)** Export a Cluster Template. - **get(cluster\_template\_id)** Get information about a Cluster Template. - **list(search\_opts=None, marker=None, limit=None, sort\_by=None, reverse=None)** Get list of Cluster Templates. - **update(cluster\_template\_id, name=NotUpdated, plugin\_name=NotUpdated, hadoop\_version=NotUpdated, description=NotUpdated, cluster\_configs=NotUpdated, node\_groups=NotUpdated, anti\_affinity=NotUpdated, net\_id=NotUpdated, default\_image\_id=NotUpdated, use\_autoconfig=NotUpdated, shares=NotUpdated, is\_public=NotUpdated, is\_protected=NotUpdated, domain\_name=NotUpdated)** Update a Cluster Template. ### Cluster ops - **class saharaclient.api.clusters.ClusterManagerV1(api)** - **create(name, plugin\_name, hadoop\_version, cluster\_template\_id=None, default\_image\_id=None, is\_transient=None, description=None, cluster\_configs=None, node\_groups=None, user\_keypair\_id=None, anti\_affinity=None, net\_id=None, count=None, use\_autoconfig=None, shares=None, is\_public=None, is\_protected=None)** Launch a Cluster. - **delete(cluster\_id)** Delete a Cluster. - **get(cluster\_id, show\_progress=False)** Get information about a Cluster. - **list(search\_opts=None, limit=None, marker=None, sort\_by=None, reverse=None)** Get a list of Clusters. - **scale(cluster\_id, scale\_object)** Scale an existing Cluster. - **Parameters** **scale\_object** -- dict that describes scaling operation - **Example** The following *scale\_object* can be used to change the number of instances in the node group and add instances of new node group to existing cluster: ``` { "add_node_groups": [ { "count": 3, "name": "new_ng", "node_group_template_id": "ngt_id" } ], "resize_node_groups": [ { "count": 2, "name": "old_ng" } ] } ``` - **update(cluster\_id, name=NotUpdated, description=NotUpdated, is\_public=NotUpdated, is\_protected=NotUpdated, shares=NotUpdated)** Update a Cluster. - **verification\_update(cluster\_id, status)** Start a verification for a Cluster. ### Data Source ops - **class saharaclient.api.data\_sources.DataSourceManagerV1(api)** - **create(name, description, data\_source\_type, url, credential\_user=None, credential\_pass=None, is\_public=None, is\_protected=None, s3\_credentials=None)** Create a Data Source. - **delete(data\_source\_id)** Delete a Data Source. - **get(data\_source\_id)** Get information about a Data Source. - **list(search\_opts=None, limit=None, marker=None, sort\_by=None, reverse=None)** Get a list of Data Sources. - **update(data\_source\_id, update\_data)** Update a Data Source. - **Parameters** **update\_data** (*dict*) -- dict that contains fields that should be updated with new values. Fields that can be updated: - • name - • description - • type - • url - • is\_public - • is\_protected - • credentials - dict with the keys *user* and *password* for data source in Swift, or with the keys *accesskey*, *secretkey*, *endpoint*, *ssl*, and *bucket\_in\_path* for data source in S3 ### Job Binary Internal ops - **class saharaclient.api.job\_binary\_internals.JobBinaryInternalsManager(api)** - **create(name, data)** Create a Job Binary Internal. - **Parameters** **data** (*str*) -- raw data of script text - **update(job\_binary\_id, name=NotUpdated, is\_public=NotUpdated, is\_protected=NotUpdated)** Update a Job Binary Internal. ### Job Binary ops - **class saharaclient.api.job\_binaries.JobBinariesManagerV1(api)** - **create(name, url, description=None, extra=None, is\_public=None, is\_protected=None)** Create a Job Binary. - **Parameters** **extra** (*dict*) -- authentication info needed for some job binaries, containing the keys *user* and *password* for job binary in Swift or the keys *accesskey*, *secretkey*, and *endpoint* for job binary in S3 - **delete(job\_binary\_id)** Delete a Job Binary. - **get(job\_binary\_id)** Get information about a Job Binary. - **get\_file(job\_binary\_id)** Download a Job Binary. - **list(search\_opts=None, limit=None, marker=None, sort\_by=None, reverse=None)** Get a list of Job Binaries. - **update(job\_binary\_id, data)** Update Job Binary. - **Parameters** **data** (*dict*) -- dict that contains fields that should be updated with new values. Fields that can be updated: - • name - • description - • url - • is\_public - • is\_protected - • extra - dict with the keys *user* and *password* for job binary in Swift, or with the keys *accesskey*, *secretkey*, and *endpoint* for job binary in S3 ### Job ops - **class saharaclient.api.jobs.JobsManagerV1(api)** - **create(name, type, mains=None, libs=None, description=None, interface=None, is\_public=None, is\_protected=None)** Create a Job. - **delete(job\_id)** Delete a Job - **get(job\_id)** Get information about a Job - **get\_configs(job\_type)** Get config hints for a specified Job type. - **list(search\_opts=None, limit=None, marker=None, sort\_by=None, reverse=None)** Get a list of Jobs. - **update(job\_id, name=NotUpdated, description=NotUpdated, is\_public=NotUpdated, is\_protected=NotUpdated)** Update a Job. ### Job Execution ops - **class saharaclient.api.job\_executions.JobExecutionsManager(api)** - **create(job\_id, cluster\_id, input\_id=None, output\_id=None, configs=None, interface=None, is\_public=None, is\_protected=None)** Launch a Job. - **delete(obj\_id)** Delete a Job Execution. - **get(obj\_id)** Get information about a Job Execution. - **list(search\_opts=None, marker=None, limit=None, sort\_by=None, reverse=None)** Get a list of Job Executions. - **update(obj\_id, is\_public=NotUpdated, is\_protected=NotUpdated)** Update a Job Execution. ### Job Types ops - **class saharaclient.api.job\_types.JobTypesManager(api)** - **list(search\_opts=None)** Get a list of job types supported by plugins. ### Python Sahara client for APIv2 ### Overview There is also support for Sahara's experimental APIv2. ### Supported operations ### Plugin ops - **class saharaclient.api.plugins.PluginManagerV2(api)** - **get(plugin\_name)** Get information about a Plugin. - **get\_version\_details(plugin\_name, plugin\_version)** Get version details Get the list of Services and Service Parameters for a specified Plugin and Plugin Version. - **list(search\_opts=None)** Get a list of Plugins. - **update(plugin\_name, values)** Update plugin and then return updated result to user ### Image Registry ops - **class saharaclient.api.images.ImageManagerV2(api)** - **get(id)** Get information about an image - **list(search\_opts=None)** Get a list of registered images. - **unregister\_image(image\_id)** Remove an Image from Sahara Image Registry. - **update\_image(image\_id, user\_name, desc=None)** Create or update an Image in Image Registry. ### Node Group Template ops - **class saharaclient.api.node\_group\_templates.NodeGroupTemplateManagerV2(api)** - **create(name, plugin\_name, plugin\_version, flavor\_id, description=None, volumes\_per\_node=None, volumes\_size=None, node\_processes=None, node\_configs=None, floating\_ip\_pool=None, security\_groups=None, auto\_security\_group=None, availability\_zone=None, volumes\_availability\_zone=None, volume\_type=None, image\_id=None, is\_proxy\_gateway=None, volume\_local\_to\_instance=None, use\_autoconfig=None, shares=None, is\_public=None, is\_protected=None, volume\_mount\_prefix=None, boot\_from\_volume=None)** Create a Node Group Template. - **delete(ng\_template\_id)** Delete a Node Group Template. - **export(ng\_template\_id)** Export a Node Group Template. - **get(ng\_template\_id)** Get information about a Node Group Template. - **list(search\_opts=None, marker=None, limit=None, sort\_by=None, reverse=None)** Get a list of Node Group Templates. - **update(ng\_template\_id, name=NotUpdated, plugin\_name=NotUpdated, plugin\_version=NotUpdated, flavor\_id=NotUpdated, description=NotUpdated, volumes\_per\_node=NotUpdated, volumes\_size=NotUpdated, node\_processes=NotUpdated, node\_configs=NotUpdated, floating\_ip\_pool=NotUpdated, security\_groups=NotUpdated, auto\_security\_group=NotUpdated, availability\_zone=NotUpdated, volumes\_availability\_zone=NotUpdated, volume\_type=NotUpdated, image\_id=NotUpdated, is\_proxy\_gateway=NotUpdated, volume\_local\_to\_instance=NotUpdated, use\_autoconfig=NotUpdated, shares=NotUpdated, is\_public=NotUpdated, is\_protected=NotUpdated, volume\_mount\_prefix=NotUpdated, boot\_from\_volume=NotUpdated)** Update a Node Group Template. ### Cluster Template ops - **class saharaclient.api.cluster\_templates.ClusterTemplateManagerV2(api)** - **create(name, plugin\_name, plugin\_version, description=None, cluster\_configs=None, node\_groups=None, anti\_affinity=None, net\_id=None, default\_image\_id=None, use\_autoconfig=None, shares=None, is\_public=None, is\_protected=None, domain\_name=None)** Create a Cluster Template. - **delete(cluster\_template\_id)** Delete a Cluster Template. - **export(cluster\_template\_id)** Export a Cluster Template. - **get(cluster\_template\_id)** Get information about a Cluster Template. - **list(search\_opts=None, marker=None, limit=None, sort\_by=None, reverse=None)** Get list of Cluster Templates. - **update(cluster\_template\_id, name=NotUpdated, plugin\_name=NotUpdated, plugin\_version=NotUpdated, description=NotUpdated, cluster\_configs=NotUpdated, node\_groups=NotUpdated, anti\_affinity=NotUpdated, net\_id=NotUpdated, default\_image\_id=NotUpdated, use\_autoconfig=NotUpdated, shares=NotUpdated, is\_public=NotUpdated, is\_protected=NotUpdated, domain\_name=NotUpdated)** Update a Cluster Template. ### Cluster ops - **class saharaclient.api.clusters.ClusterManagerV2(api)** - **create(name, plugin\_name, plugin\_version, cluster\_template\_id=None, default\_image\_id=None, is\_transient=None, description=None, cluster\_configs=None, node\_groups=None, user\_keypair\_id=None, anti\_affinity=None, net\_id=None, count=None, use\_autoconfig=None, shares=None, is\_public=None, is\_protected=None)** Launch a Cluster. - **delete(cluster\_id)** Delete a Cluster. - **force\_delete(cluster\_id)** Force Delete a Cluster. - **get(cluster\_id, show\_progress=False)** Get information about a Cluster. - **list(search\_opts=None, limit=None, marker=None, sort\_by=None, reverse=None)** Get a list of Clusters. - **scale(cluster\_id, scale\_object)** Scale an existing Cluster. - **Parameters** **scale\_object** -- dict that describes scaling operation - **Example** The following *scale\_object* can be used to change the number of instances in the node group (optionally specifiying which instances to delete) or add instances of a new node group to an existing cluster: ``` { "add_node_groups": [ { "count": 3, "name": "new_ng", "node_group_template_id": "ngt_id" } ], "resize_node_groups": [ { "count": 2, "name": "old_ng", "instances": ["instance_id1", "instance_id2"] } ] } ``` - **update(cluster\_id, name=NotUpdated, description=NotUpdated, is\_public=NotUpdated, is\_protected=NotUpdated, shares=NotUpdated)** Update a Cluster. - **verification\_update(cluster\_id, status)** Start a verification for a Cluster. ### Data Source ops - **class saharaclient.api.data\_sources.DataSourceManagerV2(api)** - **create(name, description, data\_source\_type, url, credential\_user=None, credential\_pass=None, is\_public=None, is\_protected=None, s3\_credentials=None)** Create a Data Source. - **delete(data\_source\_id)** Delete a Data Source. - **get(data\_source\_id)** Get information about a Data Source. - **list(search\_opts=None, limit=None, marker=None, sort\_by=None, reverse=None)** Get a list of Data Sources. - **update(data\_source\_id, update\_data)** Update a Data Source. - **Parameters** **update\_data** (*dict*) -- dict that contains fields that should be updated with new values. Fields that can be updated: - • name - • description - • type - • url - • is\_public - • is\_protected - • credentials - dict with the keys *user* and *password* for data source in Swift, or with the keys *accesskey*, *secretkey*, *endpoint*, *ssl*, and *bucket\_in\_path* for data source in S3 ### Job Binary ops - **class saharaclient.api.job\_binaries.JobBinariesManagerV2(api)** - **create(name, url, description=None, extra=None, is\_public=None, is\_protected=None)** Create a Job Binary. - **Parameters** **extra** (*dict*) -- authentication info needed for some job binaries, containing the keys *user* and *password* for job binary in Swift or the keys *accesskey*, *secretkey*, and *endpoint* for job binary in S3 - **delete(job\_binary\_id)** Delete a Job Binary. - **get(job\_binary\_id)** Get information about a Job Binary. - **get\_file(job\_binary\_id)** Download a Job Binary. - **list(search\_opts=None, limit=None, marker=None, sort\_by=None, reverse=None)** Get a list of Job Binaries. - **update(job\_binary\_id, data)** Update Job Binary. - **Parameters** **data** (*dict*) -- dict that contains fields that should be updated with new values. Fields that can be updated: - • name - • description - • url - • is\_public - • is\_protected - • extra - dict with the keys *user* and *password* for job binary in Swift, or with the keys *accesskey*, *secretkey*, and *endpoint* for job binary in S3 ### Job Template ops - **class saharaclient.api.v2.job\_templates.JobTemplatesManagerV2(api)** - **create(name, type, mains=None, libs=None, description=None, interface=None, is\_public=None, is\_protected=None)** Create a Job Template. - **delete(job\_id)** Delete a Job Template. - **get(job\_id)** Get information about a Job Template. - **get\_configs(job\_type)** Get config hints for a specified Job Template type. - **list(search\_opts=None, limit=None, marker=None, sort\_by=None, reverse=None)** Get a list of Job Templates. - **update(job\_id, name=NotUpdated, description=NotUpdated, is\_public=NotUpdated, is\_protected=NotUpdated)** Update a Job Template. ### Job ops - **class saharaclient.api.v2.jobs.JobsManagerV2(api)** - **create(job\_template\_id, cluster\_id, input\_id=None, output\_id=None, configs=None, interface=None, is\_public=None, is\_protected=None)** Launch a Job. - **delete(obj\_id)** Delete a Job. - **get(obj\_id)** Get information about a Job. - **list(search\_opts=None, marker=None, limit=None, sort\_by=None, reverse=None)** Get a list of Jobs. - **refresh\_status(obj\_id)** Refresh Job Status. - **update(obj\_id, is\_public=NotUpdated, is\_protected=NotUpdated)** Update a Job. ### Job Types ops - **class saharaclient.api.job\_types.JobTypesManager(api)** - **list(search\_opts=None)** Get a list of job types supported by plugins. ## SAHARA CLI CLIENT ### Introduction The Sahara shell utility now is part of the OpenStackClient, so all shell commands take the following form: ``` $ openstack dataprocessing [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 ``` For more information about commands and their parameters you can refer to the Sahara CLI commands. 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= export OS_PROJECT_NAME= export OS_USERNAME= export OS_PASSWORD= # (optional) ``` or command-line options: ``` --os-auth-url --os-project-name --os-username [--os-password ] ``` Additionally **sahara** API url can be configured with parameter: ``` --os-data-processing-url ``` or with environment variable: ``` export OS_DATA_PROCESSING_URL= ``` ### CLI Reference The following commands are currently supported by the Sahara CLI: ### Plugins **dataprocessing plugin configs get** Get plugin configs ``` usage: dataprocessing plugin configs get [-h] [--file ] ``` - **Positional arguments:** - Name of the plugin to provide config information about - Version of the plugin to provide config information about - **Options:** - **--file** Destination file (defaults to a combination of plugin name and plugin version) This command is provided by the python-saharaclient plugin. **dataprocessing plugin list** Lists plugins ``` usage: dataprocessing plugin list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width ] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long] ``` - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: csv, json, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--quote=nonnumeric** when to include quotes, defaults to nonnumeric Possible choices: all, minimal, none, nonnumeric - **--noindent=False** whether to disable indenting the JSON - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--sort-column=\[\]** specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated - **--long=False** List additional fields in output This command is provided by the python-saharaclient plugin. **dataprocessing plugin show** Display plugin details ``` usage: dataprocessing plugin show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] [--plugin-version ] ``` - **Positional arguments:** - Name of the plugin to display - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--plugin-version** Version of the plugin to display This command is provided by the python-saharaclient plugin. **dataprocessing plugin update** Command base class for displaying data about a single object. ``` usage: dataprocessing plugin update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] ``` - **Positional arguments:** - Name of the plugin to provide config information about - JSON representation of the plugin update dictionary - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. This command is provided by the python-saharaclient plugin. ### Images **dataprocessing image tags add** Add image tags ``` usage: dataprocessing image tags add [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] --tags [ ...] ``` - **Positional arguments:** - Name or id of the image - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--tags** Tag(s) to add \[REQUIRED\] This command is provided by the python-saharaclient plugin. **dataprocessing image list** Lists registered images ``` usage: dataprocessing image list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width ] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long] [--name ] [--tags [ ...]] [--username ] ``` - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: csv, json, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--quote=nonnumeric** when to include quotes, defaults to nonnumeric Possible choices: all, minimal, none, nonnumeric - **--noindent=False** whether to disable indenting the JSON - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--sort-column=\[\]** specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated - **--long=False** List additional fields in output - **--name** Regular expression to match image name - **--tags** List images with specific tag(s) - **--username** List images with specific username This command is provided by the python-saharaclient plugin. **dataprocessing image register** Register an image ``` usage: dataprocessing image register [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] --username [--description ] ``` - **Positional arguments:** - Name or ID of the image to register - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--username** Username of privileged user in the image \[REQUIRED\] - **--description** Description of the image. If not provided, description of the image will be reset to empty This command is provided by the python-saharaclient plugin. **dataprocessing image tags remove** Remove image tags ``` usage: dataprocessing image tags remove [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] [--tags [ ...] | --all] ``` - **Positional arguments:** - Name or id of the image - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--tags** Tag(s) to remove - **--all=False** Remove all tags from image This command is provided by the python-saharaclient plugin. **dataprocessing image tags set** Set image tags (Replace current image tags with provided ones) ``` usage: dataprocessing image tags set [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] --tags [ ...] ``` - **Positional arguments:** - Name or id of the image - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--tags** Tag(s) to set \[REQUIRED\] This command is provided by the python-saharaclient plugin. **dataprocessing image show** Display image details ``` usage: dataprocessing image show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] ``` - **Positional arguments:** - Name or id of the image to display - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. This command is provided by the python-saharaclient plugin. **dataprocessing image unregister** Unregister image(s) ``` usage: dataprocessing image unregister [-h] [ ...] ``` - **Positional arguments:** - Name(s) or id(s) of the image(s) to unregister This command is provided by the python-saharaclient plugin. ### Node Group Templates **dataprocessing node group template create** Creates node group template ``` usage: dataprocessing node group template create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] [--name ] [--plugin ] [--plugin-version ] [--processes [ ...]] [--flavor ] [--security-groups [ ...]] [--auto-security-group] [--availability-zone ] [--floating-ip-pool ] [--volumes-per-node ] [--volumes-size ] [--volumes-type ] [--volumes-availability-zone ] [--volumes-mount-prefix ] [--volumes-locality] [--description ] [--autoconfig] [--proxy-gateway] [--public] [--protected] [--json ] [--shares ] [--configs ] ``` - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--name** Name of the node group template \[REQUIRED if JSON is not provided\] - **--plugin** Name of the plugin \[REQUIRED if JSON is not provided\] - **--plugin-version** Version of the plugin \[REQUIRED if JSON is not provided\] - **--processes** List of the processes that will be launched on each instance \[REQUIRED if JSON is not provided\] - **--flavor** Name or ID of the flavor \[REQUIRED if JSON is not provided\] - **--security-groups** List of the security groups for the instances in this node group - **--auto-security-group=False** Indicates if an additional security group should be created for the node group - **--availability-zone** Name of the availability zone where instances will be created - **--floating-ip-pool** ID of the floating IP pool - **--volumes-per-node** Number of volumes attached to every node - **--volumes-size** Size of volumes attached to node (GB). This parameter will be taken into account only if volumes-per-node is set and non-zero - **--volumes-type** Type of the volumes. This parameter will be taken into account only if volumes-per-node is set and non-zero - **--volumes-availability-zone** Name of the availability zone where volumes will be created. This parameter will be taken into account only if volumes-per-node is set and non-zero - **--volumes-mount-prefix** Prefix for mount point directory. This parameter will be taken into account only if volumes-per-node is set and non-zero - **--volumes-locality=False** If enabled, instance and attached volumes will be created on the same physical host. This parameter will be taken into account only if volumes-per-node is set and non-zero - **--description** Description of the node group template - **--autoconfig=False** If enabled, instances of the node group will be automatically configured - **--proxy-gateway=False** If enabled, instances of the node group will be used to access other instances in the cluster - **--public=False** Make the node group template public (Visible from other projects) - **--protected=False** Make the node group template protected - **--json** JSON representation of the node group template. Other arguments will not be taken into account if this one is provided - **--shares** JSON representation of the manila shares - **--configs** JSON representation of the node group template configs This command is provided by the python-saharaclient plugin. **dataprocessing node group template delete** Deletes node group template ``` usage: dataprocessing node group template delete [-h] [ ...] ``` - **Positional arguments:** - Name(s) or id(s) of the node group template(s) to delete This command is provided by the python-saharaclient plugin. **dataprocessing node group template export** Export node group template to JSON ``` usage: dataprocessing node group template export [-h] [--file ] ``` - **Positional arguments:** - Name or id of the node group template to export - **Options:** - **--file** Name of the file node group template should be exported to.If not provided, print to stdout This command is provided by the python-saharaclient plugin. **dataprocessing node group template import** Imports node group template ``` usage: dataprocessing node group template import [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] [--name ] [--security_groups ] [--floating_ip_pool ] --image_id --flavor_id ``` - **Positional arguments:** - JSON containing node group template - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--name** Name of the node group template - **--security\_groups** Security groups of the node group template - **--floating\_ip\_pool** Floating IP pool of the node group template - **--image\_id** Image ID of the node group template - **--flavor\_id** Flavor ID of the node group template This command is provided by the python-saharaclient plugin. **dataprocessing node group template list** Lists node group templates ``` usage: dataprocessing node group template list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width ] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long] [--plugin ] [--plugin-version ] [--name ] ``` - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: csv, json, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--quote=nonnumeric** when to include quotes, defaults to nonnumeric Possible choices: all, minimal, none, nonnumeric - **--noindent=False** whether to disable indenting the JSON - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--sort-column=\[\]** specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated - **--long=False** List additional fields in output - **--plugin** List node group templates for specific plugin - **--plugin-version** List node group templates with specific version of the plugin - **--name** List node group templates with specific substring in the name This command is provided by the python-saharaclient plugin. **dataprocessing node group template show** Display node group template details ``` usage: dataprocessing node group template show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] ``` - **Positional arguments:** - Name or id of the node group template to display - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. This command is provided by the python-saharaclient plugin. **dataprocessing node group template update** Updates node group template ``` usage: dataprocessing node group template update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] [--name ] [--plugin ] [--plugin-version ] [--processes [ ...]] [--security-groups [ ...]] [--auto-security-group-enable | --auto-security-group-disable] [--availability-zone ] [--flavor ] [--floating-ip-pool ] [--volumes-per-node ] [--volumes-size ] [--volumes-type ] [--volumes-availability-zone ] [--volumes-mount-prefix ] [--volumes-locality-enable | --volumes-locality-disable] [--description ] [--autoconfig-enable | --autoconfig-disable] [--proxy-gateway-enable | --proxy-gateway-disable] [--public | --private] [--protected | --unprotected] [--json ] [--shares ] [--configs ] ``` - **Positional arguments:** - Name or ID of the node group template - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--name** New name of the node group template - **--plugin** Name of the plugin - **--plugin-version** Version of the plugin - **--processes** List of the processes that will be launched on each instance - **--security-groups** List of the security groups for the instances in this node group - **--auto-security-group-enable** Additional security group should be created for the node group - **--auto-security-group-disable** Additional security group should not be created for the node group - **--availability-zone** Name of the availability zone where instances will be created - **--flavor** Name or ID of the flavor - **--floating-ip-pool** ID of the floating IP pool - **--volumes-per-node** Number of volumes attached to every node - **--volumes-size** Size of volumes attached to node (GB). This parameter will be taken into account only if volumes-per-node is set and non-zero - **--volumes-type** Type of the volumes. This parameter will be taken into account only if volumes-per-node is set and non-zero - **--volumes-availability-zone** Name of the availability zone where volumes will be created. This parameter will be taken into account only if volumes-per-node is set and non-zero - **--volumes-mount-prefix** Prefix for mount point directory. This parameter will be taken into account only if volumes-per-node is set and non-zero - **--volumes-locality-enable** Instance and attached volumes will be created on the same physical host. This parameter will be taken into account only if volumes-per-node is set and non-zero - **--volumes-locality-disable** Instance and attached volumes creation on the same physical host will not be regulated. This parameter will be takeninto account only if volumes-per-node is set and non-zero - **--description** Description of the node group template - **--autoconfig-enable** Instances of the node group will be automatically configured - **--autoconfig-disable** Instances of the node group will not be automatically configured - **--proxy-gateway-enable** Instances of the node group will be used to access other instances in the cluster - **--proxy-gateway-disable** Instances of the node group will not be used to access other instances in the cluster - **--public** Make the node group template public (Visible from other projects) - **--private** Make the node group template private (Visible only from this project) - **--protected** Make the node group template protected - **--unprotected** Make the node group template unprotected - **--json** JSON representation of the node group template update fields. Other arguments will not be taken into account if this one is provided - **--shares** JSON representation of the manila shares - **--configs** JSON representation of the node group template configs This command is provided by the python-saharaclient plugin. ### Cluster Templates **dataprocessing cluster template create** Creates cluster template ``` usage: dataprocessing cluster template create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] [--name ] [--node-groups [ ...]] [--anti-affinity [ ...]] [--description ] [--autoconfig] [--public] [--protected] [--json ] [--shares ] [--configs ] [--domain-name ] ``` - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--name** Name of the cluster template \[REQUIRED if JSON is not provided\] - **--node-groups** List of the node groups(names or IDs) and numbers of instances for each one of them \[REQUIRED if JSON is not provided\] - **--anti-affinity** List of processes that should be added to an anti-affinity group - **--description** Description of the cluster template - **--autoconfig=False** If enabled, instances of the cluster will be automatically configured - **--public=False** Make the cluster template public (Visible from other projects) - **--protected=False** Make the cluster template protected - **--json** JSON representation of the cluster template. Other arguments will not be taken into account if this one is provided - **--shares** JSON representation of the manila shares - **--configs** JSON representation of the cluster template configs - **--domain-name** Domain name for instances of this cluster template. This option is available if 'use\_designate' config is True This command is provided by the python-saharaclient plugin. **dataprocessing cluster template delete** Deletes cluster template ``` usage: dataprocessing cluster template delete [-h] [ ...] ``` - **Positional arguments:** - Name(s) or id(s) of the cluster template(s) to delete This command is provided by the python-saharaclient plugin. **dataprocessing cluster template export** Export cluster template to JSON ``` usage: dataprocessing cluster template export [-h] [--file ] ``` - **Positional arguments:** - Name or id of the cluster template to export - **Options:** - **--file** Name of the file cluster template should be exported to If not provided, print to stdout This command is provided by the python-saharaclient plugin. **dataprocessing cluster template import** Imports cluster template ``` usage: dataprocessing cluster template import [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] [--name ] [--default-image-id ] --node-groups [ ...] ``` - **Positional arguments:** - JSON containing cluster template - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--name** Name of the cluster template - **--default-image-id** Default image ID to be used - **--node-groups** List of the node groups(names or IDs) and numbers of instances for each one of them This command is provided by the python-saharaclient plugin. **dataprocessing cluster template list** Lists cluster templates ``` usage: dataprocessing cluster template list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width ] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long] [--plugin ] [--plugin-version ] [--name ] ``` - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: csv, json, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--quote=nonnumeric** when to include quotes, defaults to nonnumeric Possible choices: all, minimal, none, nonnumeric - **--noindent=False** whether to disable indenting the JSON - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--sort-column=\[\]** specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated - **--long=False** List additional fields in output - **--plugin** List cluster templates for specific plugin - **--plugin-version** List cluster templates with specific version of the plugin - **--name** List cluster templates with specific substring in the name This command is provided by the python-saharaclient plugin. **dataprocessing cluster template show** Display cluster template details ``` usage: dataprocessing cluster template show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] ``` - **Positional arguments:** - Name or id of the cluster template to display - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. This command is provided by the python-saharaclient plugin. **dataprocessing cluster template update** Updates cluster template ``` usage: dataprocessing cluster template update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] [--name ] [--node-groups [ ...]] [--anti-affinity [ ...]] [--description ] [--autoconfig-enable | --autoconfig-disable] [--public | --private] [--protected | --unprotected] [--json ] [--shares ] [--configs ] [--domain-name ] ``` - **Positional arguments:** - Name or ID of the cluster template \[REQUIRED\] - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--name** New name of the cluster template - **--node-groups** List of the node groups(names or IDs) and numbers ofinstances for each one of them - **--anti-affinity** List of processes that should be added to an anti-affinity group - **--description** Description of the cluster template - **--autoconfig-enable** Instances of the cluster will be automatically configured - **--autoconfig-disable** Instances of the cluster will not be automatically configured - **--public** Make the cluster template public (Visible from other projects) - **--private** Make the cluster template private (Visible only from this tenant) - **--protected** Make the cluster template protected - **--unprotected** Make the cluster template unprotected - **--json** JSON representation of the cluster template. Other arguments will not be taken into account if this one is provided - **--shares** JSON representation of the manila shares - **--configs** JSON representation of the cluster template configs - **--domain-name** Domain name for instances of this cluster template. This option is available if 'use\_designate' config is True This command is provided by the python-saharaclient plugin. ### Clusters **dataprocessing cluster create** Creates cluster ``` usage: dataprocessing cluster create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] [--name ] [--cluster-template ] [--image ] [--description ] [--user-keypair ] [--neutron-network ] [--count ] [--public] [--protected] [--transient] [--json ] [--wait] ``` - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--name** Name of the cluster \[REQUIRED if JSON is not provided\] - **--cluster-template** Cluster template name or ID \[REQUIRED if JSON is not provided\] - **--image** Image that will be used for cluster deployment (Name or ID) \[REQUIRED if JSON is not provided\] - **--description** Description of the cluster - **--user-keypair** User keypair to get acces to VMs after cluster creation - **--neutron-network** Instances of the cluster will get fixed IP addresses in this network. (Name or ID should be provided) - **--count** Number of clusters to be created - **--public=False** Make the cluster public (Visible from other projects) - **--protected=False** Make the cluster protected - **--transient=False** Create transient cluster - **--json** JSON representation of the cluster. Other arguments (except for --wait) will not be taken into account if this one is provided - **--wait=False** Wait for the cluster creation to complete This command is provided by the python-saharaclient plugin. **dataprocessing cluster delete** Deletes cluster ``` usage: dataprocessing cluster delete [-h] [--wait] [ ...] ``` - **Positional arguments:** - Name(s) or id(s) of the cluster(s) to delete - **Options:** - **--wait=False** Wait for the cluster(s) delete to complete This command is provided by the python-saharaclient plugin. **dataprocessing cluster list** Lists clusters ``` usage: dataprocessing cluster list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width ] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long] [--plugin ] [--plugin-version ] [--name ] ``` - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: csv, json, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--quote=nonnumeric** when to include quotes, defaults to nonnumeric Possible choices: all, minimal, none, nonnumeric - **--noindent=False** whether to disable indenting the JSON - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--sort-column=\[\]** specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated - **--long=False** List additional fields in output - **--plugin** List clusters with specific plugin - **--plugin-version** List clusters with specific version of the plugin - **--name** List clusters with specific substring in the name This command is provided by the python-saharaclient plugin. **dataprocessing cluster scale** Scales cluster ``` usage: dataprocessing cluster scale [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] [--instances [ ...]] [--json ] [--wait] ``` - **Positional arguments:** - Name or ID of the cluster - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--instances** Node group templates and number of their instances to be scale to \[REQUIRED if JSON is not provided\] - **--json** JSON representation of the cluster scale object. Other arguments (except for --wait) will not be taken into account if this one is provided - **--wait=False** Wait for the cluster scale to complete This command is provided by the python-saharaclient plugin. **dataprocessing cluster show** Display cluster details ``` usage: dataprocessing cluster show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] [--verification] [--show-progress] [--full-dump-events] ``` - **Positional arguments:** - Name or id of the cluster to display - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--verification=False** List additional fields for verifications - **--show-progress=False** Provides ability to show brief details of event logs. - **--full-dump-events=False** Provides ability to make full dump with event log details. This command is provided by the python-saharaclient plugin. **dataprocessing cluster verification** Updates cluster ``` usage: dataprocessing cluster verification [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] [--name ] [--description ] [--shares ] [--public | --private] [--protected | --unprotected] ``` - **Positional arguments:** - Name or ID of the cluster - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--name** New name of the cluster - **--description** Description of the cluster - **--shares** JSON representation of the manila shares - **--public** Make the cluster public (Visible from other projects) - **--private** Make the cluster private (Visible only from this tenant) - **--protected** Make the cluster protected - **--unprotected** Make the cluster unprotected This command is provided by the python-saharaclient plugin. **dataprocessing cluster verification** Updates cluster verifications ``` usage: dataprocessing cluster verification [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] (--start | --show) ``` - **Positional arguments:** - Name or ID of the cluster - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--start** Start health verification for the cluster - **--show=False** Show health of the cluster This command is provided by the python-saharaclient plugin. ### Data Sources **dataprocessing data source create** Creates data source ``` usage: dataprocessing data source create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] --type --url [--username | --access-key ] [--password | --secret-key ] [--s3-endpoint ] [--enable-s3-ssl | --disable-s3-ssl] [--enable-s3-bucket-in-path | --disable-s3-bucket-in-path] [--description ] [--public] [--protected] ``` - **Positional arguments:** - Name of the data source - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--type** Type of the data source (swift, hdfs, maprfs, manila, s3) \[REQUIRED\] Possible choices: swift, hdfs, maprfs, manila, s3 - **--url** URL for the data source \[REQUIRED\] - **--username** Username for accessing the data source URL - **--access-key** S3 access key for accessing the data source URL - **--password** Password for accessing the data source URL - **--secret-key** S3 secret key for accessing the data source URL - **--s3-endpoint** S3 endpoint for accessing the data source URL (ignored if data source not in S3) - **--enable-s3-ssl=False** Enable access to S3 endpoint using SSL (ignored if data source not in S3) - **--disable-s3-ssl=True** Disable access to S3 endpoint using SSL (ignored if data source not in S3) - **--enable-s3-bucket-in-path=False** Access S3 endpoint using bucket name in path (ignored if data source not in S3) - **--disable-s3-bucket-in-path=True** Access S3 endpoint using bucket name in path (ignored if data source not in S3) - **--description** Description of the data source - **--public=False** Make the data source public - **--protected=False** Make the data source protected This command is provided by the python-saharaclient plugin. **dataprocessing data source delete** Delete data source ``` usage: dataprocessing data source delete [-h] [ ...] ``` - **Positional arguments:** - Name(s) or id(s) of the data source(s) to delete This command is provided by the python-saharaclient plugin. **dataprocessing data source list** Lists data sources ``` usage: dataprocessing data source list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width ] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long] [--type ] ``` - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: csv, json, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--quote=nonnumeric** when to include quotes, defaults to nonnumeric Possible choices: all, minimal, none, nonnumeric - **--noindent=False** whether to disable indenting the JSON - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--sort-column=\[\]** specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated - **--long=False** List additional fields in output - **--type** List data sources of specific type (swift, hdfs, maprfs, manila, s3) Possible choices: swift, hdfs, maprfs, manila, s3 This command is provided by the python-saharaclient plugin. **dataprocessing data source show** Display data source details ``` usage: dataprocessing data source show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] ``` - **Positional arguments:** - Name or id of the data source to display - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. This command is provided by the python-saharaclient plugin. **dataprocessing data source update** Update data source ``` usage: dataprocessing data source update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] [--name ] [--type ] [--url ] [--username | --access-key ] [--password | --secret-key ] [--s3-endpoint ] [--enable-s3-ssl | --disable-s3-ssl] [--enable-s3-bucket-in-path | --disable-s3-bucket-in-path] [--description ] [--public | --private] [--protected | --unprotected] ``` - **Positional arguments:** - Name or id of the data source - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--name** New name of the data source - **--type** Type of the data source (swift, hdfs, maprfs, manila, s3) Possible choices: swift, hdfs, maprfs, manila, s3 - **--url** URL for the data source - **--username** Username for accessing the data source URL - **--access-key** S3 access key for accessing the data source URL - **--password** Password for accessing the data source URL - **--secret-key** S3 secret key for accessing the data source URL - **--s3-endpoint** S3 endpoint for accessing the data source URL (ignored if data source not in S3) - **--enable-s3-ssl=False** Enable access to S3 endpoint using SSL (ignored if data source not in S3) - **--disable-s3-ssl=True** Disable access to S3 endpoint using SSL (ignored if data source not in S3) - **--enable-s3-bucket-in-path=False** Access S3 endpoint using bucket name in path (ignored if data source not in S3) - **--disable-s3-bucket-in-path=True** Access S3 endpoint using bucket name in path (ignored if data source not in S3) - **--description** Description of the data source - **--public** Make the data source public (Visible from other projects) - **--private** Make the data source private (Visible only from this tenant) - **--protected** Make the data source protected - **--unprotected** Make the data source unprotected This command is provided by the python-saharaclient plugin. ### Job Binaries **dataprocessing job binary create** Creates job binary ``` usage: dataprocessing job binary create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] [--name ] [--data | --url ] [--description ] [--username | --access-key ] [--password | --secret-key | --password-prompt | --secret-key-prompt] [--s3-endpoint ] [--public] [--protected] [--json ] ``` - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--name** Name of the job binary \[REQUIRED if JSON is not provided\] - **--data** File that will be stored in the internal DB \[REQUIRED if JSON and URL are not provided\] - **--url** URL for the job binary \[REQUIRED if JSON and file are not provided\] - **--description** Description of the job binary - **--username** Username for accessing the job binary URL - **--access-key** S3 access key for accessing the job binary URL - **--password** Password for accessing the job binary URL - **--secret-key** S3 secret key for accessing the job binary URL - **--password-prompt=False** Prompt interactively for password - **--secret-key-prompt=False** Prompt interactively for S3 secret key - **--s3-endpoint** S3 endpoint for accessing the job binary URL (ignored if binary not in S3 - **--public=False** Make the job binary public - **--protected=False** Make the job binary protected - **--json** JSON representation of the job binary. Other arguments will not be taken into account if this one is provided This command is provided by the python-saharaclient plugin. **dataprocessing job binary delete** Deletes job binary ``` usage: dataprocessing job binary delete [-h] [ ...] ``` - **Positional arguments:** - Name(s) or id(s) of the job binary(ies) to delete This command is provided by the python-saharaclient plugin. **dataprocessing job binary download** Downloads job binary ``` usage: dataprocessing job binary download [-h] [--file ] ``` - **Positional arguments:** - Name or ID of the job binary to download - **Options:** - **--file** Destination file (defaults to job binary name) This command is provided by the python-saharaclient plugin. **dataprocessing job binary list** Lists job binaries ``` usage: dataprocessing job binary list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width ] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long] [--name ] ``` - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: csv, json, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--quote=nonnumeric** when to include quotes, defaults to nonnumeric Possible choices: all, minimal, none, nonnumeric - **--noindent=False** whether to disable indenting the JSON - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--sort-column=\[\]** specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated - **--long=False** List additional fields in output - **--name** List job binaries with specific substring in the name This command is provided by the python-saharaclient plugin. **dataprocessing job binary show** Display job binary details ``` usage: dataprocessing job binary show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] ``` - **Positional arguments:** - Name or ID of the job binary to display - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. This command is provided by the python-saharaclient plugin. **dataprocessing job binary update** Updates job binary ``` usage: dataprocessing job binary update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] [--name ] [--url ] [--description ] [--username | --access-key ] [--password | --secret-key | --password-prompt | --secret-key-prompt] [--s3-endpoint ] [--public | --private] [--protected | --unprotected] [--json ] ``` - **Positional arguments:** - Name or ID of the job binary - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--name** New name of the job binary - **--url** URL for the job binary \[Internal DB URL can not be updated\] - **--description** Description of the job binary - **--username** Username for accessing the job binary URL - **--access-key** S3 access key for accessing the job binary URL - **--password** Password for accessing the job binary URL - **--secret-key** S3 secret key for accessing the job binary URL - **--password-prompt=False** Prompt interactively for password - **--secret-key-prompt=False** Prompt interactively for S3 secret key - **--s3-endpoint** S3 endpoint for accessing the job binary URL (ignored if binary not in S3 - **--public** Make the job binary public (Visible from other projects) - **--private** Make the job binary private (Visible only from this project) - **--protected** Make the job binary protected - **--unprotected** Make the job binary unprotected - **--json** JSON representation of the update object. Other arguments will not be taken into account if this one is provided This command is provided by the python-saharaclient plugin. ### Job Types **dataprocessing job type configs get** Get job type configs ``` usage: dataprocessing job type configs get [-h] [--file ] ``` - **Positional arguments:** - Type of the job to provide config information about Possible choices: Hive, Java, MapReduce, Storm, Storm.Pyleus, Pig, Shell, MapReduce.Streaming, Spark - **Options:** - **--file** Destination file (defaults to job type) This command is provided by the python-saharaclient plugin. **dataprocessing job type list** Lists job types supported by plugins ``` usage: dataprocessing job type list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width ] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--type ] [--plugin ] [--plugin-version ] ``` - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: csv, json, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--quote=nonnumeric** when to include quotes, defaults to nonnumeric Possible choices: all, minimal, none, nonnumeric - **--noindent=False** whether to disable indenting the JSON - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--sort-column=\[\]** specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated - **--type** Get information about specific job type Possible choices: Hive, Java, MapReduce, Storm, Storm.Pyleus, Pig, Shell, MapReduce.Streaming, Spark - **--plugin** Get only job types supported by this plugin - **--plugin-version** Get only job types supported by specific version of the plugin. This parameter will be taken into account only if plugin is provided This command is provided by the python-saharaclient plugin. ### Job Templates **dataprocessing job template create** Creates job template ``` usage: dataprocessing job template create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] [--name ] [--type ] [--mains
[
...]] [--libs [ ...]] [--description ] [--public] [--protected] [--interface ] [--json ] ``` - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--name** Name of the job template \[REQUIRED if JSON is not provided\] - **--type** Type of the job (Hive, Java, MapReduce, Storm, Storm.Pyleus, Pig, Shell, MapReduce.Streaming, Spark) \[REQUIRED if JSON is not provided\] Possible choices: Hive, Java, MapReduce, Storm, Storm.Pyleus, Pig, Shell, MapReduce.Streaming, Spark - **--mains** Name(s) or ID(s) for job's main job binary(s) - **--libs** Name(s) or ID(s) for job's lib job binary(s) - **--description** Description of the job template - **--public=False** Make the job template public - **--protected=False** Make the job template protected - **--interface** JSON representation of the interface - **--json** JSON representation of the job template This command is provided by the python-saharaclient plugin. **dataprocessing job template delete** Deletes job template ``` usage: dataprocessing job template delete [-h] [ ...] ``` - **Positional arguments:** - Name(s) or id(s) of the job template(s) to delete This command is provided by the python-saharaclient plugin. **dataprocessing job template list** Lists job templates ``` usage: dataprocessing job template list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width ] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long] [--type ] [--name ] ``` - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: csv, json, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--quote=nonnumeric** when to include quotes, defaults to nonnumeric Possible choices: all, minimal, none, nonnumeric - **--noindent=False** whether to disable indenting the JSON - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--sort-column=\[\]** specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated - **--long=False** List additional fields in output - **--type** List job templates of specific type Possible choices: Hive, Java, MapReduce, Storm, Storm.Pyleus, Pig, Shell, MapReduce.Streaming, Spark - **--name** List job templates with specific substring in the name This command is provided by the python-saharaclient plugin. **dataprocessing job template show** Display job template details ``` usage: dataprocessing job template show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] ``` - **Positional arguments:** - Name or ID of the job template to display - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. This command is provided by the python-saharaclient plugin. **dataprocessing job template update** Updates job template ``` usage: dataprocessing job template update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] [--name ] [--description ] [--public | --private] [--protected | --unprotected] ``` - **Positional arguments:** - Name or ID of the job template - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--name** New name of the job template - **--description** Description of the job template - **--public** Make the job template public (Visible from other projects) - **--private** Make the job\_template private (Visible only from this tenant) - **--protected** Make the job template protected - **--unprotected** Make the job template unprotected This command is provided by the python-saharaclient plugin. ### Jobs **dataprocessing job binary delete** Deletes job ``` usage: dataprocessing job binary delete [-h] [--wait] [ ...] ``` - **Positional arguments:** - ID(s) of the job(s) to delete - **Options:** - **--wait=False** Wait for the job(s) delete to complete This command is provided by the python-saharaclient plugin. **dataprocessing job execute** Executes job ``` usage: dataprocessing job execute [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] [--job-template ] [--cluster ] [--input ] [--output ] [--params [ ...]] [--args [ ...]] [--public] [--protected] [--config-json | --configs [ ...]] [--interface ] [--json ] ``` - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--job-template** Name or ID of the job template \[REQUIRED if JSON is not provided\] - **--cluster** Name or ID of the cluster \[REQUIRED if JSON is not provided\] - **--input** Name or ID of the input data source - **--output** Name or ID of the output data source - **--params** Parameters to add to the job - **--args** Arguments to add to the job - **--public=False** Make the job public - **--protected=False** Make the job protected - **--config-json** JSON representation of the job configs - **--configs** Configs to add to the job - **--interface** JSON representation of the interface - **--json** JSON representation of the job. Other arguments will not be taken into account if this one is provided This command is provided by the python-saharaclient plugin. **dataprocessing job list** Lists jobs ``` usage: dataprocessing job list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width ] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long] [--status ] ``` - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: csv, json, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--quote=nonnumeric** when to include quotes, defaults to nonnumeric Possible choices: all, minimal, none, nonnumeric - **--noindent=False** whether to disable indenting the JSON - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--sort-column=\[\]** specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated - **--long=False** List additional fields in output - **--status** List jobs with specific status Possible choices: done-with-error, failed, killed, pending, running, succeeded, to-be-killed This command is provided by the python-saharaclient plugin. **dataprocessing job binary show** Display job details ``` usage: dataprocessing job binary show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] ``` - **Positional arguments:** - ID of the job to display - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. This command is provided by the python-saharaclient plugin. **dataprocessing job binary update** Updates job ``` usage: dataprocessing job binary update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width ] [--fit-width] [--print-empty] [--public | --private] [--protected | --unprotected] ``` - **Positional arguments:** - ID of the job to update - **Options:** - **-f=table, --format=table** the output format, defaults to table Possible choices: json, shell, table, value, yaml - **-c=\[\], --column=\[\]** specify the column(s) to include, can be repeated - **--noindent=False** whether to disable indenting the JSON - **--prefix=** add a prefix to all variable names - **--max-width=0** Maximum display width, \<1 to disable. You can also use the CLIFF\_MAX\_TERM\_WIDTH environment variable, but the parameter takes precedence. - **--fit-width=False** Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF\_FIT\_WIDTH=1 to always enable - **--print-empty=False** Print empty table if there is no data to show. - **--public** Make the job public (Visible from other projects) - **--private** Make the job private (Visible only from this project) - **--protected** Make the job protected - **--unprotected** Make the job unprotected This command is provided by the python-saharaclient plugin. ## CONTRIBUTING **python-saharaclient** is part of the Sahara project. It has a separate *storyboard* page which should be used to report bugs. Like the other projects of the OpenStack community, code contribution happens through *gerrit*. Please refer to the *Sahara documentation* and its *How to Participate section* for more information on how to contribute to the project. ## AUTHOR OpenStack Foundation ## COPYRIGHT 2019, OpenStack Foundation