Chapter 14. Data Processing service command-line client

Subcommands

cluster-create

Create a cluster.

cluster-delete

Delete a cluster.

cluster-list

Print a list of available clusters.

cluster-scale

Scale a cluster.

cluster-show

Show details of a cluster.

cluster-template-create

Create a cluster template.

cluster-template-delete

Delete a cluster template.

cluster-template-list

Print a list of available cluster templates.

cluster-template-show

Show details of a cluster template.

cluster-template-update

Update a cluster template.

data-source-create

Create a data source that provides job input or receives job output.

data-source-delete

Delete a data source.

data-source-list

Print a list of available data sources.

data-source-show

Show details of a data source.

data-source-update

Update a data source.

image-add-tag

Add a tag to an image.

image-list

Print a list of available images.

image-register

Register an image from the Image index.

image-remove-tag

Remove a tag from an image.

image-show

Show details of an image.

image-unregister

Unregister an image.

job-binary-create

Record a job binary.

job-binary-data-create

Store data in the internal DB. Use 'swift upload' instead of this command. Use this command only if Swift is not available.

job-binary-data-delete

Delete an internally stored job binary data.

job-binary-data-list

Print a list of internally stored job binary data.

job-binary-delete

Delete a job binary.

job-binary-list

Print a list of job binaries.

job-binary-show

Show details of a job binary.

job-binary-update

Update a job binary.

job-create

Create a job.

job-delete

Delete a job.

job-list

Print a list of jobs.

job-show

Show details of a job.

job-template-create

Create a job template.

job-template-delete

Delete a job template.

job-template-list

Print a list of job templates.

job-template-show

Show details of a job template.

job-type-list

Show supported job types.

node-group-template-create

Create a node group template.

node-group-template-delete

Delete a node group template.

node-group-template-list

Print a list of available node group templates.

node-group-template-show

Show details of a node group template.

node-group-template-update

Update a node group template.

plugin-list

Print a list of available plugins.

plugin-show

Show details of a plugin.

bash-completion

Prints arguments for bash-completion. Prints all of the commands and options to stdout so that the sahara.bash_completion script doesn't have to hard code them.

help

Display help about this program or one of its subcommands.

--version

show program's version number and exit

--debug

Print debugging output.

--os-cache

Use the auth token cache. Defaults to False if env[OS_CACHE] is not set.

--region-name <region-name>

Defaults to env[OS_REGION_NAME].

--service-type <service-type>

Defaults to data-processing for all actions.

--endpoint-type <endpoint-type>

Defaults to env[SAHARA_ENDPOINT_TYPE] or env[OS_ENDPOINT_TYPE] or publicURL.

--sahara-api-version <sahara-api-ver>

Accepts "api", defaults to env[SAHARA_API_VERSION].

--bypass-url <bypass-url>

Use this API endpoint instead of the Service Catalog.

--os-tenant-name OS_TENANT_NAME

Defaults to env[OS_TENANT_NAME].

--os-tenant-id OS_TENANT_ID

Defaults to env[OS_TENANT_ID].

--os-auth-system OS_AUTH_SYSTEM

Defaults to env[OS_AUTH_SYSTEM].

--os-auth-token OS_AUTH_TOKEN

Defaults to env[OS_AUTH_TOKEN].

--insecure

Explicitly allow client to perform "insecure" TLS (https) requests. The server's certificate will not be verified against any certificate authorities. This option should be used with caution.

--os-cacert <ca-certificate>

Specify a CA bundle file to use in verifying a TLS (https) server certificate. Defaults to env[OS_CACERT].

--os-cert <certificate>

Defaults to env[OS_CERT].

--os-key <key>

Defaults to env[OS_KEY].

--timeout <seconds>

Set request timeout (in seconds).

--os-auth-url OS_AUTH_URL

Authentication URL

--os-domain-id OS_DOMAIN_ID

Domain ID to scope to

--os-domain-name OS_DOMAIN_NAME

Domain name to scope to

--os-project-id OS_PROJECT_ID

Project ID to scope to

--os-project-name OS_PROJECT_NAME

Project name to scope to

--os-project-domain-id OS_PROJECT_DOMAIN_ID

Domain ID containing project

--os-project-domain-name OS_PROJECT_DOMAIN_NAME

Domain name containing project

--os-trust-id OS_TRUST_ID

Trust ID

--os-user-id OS_USER_ID

User ID

--os-user-name OS_USERNAME, --os-username OS_USERNAME

Username

--os-user-domain-id OS_USER_DOMAIN_ID

User's domain id

--os-user-domain-name OS_USER_DOMAIN_NAME

User's domain name

--os-password OS_PASSWORD

User's password

Optional arguments

--json JSON

JSON representation of cluster.

--count COUNT

