diff --git a/doc/cli-reference/source/index.rst b/doc/cli-reference/source/index.rst index e635cdb65a..4ca3ce9785 100644 --- a/doc/cli-reference/source/index.rst +++ b/doc/cli-reference/source/index.rst @@ -28,7 +28,6 @@ Contents senlin compute magnum - sahara database designate image diff --git a/doc/cli-reference/source/sahara.rst b/doc/cli-reference/source/sahara.rst deleted file mode 100644 index 190023592d..0000000000 --- a/doc/cli-reference/source/sahara.rst +++ /dev/null @@ -1,1146 +0,0 @@ -.. ## WARNING ##################################### -.. This file is tool-generated. Do not edit manually. -.. ################################################## - -=========================================== -Data Processing service command-line client -=========================================== - -The sahara client is the command-line interface (CLI) for -the Data Processing service API and its extensions. - -This chapter documents :command:`sahara` version ``0.18.0``. - -For help on a specific :command:`sahara` command, enter: - -.. code-block:: console - - $ sahara help COMMAND - -.. _sahara_command_usage: - -sahara usage -~~~~~~~~~~~~ - -.. code-block:: console - - usage: sahara [--version] [--debug] [--os-cache] [--region-name ] - [--service-type ] - [--endpoint-type ] - [--sahara-api-version ] - [--bypass-url ] [--os-tenant-name OS_TENANT_NAME] - [--os-tenant-id OS_TENANT_ID] [--os-auth-system OS_AUTH_SYSTEM] - [--os-auth-token OS_AUTH_TOKEN] [--insecure] - [--os-cacert ] [--os-cert ] - [--os-key ] [--timeout ] - [--os-auth-url OS_AUTH_URL] [--os-domain-id OS_DOMAIN_ID] - [--os-domain-name OS_DOMAIN_NAME] - [--os-project-id OS_PROJECT_ID] - [--os-project-name OS_PROJECT_NAME] - [--os-project-domain-id OS_PROJECT_DOMAIN_ID] - [--os-project-domain-name OS_PROJECT_DOMAIN_NAME] - [--os-trust-id OS_TRUST_ID] [--os-user-id OS_USER_ID] - [--os-username OS_USERNAME] - [--os-user-domain-id OS_USER_DOMAIN_ID] - [--os-user-domain-name OS_USER_DOMAIN_NAME] - [--os-password OS_PASSWORD] - ... - -**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. - -.. _sahara_command_options: - -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. - -``--region-name `` - Defaults to ``env[OS_REGION_NAME]``. - -``--service-type `` - Defaults to data-processing for all actions. - -``--endpoint-type `` - Defaults to ``env[SAHARA_ENDPOINT_TYPE]`` or - ``env[OS_ENDPOINT_TYPE]`` or publicURL. - -``--sahara-api-version `` - Accepts "api", defaults to ``env[SAHARA_API_VERSION]``. - -``--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]``. - -``--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-username OS_USERNAME, --os-user_name 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 - -.. _sahara_cluster-create: - -sahara cluster-create ---------------------- - -.. code-block:: console - - usage: sahara cluster-create [--json JSON] [--count COUNT] - -Create a cluster. - -**Optional arguments:** - -``--json JSON`` - JSON representation of cluster. - -``--count COUNT`` - Number of clusters to create. - -.. _sahara_cluster-delete: - -sahara cluster-delete ---------------------- - -.. code-block:: console - - usage: sahara cluster-delete [--name NAME] [--id ] - -Delete a cluster. - -**Optional arguments:** - -``--name NAME`` - Name of the cluster. - -``--id `` - ID of the cluster to delete. - -.. _sahara_cluster-list: - -sahara cluster-list -------------------- - -.. code-block:: console - - usage: sahara cluster-list - -Print a list of available clusters. - -.. _sahara_cluster-scale: - -sahara cluster-scale --------------------- - -.. code-block:: console - - usage: sahara cluster-scale [--name NAME] [--id ] [--json JSON] - -Scale a cluster. - -**Optional arguments:** - -``--name NAME`` - Name of the cluster. - -``--id `` - ID of the cluster. - -``--json JSON`` - JSON representation of cluster scale. - -.. _sahara_cluster-show: - -sahara cluster-show -------------------- - -.. code-block:: console - - usage: sahara cluster-show [--name NAME] [--id ] - [--show-progress SHOW_PROGRESS] [--json] - -Show details of a cluster. - -**Optional arguments:** - -``--name NAME`` - Name of the 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. - -.. _sahara_cluster-template-create: - -sahara cluster-template-create ------------------------------- - -.. code-block:: console - - usage: sahara cluster-template-create [--json JSON] - -Create a cluster template. - -**Optional arguments:** - -``--json JSON`` - JSON representation of cluster template. - -.. _sahara_cluster-template-delete: - -sahara cluster-template-delete ------------------------------- - -.. code-block:: console - - usage: sahara cluster-template-delete [--name NAME] [--id ] - -Delete a cluster template. - -**Optional arguments:** - -``--name NAME`` - Name of the cluster template. - -``--id `` - ID of the cluster template to delete. - -.. _sahara_cluster-template-list: - -sahara cluster-template-list ----------------------------- - -.. code-block:: console - - usage: sahara cluster-template-list - -Print a list of available cluster templates. - -.. _sahara_cluster-template-show: - -sahara cluster-template-show ----------------------------- - -.. code-block:: console - - usage: sahara cluster-template-show [--name NAME] [--id ] - [--json] - -Show details of a cluster template. - -**Optional arguments:** - -``--name NAME`` - Name of the cluster template. - -``--id `` - ID of the cluster template to show. - -``--json`` - Print JSON representation of cluster template. - -.. _sahara_cluster-template-update: - -sahara cluster-template-update ------------------------------- - -.. code-block:: console - - usage: sahara cluster-template-update [--name NAME] [--id ] - [--json JSON] - -Update a cluster template. - -**Optional arguments:** - -``--name NAME`` - Name of the cluster template to update. - -``--id `` - ID of the cluster template to update. - -``--json JSON`` - JSON representation of cluster template update. - -.. _sahara_data-source-create: - -sahara data-source-create -------------------------- - -.. code-block:: console - - 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: - -sahara data-source-delete -------------------------- - -.. code-block:: console - - 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: - -sahara data-source-list ------------------------ - -.. code-block:: console - - usage: sahara data-source-list - -Print a list of available data sources. - -.. _sahara_data-source-show: - -sahara data-source-show ------------------------ - -.. code-block:: console - - 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_data-source-update: - -sahara data-source-update -------------------------- - -.. code-block:: console - - usage: sahara data-source-update [--name NAME] [--id ID] [--json JSON] - -Update a 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. - -.. _sahara_image-add-tag: - -sahara image-add-tag --------------------- - -.. code-block:: console - - usage: sahara image-add-tag [--name NAME] [--id ] --tag - -Add a tag to an image. - -**Optional arguments:** - -``--name NAME`` - Name of the image. - -``--id `` - ID of image to tag. - -``--tag `` - Tag to add. - -.. _sahara_image-list: - -sahara image-list ------------------ - -.. code-block:: console - - usage: sahara image-list - -Print a list of available images. - -.. _sahara_image-register: - -sahara image-register ---------------------- - -.. code-block:: console - - usage: sahara image-register --id [--username ] - [--description ] - -Register an image from the Image index. - -**Optional arguments:** - -``--id `` - ID of image, run "glance image-list" to see all IDs. - -``--username `` - Username of privileged user in the image. - -``--description `` - Description of the image. - -.. _sahara_image-remove-tag: - -sahara image-remove-tag ------------------------ - -.. code-block:: console - - usage: sahara image-remove-tag [--name NAME] [--id ] --tag - -Remove a tag from an image. - -**Optional arguments:** - -``--name NAME`` - Name of the image. - -``--id `` - Image to tag. - -``--tag `` - Tag to remove. - -.. _sahara_image-show: - -sahara image-show ------------------ - -.. code-block:: console - - usage: sahara image-show [--name NAME] [--id ] - -Show details of an image. - -**Optional arguments:** - -``--name NAME`` - Name of the image. - -``--id `` - ID of the image. - -.. _sahara_image-unregister: - -sahara image-unregister ------------------------ - -.. code-block:: console - - usage: sahara image-unregister [--name NAME] [--id ] - -Unregister an image. - -**Optional arguments:** - -``--name NAME`` - Name of the image. - -``--id `` - ID of image to unregister. - -.. _sahara_job-binary-create: - -sahara job-binary-create ------------------------- - -.. code-block:: console - - 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: - -sahara job-binary-data-create ------------------------------ - -.. code-block:: console - - usage: sahara job-binary-data-create [--file FILE] [--name NAME] - -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. - -``--name NAME`` - Name of the job binary internal. - -.. _sahara_job-binary-data-delete: - -sahara job-binary-data-delete ------------------------------ - -.. code-block:: console - - 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: - -sahara job-binary-data-list ---------------------------- - -.. code-block:: console - - usage: sahara job-binary-data-list - -Print a list of internally stored job binary data. - -.. _sahara_job-binary-delete: - -sahara job-binary-delete ------------------------- - -.. code-block:: console - - 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: - -sahara job-binary-list ----------------------- - -.. code-block:: console - - usage: sahara job-binary-list - -Print a list of job binaries. - -.. _sahara_job-binary-show: - -sahara job-binary-show ----------------------- - -.. code-block:: console - - 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-binary-update: - -sahara job-binary-update ------------------------- - -.. code-block:: console - - usage: sahara job-binary-update [--name NAME] [--id ] - [--json JSON] - -Update a job binary. - -**Optional arguments:** - -``--name NAME`` - Name of the job binary to update. - -``--id `` - ID of the job binary to update. - -``--json JSON`` - JSON representation of job binary update. - -.. _sahara_job-create: - -sahara job-create ------------------ - -.. code-block:: console - - 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] [--json JSON] - -Create a job. - -**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. - -.. _sahara_job-delete: - -sahara job-delete ------------------ - -.. code-block:: console - - usage: sahara job-delete --id ID - -Delete a job. - -**Optional arguments:** - -``--id ID`` - ID of a job. - -.. _sahara_job-list: - -sahara job-list ---------------- - -.. code-block:: console - - usage: sahara job-list - -Print a list of jobs. - -.. _sahara_job-show: - -sahara job-show ---------------- - -.. code-block:: console - - usage: sahara job-show --id ID - -Show details of a job. - -**Optional arguments:** - -``--id ID`` - ID of the job. - -.. _sahara_job-template-create: - -sahara job-template-create --------------------------- - -.. code-block:: console - - usage: sahara job-template-create [--name NAME] [--type TYPE] [--main MAIN] - [--lib LIB] [--description DESCRIPTION] - [--json JSON] - -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. - -``--json JSON`` - JSON representation of job template. - -.. _sahara_job-template-delete: - -sahara job-template-delete --------------------------- - -.. code-block:: console - - 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: - -sahara job-template-list ------------------------- - -.. code-block:: console - - usage: sahara job-template-list - -Print a list of job templates. - -.. _sahara_job-template-show: - -sahara job-template-show ------------------------- - -.. code-block:: console - - 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_job-type-list: - -sahara job-type-list --------------------- - -.. code-block:: console - - usage: sahara job-type-list [--type ] [--plugin ] - [--plugin-version ] - -Show supported job types. - -**Optional arguments:** - -``--type `` - Report only on this job type. - -``--plugin `` - Report only job types supported by this plugin. - -``--plugin-version `` - Report only on job types supported by this version of - a specified plugin. Only valid with :option:`--plugin`. - -.. _sahara_node-group-template-create: - -sahara node-group-template-create ---------------------------------- - -.. code-block:: console - - 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: - -sahara node-group-template-delete ---------------------------------- - -.. code-block:: console - - usage: sahara node-group-template-delete [--name NAME] [--id ] - -Delete a node group template. - -**Optional arguments:** - -``--name NAME`` - Name of the node group template. - -``--id `` - ID of the node group template to delete. - -.. _sahara_node-group-template-list: - -sahara node-group-template-list -------------------------------- - -.. code-block:: console - - usage: sahara node-group-template-list - -Print a list of available node group templates. - -.. _sahara_node-group-template-show: - -sahara node-group-template-show -------------------------------- - -.. code-block:: console - - usage: sahara node-group-template-show [--name NAME] [--id ] - [--json] - -Show details of a node group template. - -**Optional arguments:** - -``--name NAME`` - Name of the node group template. - -``--id `` - ID of the node group template to show. - -``--json`` - Print JSON representation of node group template. - -.. _sahara_node-group-template-update: - -sahara node-group-template-update ---------------------------------- - -.. code-block:: console - - usage: sahara node-group-template-update [--name NAME] [--id ] - [--json JSON] - -Update a node group template. - -**Optional arguments:** - -``--name NAME`` - Name of the node group template to update. - -``--id `` - ID of the node group template to update. - -``--json JSON`` - JSON representation of the node group template update. - -.. _sahara_plugin-list: - -sahara plugin-list ------------------- - -.. code-block:: console - - usage: sahara plugin-list - -Print a list of available plugins. - -.. _sahara_plugin-show: - -sahara plugin-show ------------------- - -.. code-block:: console - - usage: sahara plugin-show --name - -Show details of a plugin. - -**Optional arguments:** - -``--name `` - Name of the plugin. - diff --git a/www/static/.htaccess b/www/static/.htaccess index 90e100c1a2..dd37c68ac2 100644 --- a/www/static/.htaccess +++ b/www/static/.htaccess @@ -507,3 +507,6 @@ redirect 301 /mitaka/networking-guide/adv-config-service-chaining.html /mitaka/n redirect 301 /mitaka/networking-guide/adv-config-sriov.html /mitaka/networking-guide/config-sriov.html redirect 301 /mitaka/networking-guide/adv-config-subnet-pools.html /mitaka/networking-guide/config-subnet-pools.html redirect 301 /mitaka/networking-guide/adv-config-tag.html /mitaka/networking-guide/ops-resource-tags.html + +# Redirect removed CLI reference +redirect 301 /cli-reference/sahara.html /developer/python-openstackclient/plugin-commands.html#sahara