diff --git a/userdocs/fuel-user-guide/cli.rst b/userdocs/fuel-user-guide/cli.rst index 07212bc4f..98aa4cd30 100644 --- a/userdocs/fuel-user-guide/cli.rst +++ b/userdocs/fuel-user-guide/cli.rst @@ -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 diff --git a/userdocs/fuel-user-guide/cli/cli_graphs.rst b/userdocs/fuel-user-guide/cli/cli_graphs.rst new file mode 100644 index 000000000..88f6b3c63 --- /dev/null +++ b/userdocs/fuel-user-guide/cli/cli_graphs.rst @@ -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 `_. +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 `` + + * - 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 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 --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. + + * - 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. \ No newline at end of file