From 13fd6423d8eb07ebeff7a15fb3193b19a7d19b09 Mon Sep 17 00:00:00 2001 From: Irina Povolotskaya Date: Mon, 13 Apr 2015 12:55:36 +0300 Subject: [PATCH] Provides CLI reference for Fuel Plugins in User Guide Change-Id: I6481d8e8bec7b0df6661b14f1d7405dc1ae51fbd Closes-Bug: 1439234 --- pages/user-guide/cli.rst | 68 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) diff --git a/pages/user-guide/cli.rst b/pages/user-guide/cli.rst index aaa1dfe3f..97afb58b8 100644 --- a/pages/user-guide/cli.rst +++ b/pages/user-guide/cli.rst @@ -332,3 +332,71 @@ to other fuel CLI commands: See :ref:`fuel-passwd-ops` for more information about Fuel authentication. +Fuel Plugins +++++++++++++ + +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: + + :: + + fuel plugins --install + + It is recommended that you install rpm plugins + using the command above. + + Nevertheless, if you would + like to do that manually, follow these steps: + + * Run the following command: + + :: + + yum install + + * 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. + +* You can see the list of all installed plugins using: + + :: + + fuel plugins --list + + + You should get the following output: + + :: + + fuel plugins --list + + id | name | version | package_version + ----|--------------------------|----------|-------- + 1 | | 1.0.0 | 2.0.0 + + +* To remove a plugin, run: + + :: + + fuel plugins --remove == + + +* To update an rpm plugin, run: + + :: + + fuel plugins --update + + + .. note:: Updates are *not* supported for fp plugins. + +To see the list of all available options, use ``fuel plugins --help`` command.