Merge "[UG] Add description of `delete graph` command"

This commit is contained in:
Jenkins 2016-12-05 16:25:03 +00:00 committed by Gerrit Code Review
commit a9699d0fa1
10 changed files with 116 additions and 62 deletions

View File

@ -41,7 +41,7 @@ This section includes the following topics:
cli/cli_roles.rst
cli/cli_nodes_empty_role.rst
cli/cli_plugins.rst
cli/cli_graphs.rst
cli/cli_workflows.rst
cli/cli_config_openstack.rst
cli/cli_config_openstack_services_workflow.rst
cli/cli_change_ip_range.rst

View File

@ -1,49 +0,0 @@
.. _cli-graphs:
=====================================
Deployment graphs management commands
=====================================
The following table describes the deployment graphs management commands
supported by the Fuel CLI.
.. list-table:: **Deployment graphs management commands**
:widths: 15 20
:header-rows: 1
* - Description
- Command
* - List deployment graphs.
- ``fuel2 graph list --env <env_id>``
* - Upload deployment graphs for an environment, release, or plugin
to the ``tasks.yaml`` file.
- * ``fuel2 graph upload --env <env_id> [--type graph_type] --file tasks.yaml``
* ``fuel2 graph upload --release <release_id> [--type graph_type] --file tasks.yaml``
* ``fuel2 graph upload --plugin <plugin_id> [--type graph_type] --file tasks.yaml``
| The ``--type`` parameter is optional. If not specified, the default graph is uploaded.
* - Download deployment graphs from a certain environment. Use the ``--all``, ``--cluster``, ``--release``, or ``plugins`` flag to specify the level of the graphs to download.
- * ``fuel2 graph download --env <env_id> --all [--type <graph_type>] [--file <cluster_graph.yaml>]``
* ``fuel2 graph download --env <env_id> --cluster [--type <graph_type>] [--file <cluster_graph.yaml>]``
* ``fuel2 graph download --env <env_id> --release [--type <graph_type>] [--file <cluster_graph.yaml>]``
* ``fuel2 graph download --env <env_id> --plugins [--type <graph_type>] [--file <cluster_graph.yaml>]``
| The ``--type`` parameter is optional. If not specified, the default graph is downloaded.
| The graphs downloaded with the keys ``--all`` and ``--plugins`` are the
result of other graphs merge. They are not supposed to be edited and uploaded back,
because, in most cases, they will override further changes in source graphs.
* - Execute deployment graphs. Available for environments only.
- ``fuel2 graph execute --env <env_id> [--type <graph_type>] [--node <node_id>]``
| The ``--type`` parameter is optional. If not specified, the default graph is downloaded.
* - Run any task graph in a ``noop`` mode to detect customizations.
- ``fuel2 graph execute --env <env_id> [--type <graph_type>] --noop --force``
| The ``--force`` parameter is optional and is necessary for previously
executed graphs or tasks to prevent tasks skipping by Fuel LCM engine.

View File

@ -0,0 +1,69 @@
.. _cli-workflows:
========================================
Deployment workflows management commands
========================================
The following table describes the deployment workflows management commands
supported by the Fuel CLI.
.. list-table:: **Deployment workflows management commands**
:widths: 15 20
:header-rows: 1
* - Description
- Command
* - List deployment workflows.
Use ``-e <ENV_ID>``, ``--cluster``, ``--plugins``, or ``--release``
flags to specify an environment, cluster-, plugins-, or
release-related workflows.
- * ``fuel2 graph list``
* - Upload a specific type of deployment workflows configuration of an
environment, release, or plugin from the ``YAML`` file or the
directory that includes ``tasks.yaml`` and ``metadata.yaml``.
- * ``fuel2 graph upload -e <ENV_ID> -t <GRAPH_TYPE> (-f YAML_FILE_NAME | -d DIR_NAME)``
* ``fuel2 graph upload -r <RELEASE_ID> -t <GRAPH_TYPE> (-f YAML_FILE_NAME | -d DIR_NAME)``
* ``fuel2 graph upload -p <PLUGIN_ID> -t <GRAPH_TYPE> (-f YAML_FILE_NAME | -d DIR_NAME)``
* - Download deployment workflows of an environment.
Use the ``-a``, ``-c``, ``-r``, or ``-p`` flag to specify
the level of the workflows to download.
- * ``fuel2 graph download -e <ENV_ID> -a [-t <GRAPH_TYPE>]``
* ``fuel2 graph download -e <ENV_ID> -c [-t <GRAPH_TYPE>]``
* ``fuel2 graph download -e <ENV_ID> -r <RELEASE_ID> [-t <GRAPH_TYPE>]``
* ``fuel2 graph download -e <ENV_ID> -p <PLUGIN_ID> [-t <GRAPH_TYPE>]``
The ``-t`` parameter is optional. If not specified, the default
workflow is downloaded.
The workflows downloaded with the keys ``-a`` and ``-p`` are the
result of other workflows merge. They are not supposed to be edited
and uploaded back, because, in most cases, they will override
further changes in source workflows.
* - Start a deployment with given workflow types.
Available for environments only.
- * ``fuel2 graph execute -e <ENV_ID> -t GRAPH_TYPES <GRAPH_TYPES>``
The ``-t GRAPH_TYPES`` parameter specifies the types of deployment
workflow in order of execution.
* - Run any task workflow in the ``noop`` mode to detect customizations.
- * ``fuel2 graph execute -e <ENV_ID> -t GRAPH_TYPES <GRAPH_TYPES> --noop --force``
The ``--force`` parameter is optional and is necessary for previously
executed workflows or tasks to prevent tasks skipping by Fuel
LCM engine.
* - Delete deployment workflows.
Use ``-e <ENV_ID>``, ``-p``, or ``-r`` flag to specify
an environment, plugins- or release-related workflows.
- * ``fuel2 graph delete -e <ENV_ID> -t <GRAPH_TYPE>``
* ``fuel2 graph delete -r <RELEASE_ID> -t <GRAPH_TYPE>``
* ``fuel2 graph delete -p <PLUGIN_ID> -t <GRAPH_TYPE>``

