diff --git a/doc/cli-reference/bk-cli-reference.xml b/doc/cli-reference/bk-cli-reference.xml index 46ac25eed2..7c1f3128b9 100644 --- a/doc/cli-reference/bk-cli-reference.xml +++ b/doc/cli-reference/bk-cli-reference.xml @@ -90,5 +90,6 @@ + diff --git a/doc/cli-reference/generated/ch_cli_sahara_commands.xml b/doc/cli-reference/generated/ch_cli_sahara_commands.xml new file mode 100644 index 0000000000..0bfc234178 --- /dev/null +++ b/doc/cli-reference/generated/ch_cli_sahara_commands.xml @@ -0,0 +1,1400 @@ + + + + + + + + Data processing command-line client + The sahara client is the command-line interface + (CLI) for the Data processing and its extensions. This chapter documents + sahara version 0.7.0. + + For help on a specific sahara + command, enter: + + $ sahara COMMAND + +
+ sahara usage + usage: sahara [--version] [--debug] [--os-cache] + [--os-username <auth-user-name>] [--os-password <auth-password>] + [--os-tenant-name <auth-tenant-name>] + [--os-tenant-id <auth-tenant-id>] [--os-auth-url <auth-url>] + [--os-auth-system <auth-system>] [--service-type <service-type>] + [--endpoint-type <endpoint-type>] + [--sahara-api-version <sahara-api-ver>] + [--os-cacert <ca-certificate>] [--bypass-url <bypass-url>] + <subcommand> ... + + Subcommands + + cluster-create + + + Create a cluster. + + + + + cluster-delete + + + Delete a cluster. + + + + + cluster-list + + + Print a list of available clusters. + + + + + 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. + + + + + 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. + + + + + 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-create + + + + + + + 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. + + + + + 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. + + + + + plugin-list + + + Print a list of available plugins. + + + + + plugin-show + + + Show details of a plugin. + + + + + 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. + + + + +
+
+ sahara optional arguments + + + --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. + + + + + --os-username <auth-user-name> + + + Defaults to env[OS_USERNAME]. + + + + + --os-password <auth-password> + + + Defaults to env[OS_PASSWORD]. + + + + + --os-tenant-name <auth-tenant-name> + + + Defaults to env[OS_TENANT_NAME]. + + + + + --os-tenant-id <auth-tenant-id> + + + Defaults to env[OS_TENANT_ID]. + + + + + --os-auth-url <auth-url> + + + Defaults to env[OS_AUTH_URL]. + + + + + --os-auth-system <auth-system> + + + Defaults to env[OS_AUTH_SYSTEM]. + + + + + --service-type <service-type> + + + Defaults to data_processing for all actions. + + + + + --endpoint-type <endpoint-type> + + + Defaults to env[SAHARA_ENDPOINT_TYPE] or publicURL. + + + + + --sahara-api-version <sahara-api-ver> + + + Accepts "api", defaults to env[SAHARA_API_VERSION]. + + + + + --os-cacert <ca-certificate> + + + Specify a CA bundle file to use in verifying a TLS + (https) server certificate. Defaults to + env[OS_CACERT]. + + + + + --bypass-url <bypass-url> + + + Use this API endpoint instead of the Service Catalog. + + + + +
+
+ sahara cluster-create command + usage: sahara cluster-create [--json JSON] + +Create a cluster. + + Optional arguments + + --json JSON JSON + + + representation of cluster. + + + + +
+
+ sahara cluster-delete command + usage: sahara cluster-delete [--name NAME] [--id <cluster_id>] + +Delete a cluster. + + Optional arguments + + --name NAME + + + Name of the cluster. + + + + + --id <cluster_id> ID + + + of the cluster to delete. + + + + +
+
+ sahara cluster-list command + usage: sahara cluster-list + +Print a list of available clusters. + +
+
+ sahara cluster-show command + usage: sahara cluster-show [--name NAME] [--id <cluster_id>] [--json] + +Show details of a cluster. + + Optional arguments + + --name NAME + + + Name of the cluster. + + + + + --id <cluster_id> ID + + + of the cluster to show. + + + + + --json + + + Print JSON representation of the cluster. + + + + +
+
+ sahara cluster-template-create command + usage: sahara cluster-template-create [--json JSON] + +Create a cluster template. + + Optional arguments + + --json JSON JSON + + + representation of cluster template. + + + + +
+
+ sahara cluster-template-delete command + usage: sahara cluster-template-delete [--name NAME] [--id <template_id>] + +Delete a cluster template. + + Optional arguments + + --name NAME + + + Name of the cluster template. + + + + + --id <template_id> ID + + + of the cluster template to delete. + + + + +
+
+ sahara cluster-template-list command + usage: sahara cluster-template-list + +Print a list of available cluster templates. + +
+
+ sahara cluster-template-show command + usage: sahara cluster-template-show [--name NAME] [--id <template_id>] + [--json] + +Show details of a cluster template. + + 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. + + + + +
+
+ sahara data-source-create command + usage: sahara data-source-create --name NAME --type TYPE --url URL + [--description DESCRIPTION] [--user USER] + [--password PASSWORD] + +Create a data source that provides job input or receives job output. + + 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. + + + + +
+
+ sahara data-source-delete command + usage: sahara data-source-delete [--name NAME] [--id ID] + +Delete a data source. + + Optional arguments + + --name NAME + + + Name of the data source. + + + + + --id ID ID + + + of data source to delete. + + + + +
+
+ sahara data-source-list command + usage: sahara data-source-list + +Print a list of available data sources. + +
+
+ sahara data-source-show command + usage: sahara data-source-show [--name NAME] [--id ID] + +Show details of a data source. + + Optional arguments + + --name NAME + + + Name of the data source. + + + + + --id ID ID + + + of the data source. + + + + +
+
+ sahara image-add-tag command + usage: sahara image-add-tag [--name NAME] [--id <image_id>] --tag <tag> + +Add a tag to an image. + + Optional arguments + + --name NAME + + + Name of the image. + + + + + --id <image_id> ID + + + of image to tag. + + + + + --tag <tag> + + + Tag to add. + + + + +
+
+ sahara image-list command + usage: sahara image-list + +Print a list of available images. + +
+
+ sahara image-register command + usage: sahara image-register --id <image_id> [--username <name>] + [--description <desc>] + +Register an image from the Image index. + + 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. + + + + +
+
+ sahara image-remove-tag command + usage: sahara image-remove-tag [--name NAME] [--id <image_id>] --tag <tag> + +Remove a tag from an image. + + Optional arguments + + --name NAME + + + Name of the image. + + + + + --id <image_id> + + + Image to tag. + + + + + --tag <tag> + + + Tag to remove. + + + + +
+
+ sahara image-show command + usage: sahara image-show [--name NAME] [--id <image_id>] + +Show details of an image. + + Optional arguments + + --name NAME + + + Name of the image. + + + + + --id <image_id> ID + + + of the image. + + + + +
+
+ sahara image-unregister command + usage: sahara image-unregister [--name NAME] [--id <image_id>] + +Unregister an image. + + Optional arguments + + --name NAME + + + Name of the image. + + + + + --id <image_id> ID + + + of image to unregister. + + + + +
+
+ sahara job-binary-create command + usage: sahara job-binary-create --name NAME --url URL + [--description DESCRIPTION] [--user USER] + [--password PASSWORD] + +Record a job binary. + + 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. + + + + +
+
+ sahara job-binary-data-create command + usage: sahara job-binary-data-create [--file FILE] + +Store data in the internal DB. Use 'swift upload' instead of this command. Use +this command only if Swift is not available. + + Optional arguments + + --file FILE + + + Data to store. + + + + +
+
+ sahara job-binary-data-delete command + usage: sahara job-binary-data-delete --id ID + +Delete an internally stored job binary data. + + Optional arguments + + --id ID ID + + + of internally stored job binary data. + + + + +
+
+ sahara job-binary-data-list command + usage: sahara job-binary-data-list + +Print a list of internally stored job binary data. + +
+
+ sahara job-binary-delete command + usage: sahara job-binary-delete [--name NAME] [--id ID] + +Delete a job binary. + + Optional arguments + + --name NAME + + + Name of the job binary. + + + + + --id ID ID + + + of the job binary to delete. + + + + +
+
+ sahara job-binary-list command + usage: sahara job-binary-list + +Print a list of job binaries. + +
+
+ sahara job-binary-show command + usage: sahara job-binary-show [--name NAME] [--id ID] + +Show details of a job binary. + + Optional arguments + + --name NAME + + + Name of the job binary. + + + + + --id ID ID + + + of the job binary. + + + + +
+
+ sahara job-create command + usage: sahara job-create --job-template JOB_TEMPLATE --cluster CLUSTER + [--input-data INPUT_DATA] [--output-data OUTPUT_DATA] + [--param name=value] [--arg ARG] + [--config name=value] + + + 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. + + + + +
+
+ sahara job-delete command + usage: sahara job-delete --id ID + +Delete a job. + + Optional arguments + + --id ID ID + + + of a job. + + + + +
+
+ sahara job-list command + usage: sahara job-list + +Print a list of jobs. + +
+
+ sahara job-show command + usage: sahara job-show --id ID + +Show details of a job. + + Optional arguments + + --id ID ID + + + of the job. + + + + +
+
+ sahara job-template-create command + usage: sahara job-template-create --name NAME --type TYPE [--main MAIN] + [--lib LIB] [--description DESCRIPTION] + +Create a job template. + + 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. + + + + +
+
+ sahara job-template-delete command + usage: sahara job-template-delete [--name NAME] [--id ID] + +Delete a job template. + + Optional arguments + + --name NAME + + + Name of the job template. + + + + + --id ID ID + + + of the job template. + + + + +
+
+ sahara job-template-list command + usage: sahara job-template-list + +Print a list of job templates. + +
+
+ sahara job-template-show command + usage: sahara job-template-show [--name NAME] [--id ID] + +Show details of a job template. + + Optional arguments + + --name NAME + + + Name of the job template. + + + + + --id ID ID + + + of the job template. + + + + +
+
+ sahara node-group-template-create command + usage: sahara node-group-template-create [--json JSON] + +Create a node group template. + + Optional arguments + + --json JSON JSON + + + representation of node group template. + + + + +
+
+ sahara node-group-template-delete command + usage: sahara node-group-template-delete [--name NAME] [--id <template_id>] + +Delete a node group template. + + Optional arguments + + --name NAME + + + Name of the node group template. + + + + + --id <template_id> ID + + + of the node group template to delete. + + + + +
+
+ sahara node-group-template-list command + usage: sahara node-group-template-list + +Print a list of available node group templates. + +
+
+ sahara node-group-template-show command + usage: sahara node-group-template-show [--name NAME] [--id <template_id>] + [--json] + +Show details of a node group template. + + 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. + + + + +
+
+ sahara plugin-list command + usage: sahara plugin-list + +Print a list of available plugins. + +
+
+ sahara plugin-show command + usage: sahara plugin-show --name <plugin> + +Show details of a plugin. + + Optional arguments + + --name <plugin> + + + Name of the plugin. + + + + +
+