Browse Source

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

changes/37/408337/1
Jenkins 2 years ago
parent
commit
a9699d0fa1

+ 1
- 1
userdocs/fuel-user-guide/cli.rst View File

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

+ 0
- 49
userdocs/fuel-user-guide/cli/cli_graphs.rst View File

@@ -1,49 +0,0 @@
1
-.. _cli-graphs:
2
-
3
-=====================================
4
-Deployment graphs management commands
5
-=====================================
6
-
7
-The following table describes the deployment graphs management commands
8
-supported by the Fuel CLI.
9
-
10
-.. list-table:: **Deployment graphs management commands**
11
-   :widths: 15 20
12
-   :header-rows: 1
13
-
14
-   * - Description
15
-     - Command
16
-
17
-   * - List deployment graphs.
18
-     - ``fuel2 graph list --env <env_id>``
19
-
20
-   * - Upload deployment graphs for an environment, release, or plugin
21
-       to the ``tasks.yaml`` file.
22
-     - * ``fuel2 graph upload --env <env_id> [--type graph_type] --file tasks.yaml``
23
-       * ``fuel2 graph upload --release <release_id> [--type graph_type] --file tasks.yaml``
24
-       * ``fuel2 graph upload --plugin <plugin_id> [--type graph_type] --file tasks.yaml``
25
-
26
-       | The ``--type`` parameter is optional. If not specified, the default graph is uploaded.
27
-
28
-   * - Download deployment graphs from a certain environment. Use the ``--all``, ``--cluster``, ``--release``, or ``plugins`` flag to specify the level of the graphs to download.
29
-     - * ``fuel2 graph download --env <env_id> --all [--type <graph_type>] [--file <cluster_graph.yaml>]``
30
-       * ``fuel2 graph download --env <env_id> --cluster [--type <graph_type>] [--file <cluster_graph.yaml>]``
31
-       * ``fuel2 graph download --env <env_id> --release [--type <graph_type>] [--file <cluster_graph.yaml>]``
32
-       * ``fuel2 graph download --env <env_id> --plugins [--type <graph_type>] [--file <cluster_graph.yaml>]``
33
-
34
-       | The ``--type`` parameter is optional. If not specified, the default graph is downloaded.
35
-
36
-       | The graphs downloaded with the keys ``--all`` and ``--plugins`` are the
37
-         result of other graphs merge. They are not supposed to be edited and uploaded back,
38
-         because, in most cases, they will override further changes in source graphs.
39
-
40
-   * - Execute deployment graphs. Available for environments only.
41
-     - ``fuel2 graph execute --env <env_id> [--type <graph_type>] [--node <node_id>]``
42
-
43
-       | The ``--type`` parameter is optional. If not specified, the default graph is downloaded.
44
-
45
-   * - Run any task graph in a ``noop`` mode to detect customizations.
46
-     - ``fuel2 graph execute --env <env_id> [--type <graph_type>] --noop --force``
47
-
48
-       | The ``--force`` parameter is optional and is necessary for previously
49
-         executed graphs or tasks to prevent tasks skipping by Fuel LCM engine.

+ 69
- 0
userdocs/fuel-user-guide/cli/cli_workflows.rst View File

