.\" Man page generated from reStructuredText. . .TH "SAHARACLIENT" "1" "May 30, 2016" "0.14.0" "Sahara Client" .SH NAME saharaclient \- Sahara Client . .nr rst2man-indent-level 0 . .de1 rstReportMargin \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .de1 INDENT .\" .rstReportMargin pre: . RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .\" .rstReportMargin post: .. .de UNINDENT . RE .\" indent \\n[an-margin] .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] .nr rst2man-indent-level -1 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. .sp This is a client for OpenStack Sahara API. There\(aqs \fBa Python API\fP (the \fBsaharaclient\fP module), and a \fBcommand\-line utility\fP (installed as an OpenStackClient plugin). Each implements the entire OpenStack Sahara API. .sp You\(aqll need credentials for an OpenStack cloud that implements the Data Processing API, in order to use the sahara client. .sp You may want to read the \fI\%OpenStack Sahara Docs\fP \-\- the overview, at least \-\- to get an idea of the concepts. By understanding the concepts this library should make more sense. .INDENT 0.0 .INDENT 3.5 .UNINDENT .UNINDENT .sp Contents: .SH SAHARA CLIENT .SS Overview .sp 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. .SS Instantiating a Client .sp To start using the Sahara Client users have to create an instance of the \fIClient\fP class. The client constructor has a list of parameters to authenticate and locate Sahara endpoint. .INDENT 0.0 .TP .B class saharaclient.api.client.Client(username=None, api_key=None, project_id=None, project_name=None, auth_url=None, sahara_url=None, endpoint_type=\(aqpublicURL\(aq, service_type=\(aqdata\-processing\(aq, input_auth_token=None, session=None, auth=None, insecure=False, cacert=None, region_name=None, **kwargs) Client for the OpenStack Data Processing v1 API. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBusername\fP (\fIstr\fP) \-\- Username for Keystone authentication. .IP \(bu 2 \fBapi_key\fP (\fIstr\fP) \-\- Password for Keystone authentication. .IP \(bu 2 \fBproject_id\fP (\fIstr\fP) \-\- Keystone Tenant id. .IP \(bu 2 \fBproject_name\fP (\fIstr\fP) \-\- Keystone Tenant name. .IP \(bu 2 \fBauth_url\fP (\fIstr\fP) \-\- Keystone URL that will be used for authentication. .IP \(bu 2 \fBsahara_url\fP (\fIstr\fP) \-\- Sahara REST API URL to communicate with. .IP \(bu 2 \fBendpoint_type\fP (\fIstr\fP) \-\- Desired Sahara endpoint type. .IP \(bu 2 \fBservice_type\fP (\fIstr\fP) \-\- Sahara service name in Keystone catalog. .IP \(bu 2 \fBinput_auth_token\fP (\fIstr\fP) \-\- Keystone authorization token. .IP \(bu 2 \fBsession\fP \-\- Keystone Session object. .IP \(bu 2 \fBauth\fP \-\- Keystone Authentication Plugin object. .IP \(bu 2 \fBinsecure\fP (\fIboolean\fP) \-\- Allow insecure. .IP \(bu 2 \fBcacert\fP (\fIstring\fP) \-\- Path to the Privacy Enhanced Mail (PEM) file which contains certificates needed to establish SSL connection with the identity service. .IP \(bu 2 \fBregion_name\fP (\fIstring\fP) \-\- Name of a region to select when choosing an endpoint from the service catalog. .UNINDENT .UNINDENT .UNINDENT .INDENT 0.0 .TP .B \fBImportant!\fP 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. .UNINDENT .SS Authentication check .sp Passing authentication parameters to Sahara Client is deprecated. Keystone Session object should be used for this purpose. For example: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C 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(\(aq1.1\(aq, session=ses) .ft P .fi .UNINDENT .UNINDENT .sp For more information about Keystone Sessions, see \fI\%Using Sessions\fP\&. .SS Sahara endpoint discovery .sp If user has a direct URL pointing to Sahara REST API, it may be specified as \fIsahara_url\fP\&. If this parameter is missing, Sahara client will use Keystone Service Catalog to find the endpoint. There are two parameters: \fIservice_type\fP and \fIendpoint_type\fP to configure endpoint search. Both parameters have default values. .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C 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(\(aq1.1\(aq, session=ses, service_type="non\-default\-service\-type", endpoint_type="internalURL") .ft P .fi .UNINDENT .UNINDENT .SS Object managers .sp Sahara Client has a list of fields to operate with: .INDENT 0.0 .INDENT 3.5 .INDENT 0.0 .IP \(bu 2 plugins .IP \(bu 2 clusters .IP \(bu 2 cluster_templates .IP \(bu 2 node_group_templates .IP \(bu 2 images .IP \(bu 2 data_sources .IP \(bu 2 job_binaries .IP \(bu 2 job_binary_internals .IP \(bu 2 job_executions .IP \(bu 2 job_types .UNINDENT .UNINDENT .UNINDENT .sp Each of this fields is a reference to a Manager for a corresponding group of REST calls. .SS Supported operations .SS Plugin ops .INDENT 0.0 .TP .B class saharaclient.api.plugins.PluginManager(api) .INDENT 7.0 .TP .B convert_to_cluster_template(plugin_name, hadoop_version, template_name, filecontent) Convert to cluster template .sp Create Cluster Template directly, avoiding Cluster Template mechanism. .UNINDENT .INDENT 7.0 .TP .B get(plugin_name) Get information about a Plugin. .UNINDENT .INDENT 7.0 .TP .B get_version_details(plugin_name, hadoop_version) Get version details .sp Get the list of Services and Service Parameters for a specified Plugin and Plugin Version. .UNINDENT .INDENT 7.0 .TP .B list(search_opts=None) Get a list of Plugins. .UNINDENT .UNINDENT .SS Image Registry ops .INDENT 0.0 .TP .B class saharaclient.api.images.ImageManager(api) .INDENT 7.0 .TP .B get(id) Get information about an image .UNINDENT .INDENT 7.0 .TP .B list(search_opts=None) Get a list of registered images. .UNINDENT .INDENT 7.0 .TP .B unregister_image(image_id) Remove an Image from Sahara Image Registry. .UNINDENT .INDENT 7.0 .TP .B update_image(image_id, user_name, desc=None) Create or update an Image in Image Registry. .UNINDENT .INDENT 7.0 .TP .B update_tags(image_id, new_tags) Update an Image tags. .INDENT 7.0 .TP .B Parameters \fBnew_tags\fP (\fIlist\fP) \-\- list of tags that will replace currently assigned tags .UNINDENT .UNINDENT .UNINDENT .SS Node Group Template ops .INDENT 0.0 .TP .B class saharaclient.api.node_group_templates.NodeGroupTemplateManager(api) .INDENT 7.0 .TP .B 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. .UNINDENT .INDENT 7.0 .TP .B delete(ng_template_id) Delete a Node Group Template. .UNINDENT .INDENT 7.0 .TP .B get(ng_template_id) Get information about a Node Group Template. .UNINDENT .INDENT 7.0 .TP .B list(search_opts=None) Get a list of Node Group Templates. .UNINDENT .INDENT 7.0 .TP .B 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. .UNINDENT .UNINDENT .SS Cluster Template ops .INDENT 0.0 .TP .B class saharaclient.api.cluster_templates.ClusterTemplateManager(api) .INDENT 7.0 .TP .B 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) Create a Cluster Template. .UNINDENT .INDENT 7.0 .TP .B delete(cluster_template_id) Delete a Cluster Template. .UNINDENT .INDENT 7.0 .TP .B get(cluster_template_id) Get information about a Cluster Template. .UNINDENT .INDENT 7.0 .TP .B list(search_opts=None) Get list of Cluster Templates. .UNINDENT .INDENT 7.0 .TP .B 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) Update a Cluster Template. .UNINDENT .UNINDENT .SS Cluster ops .INDENT 0.0 .TP .B class saharaclient.api.clusters.ClusterManager(api) .INDENT 7.0 .TP .B 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. .UNINDENT .INDENT 7.0 .TP .B delete(cluster_id) Delete a Cluster. .UNINDENT .INDENT 7.0 .TP .B get(cluster_id, show_progress=False) Get information about a Cluster. .UNINDENT .INDENT 7.0 .TP .B list(search_opts=None) Get a list of Clusters. .UNINDENT .INDENT 7.0 .TP .B scale(cluster_id, scale_object) Scale an existing Cluster. .INDENT 7.0 .TP .B Parameters \fBscale_object\fP \-\- dict that describes scaling operation .TP .B Example .UNINDENT .sp The following \fIscale_object\fP can be used to change the number of instances in the node group and add instances of new node group to existing cluster: .INDENT 7.0 .INDENT 3.5 .sp .nf .ft C { "add_node_groups": [ { "count": 3, "name": "new_ng", "node_group_template_id": "ngt_id" } ], "resize_node_groups": [ { "count": 2, "name": "old_ng" } ] } .ft P .fi .UNINDENT .UNINDENT .UNINDENT .INDENT 7.0 .TP .B update(cluster_id, name=NotUpdated, description=NotUpdated, is_public=NotUpdated, is_protected=NotUpdated, shares=NotUpdated) Update a Cluster. .UNINDENT .INDENT 7.0 .TP .B verification_update(cluster_id, status) Start a verification for a Cluster. .UNINDENT .UNINDENT .SS Data Source ops .INDENT 0.0 .TP .B class saharaclient.api.data_sources.DataSourceManager(api) .INDENT 7.0 .TP .B create(name, description, data_source_type, url, credential_user=None, credential_pass=None, is_public=None, is_protected=None) Create a Data Source. .UNINDENT .INDENT 7.0 .TP .B delete(data_source_id) Delete a Data Source. .UNINDENT .INDENT 7.0 .TP .B get(data_source_id) Get information about a Data Source. .UNINDENT .INDENT 7.0 .TP .B list(search_opts=None) Get a list of Data Sources. .UNINDENT .INDENT 7.0 .TP .B update(data_source_id, update_data) Update a Data Source. .INDENT 7.0 .TP .B Parameters \fBupdate_data\fP (\fIdict\fP) \-\- dict that contains fields that should be updated with new values. .UNINDENT .sp Fields that can be updated: .INDENT 7.0 .IP \(bu 2 name .IP \(bu 2 description .IP \(bu 2 type .IP \(bu 2 url .IP \(bu 2 is_public .IP \(bu 2 is_protected .IP \(bu 2 credentials \- dict with \fIuser\fP and \fIpassword\fP keyword arguments .UNINDENT .UNINDENT .UNINDENT .SS Job Binary Internal ops .INDENT 0.0 .TP .B class saharaclient.api.job_binary_internals.JobBinaryInternalsManager(api) .INDENT 7.0 .TP .B create(name, data) Create a Job Binary Internal. .INDENT 7.0 .TP .B Parameters \fBdata\fP (\fIstr\fP) \-\- raw data ot script text .UNINDENT .UNINDENT .INDENT 7.0 .TP .B update(job_binary_id, name=NotUpdated, is_public=NotUpdated, is_protected=NotUpdated) Update a Job Binary Internal. .UNINDENT .UNINDENT .SS Job Binary ops .INDENT 0.0 .TP .B class saharaclient.api.job_binaries.JobBinariesManager(api) .INDENT 7.0 .TP .B create(name, url, description=None, extra=None, is_public=None, is_protected=None) Create a Job Binary. .UNINDENT .INDENT 7.0 .TP .B delete(job_binary_id) Delete a Job Binary. .UNINDENT .INDENT 7.0 .TP .B get(job_binary_id) Get information about a Job Binary. .UNINDENT .INDENT 7.0 .TP .B get_file(job_binary_id) Download a Job Binary. .UNINDENT .INDENT 7.0 .TP .B list(search_opts=None) Get a list of Job Binaries. .UNINDENT .INDENT 7.0 .TP .B update(job_binary_id, data) Update Job Binary. .INDENT 7.0 .TP .B Parameters \fBdata\fP (\fIdict\fP) \-\- dict that contains fields that should be updated with new values. .UNINDENT .sp Fields that can be updated: .INDENT 7.0 .IP \(bu 2 name .IP \(bu 2 description .IP \(bu 2 url .IP \(bu 2 is_public .IP \(bu 2 is_protected .IP \(bu 2 extra \- dict with \fIuser\fP and \fIpassword\fP keyword arguments .UNINDENT .UNINDENT .UNINDENT .SS Job ops .INDENT 0.0 .TP .B class saharaclient.api.jobs.JobsManager(api) .INDENT 7.0 .TP .B create(name, type, mains=None, libs=None, description=None, interface=None, is_public=None, is_protected=None) Create a Job. .UNINDENT .INDENT 7.0 .TP .B delete(job_id) Delete a Job .UNINDENT .INDENT 7.0 .TP .B get(job_id) Get information about a Job .UNINDENT .INDENT 7.0 .TP .B get_configs(job_type) Get config hints for a specified Job type. .UNINDENT .INDENT 7.0 .TP .B list(search_opts=None) Get a list of Jobs. .UNINDENT .INDENT 7.0 .TP .B update(job_id, name=NotUpdated, description=NotUpdated, is_public=NotUpdated, is_protected=NotUpdated) Update a Job. .UNINDENT .UNINDENT .SS Job Execution ops .INDENT 0.0 .TP .B class saharaclient.api.job_executions.JobExecutionsManager(api) .INDENT 7.0 .TP .B create(job_id, cluster_id, input_id=None, output_id=None, configs=None, interface=None, is_public=None, is_protected=None) Launch a Job. .UNINDENT .INDENT 7.0 .TP .B delete(obj_id) Delete a Job Execution. .UNINDENT .INDENT 7.0 .TP .B get(obj_id) Get information about a Job Execution. .UNINDENT .INDENT 7.0 .TP .B list(search_opts=None) Get a list of Job Executions. .UNINDENT .INDENT 7.0 .TP .B update(obj_id, is_public=NotUpdated, is_protected=NotUpdated) Update a Job Execution. .UNINDENT .UNINDENT .SS Job Types ops .INDENT 0.0 .TP .B class saharaclient.api.job_types.JobTypesManager(api) .INDENT 7.0 .TP .B list(search_opts=None) Get a list of job types supported by plugins. .UNINDENT .UNINDENT .SH SAHARA CLI .sp The Sahara shell utility now is part of the OpenStackClient, so all shell commands take the following form: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C $ openstack dataprocessing [arguments...] .ft P .fi .UNINDENT .UNINDENT .sp To get a list of all possible commands you can run: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C $ openstack help dataprocessing .ft P .fi .UNINDENT .UNINDENT .sp To get detailed help for the command you can run: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C $ openstack help dataprocessing .ft P .fi .UNINDENT .UNINDENT .sp For more information about commands and their parameters you can refer to \fBthe Sahara CLI commands\fP\&. .sp For more information about abilities and features of OpenStackClient CLI you can refer to \fI\%OpenStackClient documentation\fP .SS Configuration .sp The CLI is configured via environment variables and command\-line options which are described in \fI\%http://docs.openstack.org/developer/python\-openstackclient/authentication.html\fP\&. .sp Authentication using username/password is most commonly used and can be provided with environment variables: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C export OS_AUTH_URL= export OS_PROJECT_NAME= export OS_USERNAME= export OS_PASSWORD= # (optional) .ft P .fi .UNINDENT .UNINDENT .sp or command\-line options: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C \-\-os\-auth\-url \-\-os\-project\-name \-\-os\-username [\-\-os\-password ] .ft P .fi .UNINDENT .UNINDENT .sp Additionally \fBsahara\fP API url can be configured with parameter: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C \-\-os\-data\-processing\-url .ft P .fi .UNINDENT .UNINDENT .sp or with environment variable: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C export OS_DATA_PROCESSING_URL= .ft P .fi .UNINDENT .UNINDENT .SH SAHARA CLI COMMANDS .sp The following commands are currently supported by the Sahara CLI: .SS Plugins \fBdataprocessing plugin configs get\fP .PP .sp Get plugin configs .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing plugin configs get [\-h] [\-\-file ] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bplugin Name of the plugin to provide config information about .TP .Bversion Version of the plugin to provide config information about .UNINDENT .TP .B Options: .INDENT 7.0 .TP .B \-\-file Destination file (defaults to plugin name) .UNINDENT .UNINDENT \fBdataprocessing plugin list\fP .PP .sp Lists plugins .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing plugin list [\-h] [\-f {csv,json,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-quote {all,minimal,none,nonnumeric}] [\-\-long] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: csv, json, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-quote=nonnumeric when to include quotes, defaults to nonnumeric .sp Possible choices: all, minimal, none, nonnumeric .TP .B \-\-long=False List additional fields in output .UNINDENT .UNINDENT \fBdataprocessing plugin show\fP .PP .sp Display plugin details .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing plugin show [\-h] [\-f {json,shell,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-prefix PREFIX] [\-\-version VERSION] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bplugin Name of the plugin to display .UNINDENT .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: json, shell, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-prefix= add a prefix to all variable names .TP .B \-\-version Version of the plugin to display .UNINDENT .UNINDENT .SS Images \fBdataprocessing image tags add\fP .PP .sp Add image tags .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing image tags add [\-h] [\-f {json,shell,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-prefix PREFIX] \-\-tags [ ...] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bimage Name or id of the image .UNINDENT .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: json, shell, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-prefix= add a prefix to all variable names .TP .B \-\-tags Tag(s) to add [REQUIRED] .UNINDENT .UNINDENT \fBdataprocessing image list\fP .PP .sp Lists registered images .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing image list [\-h] [\-f {csv,json,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-quote {all,minimal,none,nonnumeric}] [\-\-long] [\-\-name ] [\-\-tags [ ...]] [\-\-username ] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: csv, json, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-quote=nonnumeric when to include quotes, defaults to nonnumeric .sp Possible choices: all, minimal, none, nonnumeric .TP .B \-\-long=False List additional fields in output .TP .B \-\-name Regular expression to match image name .TP .B \-\-tags List images with specific tag(s) .TP .B \-\-username List images with specific username .UNINDENT .UNINDENT \fBdataprocessing image register\fP .PP .sp Register an image .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing image register [\-h] [\-f {json,shell,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-prefix PREFIX] \-\-username [\-\-description ] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bimage Name or ID of the image to register .UNINDENT .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: json, shell, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-prefix= add a prefix to all variable names .TP .B \-\-username Username of privileged user in the image [REQUIRED] .TP .B \-\-description Description of the image. If not provided, description of the image will be reset to empty .UNINDENT .UNINDENT \fBdataprocessing image tags remove\fP .PP .sp Remove image tags .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing image tags remove [\-h] [\-f {json,shell,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-prefix PREFIX] [\-\-tags [ ...] | \-\-all] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bimage Name or id of the image .UNINDENT .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: json, shell, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-prefix= add a prefix to all variable names .TP .B \-\-tags Tag(s) to remove .TP .B \-\-all=False Remove all tags from image .UNINDENT .UNINDENT \fBdataprocessing image tags set\fP .PP .sp Set image tags (Replace current image tags with provided ones) .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing image tags set [\-h] [\-f {json,shell,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-prefix PREFIX] \-\-tags [ ...] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bimage Name or id of the image .UNINDENT .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: json, shell, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-prefix= add a prefix to all variable names .TP .B \-\-tags Tag(s) to set [REQUIRED] .UNINDENT .UNINDENT \fBdataprocessing image show\fP .PP .sp Display image details .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing image show [\-h] [\-f {json,shell,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-prefix PREFIX] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bimage Name or id of the image to display .UNINDENT .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: json, shell, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-prefix= add a prefix to all variable names .UNINDENT .UNINDENT \fBdataprocessing image unregister\fP .PP .sp Unregister image(s) .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing image unregister [\-h] [ ...] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bimage Name(s) or id(s) of the image(s) to unregister .UNINDENT .UNINDENT .SS Node Group Templates \fBdataprocessing node group template create\fP .PP .sp Creates node group template .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing node group template create [\-h] [\-f {json,shell,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-prefix PREFIX] [\-\-name ] [\-\-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 ] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: json, shell, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-prefix= add a prefix to all variable names .TP .B \-\-name Name of the node group template [REQUIRED if JSON is not provided] .TP .B \-\-plugin Name of the plugin [REQUIRED if JSON is not provided] .TP .B \-\-version Version of the plugin [REQUIRED if JSON is not provided] .TP .B \-\-processes List of the processes that will be launched on each instance [REQUIRED if JSON is not provided] .TP .B \-\-flavor Name or ID of the flavor [REQUIRED if JSON is not provided] .TP .B \-\-security\-groups List of the security groups for the instances in this node group .TP .B \-\-auto\-security\-group=False Indicates if an additional security group should be created for the node group .TP .B \-\-availability\-zone Name of the availability zone where instances will be created .TP .B \-\-floating\-ip\-pool ID of the floating IP pool .TP .B \-\-volumes\-per\-node Number of volumes attached to every node .TP .B \-\-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 .TP .B \-\-volumes\-type Type of the volumes. This parameter will be taken into account only if volumes\-per\-node is set and non\-zero .TP .B \-\-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 .TP .B \-\-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 .TP .B \-\-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 .TP .B \-\-description Description of the node group template .TP .B \-\-autoconfig=False If enabled, instances of the node group will be automatically configured .TP .B \-\-proxy\-gateway=False If enabled, instances of the node group will be used to access other instances in the cluster .TP .B \-\-public=False Make the node group template public (Visible from other tenants) .TP .B \-\-protected=False Make the node group template protected .TP .B \-\-json JSON representation of the node group template. Other arguments will not be taken into account if this one is provided .TP .B \-\-shares JSON representation of the manila shares .TP .B \-\-configs JSON representation of the node group template configs .UNINDENT .UNINDENT \fBdataprocessing node group template delete\fP .PP .sp Deletes node group template .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing node group template delete [\-h] [ ...] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bnode_group_template Name(s) or id(s) of the node group template(s) to delete .UNINDENT .UNINDENT \fBdataprocessing node group template list\fP .PP .sp Lists node group templates .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing node group template list [\-h] [\-f {csv,json,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-quote {all,minimal,none,nonnumeric}] [\-\-long] [\-\-plugin ] [\-\-version ] [\-\-name ] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: csv, json, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-quote=nonnumeric when to include quotes, defaults to nonnumeric .sp Possible choices: all, minimal, none, nonnumeric .TP .B \-\-long=False List additional fields in output .TP .B \-\-plugin List node group templates for specific plugin .TP .B \-\-version List node group templates with specific version of the plugin .TP .B \-\-name List node group templates with specific substring in the name .UNINDENT .UNINDENT \fBdataprocessing node group template show\fP .PP .sp Display node group template details .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing node group template show [\-h] [\-f {json,shell,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-prefix PREFIX] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bnode_group_template Name or id of the node group template to display .UNINDENT .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: json, shell, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-prefix= add a prefix to all variable names .UNINDENT .UNINDENT \fBdataprocessing node group template update\fP .PP .sp Updates node group template .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing node group template update [\-h] [\-f {json,shell,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-prefix PREFIX] [\-\-name ] [\-\-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 ] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bnode_group_template Name or ID of the node group template .UNINDENT .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: json, shell, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-prefix= add a prefix to all variable names .TP .B \-\-name New name of the node group template .TP .B \-\-plugin Name of the plugin .TP .B \-\-version Version of the plugin .TP .B \-\-processes List of the processes that will be launched on each instance .TP .B \-\-security\-groups List of the security groups for the instances in this node group .TP .B \-\-auto\-security\-group\-enable Additional security group should be created for the node group .TP .B \-\-auto\-security\-group\-disable Additional security group should not be created for the node group .TP .B \-\-availability\-zone Name of the availability zone where instances will be created .TP .B \-\-flavor Name or ID of the flavor .TP .B \-\-floating\-ip\-pool ID of the floating IP pool .TP .B \-\-volumes\-per\-node Number of volumes attached to every node .TP .B \-\-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 .TP .B \-\-volumes\-type Type of the volumes. This parameter will be taken into account only if volumes\-per\-node is set and non\-zero .TP .B \-\-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 .TP .B \-\-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 .TP .B \-\-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 .TP .B \-\-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 .TP .B \-\-description Description of the node group template .TP .B \-\-autoconfig\-enable Instances of the node group will be automatically configured .TP .B \-\-autoconfig\-disable Instances of the node group will not be automatically configured .TP .B \-\-proxy\-gateway\-enable Instances of the node group will be used to access other instances in the cluster .TP .B \-\-proxy\-gateway\-disable Instances of the node group will not be used to access other instances in the cluster .TP .B \-\-public Make the node group template public (Visible from other tenants) .TP .B \-\-private Make the node group template private (Visible only from this tenant) .TP .B \-\-protected Make the node group template protected .TP .B \-\-unprotected Make the node group template unprotected .TP .B \-\-json JSON representation of the node group template update fields. Other arguments will not be taken into account if this one is provided .TP .B \-\-shares JSON representation of the manila shares .TP .B \-\-configs JSON representation of the node group template configs .UNINDENT .UNINDENT .SS Cluster Templates \fBdataprocessing cluster template create\fP .PP .sp Creates cluster template .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing cluster template create [\-h] [\-f {json,shell,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-prefix PREFIX] [\-\-name ] [\-\-node\-groups [ ...]] [\-\-anti\-affinity [ ...]] [\-\-description ] [\-\-autoconfig] [\-\-public] [\-\-protected] [\-\-json ] [\-\-shares ] [\-\-configs ] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: json, shell, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-prefix= add a prefix to all variable names .TP .B \-\-name Name of the cluster template [REQUIRED if JSON is not provided] .TP .B \-\-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] .TP .B \-\-anti\-affinity List of processes that should be added to an anti\-affinity group .TP .B \-\-description Description of the cluster template .TP .B \-\-autoconfig=False If enabled, instances of the cluster will be automatically configured .TP .B \-\-public=False Make the cluster template public (Visible from other tenants) .TP .B \-\-protected=False Make the cluster template protected .TP .B \-\-json JSON representation of the cluster template. Other arguments will not be taken into account if this one is provided .TP .B \-\-shares JSON representation of the manila shares .TP .B \-\-configs JSON representation of the cluster template configs .UNINDENT .UNINDENT \fBdataprocessing cluster template delete\fP .PP .sp Deletes cluster template .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing cluster template delete [\-h] [ ...] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bcluster_template Name(s) or id(s) of the cluster template(s) to delete .UNINDENT .UNINDENT \fBdataprocessing cluster template list\fP .PP .sp Lists cluster templates .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing cluster template list [\-h] [\-f {csv,json,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-quote {all,minimal,none,nonnumeric}] [\-\-long] [\-\-plugin ] [\-\-version ] [\-\-name ] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: csv, json, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-quote=nonnumeric when to include quotes, defaults to nonnumeric .sp Possible choices: all, minimal, none, nonnumeric .TP .B \-\-long=False List additional fields in output .TP .B \-\-plugin List cluster templates for specific plugin .TP .B \-\-version List cluster templates with specific version of the plugin .TP .B \-\-name List cluster templates with specific substring in the name .UNINDENT .UNINDENT \fBdataprocessing cluster template show\fP .PP .sp Display cluster template details .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing cluster template show [\-h] [\-f {json,shell,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-prefix PREFIX] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bcluster_template Name or id of the cluster template to display .UNINDENT .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: json, shell, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-prefix= add a prefix to all variable names .UNINDENT .UNINDENT \fBdataprocessing cluster template update\fP .PP .sp Updates cluster template .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing cluster template update [\-h] [\-f {json,shell,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-prefix PREFIX] [\-\-name ] [\-\-node\-groups [ ...]] [\-\-anti\-affinity [ ...]] [\-\-description ] [\-\-autoconfig\-enable | \-\-autoconfig\-disable] [\-\-public | \-\-private] [\-\-protected | \-\-unprotected] [\-\-json ] [\-\-shares ] [\-\-configs ] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bcluster_template Name or ID of the cluster template [REQUIRED] .UNINDENT .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: json, shell, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-prefix= add a prefix to all variable names .TP .B \-\-name New name of the cluster template .TP .B \-\-node\-groups List of the node groups(names or IDs) and numbers ofinstances for each one of them .TP .B \-\-anti\-affinity List of processes that should be added to an anti\-affinity group .TP .B \-\-description Description of the cluster template .TP .B \-\-autoconfig\-enable Instances of the cluster will be automatically configured .TP .B \-\-autoconfig\-disable Instances of the cluster will not be automatically configured .TP .B \-\-public Make the cluster template public (Visible from other tenants) .TP .B \-\-private Make the cluster template private (Visible only from this tenant) .TP .B \-\-protected Make the cluster template protected .TP .B \-\-unprotected Make the cluster template unprotected .TP .B \-\-json JSON representation of the cluster template. Other arguments will not be taken into account if this one is provided .TP .B \-\-shares JSON representation of the manila shares .TP .B \-\-configs JSON representation of the cluster template configs .UNINDENT .UNINDENT .SS Clusters \fBdataprocessing cluster create\fP .PP .sp Creates cluster .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing cluster create [\-h] [\-f {json,shell,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-prefix PREFIX] [\-\-name ] [\-\-cluster\-template ] [\-\-image ] [\-\-description ] [\-\-user\-keypair ] [\-\-neutron\-network ] [\-\-count ] [\-\-public] [\-\-protected] [\-\-transient] [\-\-json ] [\-\-wait] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: json, shell, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-prefix= add a prefix to all variable names .TP .B \-\-name Name of the cluster [REQUIRED if JSON is not provided] .TP .B \-\-cluster\-template Cluster template name or ID [REQUIRED if JSON is not provided] .TP .B \-\-image Image that will be used for cluster deployment (Name or ID) [REQUIRED if JSON is not provided] .TP .B \-\-description Description of the cluster .TP .B \-\-user\-keypair User keypair to get acces to VMs after cluster creation .TP .B \-\-neutron\-network Instances of the cluster will get fixed IP addresses in this network. (Name or ID should be provided) .TP .B \-\-count Number of clusters to be created .TP .B \-\-public=False Make the cluster public (Visible from other tenants) .TP .B \-\-protected=False Make the cluster protected .TP .B \-\-transient=False Create transient cluster .TP .B \-\-json JSON representation of the cluster. Other arguments (except for \-\-wait) will not be taken into account if this one is provided .TP .B \-\-wait=False Wait for the cluster creation to complete .UNINDENT .UNINDENT \fBdataprocessing cluster delete\fP .PP .sp Deletes cluster .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing cluster delete [\-h] [\-\-wait] [ ...] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bcluster Name(s) or id(s) of the cluster(s) to delete .UNINDENT .TP .B Options: .INDENT 7.0 .TP .B \-\-wait=False Wait for the cluster(s) delete to complete .UNINDENT .UNINDENT \fBdataprocessing cluster list\fP .PP .sp Lists clusters .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing cluster list [\-h] [\-f {csv,json,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-quote {all,minimal,none,nonnumeric}] [\-\-long] [\-\-plugin ] [\-\-version ] [\-\-name ] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: csv, json, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-quote=nonnumeric when to include quotes, defaults to nonnumeric .sp Possible choices: all, minimal, none, nonnumeric .TP .B \-\-long=False List additional fields in output .TP .B \-\-plugin List clusters with specific plugin .TP .B \-\-version List clusters with specific version of the plugin .TP .B \-\-name List clusters with specific substring in the name .UNINDENT .UNINDENT \fBdataprocessing cluster scale\fP .PP .sp Scales cluster .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing cluster scale [\-h] [\-f {json,shell,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-prefix PREFIX] [\-\-instances [ ...]] [\-\-json ] [\-\-wait] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bcluster Name or ID of the cluster .UNINDENT .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: json, shell, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-prefix= add a prefix to all variable names .TP .B \-\-instances Node group templates and number of their instances to be scale to [REQUIRED if JSON is not provided] .TP .B \-\-json JSON representation of the cluster scale object. Other arguments (except for \-\-wait) will not be taken into account if this one is provided .TP .B \-\-wait=False Wait for the cluster scale to complete .UNINDENT .UNINDENT \fBdataprocessing cluster show\fP .PP .sp Display cluster details .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing cluster show [\-h] [\-f {json,shell,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-prefix PREFIX] [\-\-verification] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bcluster Name or id of the cluster to display .UNINDENT .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: json, shell, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-prefix= add a prefix to all variable names .TP .B \-\-verification=False List additional fields for verifications .UNINDENT .UNINDENT \fBdataprocessing cluster verification\fP .PP .sp Updates cluster .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing cluster verification [\-h] [\-f {json,shell,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-prefix PREFIX] [\-\-name ] [\-\-description ] [\-\-shares ] [\-\-public | \-\-private] [\-\-protected | \-\-unprotected] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bcluster Name or ID of the cluster .UNINDENT .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: json, shell, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-prefix= add a prefix to all variable names .TP .B \-\-name New name of the cluster .TP .B \-\-description Description of the cluster .TP .B \-\-shares JSON representation of the manila shares .TP .B \-\-public Make the cluster public (Visible from other tenants) .TP .B \-\-private Make the cluster private (Visible only from this tenant) .TP .B \-\-protected Make the cluster protected .TP .B \-\-unprotected Make the cluster unprotected .UNINDENT .UNINDENT \fBdataprocessing cluster verification\fP .PP .sp Updates cluster verifications .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing cluster verification [\-h] [\-f {json,shell,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-prefix PREFIX] (\-\-start | \-\-show) .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bcluster Name or ID of the cluster .UNINDENT .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: json, shell, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-prefix= add a prefix to all variable names .TP .B \-\-start Start health verification for the cluster .TP .B \-\-show=False Show health of the cluster .UNINDENT .UNINDENT .SS Data Sources \fBdataprocessing data source create\fP .PP .sp Creates data source .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing data source create [\-h] [\-f {json,shell,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-prefix PREFIX] \-\-type \-\-url [\-\-username ] [\-\-password ] [\-\-description ] [\-\-public] [\-\-protected] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bname Name of the data source .UNINDENT .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: json, shell, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-prefix= add a prefix to all variable names .TP .B \-\-type Type of the data source (swift, hdfs, maprfs, manila) [REQUIRED] .sp Possible choices: swift, hdfs, maprfs, manila .TP .B \-\-url Url for the data source [REQUIRED] .TP .B \-\-username Username for accessing the data source url .TP .B \-\-password Password for accessing the data source url .TP .B \-\-description Description of the data source .TP .B \-\-public=False Make the data source public .TP .B \-\-protected=False Make the data source protected .UNINDENT .UNINDENT \fBdataprocessing data source delete\fP .PP .sp Delete data source .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing data source delete [\-h] [ ...] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bdata_source Name(s) or id(s) of the data source(s) to delete .UNINDENT .UNINDENT \fBdataprocessing data source list\fP .PP .sp Lists data sources .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing data source list [\-h] [\-f {csv,json,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-quote {all,minimal,none,nonnumeric}] [\-\-long] [\-\-type ] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: csv, json, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-quote=nonnumeric when to include quotes, defaults to nonnumeric .sp Possible choices: all, minimal, none, nonnumeric .TP .B \-\-long=False List additional fields in output .TP .B \-\-type List data sources of specific type (swift, hdfs, maprfs, manila) .sp Possible choices: swift, hdfs, maprfs, manila .UNINDENT .UNINDENT \fBdataprocessing data source show\fP .PP .sp Display data source details .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing data source show [\-h] [\-f {json,shell,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-prefix PREFIX] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bdata_source Name or id of the data source to display .UNINDENT .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: json, shell, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-prefix= add a prefix to all variable names .UNINDENT .UNINDENT \fBdataprocessing data source update\fP .PP .sp Update data source .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing data source update [\-h] [\-f {json,shell,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-prefix PREFIX] [\-\-name ] [\-\-type ] [\-\-url ] [\-\-username ] [\-\-password ] [\-\-description ] [\-\-public | \-\-private] [\-\-protected | \-\-unprotected] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bdata_source Name or id of the data source .UNINDENT .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: json, shell, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-prefix= add a prefix to all variable names .TP .B \-\-name New name of the data source .TP .B \-\-type Type of the data source (swift, hdfs, maprfs, manila) .sp Possible choices: swift, hdfs, maprfs, manila .TP .B \-\-url Url for the data source .TP .B \-\-username Username for accessing the data source url .TP .B \-\-password Password for accessing the data source url .TP .B \-\-description Description of the data source .TP .B \-\-public Make the data source public (Visible from other tenants) .TP .B \-\-private Make the data source private (Visible only from this tenant) .TP .B \-\-protected Make the data source protected .TP .B \-\-unprotected Make the data source unprotected .UNINDENT .UNINDENT .SS Job Binaries \fBdataprocessing job binary create\fP .PP .sp Creates job binary .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing job binary create [\-h] [\-f {json,shell,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-prefix PREFIX] [\-\-name ] [\-\-data | \-\-url ] [\-\-description ] [\-\-username ] [\-\-password | \-\-password\-prompt] [\-\-public] [\-\-protected] [\-\-json ] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: json, shell, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-prefix= add a prefix to all variable names .TP .B \-\-name Name of the job binary [REQUIRED if JSON is not provided] .TP .B \-\-data File that will be stored in the internal DB [REQUIRED if JSON and URL are not provided] .TP .B \-\-url URL for the job binary [REQUIRED if JSON and file are not provided] .TP .B \-\-description Description of the job binary .TP .B \-\-username Username for accessing the job binary URL .TP .B \-\-password Password for accessing the job binary URL .TP .B \-\-password\-prompt=False Prompt interactively for password .TP .B \-\-public=False Make the job binary public .TP .B \-\-protected=False Make the job binary protected .TP .B \-\-json JSON representation of the job binary. Other arguments will not be taken into account if this one is provided .UNINDENT .UNINDENT \fBdataprocessing job binary delete\fP .PP .sp Deletes job binary .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing job binary delete [\-h] [ ...] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bjob_binary Name(s) or id(s) of the job binary(ies) to delete .UNINDENT .UNINDENT \fBdataprocessing job binary download\fP .PP .sp Downloads job binary .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing job binary download [\-h] [\-\-file ] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bjob_binary Name or ID of the job binary to download .UNINDENT .TP .B Options: .INDENT 7.0 .TP .B \-\-file Destination file (defaults to job binary name) .UNINDENT .UNINDENT \fBdataprocessing job binary list\fP .PP .sp Lists job binaries .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing job binary list [\-h] [\-f {csv,json,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-quote {all,minimal,none,nonnumeric}] [\-\-long] [\-\-name ] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: csv, json, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-quote=nonnumeric when to include quotes, defaults to nonnumeric .sp Possible choices: all, minimal, none, nonnumeric .TP .B \-\-long=False List additional fields in output .TP .B \-\-name List job binaries with specific substring in the name .UNINDENT .UNINDENT \fBdataprocessing job binary show\fP .PP .sp Display job binary details .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing job binary show [\-h] [\-f {json,shell,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-prefix PREFIX] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bjob_binary Name or ID of the job binary to display .UNINDENT .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: json, shell, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-prefix= add a prefix to all variable names .UNINDENT .UNINDENT \fBdataprocessing job binary update\fP .PP .sp Updates job binary .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing job binary update [\-h] [\-f {json,shell,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-prefix PREFIX] [\-\-name ] [\-\-url ] [\-\-description ] [\-\-username ] [\-\-password | \-\-password\-prompt] [\-\-public | \-\-private] [\-\-protected | \-\-unprotected] [\-\-json ] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bjob_binary Name or ID of the job binary .UNINDENT .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: json, shell, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-prefix= add a prefix to all variable names .TP .B \-\-name New name of the job binary .TP .B \-\-url URL for the job binary [Internal DB URL can not be updated] .TP .B \-\-description Description of the job binary .TP .B \-\-username Username for accessing the job binary URL .TP .B \-\-password Password for accessing the job binary URL .TP .B \-\-password\-prompt=False Prompt interactively for password .TP .B \-\-public Make the job binary public (Visible from other tenants) .TP .B \-\-private Make the job binary private (Visible only from this tenant) .TP .B \-\-protected Make the job binary protected .TP .B \-\-unprotected Make the job binary unprotected .TP .B \-\-json JSON representation of the update object. Other arguments will not be taken into account if this one is provided .UNINDENT .UNINDENT .SS Job Types \fBdataprocessing job type configs get\fP .PP .sp Get job type configs .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing job type configs get [\-h] [\-\-file ] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bjob_type Type of the job to provide config information about .sp Possible choices: Hive, Java, MapReduce, Storm, Pig, Shell, MapReduce.Streaming, Spark .UNINDENT .TP .B Options: .INDENT 7.0 .TP .B \-\-file Destination file (defaults to job type) .UNINDENT .UNINDENT \fBdataprocessing job type list\fP .PP .sp Lists job types supported by plugins .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing job type list [\-h] [\-f {csv,json,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-quote {all,minimal,none,nonnumeric}] [\-\-type ] [\-\-plugin ] [\-\-version ] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: csv, json, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-quote=nonnumeric when to include quotes, defaults to nonnumeric .sp Possible choices: all, minimal, none, nonnumeric .TP .B \-\-type Get information about specific job type .sp Possible choices: Hive, Java, MapReduce, Storm, Pig, Shell, MapReduce.Streaming, Spark .TP .B \-\-plugin Get only job types supported by this plugin .TP .B \-\-version Get only job types supported by specific version of the plugin. This parameter will be taken into account only if plugin is provided .UNINDENT .UNINDENT .SS Job Templates \fBdataprocessing job template create\fP .PP .sp Creates job template .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing job template create [\-h] [\-f {json,shell,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-prefix PREFIX] [\-\-name ] [\-\-type ] [\-\-mains
[
...]] [\-\-libs [ ...]] [\-\-description ] [\-\-public] [\-\-protected] [\-\-interface ] [\-\-json ] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: json, shell, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-prefix= add a prefix to all variable names .TP .B \-\-name Name of the job template [REQUIRED if JSON is not provided] .TP .B \-\-type Type of the job (Hive, Java, MapReduce, Storm, Pig, Shell, MapReduce.Streaming, Spark) [REQUIRED if JSON is not provided] .sp Possible choices: Hive, Java, MapReduce, Storm, Pig, Shell, MapReduce.Streaming, Spark .TP .B \-\-mains Name(s) or ID(s) for job\(aqs main job binary(s) .TP .B \-\-libs Name(s) or ID(s) for job\(aqs lib job binary(s) .TP .B \-\-description Description of the job template .TP .B \-\-public=False Make the job template public .TP .B \-\-protected=False Make the job template protected .TP .B \-\-interface JSON representation of the interface .TP .B \-\-json JSON representation of the job template .UNINDENT .UNINDENT \fBdataprocessing job template delete\fP .PP .sp Deletes job template .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing job template delete [\-h] [ ...] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bjob_template Name(s) or id(s) of the job template(s) to delete .UNINDENT .UNINDENT \fBdataprocessing job template list\fP .PP .sp Lists job templates .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing job template list [\-h] [\-f {csv,json,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-quote {all,minimal,none,nonnumeric}] [\-\-long] [\-\-type ] [\-\-name ] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: csv, json, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-quote=nonnumeric when to include quotes, defaults to nonnumeric .sp Possible choices: all, minimal, none, nonnumeric .TP .B \-\-long=False List additional fields in output .TP .B \-\-type List job templates of specific type .sp Possible choices: Hive, Java, MapReduce, Storm, Pig, Shell, MapReduce.Streaming, Spark .TP .B \-\-name List job templates with specific substring in the name .UNINDENT .UNINDENT \fBdataprocessing job template show\fP .PP .sp Display job template details .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing job template show [\-h] [\-f {json,shell,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-prefix PREFIX] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bjob_template Name or ID of the job template to display .UNINDENT .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: json, shell, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-prefix= add a prefix to all variable names .UNINDENT .UNINDENT \fBdataprocessing job template update\fP .PP .sp Updates job template .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing job template update [\-h] [\-f {json,shell,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-prefix PREFIX] [\-\-name ] [\-\-description ] [\-\-public | \-\-private] [\-\-protected | \-\-unprotected] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bjob_template Name or ID of the job template .UNINDENT .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: json, shell, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-prefix= add a prefix to all variable names .TP .B \-\-name New name of the job template .TP .B \-\-description Description of the job template .TP .B \-\-public Make the job template public (Visible from other tenants) .TP .B \-\-private Make the job_template private (Visible only from this tenant) .TP .B \-\-protected Make the job template protected .TP .B \-\-unprotected Make the job template unprotected .UNINDENT .UNINDENT .SS Jobs \fBdataprocessing job binary delete\fP .PP .sp Deletes job .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing job binary delete [\-h] [\-\-wait] [ ...] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bjob ID(s) of the job(s) to delete .UNINDENT .TP .B Options: .INDENT 7.0 .TP .B \-\-wait=False Wait for the job(s) delete to complete .UNINDENT .UNINDENT \fBdataprocessing job execute\fP .PP .sp Executes job .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing job execute [\-h] [\-f {json,shell,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-prefix PREFIX] [\-\-job\-template ] [\-\-cluster ] [\-\-input ] [\-\-output ] [\-\-params [ ...]] [\-\-args [ ...]] [\-\-public] [\-\-protected] [\-\-config\-json | \-\-configs [ ...]] [\-\-interface ] [\-\-json ] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: json, shell, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-prefix= add a prefix to all variable names .TP .B \-\-job\-template Name or ID of the job template [REQUIRED if JSON is not provided] .TP .B \-\-cluster Name or ID of the cluster [REQUIRED if JSON is not provided] .TP .B \-\-input Name or ID of the input data source .TP .B \-\-output Name or ID of the output data source .TP .B \-\-params Parameters to add to the job .TP .B \-\-args Arguments to add to the job .TP .B \-\-public=False Make the job public .TP .B \-\-protected=False Make the job protected .TP .B \-\-config\-json JSON representation of the job configs .TP .B \-\-configs Configs to add to the job .TP .B \-\-interface JSON representation of the interface .TP .B \-\-json JSON representation of the job. Other arguments will not be taken into account if this one is provided .UNINDENT .UNINDENT \fBdataprocessing job list\fP .PP .sp Lists jobs .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing job list [\-h] [\-f {csv,json,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-quote {all,minimal,none,nonnumeric}] [\-\-long] [\-\-status ] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: csv, json, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-quote=nonnumeric when to include quotes, defaults to nonnumeric .sp Possible choices: all, minimal, none, nonnumeric .TP .B \-\-long=False List additional fields in output .TP .B \-\-status List jobs with specific status .sp Possible choices: done\-with\-error, failed, killed, pending, running, succeeded, to\-be\-killed .UNINDENT .UNINDENT \fBdataprocessing job binary show\fP .PP .sp Display job details .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing job binary show [\-h] [\-f {json,shell,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-prefix PREFIX] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bjob ID of the job to display .UNINDENT .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: json, shell, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-prefix= add a prefix to all variable names .UNINDENT .UNINDENT \fBdataprocessing job binary update\fP .PP .sp Updates job .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C usage: dataprocessing job binary update [\-h] [\-f {json,shell,table,value,yaml}] [\-c COLUMN] [\-\-max\-width ] [\-\-noindent] [\-\-prefix PREFIX] [\-\-public | \-\-private] [\-\-protected | \-\-unprotected] .ft P .fi .UNINDENT .UNINDENT .INDENT 0.0 .TP .B Positional arguments: .INDENT 7.0 .TP .Bjob ID of the job to update .UNINDENT .TP .B Options: .INDENT 7.0 .TP .B \-f=table\fP,\fB \-\-format=table the output format, defaults to table .sp Possible choices: json, shell, table, value, yaml .TP .B \-c=[]\fP,\fB \-\-column=[] specify the column(s) to include, can be repeated .TP .B \-\-max\-width=0 Maximum display width, 0 to disable .TP .B \-\-noindent=False whether to disable indenting the JSON .TP .B \-\-prefix= add a prefix to all variable names .TP .B \-\-public Make the job public (Visible from other tenants) .TP .B \-\-private Make the job private (Visible only from this tenant) .TP .B \-\-protected Make the job protected .TP .B \-\-unprotected Make the job unprotected .UNINDENT .UNINDENT .SH HOW TO PARTICIPATE .SS Getting started .INDENT 0.0 .IP \(bu 2 Create account on \fI\%Github\fP (if you don\(aqt have one) .INDENT 2.0 .IP \(bu 2 Make sure that your local git is properly configured by executing \fBgit config \-\-list\fP\&. If not, configure \fBuser.name\fP, \fBuser.email\fP .UNINDENT .IP \(bu 2 Create account on \fI\%Launchpad\fP (if you don\(aqt have one) .IP \(bu 2 Subscribe to \fI\%OpenStack general mail\-list\fP .IP \(bu 2 Subscribe to \fI\%OpenStack development mail\-list\fP .IP \(bu 2 Create \fI\%OpenStack profile\fP .IP \(bu 2 Login to \fI\%OpenStack Gerrit\fP with your Launchpad id .INDENT 2.0 .IP \(bu 2 Sign \fI\%OpenStack Individual Contributor License Agreement\fP .IP \(bu 2 Make sure that your email is listed in \fI\%identities\fP .UNINDENT .IP \(bu 2 Subscribe to code\-reviews. Go to your settings on \fI\%http://review.openstack.org\fP .INDENT 2.0 .IP \(bu 2 Go to \fBwatched projects\fP .IP \(bu 2 Add \fBopenstack/sahara\fP, \fBopenstack/sahara\-dashboard\fP, \fBopenstack/sahara\-extra\fP, \fBopenstack/python\-saharaclient\fP, \fBopenstack/sahara\-image\-elements\fP, \fBopenstack/horizon\fP .UNINDENT .UNINDENT .SS How to stay in touch with the community? .INDENT 0.0 .IP \(bu 2 If you have something to discuss use \fI\%OpenStack development mail\-list\fP\&. Prefix mail subject with \fB[Sahara]\fP .IP \(bu 2 Join \fB#openstack\-sahara\fP IRC channel on \fI\%freenode\fP .IP \(bu 2 Join public weekly meetings on \fIThursdays at 18:00 UTC\fP on \fB#openstack\-meeting\-alt\fP IRC channel .IP \(bu 2 Join public weekly meetings on \fIThursdays at 14:00 UTC\fP on \fB#openstack\-meeting\-3\fP IRC channel .UNINDENT .SS How to send your first patch on review? .INDENT 0.0 .IP \(bu 2 Checkout Sahara code from \fI\%Github\fP .IP \(bu 2 Carefully read \fI\%https://wiki.openstack.org/wiki/Gerrit_Workflow\fP .INDENT 2.0 .IP \(bu 2 Pay special attention to \fI\%https://wiki.openstack.org/wiki/Gerrit_Workflow#Committing_Changes\fP .UNINDENT .IP \(bu 2 Apply and commit your changes .IP \(bu 2 Make sure that your code passes \fBPEP8\fP checks and unit\-tests .IP \(bu 2 Send your patch on review .IP \(bu 2 Monitor status of your patch review on \fI\%https://review.openstack.org/#/\fP .UNINDENT .sp Code is hosted in \fI\%review.o.o\fP and mirrored to \fI\%github\fP and \fI\%git.o.o\fP . Submit bugs to the Sahara project on \fI\%launchpad\fP and to the Sahara client on \fI\%launchpad_client\fP\&. Submit code to the openstack/python\-saharaclient project using \fI\%gerrit\fP\&. .SH AUTHOR OpenStack Foundation .SH COPYRIGHT 2013, OpenStack Foundation .\" Generated by docutils manpage writer. .