Number of clusters to create.

Optional arguments

--name NAME

Name of the cluster.

--id <cluster_id>

ID of the cluster to delete.

Optional arguments

--name NAME

Name of the cluster.

--id <cluster_id>

ID of the cluster.

--json JSON

JSON representation of cluster scale.

Optional arguments

--name NAME

Name of the cluster.

--id <cluster_id>

ID of the cluster to show.

--show-progress SHOW_PROGRESS

Show provision progress events of the cluster.

--json

Print JSON representation of the cluster.

Optional arguments

--json JSON

JSON representation of cluster template.

Optional arguments

--name NAME

Name of the cluster template.

--id <template_id>

ID of the cluster template to delete.

Optional arguments

--name NAME

Name of the cluster template.

--id <template_id>

ID of the cluster template to show.

--json

Print JSON representation of cluster template.

Optional arguments

--name NAME

Name of the cluster template to update.

--id <template_id>

ID of the cluster template to update.

--json JSON

JSON representation of cluster template update.

Optional arguments

--name NAME

Name of the data source.

--type TYPE

Type of the data source.

--url URL

URL for the data source.

--description DESCRIPTION

Description of the data source.

--user USER

Username for accessing the data source URL.

--password PASSWORD

Password for accessing the data source URL.

Optional arguments

--name NAME

Name of the data source.

--id ID

ID of data source to delete.

Optional arguments

--name NAME

Name of the data source.

--id ID

ID of the data source.

Optional arguments

--name NAME

Name of the data source to update.

--id ID

ID of the data source to update.

--json JSON

JSON containing the data source fields to update.

Optional arguments

--name NAME

Name of the image.

--id <image_id>

ID of image to tag.

--tag <tag>

Tag to add.

Optional arguments

--id <image_id>

ID of image, run "glance image-list" to see all IDs.

--username <name>

Username of privileged user in the image.

--description <desc>

Description of the image.

Optional arguments

--name NAME

Name of the image.

--id <image_id>

Image to tag.

--tag <tag>

Tag to remove.

Optional arguments

--name NAME

Name of the image.

--id <image_id>

ID of the image.

Optional arguments

--name NAME

Name of the image.

--id <image_id>

ID of image to unregister.

Optional arguments

--name NAME

Name of the job binary.

--url URL

URL for the job binary.

--description DESCRIPTION

Description of the job binary.

--user USER

Username for accessing the job binary URL.

--password PASSWORD

Password for accessing the job binary URL.

Optional arguments

--file FILE

Data to store.

--name NAME

Name of the job binary internal.

Optional arguments

--id ID

ID of internally stored job binary data.

Optional arguments

--name NAME

Name of the job binary.

--id ID

ID of the job binary to delete.

Optional arguments

--name NAME

Name of the job binary.

--id ID

ID of the job binary.

Optional arguments

--name NAME

Name of the job binary to update.

--id <job_binary_id>

ID of the job binary to update.

--json JSON

JSON representation of job binary update.

Optional arguments

--job-template JOB_TEMPLATE

ID of the job template to run.

--cluster CLUSTER

ID of the cluster to run the job in.

--input-data INPUT_DATA

ID of the input data source.

--output-data OUTPUT_DATA

ID of the output data source.

--param

name=value Parameters to add to the job, repeatable.

--arg ARG

Arguments to add to the job, repeatable.

--config

name=value Config parameters to add to the job, repeatable.

--json JSON

JSON representation of the job.

Optional arguments

--id ID

ID of a job.

Optional arguments

--id ID

ID of the job.

Optional arguments

--name NAME

Name of the job template.

--type TYPE

Type of the job template.

--main MAIN

ID for job's main job-binary.

--lib LIB

ID of job's lib job-binary, repeatable.

--description DESCRIPTION

Description of the job template.

--json JSON

JSON representation of job template.

Optional arguments

--name NAME

Name of the job template.

--id ID

ID of the job template.

Optional arguments

--name NAME

Name of the job template.

--id ID

ID of the job template.

Optional arguments

--type <job_type>

Report only on this job type.

--plugin <plugin>

Report only job types supported by this plugin.

--plugin-version <plugin_version>

Report only on job types supported by this version of a specified plugin. Only valid with --plugin.

Optional arguments

--json JSON

JSON representation of node group template.

Optional arguments

--name NAME

Name of the node group template.

--id <template_id>

ID of the node group template to delete.

Optional arguments

--name NAME

Name of the node group template.

--id <template_id>

ID of the node group template to show.

--json

Print JSON representation of node group template.

Optional arguments

--name NAME

Name of the node group template to update.

--id <template_id>

ID of the node group template to update.

--json JSON

JSON representation of the node group template update.

Optional arguments

--name <plugin>

Name of the plugin.