@@ -0,0 +1,69 @@
1
+.. _cli-workflows:
2
+
3
+========================================
4
+Deployment workflows management commands
5
+========================================
6
+
7
+The following table describes the deployment workflows management commands
8
+supported by the Fuel CLI.
9
+
10
+.. list-table:: **Deployment workflows management commands**
11
+   :widths: 15 20
12
+   :header-rows: 1
13
+
14
+   * - Description
15
+     - Command
16
+
17
+   * - List deployment workflows.
18
+
19
+       Use ``-e <ENV_ID>``, ``--cluster``, ``--plugins``, or ``--release``
20
+       flags to specify an environment, cluster-, plugins-, or
21
+       release-related workflows.
22
+     - * ``fuel2 graph list``
23
+
24
+   * - Upload a specific type of deployment workflows configuration of an
25
+       environment, release, or plugin from the ``YAML`` file or the
26
+       directory that includes ``tasks.yaml`` and ``metadata.yaml``.
27
+     - * ``fuel2 graph upload -e <ENV_ID> -t <GRAPH_TYPE> (-f YAML_FILE_NAME | -d DIR_NAME)``
28
+       * ``fuel2 graph upload -r <RELEASE_ID> -t <GRAPH_TYPE> (-f YAML_FILE_NAME | -d DIR_NAME)``
29
+       * ``fuel2 graph upload -p <PLUGIN_ID> -t <GRAPH_TYPE> (-f YAML_FILE_NAME | -d DIR_NAME)``
30
+
31
+   * - Download deployment workflows of an environment.
32
+
33
+       Use the ``-a``, ``-c``, ``-r``, or ``-p`` flag to specify
34
+       the level of the workflows to download.
35
+     - * ``fuel2 graph download -e <ENV_ID> -a [-t <GRAPH_TYPE>]``
36
+       * ``fuel2 graph download -e <ENV_ID> -c [-t <GRAPH_TYPE>]``
37
+       * ``fuel2 graph download -e <ENV_ID> -r <RELEASE_ID> [-t <GRAPH_TYPE>]``
38
+       * ``fuel2 graph download -e <ENV_ID> -p <PLUGIN_ID> [-t <GRAPH_TYPE>]``
39
+
40
+       The ``-t`` parameter is optional. If not specified, the default
41
+       workflow is downloaded.
42
+
43
+       The workflows downloaded with the keys ``-a`` and ``-p`` are the
44
+       result of other workflows merge. They are not supposed to be edited
45
+       and uploaded back, because, in most cases, they will override
46
+       further changes in source workflows.
47
+
48
+   * - Start a deployment with given workflow types.
49
+
50
+       Available for environments only.
51
+     - * ``fuel2 graph execute -e <ENV_ID> -t GRAPH_TYPES <GRAPH_TYPES>``
52
+
53
+       The ``-t GRAPH_TYPES`` parameter specifies the types of deployment
54
+       workflow in order of execution.
55
+
56
+   * - Run any task workflow in the ``noop`` mode to detect customizations.
57
+     - * ``fuel2 graph execute -e <ENV_ID> -t GRAPH_TYPES <GRAPH_TYPES> --noop --force``
58
+
59
+       The ``--force`` parameter is optional and is necessary for previously
60
+       executed workflows or tasks to prevent tasks skipping by Fuel
61
+       LCM engine.
62
+
63
+   * - Delete deployment workflows.
64
+
65
+       Use ``-e <ENV_ID>``, ``-p``, or ``-r`` flag to specify
66
+       an environment, plugins- or release-related workflows.
67
+     - * ``fuel2 graph delete -e <ENV_ID> -t <GRAPH_TYPE>``
68
+       * ``fuel2 graph delete -r <RELEASE_ID> -t <GRAPH_TYPE>``
69
+       * ``fuel2 graph delete -p <PLUGIN_ID> -t <GRAPH_TYPE>``

+ 1
- 1
userdocs/fuel-user-guide/configure-environment/workflows.rst View File

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

+ 7
- 6
userdocs/fuel-user-guide/maintain-environment/workflows-manage.rst View File

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

+ 33
- 0
userdocs/fuel-user-guide/maintain-environment/workflows-manage/delete-workflows.rst View File

@@ -0,0 +1,33 @@
1
+.. _delete_workflows:
2
+
3
+============================
4
+Delete a deployment workflow
5
+============================
6
+
7
+Fuel stores the information about all deployment workflows associated with
8
+each deployment of an environment as well as custom workflows if any.
9
+You can delete deployment workflows using the Fuel web UI or
10
+Fuel CLI.
11
+
12
+**To delete a deployment workflow using the Fuel web UI:**
13
+
14
+#. Log in to the Fuel web UI.
15
+#. Select the required OpenStack environment.
16
+#. Go to the :guilabel:`Workflows` tab.
17
+#. Click :guilabel:`Delete` in the required workflow field.
18
+
19
+**To delete a deployment workflow using the Fuel CLI:**
20
+
21
+#. Log in to the Fuel Master node CLI.
22
+#. Delete the required workflow using the :command:`fuel2 graph delete`
23
+   command.
24
+
25
+   **Example:**
26
+
27
+   .. code-block:: console
28
+
29
+      fuel2 graph delete -e 1 -t provision
30
+
31
+.. seealso::
32
+
33
+   * :ref:`cli-workflows`

+ 1
- 1
userdocs/fuel-user-guide/maintain-environment/workflows-manage/download-workflows.rst View File

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

+ 1
- 1
userdocs/fuel-user-guide/maintain-environment/workflows-manage/run-workflows.rst View File

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

+ 2
- 2
userdocs/fuel-user-guide/maintain-environment/workflows-manage/upload-workflows.rst View File

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

+ 1
- 1
userdocs/fuel-user-guide/maintain-environment/workflows-manage/view-history.rst View File

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

Loading…
Cancel
Save