diff --git a/doc/source/deploy/user-guide.rst b/doc/source/deploy/user-guide.rst index d74e16850..367b57974 100644 --- a/doc/source/deploy/user-guide.rst +++ b/doc/source/deploy/user-guide.rst @@ -32,17 +32,17 @@ This guide assumes you have a working installation of Watcher. If you get Please refer to the `installation guide`_. In order to use Watcher, you have to configure your credentials suitable for watcher command-line tools. -If you need help on a specific command, you can use: -.. code:: bash - - $ watcher help COMMAND +You can interact with Watcher either by using our dedicated `Watcher CLI`_ +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`_. .. _`installation guide`: https://factory.b-com.com/www/watcher/doc/python-watcherclient .. _`Watcher Horizon plugin installation guide`: https://factory.b-com.com/www/watcher/doc/watcher-dashboard/deploy/installation.html +.. _`OpenStack CLI`: http://docs.openstack.org/developer/python-openstackclient/man/openstack.html +.. _`Watcher CLI`: https://factory.b-com.com/www/watcher/doc/python-watcherclient/index.html Seeing what the Watcher CLI can do ? ------------------------------------ @@ -51,7 +51,11 @@ watcher binary without options. .. code:: bash - $ watcher + $ watcher help + +or:: + + $ openstack help optimize How do I run an audit of my cluster ? ------------------------------------- @@ -60,7 +64,11 @@ First, you need to find the :ref:`goal ` you want to achieve: .. code:: bash - $ watcher goal-list + $ watcher goal list + +or:: + + $ openstack optimize goal list .. note:: @@ -73,22 +81,36 @@ An :ref:`audit template ` defines an optimization .. code:: bash - $ watcher audit-template-create my_first_audit_template + $ 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 -audit template. If so, you may can search of its UUID using the following -command: +audit template. If so, you may can search of its UUID or name using the +following command: .. code:: bash - $ watcher strategy-list --goal-uuid + $ watcher strategy list --goal-uuid + +or:: + + $ openstack optimize strategy list --goal-uuid + The command to create your audit template would then be: .. code:: bash - $ watcher audit-template-create my_first_audit_template \ - --strategy-uuid + $ watcher audittemplate create my_first_audit_template \ + --strategy + +or:: + + $ openstack optimize audittemplate create my_first_audit_template \ + --strategy Then, you can create an audit. An audit is a request for optimizing your cluster depending on the specified :ref:`goal `. @@ -97,19 +119,26 @@ You can launch an audit on your cluster by referencing the :ref:`audit template ` (i.e. the settings of your audit) that you want to use. -- Get the :ref:`audit template ` UUID: +- Get the :ref:`audit template ` UUID or name: .. code:: bash - $ watcher audit-template-list + $ watcher audittemplate list + +or:: + + $ openstack optimize audittemplate list - Start an audit based on this :ref:`audit template ` settings: .. code:: bash - $ watcher audit-create -a + $ watcher audit create -a +or:: + + $ openstack optimize audit create -a Watcher service will compute an :ref:`Action Plan ` composed of a list of potential optimization :ref:`actions ` @@ -123,15 +152,22 @@ configuration file. .. code:: bash - $ watcher action-plan-list --audit + $ watcher actionplan list --audit + +or:: + + $ openstack optimize actionplan list --audit - Have a look on the list of optimization :ref:`actions ` contained in this new :ref:`action plan `: .. code:: bash - $ watcher action-list --action-plan + $ watcher action list --action-plan +or:: + + $ openstack optimize action list --action-plan Once you have learned how to create an :ref:`Action Plan `, it's time to go further by applying it to your @@ -141,18 +177,30 @@ cluster: .. code:: bash - $ watcher action-plan-start + $ watcher actionplan start + +or:: + + $ openstack optimize actionplan start You can follow the states of the :ref:`actions ` by periodically calling: .. code:: bash - $ watcher action-list + $ watcher action list + +or:: + + $ openstack optimize action list You can also obtain more detailed information about a specific action: .. code:: bash - $ watcher action-show + $ watcher action show + +or:: + + $ openstack optimize action show diff --git a/doc/source/image_src/plantuml/README.rst b/doc/source/image_src/plantuml/README.rst new file mode 100644 index 000000000..e73c9c05d --- /dev/null +++ b/doc/source/image_src/plantuml/README.rst @@ -0,0 +1,14 @@ +plantuml +======== + + +To build an image from a source file, you have to upload the plantuml JAR file +available on http://plantuml.com/download.html. +After, just run this command to build your image: + +.. code-block:: shell + + $ cd doc/source/images + $ java -jar /path/to/plantuml.jar doc/source/image_src/plantuml/my_image.txt + $ ls doc/source/images/ + my_image.png diff --git a/doc/source/image_src/plantuml/sequence_create_and_launch_audit.txt b/doc/source/image_src/plantuml/sequence_create_and_launch_audit.txt index 135df1ee6..fd6035fa2 100644 --- a/doc/source/image_src/plantuml/sequence_create_and_launch_audit.txt +++ b/doc/source/image_src/plantuml/sequence_create_and_launch_audit.txt @@ -3,7 +3,7 @@ actor Administrator -Administrator -> "Watcher CLI" : watcher audit-create -a +Administrator -> "Watcher CLI" : watcher audit create -a "Watcher CLI" -> "Watcher API" : POST audit(parameters) "Watcher API" -> "Watcher Database" : create new audit in database (status=PENDING) @@ -14,7 +14,7 @@ Administrator -> "Watcher CLI" : watcher audit-create -a Administrator <-- "Watcher CLI" : new audit uuid "Watcher API" -> "AMQP Bus" : trigger_audit(new_audit.uuid) -"AMQP Bus" -> "Watcher Decision Engine" : trigger_audit(new_audit.uuid) +"AMQP Bus" -> "Watcher Decision Engine" : trigger_audit(new_audit.uuid) (status=ONGOING) ref over "Watcher Decision Engine" Trigger audit in the diff --git a/doc/source/image_src/plantuml/sequence_create_audit_template.txt b/doc/source/image_src/plantuml/sequence_create_audit_template.txt index 455cb3a77..ef422a5a6 100644 --- a/doc/source/image_src/plantuml/sequence_create_audit_template.txt +++ b/doc/source/image_src/plantuml/sequence_create_audit_template.txt @@ -2,7 +2,7 @@ actor Administrator -Administrator -> "Watcher CLI" : watcher audit-template-create \ +Administrator -> "Watcher CLI" : watcher audittemplate create \ [--strategy-uuid ] "Watcher CLI" -> "Watcher API" : POST audit_template(parameters) diff --git a/doc/source/image_src/plantuml/sequence_launch_action_plan.txt b/doc/source/image_src/plantuml/sequence_launch_action_plan.txt index 88785ced5..8c60727ec 100644 --- a/doc/source/image_src/plantuml/sequence_launch_action_plan.txt +++ b/doc/source/image_src/plantuml/sequence_launch_action_plan.txt @@ -2,7 +2,7 @@ actor Administrator -Administrator -> "Watcher CLI" : watcher action-plan-start +Administrator -> "Watcher CLI" : watcher actionplan start "Watcher CLI" -> "Watcher API" : PATCH action_plan(state=PENDING) "Watcher API" -> "Watcher Database" : action_plan.state=PENDING diff --git a/doc/source/images/sequence_create_and_launch_audit.png b/doc/source/images/sequence_create_and_launch_audit.png index 0e13a4492..f697192c6 100644 Binary files a/doc/source/images/sequence_create_and_launch_audit.png and b/doc/source/images/sequence_create_and_launch_audit.png differ diff --git a/doc/source/images/sequence_create_audit_template.png b/doc/source/images/sequence_create_audit_template.png index 92b57bc54..afc983919 100644 Binary files a/doc/source/images/sequence_create_audit_template.png and b/doc/source/images/sequence_create_audit_template.png differ diff --git a/doc/source/images/sequence_launch_action_plan.png b/doc/source/images/sequence_launch_action_plan.png index 97465c568..ca5496aca 100644 Binary files a/doc/source/images/sequence_launch_action_plan.png and b/doc/source/images/sequence_launch_action_plan.png differ