watcher/doc/source/deploy/user-guide.rst

Watcher User Guide

See the architecture page for an architectural overview of the different components of Watcher and how they fit together.

In this guide we're going to take you through the fundamentals of using Watcher.

The following diagram shows the main interactions between the Administrator <administrator_definition> and the Watcher system:

Getting started with Watcher

This guide assumes you have a working installation of Watcher. If you get "watcher: command not found" you may have to verify your installation. 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:

$ watcher help COMMAND

If you want to deploy Watcher in Horizon, please refer to the Watcher Horizon plugin installation guide.

Seeing what the Watcher CLI can do ?

We can see all of the commands available with Watcher CLI by running the watcher binary without options.

$ watcher

How do I run an audit of my cluster ?

First, you need to find the goal <goal_definition> you want to achieve:

$ watcher goal-list

Note

If you get "You must provide a username via either --os-username or via env[OS_USERNAME]" you may have to verify your credentials.

Then, you can create an audit template <audit_template_definition>. An audit template <audit_template_definition> defines an optimization goal <goal_definition> to achieve (i.e. the settings of your audit).

$ watcher audit-template-create my_first_audit_template <your_goal_uuid>

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:

$ watcher strategy-list --goal-uuid <your_goal_uuid>

The command to create your audit template would then be:

$ watcher audit-template-create my_first_audit_template <your_goal_uuid> \
  --strategy-uuid <your_strategy_uuid>

Then, you can create an audit. An audit is a request for optimizing your cluster depending on the specified goal <goal_definition>.

You can launch an audit on your cluster by referencing the audit template <audit_template_definition> (i.e. the settings of your audit) that you want to use.

• Get the audit template <audit_template_definition> UUID:

$ watcher audit-template-list

• Start an audit based on this audit template <audit_template_definition> settings:

$ watcher audit-create -a <your_audit_template_uuid>

Watcher service will compute an Action Plan <action_plan_definition> composed of a list of potential optimization actions <action_definition> (instance migration, disabling of an hypervisor, ...) according to the goal <goal_definition> to achieve. You can see all of the goals available in section [watcher_strategies] of the Watcher service configuration file.

• Wait until the Watcher audit has produced a new action plan <action_plan_definition>, and get it:

$ watcher action-plan-list --audit <the_audit_uuid>

• Have a look on the list of optimization actions <action_definition> contained in this new action plan <action_plan_definition>:

$ watcher action-list --action-plan <the_action_plan_uuid>

Once you have learned how to create an Action Plan <action_plan_definition>, it's time to go further by applying it to your cluster:

• Execute the action plan <action_plan_definition>:

$ watcher action-plan-start <the_action_plan_uuid>

You can follow the states of the actions <action_definition> by periodically calling:

$ watcher action-list

You can also obtain more detailed information about a specific action:

$ watcher action-show <the_action_uuid>