View File

@ -30,5 +30,5 @@ This section includes the following topics:
.. seealso::
- :ref:`workflows_manage`
- :ref:`cli-graphs`
- :ref:`cli-workflows`
- :ref:`data-driven`

View File

@ -5,11 +5,11 @@ Manage workflows
================
Fuel enables you to manage the deployment workflows through both the Fuel web
UI and CLI. You can view, upload, download, and execute default workflows
as well as the custom ones. Execution of the custom deployment workflows
and merging them with the default deployment workflows allows for the
implementation of complex orchestrated workflows, such as bug fixes application,
reference architecture alteration, and upgrades.
UI and CLI. You can view, upload, download, execute, and delete default
workflows as well as the custom ones. Execution of the custom deployment
workflows and merging them with the default deployment workflows allows for
the implementation of complex orchestrated workflows, such as bug fixes
application, reference architecture alteration, and upgrades.
This section includes the following topics:
@ -20,11 +20,12 @@ This section includes the following topics:
workflows-manage/upload-workflows.rst
workflows-manage/download-workflows.rst
workflows-manage/run-workflows.rst
workflows-manage/delete-workflows.rst
workflows-manage/view-history.rst
workflows-manage/download-deployment-info.rst
.. seealso::
* :ref:`workflow-intro`
* :ref:`cli-graphs`
* :ref:`cli-workflows`
* :ref:`data-driven`

View File

@ -0,0 +1,33 @@
.. _delete_workflows:
============================
Delete a deployment workflow
============================
Fuel stores the information about all deployment workflows associated with
each deployment of an environment as well as custom workflows if any.
You can delete deployment workflows using the Fuel web UI or
Fuel CLI.
**To delete a deployment workflow using the Fuel web UI:**
#. Log in to the Fuel web UI.
#. Select the required OpenStack environment.
#. Go to the :guilabel:`Workflows` tab.
#. Click :guilabel:`Delete` in the required workflow field.
**To delete a deployment workflow using the Fuel CLI:**
#. Log in to the Fuel Master node CLI.
#. Delete the required workflow using the :command:`fuel2 graph delete`
command.
**Example:**
.. code-block:: console
fuel2 graph delete -e 1 -t provision
.. seealso::
* :ref:`cli-workflows`

View File

@ -29,4 +29,4 @@ Fuel CLI.
.. seealso::
* :ref:`cli-graphs`
* :ref:`cli-workflows`

View File

@ -42,4 +42,4 @@ or Fuel CLI.
.. seealso::
* :ref:`cli-graphs`
* :ref:`cli-workflows`

View File

@ -27,8 +27,8 @@ Fuel CLI.
.. code-block:: console
fuel2 graph upload --env 1 --file tasks.yaml
fuel2 graph upload -e 1 -t provision -f tasks.yaml
.. seealso::
* :ref:`cli-graphs`
* :ref:`cli-workflows`

View File

@ -25,7 +25,7 @@ the Fuel web UI (timeline or table view mode) as well as the Fuel CLI.
#. Go the :guilabel:`History` tab.
#. Select the required deployment.
**To view the deployment history using the Fuel Web CLI:**
**To view the deployment history using the Fuel CLI:**
#. Log in to the Fuel Master node.
#. Obtain the ID of the deployment task using one of the following commands: