diff --git a/doc/source/user/user-guide.rst b/doc/source/user/user-guide.rst index b067b9bf2..e1ad7a6f5 100644 --- a/doc/source/user/user-guide.rst +++ b/doc/source/user/user-guide.rst @@ -39,6 +39,22 @@ named ``watcher``, or by using the `OpenStack CLI`_ ``openstack``. If you want to deploy Watcher in Horizon, please refer to the `Watcher Horizon plugin installation guide`_. +.. note:: + + Notice, that in this guide we'll use `OpenStack CLI`_ as major interface. + Nevertheless, you can use `Watcher CLI`_ in the same way. It can be + achieved by replacing + + .. code:: bash + + $ openstack optimize ... + + with + + .. code:: bash + + $ watcher ... + .. _`installation guide`: https://docs.openstack.org/python-watcherclient/latest .. _`Watcher Horizon plugin installation guide`: https://docs.openstack.org/watcher-dashboard/latest/install/installation.html .. _`OpenStack CLI`: https://docs.openstack.org/python-openstackclient/latest/cli/man/openstack.html @@ -51,10 +67,6 @@ watcher binary without options. .. code:: bash - $ watcher help - -or:: - $ openstack help optimize How do I run an audit of my cluster ? @@ -64,10 +76,6 @@ First, you need to find the :ref:`goal ` you want to achieve: .. code:: bash - $ watcher goal list - -or:: - $ openstack optimize goal list .. note:: @@ -81,10 +89,6 @@ An :ref:`audit template ` defines an optimization .. code:: bash - $ watcher audittemplate create my_first_audit_template - -or:: - $ openstack optimize audittemplate create my_first_audit_template Although optional, you may want to actually set a specific strategy for your @@ -93,10 +97,6 @@ following command: .. code:: bash - $ watcher strategy list --goal - -or:: - $ openstack optimize strategy list --goal You can use the following command to check strategy details including which @@ -104,21 +104,12 @@ parameters of which format it supports: .. code:: bash - $ watcher strategy show - -or:: - $ openstack optimize strategy show The command to create your audit template would then be: .. code:: bash - $ watcher audittemplate create my_first_audit_template \ - --strategy - -or:: - $ openstack optimize audittemplate create my_first_audit_template \ --strategy @@ -133,10 +124,6 @@ audit) that you want to use. .. code:: bash - $ watcher audittemplate list - -or:: - $ openstack optimize audittemplate list - Start an audit based on this :ref:`audit template @@ -144,10 +131,6 @@ or:: .. code:: bash - $ watcher audit create -a - -or:: - $ openstack optimize audit create -a If your_audit_template was created by --strategy , and it @@ -156,11 +139,6 @@ format), your can append `-p` to input required parameters: .. code:: bash - $ watcher audit create -a \ - -p =5.5 -p =hi - -or:: - $ openstack optimize audit create -a \ -p =5.5 -p =hi @@ -173,19 +151,13 @@ Input parameter could cause audit creation failure, when: Watcher service will compute an :ref:`Action Plan ` composed of a list of potential optimization :ref:`actions ` (instance migration, disabling of a compute node, ...) according to the -:ref:`goal ` to achieve. You can see all of the goals -available in section ``[watcher_strategies]`` of the Watcher service -configuration file. +:ref:`goal ` to achieve. - Wait until the Watcher audit has produced a new :ref:`action plan `, and get it: .. code:: bash - $ watcher actionplan list --audit - -or:: - $ openstack optimize actionplan list --audit - Have a look on the list of optimization :ref:`actions ` @@ -193,10 +165,6 @@ or:: .. code:: bash - $ watcher action list --action-plan - -or:: - $ openstack optimize action list --action-plan Once you have learned how to create an :ref:`Action Plan @@ -207,10 +175,6 @@ cluster: .. code:: bash - $ watcher actionplan start - -or:: - $ openstack optimize actionplan start You can follow the states of the :ref:`actions ` by @@ -218,19 +182,11 @@ periodically calling: .. code:: bash - $ watcher action list - -or:: - $ openstack optimize action list You can also obtain more detailed information about a specific action: .. code:: bash - $ watcher action show - -or:: - $ openstack optimize action show