summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2016-12-05 16:25:03 +0000
committerGerrit Code Review <review@openstack.org>2016-12-05 16:25:03 +0000
commita9699d0fa1d043d85a5863b584b4354258fb8349 (patch)
tree16a9b15f32d0ec440c6e1c059ee9630371aa8757
parentaac5cb4aad0170d6488fc92b3366fb0e4a7d4cbe (diff)
parent51ac33c003e683bd169191410408b8a2f0c56985 (diff)
Merge "[UG] Add description of `delete graph` command"
-rw-r--r--userdocs/fuel-user-guide/cli.rst2
-rw-r--r--userdocs/fuel-user-guide/cli/cli_graphs.rst49
-rw-r--r--userdocs/fuel-user-guide/cli/cli_workflows.rst69
-rw-r--r--userdocs/fuel-user-guide/configure-environment/workflows.rst2
-rw-r--r--userdocs/fuel-user-guide/maintain-environment/workflows-manage.rst13
-rw-r--r--userdocs/fuel-user-guide/maintain-environment/workflows-manage/delete-workflows.rst33
-rw-r--r--userdocs/fuel-user-guide/maintain-environment/workflows-manage/download-workflows.rst2
-rw-r--r--userdocs/fuel-user-guide/maintain-environment/workflows-manage/run-workflows.rst2
-rw-r--r--userdocs/fuel-user-guide/maintain-environment/workflows-manage/upload-workflows.rst4
-rw-r--r--userdocs/fuel-user-guide/maintain-environment/workflows-manage/view-history.rst2
10 files changed, 116 insertions, 62 deletions
diff --git a/userdocs/fuel-user-guide/cli.rst b/userdocs/fuel-user-guide/cli.rst
index 7932a72..f0aabf4 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:
41 cli/cli_roles.rst 41 cli/cli_roles.rst
42 cli/cli_nodes_empty_role.rst 42 cli/cli_nodes_empty_role.rst
43 cli/cli_plugins.rst 43 cli/cli_plugins.rst
44 cli/cli_graphs.rst 44 cli/cli_workflows.rst
45 cli/cli_config_openstack.rst 45 cli/cli_config_openstack.rst
46 cli/cli_config_openstack_services_workflow.rst 46 cli/cli_config_openstack_services_workflow.rst
47 cli/cli_change_ip_range.rst 47 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 ec2b9ee..0000000
--- a/userdocs/fuel-user-guide/cli/cli_graphs.rst
+++ /dev/null
@@ -1,49 +0,0 @@
1.. _cli-graphs:
2
3=====================================
4Deployment graphs management commands
5=====================================
6
7The following table describes the deployment graphs management commands
8supported 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. \ 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 0000000..18b93e3
--- /dev/null
+++ b/userdocs/fuel-user-guide/cli/cli_workflows.rst
@@ -0,0 +1,69 @@
1.. _cli-workflows:
2
3========================================
4Deployment workflows management commands
5========================================
6
7The following table describes the deployment workflows management commands
8supported 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>``
diff --git a/userdocs/fuel-user-guide/configure-environment/workflows.rst b/userdocs/fuel-user-guide/configure-environment/workflows.rst
index f49b2cb..2265e12 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:
30.. seealso:: 30.. seealso::
31 31
32 - :ref:`workflows_manage` 32 - :ref:`workflows_manage`
33 - :ref:`cli-graphs` 33 - :ref:`cli-workflows`
34 - :ref:`data-driven` 34 - :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 02c06bf..e57e5f2 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
5================ 5================
6 6
7Fuel enables you to manage the deployment workflows through both the Fuel web 7Fuel enables you to manage the deployment workflows through both the Fuel web
8UI and CLI. You can view, upload, download, and execute default workflows 8UI and CLI. You can view, upload, download, execute, and delete default
9as well as the custom ones. Execution of the custom deployment workflows 9workflows as well as the custom ones. Execution of the custom deployment
10and merging them with the default deployment workflows allows for the 10workflows and merging them with the default deployment workflows allows for
11implementation of complex orchestrated workflows, such as bug fixes application, 11the implementation of complex orchestrated workflows, such as bug fixes
12reference architecture alteration, and upgrades. 12application, reference architecture alteration, and upgrades.
13 13
14This section includes the following topics: 14This section includes the following topics:
15 15
@@ -20,11 +20,12 @@ This section includes the following topics:
20 workflows-manage/upload-workflows.rst 20 workflows-manage/upload-workflows.rst
21 workflows-manage/download-workflows.rst 21 workflows-manage/download-workflows.rst
22 workflows-manage/run-workflows.rst 22 workflows-manage/run-workflows.rst
23 workflows-manage/delete-workflows.rst
23 workflows-manage/view-history.rst 24 workflows-manage/view-history.rst
24 workflows-manage/download-deployment-info.rst 25 workflows-manage/download-deployment-info.rst
25 26
26.. seealso:: 27.. seealso::
27 28
28 * :ref:`workflow-intro` 29 * :ref:`workflow-intro`
29 * :ref:`cli-graphs` 30 * :ref:`cli-workflows`
30 * :ref:`data-driven` \ No newline at end of file 31 * :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 0000000..15bb77c
--- /dev/null
+++ b/userdocs/fuel-user-guide/maintain-environment/workflows-manage/delete-workflows.rst
@@ -0,0 +1,33 @@
1.. _delete_workflows:
2
3============================
4Delete a deployment workflow
5============================
6
7Fuel stores the information about all deployment workflows associated with
8each deployment of an environment as well as custom workflows if any.
9You can delete deployment workflows using the Fuel web UI or
10Fuel 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`
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 b30c0e8..cfb0c2a 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.
29 29
30.. seealso:: 30.. seealso::
31 31
32 * :ref:`cli-graphs` \ No newline at end of file 32 * :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 308cfc3..9949709 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.
42 42
43.. seealso:: 43.. seealso::
44 44
45 * :ref:`cli-graphs` \ No newline at end of file 45 * :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 ca609c0..e2f9326 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.
27 27
28 .. code-block:: console 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.. seealso:: 32.. seealso::
33 33
34 * :ref:`cli-graphs` \ No newline at end of file 34 * :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 5bd3cd1..9c16dd4 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.
25 #. Go the :guilabel:`History` tab. 25 #. Go the :guilabel:`History` tab.
26 #. Select the required deployment. 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#. Log in to the Fuel Master node. 30#. Log in to the Fuel Master node.
31#. Obtain the ID of the deployment task using one of the following commands: 31#. Obtain the ID of the deployment task using one of the following commands: