[UG] Deployment graphs management commands

* Adds the `Deployment graphs management commands` section (CLI)
* Explicitly states that it is supported by Fuel CLI v2 only
* Adds the --type parameter (bug-fix)
* Improves the wording in the warning (in the parent section fro all
  cli-related sections)

Change-Id: Iefce63b9652a338ff8904e3f9350c78bd979f2a0
Closes-bug: #1568875
This commit is contained in:
OlgaGusarenko
2016-05-20 17:19:21 +03:00
committed by Olga Gusarenko
parent 3541751c30
commit b58abc8bb1
2 changed files with 45 additions and 3 deletions

View File

@@ -3,7 +3,7 @@
Use the Fuel CLI
================
Using the Fuel Command Line Interface (CLI) you can:
Using the Fuel Command Line Interface (CLI), you can:
* Operate your OpenStack environments using Fuel text commands, as well as
using standard Linux commands.
@@ -11,8 +11,8 @@ Using the Fuel Command Line Interface (CLI) you can:
modify using the Fuel Web UI.
.. warning::
We do not recommend to use Fuel CLi for unexperienced users.
Fuel CLI may break your environment if not used carefully.
We recommend using Fuel CLI only to experienced users as it may break
your environment if not used carefully.
Modifications that you make using the Fuel CLI take precedence over the
settings applied from the Fuel Web UI. If a change has been applied using
@@ -36,6 +36,7 @@ This section includes the following topics:
cli/cli_node_group.rst
cli/cli_roles.rst
cli/cli_plugins.rst
cli/cli_graphs.rst
cli/cli_config_openstack.rst
cli/cli_config_openstack_services_workflow.rst
cli/cli_change_ip_range.rst

View File

@@ -0,0 +1,41 @@
.. _cli-graphs:
Deployment graphs management commands
-------------------------------------
The following table describes the deployment graphs management commands
supported by the Fuel CLI v2. To execute these commands, you need to have
the Fuel CLI installed as described in `Install the OpenStack
command-line clients <http://docs.openstack.org/user-guide/common/cli_install_openstack_command_line_clients.html>`_.
No additional configuration is required.
.. 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 downloaded.
* - 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.
* - 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.