From 51ac33c003e683bd169191410408b8a2f0c56985 Mon Sep 17 00:00:00 2001 From: Olena Logvinova Date: Wed, 16 Nov 2016 18:16:43 +0200 Subject: [PATCH] [UG] Add description of `delete graph` command This patch: - adds the description of the `fuel2 delete graph` command to the corresponding sub-section of Fuel CLI section; - adds steps on how to delete a deployment workflow to the Manage workflows sub-section of the Maintain your env section; - changes the following parameters as preferable in fuel2 CLI where applicable: '--env' to '-e', '--type' to '-t', '--release' to '-r', '--plugin' to '-p', '--all' to '-a', '--cluster' to 'c'; - renames 'graph' to 'workflow'; - fixes noticed typos. Change-Id: I2e88436792d812ba60f5189c4a572d680ed0ae21 Closes-Bug: #1633773 --- userdocs/fuel-user-guide/cli.rst | 2 +- userdocs/fuel-user-guide/cli/cli_graphs.rst | 49 ------------- .../fuel-user-guide/cli/cli_workflows.rst | 69 +++++++++++++++++++ .../configure-environment/workflows.rst | 2 +- .../maintain-environment/workflows-manage.rst | 13 ++-- .../workflows-manage/delete-workflows.rst | 33 +++++++++ .../workflows-manage/download-workflows.rst | 2 +- .../workflows-manage/run-workflows.rst | 2 +- .../workflows-manage/upload-workflows.rst | 4 +- .../workflows-manage/view-history.rst | 2 +- 10 files changed, 116 insertions(+), 62 deletions(-) delete mode 100644 userdocs/fuel-user-guide/cli/cli_graphs.rst create mode 100644 userdocs/fuel-user-guide/cli/cli_workflows.rst create mode 100644 userdocs/fuel-user-guide/maintain-environment/workflows-manage/delete-workflows.rst diff --git a/userdocs/fuel-user-guide/cli.rst b/userdocs/fuel-user-guide/cli.rst index 7932a72e0..f0aabf49e 100644 --- a/userdocs/fuel-user-guide/cli.rst +++ b/userdocs/fuel-user-guide/cli.rst @@ -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 diff --git a/userdocs/fuel-user-guide/cli/cli_graphs.rst b/userdocs/fuel-user-guide/cli/cli_graphs.rst deleted file mode 100644 index ec2b9eed4..000000000 --- a/userdocs/fuel-user-guide/cli/cli_graphs.rst +++ /dev/null @@ -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 `` - - * - Upload deployment graphs for an environment, release, or plugin - to the ``tasks.yaml`` file. - - * ``fuel2 graph upload --env [--type graph_type] --file tasks.yaml`` - * ``fuel2 graph upload --release [--type graph_type] --file tasks.yaml`` - * ``fuel2 graph upload --plugin [--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 --all [--type ] [--file ]`` - * ``fuel2 graph download --env --cluster [--type ] [--file ]`` - * ``fuel2 graph download --env --release [--type ] [--file ]`` - * ``fuel2 graph download --env --plugins [--type ] [--file ]`` - - | 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 [--type ] [--node ]`` - - | 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 [--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. \ No newline at end of file diff --git a/userdocs/fuel-user-guide/cli/cli_workflows.rst b/userdocs/fuel-user-guide/cli/cli_workflows.rst new file mode 100644 index 000000000..18b93e317 --- /dev/null +++ b/userdocs/fuel-user-guide/cli/cli_workflows.rst @@ -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 ``, ``--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 -t (-f YAML_FILE_NAME | -d DIR_NAME)`` + * ``fuel2 graph upload -r -t (-f YAML_FILE_NAME | -d DIR_NAME)`` + * ``fuel2 graph upload -p -t (-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 -a [-t ]`` + * ``fuel2 graph download -e -c [-t ]`` + * ``fuel2 graph download -e -r [-t ]`` + * ``fuel2 graph download -e -p [-t ]`` + + 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 -t 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 -t 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 ``, ``-p``, or ``-r`` flag to specify + an environment, plugins- or release-related workflows. + - * ``fuel2 graph delete -e -t `` + * ``fuel2 graph delete -r -t `` + * ``fuel2 graph delete -p -t `` diff --git a/userdocs/fuel-user-guide/configure-environment/workflows.rst b/userdocs/fuel-user-guide/configure-environment/workflows.rst index f49b2cbfc..2265e126d 100644 --- a/userdocs/fuel-user-guide/configure-environment/workflows.rst +++ b/userdocs/fuel-user-guide/configure-environment/workflows.rst @@ -30,5 +30,5 @@ This section includes the following topics: .. seealso:: - :ref:`workflows_manage` - - :ref:`cli-graphs` + - :ref:`cli-workflows` - :ref:`data-driven` diff --git a/userdocs/fuel-user-guide/maintain-environment/workflows-manage.rst b/userdocs/fuel-user-guide/maintain-environment/workflows-manage.rst index 02c06bf21..e57e5f22b 100644 --- a/userdocs/fuel-user-guide/maintain-environment/workflows-manage.rst +++ b/userdocs/fuel-user-guide/maintain-environment/workflows-manage.rst @@ -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` \ No newline at end of file diff --git a/userdocs/fuel-user-guide/maintain-environment/workflows-manage/delete-workflows.rst b/userdocs/fuel-user-guide/maintain-environment/workflows-manage/delete-workflows.rst new file mode 100644 index 000000000..15bb77cf0 --- /dev/null +++ b/userdocs/fuel-user-guide/maintain-environment/workflows-manage/delete-workflows.rst @@ -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` diff --git a/userdocs/fuel-user-guide/maintain-environment/workflows-manage/download-workflows.rst b/userdocs/fuel-user-guide/maintain-environment/workflows-manage/download-workflows.rst index b30c0e80d..cfb0c2a83 100644 --- a/userdocs/fuel-user-guide/maintain-environment/workflows-manage/download-workflows.rst +++ b/userdocs/fuel-user-guide/maintain-environment/workflows-manage/download-workflows.rst @@ -29,4 +29,4 @@ Fuel CLI. .. seealso:: - * :ref:`cli-graphs` \ No newline at end of file + * :ref:`cli-workflows` \ No newline at end of file diff --git a/userdocs/fuel-user-guide/maintain-environment/workflows-manage/run-workflows.rst b/userdocs/fuel-user-guide/maintain-environment/workflows-manage/run-workflows.rst index 308cfc338..994970973 100644 --- a/userdocs/fuel-user-guide/maintain-environment/workflows-manage/run-workflows.rst +++ b/userdocs/fuel-user-guide/maintain-environment/workflows-manage/run-workflows.rst @@ -42,4 +42,4 @@ or Fuel CLI. .. seealso:: - * :ref:`cli-graphs` \ No newline at end of file + * :ref:`cli-workflows` \ No newline at end of file diff --git a/userdocs/fuel-user-guide/maintain-environment/workflows-manage/upload-workflows.rst b/userdocs/fuel-user-guide/maintain-environment/workflows-manage/upload-workflows.rst index ca609c005..e2f932666 100644 --- a/userdocs/fuel-user-guide/maintain-environment/workflows-manage/upload-workflows.rst +++ b/userdocs/fuel-user-guide/maintain-environment/workflows-manage/upload-workflows.rst @@ -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` \ No newline at end of file + * :ref:`cli-workflows` \ No newline at end of file diff --git a/userdocs/fuel-user-guide/maintain-environment/workflows-manage/view-history.rst b/userdocs/fuel-user-guide/maintain-environment/workflows-manage/view-history.rst index 5bd3cd1bb..9c16dd41c 100644 --- a/userdocs/fuel-user-guide/maintain-environment/workflows-manage/view-history.rst +++ b/userdocs/fuel-user-guide/maintain-environment/workflows-manage/view-history.rst @@ -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: