diff --git a/doc/source/guides/cli_guide.rst b/doc/source/guides/cli_guide.rst index 985e6789..f4d9be61 100644 --- a/doc/source/guides/cli_guide.rst +++ b/doc/source/guides/cli_guide.rst @@ -1,658 +1,87 @@ Mistral Client Commands Guide ============================= -Workbooks -^^^^^^^^^ +The Mistral CLI can be used with ``mistral`` command or via `OpenStackClient +`_. -**workbook-create**: -:: +Mistral Client +-------------- - mistral workbook-create +The best way to learn about all the commands and arguements that are expected +is to use the ``mistral help`` comand. -Create new workbook. +.. code-block:: bash -positional arguments: - definition - Workbook definition file. + $ mistral help + usage: mistral [--version] [-v] [--log-file LOG_FILE] [-q] [-h] [--debug] + [--os-mistral-url MISTRAL_URL] + [--os-mistral-version MISTRAL_VERSION] + [--os-mistral-service-type SERVICE_TYPE] + ... -**workbook-delete**: -:: +It can also be used with the name of a sub-command. - mistral workbook-delete [ ...] +.. code-block:: bash -Delete workbook. + $ mistral help execution-create + usage: mistral execution-create [-h] [-f {json,shell,table,value,yaml}] + [-c COLUMN] [--max-width ] + [--print-empty] [--noindent] [--prefix PREFIX] + [-d DESCRIPTION] + workflow_identifier [workflow_input] [params] -positional arguments: - name - Name of workbook(s). + Create new execution. -**workbook-get**: -:: + positional arguments: + workflow_identifier Workflow ID or name. Workflow name will be deprecated + sinceMitaka. + ... - mistral workbook-get -Show specific workbook. +OpenStack Client +---------------- -positional arguments: - name - Workbook name. +OpenStack client works in a similar way, the command ``openstack help`` shows +all the available commands and then ``openstack help `` will show +the detailed usage. -**workbook-get-definition**: -:: +The full list of Mistral commands that are registered with OpenStack client +can be listed with ``openstack command list``. By default it will list all +commands grouped togehter, but we can specify only the Mistral command group. - mistral workbook-get-definition +.. code-block:: bash -Show workbook definition. + $ openstack command list --group openstack.workflow_engine.v2 + +------------------------------+-----------------------------------+ + | Command Group | Commands | + +------------------------------+-----------------------------------+ + | openstack.workflow_engine.v2 | action definition create | + | | action definition definition show | + | | action definition delete | + | | action definition list | + | | action definition show | + | | action definition update | + | | action execution delete | + ... -positional arguments: - workbook_identifier - Workbook name or ID. +Then detailed help output can be requested for an individual command. -**workbook-list**: -:: +.. code-block:: bash - mistral workbook-list + $ openstack help workflow execution create + usage: openstack workflow execution create [-h] + [-f {json,shell,table,value,yaml}] + [-c COLUMN] [--max-width ] + [--print-empty] [--noindent] + [--prefix PREFIX] [-d DESCRIPTION] + workflow_identifier + [workflow_input] [params] -List all workbooks. + Create new execution. -**workbook-update**: -:: + positional arguments: + workflow_identifier Workflow ID or name. Workflow name will be deprecated + sinceMitaka. + workflow_input Workflow input + params Workflow additional parameters - mistral workbook-update - -Update workbook. - -positional arguments: - definition - Workbook definition file. - -**workbook-validate**: -:: - - mistral workbook-validate - -Validate workbook. - -positional arguments: - definition - Workbook definition file. - -Workflows -^^^^^^^^^ - -**workflow-create**: -:: - - mistral workflow-create [--public] - -Create new workflow. - -positional arguments: - definition - Workflow definition file. - -optional arguments: - --public - With this flag workflow will be marked as "public". - -**workflow-delete**: -:: - - mistral workflow-delete [ ...] - -Delete workflow. - -positional arguments: - name - Name of workflow(s). - -**workflow-get**: -:: - - mistral workflow-get - -Show specific workflow. - -positional arguments: - name - Workflow name. - -**workflow-get-definition**: -:: - - mistral workflow-get-definition - -Show workflow definition. - -positional arguments: - name - Workflow name. - -**workflow-list**: -:: - - mistral workflow-list - -List all workflows. - -**workflow-update**: -:: - - mistral workflow-update - -Update workflow. - -positional arguments: - definition - Workflow definition. - -**workflow-validate**: -:: - - mistral workflow-validate - -Validate workflow. - -positional arguments: - definition - Workflow definition file. - -Actions -^^^^^^^ - -**action-create**: -:: - - mistral action-create [--public] - -Create new action. - -positional arguments: - definition - Action definition file. - -optional arguments: - --public - With this flag action will be marked as "public". - -**action-delete**: -:: - - mistral action-delete action [action ...] - -Delete action. - -positional arguments: - action - Name or ID of action(s). - -**action-get**: -:: - - mistral action-get - -Show specific action. - -positional arguments: - action - Action (name or ID). - -**action-get-definition**: -:: - - mistral action-get-definition - -Show action definition. - -positional arguments: - name - Action name. - -**action-list**: -:: - - mistral action-list - -List all actions. - -**action-update**: -:: - - mistral action-update [--public] [--id ID] - -Update action. - -positional arguments: - definition - Action definition file. - -optional arguments: - --id ID Action ID. - --public With this flag, action will be marked as "public". - -**action-validate**: -:: - - mistral action-validate - -Validate action. - -positional arguments: - definition - Action definition file. - -Workflow executions -^^^^^^^^^^^^^^^^^^^ - -**execution-create**: -:: - - mistral execution-create [-d DESCRIPTION] - [] [] - -Create a new execution. - -positional arguments: - workflow_identifier - Workflow ID or name. Workflow name has been deprecated - since Mitaka. - workflow_input - Workflow input. - params - Workflow additional parameters. - -optional arguments: - -d DESCRIPTION, --description DESCRIPTION - Execution description - -**execution-delete**: -:: - - mistral execution-delete [ ...] - -Delete execution. - -positional arguments: - execution - Id of execution identifier(s). - -**execution-get**: -:: - - mistral execution-get - -Show specific execution. - -positional arguments: - execution - Execution identifier. - -**execution-get-input**: -:: - - mistral execution-get-input - -Show execution input data. - -positional arguments: - id - Execution ID. - -**execution-get-output**: -:: - - mistral execution-get-output [-h] id - -Show execution output data. - -positional arguments: - id - Execution ID. - -**execution-list**: -:: - - mistral execution-list [--marker [MARKER]] [--limit [LIMIT]] - [--sort_keys [SORT_KEYS]] - [--sort_dirs [SORT_DIRS]] - -List all executions. - -optional arguments: - --marker [MARKER] The last execution uuid of the previous page, displays - list of executions after "marker". - --limit [LIMIT] Maximum number of executions to return in a single - result. - --sort_keys [SORT_KEYS] - Comma-separated list of sort keys to sort results by. - Default: created_at. Example: mistral execution-list - --sort_keys=id,description - --sort_dirs [SORT_DIRS] - Comma-separated list of sort directions. Default: asc. - Example: mistral execution-list - --sort_keys=id,description --sort_dirs=asc,desc - -**execution-update**: -:: - - mistral execution-update [-s {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}] - [-e ENV] [-d DESCRIPTION] - -Update execution. - -positional arguments: - id - Execution identifier. - -optional arguments: - -s {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}, --state {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED} - Execution state - -e ENV, --env ENV Environment variables - -d DESCRIPTION, --description DESCRIPTION - Execution description - -Task executions -^^^^^^^^^^^^^^^ - -**task-get**: -:: - - mistral task-get - -Show specific task. - -positional arguments: - id - Task identifier. - -**task-get-published**: -:: - - mistral task-get-published - -Show task published variables. - -positional arguments: - id - Task ID. - -**task-get-result**: -:: - - mistral task-get-result - -Show task output data. - -positional arguments: - id - Task ID. - -**task-list**: -:: - - mistral task-list [] - -List all tasks. - -positional arguments: - workflow_execution - Workflow execution ID associated with list of Tasks. - -**task-rerun**: -:: - - mistral task-rerun [--resume] [-e ENV] - -Rerun an existing task. - -positional arguments: - id - Task identifier. - -optional arguments: - --resume rerun only failed or unstarted action executions for - with-items task. - -e ENV, --env ENV Environment variables. - -Action executions -^^^^^^^^^^^^^^^^^ - -**action-execution-delete**: -:: - - mistral action-execution-delete [ ...] - -Delete action execution. - -positional arguments: - action_execution - Action execution ID. - -**action-execution-get**: -:: - - mistral action-execution-get - -Show specific Action execution. - -positional arguments: - action_execution - Action execution ID. - -**action-execution-get-input**: -:: - - mistral action-execution-get-input - -Show Action execution input data. - -positional arguments: - id - Action execution ID. - -**action-execution-get-output**: -:: - - mistral action-execution-get-output - -Show Action execution output data. - -positional arguments: - id - Action execution ID. - -**action-execution-list**: -:: - - mistral action-execution-list [] - -List all Action executions. - -positional arguments: - task-execution-id - Task execution ID. - -**action-execution-update**: -:: - - mistral action-execution-update [--state {IDLE,RUNNING,SUCCESS,ERROR}] [--output ] - -Update specific Action execution. - -positional arguments: - id - Action execution ID. - -optional arguments: - --state {IDLE,RUNNING,SUCCESS,ERROR} - Action execution state - --output OUTPUT - Action execution output - -**run-action**: -:: - - mistral run-action [] [-t ] - -Create new Action execution or just run specific action. - -positional arguments: - name - Action name to execute. - input - Action input. - -optional arguments: - -s, --save-result - Save the result into DB. - -t TARGET, --target TARGET - Action will be executed on executor. - -Cron-triggers -^^^^^^^^^^^^^ - -**cron-trigger-create**: -:: - - mistral cron-trigger-create [--params ] [--pattern <* * * * *>] - [--first-time ] - [--count ] - [] - -Create new trigger. - -positional arguments: - name - Cron trigger name. - workflow_identifier - Workflow name or ID. - workflow_input - Workflow input. - -optional arguments: - --params PARAMS - Workflow params. - --pattern <* * * * *> - Cron trigger pattern. - --first-time - Date and time of the first execution. - --count Number of wanted executions. - -**cron-trigger-delete**: -:: - - mistral cron-trigger-delete [ ...] - -Delete trigger. - -positional arguments: - name - Name of cron trigger(s). - -**cron-trigger-get**: -:: - - mistral cron-trigger-get - -Show specific cron trigger. - -positional arguments: - name - Cron trigger name. - -**cron-trigger-list**: -:: - - mistral cron-trigger-list - -List all cron triggers. - -Environments -^^^^^^^^^^^^ - -**environment-create**: -:: - - mistral environment-create - -Create new environment. - -positional arguments: - file - Environment configuration file in JSON or YAML. - -**environment-delete**: -:: - - mistral environment-delete [ ...] - -Delete environment. - -positional arguments: - environment - Name of environment(s). - -**environment-get**: -:: - - mistral environment-get - -Show specific environment. - -positional arguments: - name - Environment name. - -**environment-list**: -:: - - mistral environment-list - -List all environments. - -**environment-update**: -:: - - mistral environment-update - -Update environment. - -positional arguments: - file - Environment configuration file in JSON or YAML. - - -Members -^^^^^^^ - -**member-create**: -:: - - mistral member-create - -Shares a resource to another tenant. - -positional arguments: - resource_id - Resource ID to be shared. - resource_type - Resource type. - member_id - Project ID to whom the resource is shared to. - -**member-delete**: -:: - - mistral member-delete - -Delete a resource sharing relationship. - -positional arguments: - resource - Resource ID to be shared. - resource_type - Resource type. - member_id - Project ID to whom the resource is shared to. - -**member-get**: -:: - - mistral member-get [-m MEMBER_ID] - - -Show specific member information. - -positional arguments: - resource - Resource ID to be shared. - resource_type - Resource type. - -optional arguments: - -m MEMBER_ID, --member-id MEMBER_ID - Project ID to whom the resource is shared to. No need - to provide this param if you are the resource member. - -**member-list**: -:: - - mistral member-list - -List all members. - -positional arguments: - resource_id - Resource id to be shared. - resource_type - Resource type. - -**member-update**: -:: - - mistral member-update [-m MEMBER_ID] - [-s {pending,accepted,rejected}] - - -Update resource sharing status. - -positional arguments: - resource_id - Resource ID to be shared. - resource_type - Resource type. - -optional arguments: - -m MEMBER_ID, --member-id MEMBER_ID - Project ID to whom the resource is shared to. No need - to provide this param if you are the resource member. - -s {pending,accepted,rejected}, --status {pending,accepted,rejected} - status of the sharing. - -Services API -^^^^^^^^^^^^ - -**service-list**: -:: - - mistral service-list - -List all services. - -.. seealso:: - `Workflow service command-line client `_.