Browse Source

Merge "[UG] Add filters to the 'fuel2 task list' command"

Jenkins 2 years ago
parent
commit
18ad8ebf34

+ 2
- 0
userdocs/fuel-user-guide/maintain-environment/workflows-manage/download-deployment-info.rst View File

@@ -19,6 +19,8 @@ deployment.
19 19
      fuel task
20 20
      fuel2 task list
21 21
 
22
+   .. include:: /userdocs/snippets/notes/fuel2-task-list-filters.rst
23
+
22 24
 #. Download the deployment information:
23 25
 
24 26
    .. code-block:: console

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

@@ -35,6 +35,8 @@ the Fuel web UI (timeline or table view mode) as well as the Fuel CLI.
35 35
       fuel task
36 36
       fuel2 task list
37 37
 
38
+   .. include:: /userdocs/snippets/notes/fuel2-task-list-filters.rst
39
+
38 40
 #. Get the information on deployment tasks running on nodes:
39 41
 
40 42
    .. code-block:: console

+ 25
- 0
userdocs/snippets/notes/fuel2-task-list-filters.rst View File

@@ -0,0 +1,25 @@
1
+.. note::
2
+
3
+   By default, the :command:`fuel2 task list` shows all deployment tasks.
4
+   Although, you can filter the tasks in the command output by:
5
+
6
+   * Environment ID:
7
+
8
+     .. code-block:: console
9
+
10
+        fuel2 task list --env <ENV_ID>
11
+
12
+   * Tasks statuses:
13
+
14
+     .. code-block:: console
15
+
16
+        fuel2 task list --statuses ready
17
+
18
+     The available tasks statuses are ``pending``, ``error``,
19
+     ``ready``, and ``running``.
20
+
21
+   * Tasks names:
22
+
23
+     .. code-block:: console
24
+
25
+        fuel2 task list --names <TASK_NAME>

Loading…
Cancel
Save