[UG] [CLI] Noop run

Change-Id: I4f719aead12592db905178a777ba682f828de941
This commit is contained in:
OlgaGusarenko 2016-09-02 19:05:21 +03:00 committed by Olena Logvinova
parent 8cc83d9237
commit d2b093a61c
3 changed files with 60 additions and 6 deletions

View File

@ -45,3 +45,4 @@ This section includes the following topics:
cli/cli_config_openstack_services_workflow.rst
cli/cli_change_ip_range.rst
cli/cli_modify_environment.rst
cli/cli_noop.rst

View File

@ -1,13 +1,11 @@
.. _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.
supported by the Fuel CLI.
.. list-table:: **Deployment graphs management commands**
:widths: 15 20
@ -38,4 +36,10 @@ No additional configuration is required.
* - 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.
| The ``--type`` parameter is optional. If not specified, the default graph is downloaded.
* - Run any task graph in a ``noop`` mode to detect customizations.
- ``fuel2 graph execute --env <env_id> [--type <graph_type>] --noop --force``
| The ``--force`` parameter is optional and is necessary for previously
executed graphs or tasks to prevent tasks skipping by Fuel LCM engine.

View File

@ -0,0 +1,49 @@
.. _cli_noop:
========================================================
Detect custom configurations in an OpenStack environment
========================================================
Before you redeploy, update, or upgrade your OpenStack environment, ensure
that next Fuel tasks run will not override important changes that had been
applied to a whole OpenStack environment or a particular OpenStack node.
This procedure should only be applied to OpenStack nodes with the ``ready``
statuses or to OpenStack environments with the ``operational`` statuses.
**To detect custom configurations using the Fuel task graphs:**
#. Select from the following options:
* If you want to check that an environment has customizations using
a specific graph, execute the graph in the ``noop`` mode:
.. code-block:: console
fuel2 graph execute --env <ENV_ID> --type <GRAPH_TYPE> --noop --force
* If you want to check that particular OpenStack nodes have customizations
using a specific graph, execute this graph in the ``noop`` mode:
.. code-block:: console
fuel2 graph execute --env <ENV_ID> --type <GRAPH_TYPE> -n <NODE_IDs> --noop --force
.. note:: The Puppet Noop run for any OpenStack environment or node
does not change their statuses. The Noop run is an additional
check rather than a part of the deployment process.
* If you want to view the Puppet Noop run reports for a particular task graph,
type one of the following:
.. code-block:: console
fuel deployment-tasks --tid <TASK_ID> --task-name <TASK_NAME> --include-summary
.. code-block:: console
fuel2 task history show <TASK_ID> --include-summary
Reports for each Puppet Noop run are stored on all OpenStack nodes in
the ``/var/lib/puppet/reports/<NODE-FQDN>/<TIMESTAMP>.yaml`` directory
and include details about the changes that were applied to the Fuel task
graphs.