From c944443fcff7023d1efd21232c37b11e0a4c07cf Mon Sep 17 00:00:00 2001 From: Irina Povolotskaya Date: Thu, 6 Aug 2015 16:14:13 +0300 Subject: [PATCH] Reworks the Fuel Plugins CLI section of the User Guide Co-Authored-By: Svetlana Karslioglu Change-Id: I3968c2393b7f31d7441def8c6d36524a5cccd02c Closes-Bug: 1482207 --- pages/user-guide/cli.rst | 109 +++++++++++++++++++++------------------ 1 file changed, 58 insertions(+), 51 deletions(-) diff --git a/pages/user-guide/cli.rst b/pages/user-guide/cli.rst index 4496c4a93..0fb851706 100644 --- a/pages/user-guide/cli.rst +++ b/pages/user-guide/cli.rst @@ -9,19 +9,16 @@ Using Fuel CLI ============== -Introduction ------------- - -Fuel CLI tool is a powerful tool that allows you to: +Fuel CLI is a powerful tool that allows you to: * Operate with environments using the text console only. -* Modify directly the internal data that you can't modify via the web UI. -* Avoid data verifications done by the web UI logic. +* Modify directly the internal data that you can't modify via the Fuel Web UI. +* Avoid data verifications done by the Fuel Web UI logic. Fuel CLI may break your environment if not used carefully. It is necessary to understand that any modifications done using Fuel CLI -take precedence over the settings made from the browser. +take precedence over the settings made from the Fuel Web UI. Fuel shows a special message to inform you: .. image:: /_images/fuel-cli-warning.png @@ -29,7 +26,7 @@ Fuel shows a special message to inform you: .. contents :local: Basic usage ------------------------------------------ +----------- Fuel CLI has the following usage pattern: @@ -39,18 +36,18 @@ Fuel CLI has the following usage pattern: *Example*:: - fuel --env-id=1 node set --node-id=1,4,5 --role=controller,compute + fuel --env-id=1 node set --node-id=1,4,5 --role=controller where ``--env-id=1`` is a global optional argument pointing to the specific environment, ``node`` - is a namespace for all node control functions, ``set`` is an action that assigns specific nodes to some environments in certain roles. -for getting list of all global optional args and namespaces you can run: +To get the list of all global optional arguments and namespaces, run: :: fuel --help -and for getting actions and optional args for some namespace run: +To get the list of actions and optional arguments for a namespace, run: :: fuel --help @@ -351,9 +348,12 @@ Configuring +++++++++++ Configuration of the environment or some node -is universal and done in three stages +is universal and done in three stages: -1. Download current or default configuration. works for (``network``, ``settings``, ``node --disk``, ``node --network``). Operations with ``deployment`` and ``provisioning`` can be node specific. (e.g. ``fuel --env 1 deployment --node-id=1,2``) +1. Download current or default configuration. Works for +(``network``, ``settings``, ``node --disk``, ``node --network``). +Operations with ``deployment`` and ``provisioning`` can be node +specific. (e.g. ``fuel --env 1 deployment --node-id=1,2``) *Example*:: @@ -460,65 +460,72 @@ Fuel Plugins CLI For summary information on Fuel plugins, see :ref:`Install Fuel plugins ` section. -* Once a plugin is downloaded and copied - to the Fuel Master node, - you can install it with: +* To install a Fuel plugin: - :: +1. Select from the following options: - fuel plugins --install +* If you install a Fuel plugin from an `.fp` package, type: - It is recommended that you install rpm plugins - using the command above. + .. code-block:: bash - Nevertheless, if you would - like to do that manually, follow these steps: + fuel plugins --install - * Run the following command: +* If you install a Fuel plugin from an `.rpm` package, select from the + following options: - :: + * Using ``yum install``: - yum install + 1. Install the Fuel plugin: - * Register the plugin in :ref:`Nailgun` with - *fuel plugins --register ==* - command. - You can run *fuel plugins --sync* instead, but - in this case Fuel Client will update all - plugins on the file system in Nailgun. + .. code-block:: bash -* You can see the list of all installed plugins using: + yum install - :: + 2. Register the plugin in :ref:`Nailgun`: - fuel plugins --list + .. code-block:: bash + + fuel plugins --register == + + * Using the same command you used to install a Fuel plugin from the + `.fp` package: + + .. code-block:: bash + + fuel plugins --install + +2. View the list of installed plugins: + + .. code-block:: bash + + fuel plugins --list + + id | name | version | package_version + ---|---------------------------|----------|---------------- + 1 | | 1.0.0 | 2.0.0 - You should get the following output: +* To remove a plugin, type: - :: + .. code-block:: bash - fuel plugins --list - - id | name | version | package_version - ----|--------------------------|----------|-------- - 1 | | 1.0.0 | 2.0.0 + fuel plugins --remove == -* To remove a plugin, run: +* To upgrade a Fuel RPM plugin, type: - :: - - fuel plugins --remove == - - -* To update an rpm plugin, run: - - :: + .. code-block:: bash fuel plugins --update - .. note:: Updates are *not* supported for fp plugins. + .. note:: Upgradess are *not* supported for: + + * fp plugins + + * major versions of RPM plugins + + For example, you can only upgrade from version 1.0.0 to 1.0.1. + To see the list of all available options, use ``fuel plugins --help`` command.