watcher/doc/source/index.rst
Vincent Françoise cdee2719f7 Added notifications documentation page
In this changeset, I added a new Sphinx directive (from Nova) that
allows us to automatically display notification samples for of
all the upcoming notifications in Watcher.

Partially Implements: blueprint watcher-notifications-ovo

Change-Id: Id7d819ee21db6dc616c78faea483b883f77e3bd6
2016-11-16 13:57:25 +01:00

2.9 KiB

Welcome to Watcher documentation

OpenStack Watcher provides a flexible and scalable resource optimization service for multi-tenant OpenStack-based clouds. Watcher provides a complete optimization loop—including everything from a metrics receiver, complex event processor and profiler, optimization processor and an action plan applier. This provides a robust framework to realize a wide range of cloud optimization goals, including the reduction of data center operating costs, increased system performance via intelligent virtual machine migration, increased energy efficiency—and more!

Watcher project consists of several source code repositories:

  • watcher - is the main repository. It contains code for Watcher API server, Watcher Decision Engine and Watcher Applier.
  • python-watcherclient - Client library and CLI client for Watcher.
  • watcher-dashboard - Watcher Horizon plugin.

The documentation provided here is continually kept up-to-date based on the latest code, and may not represent the state of the project at any specific prior release.

Developer Guide

Introduction

glossary architecture dev/contributing

Getting Started

dev/environment dev/devstack deploy/configuration deploy/conf-files dev/notifications dev/testing dev/rally_link

API References

webapi/v1

Plugins

dev/plugin/base-setup dev/plugin/goal-plugin dev/plugin/scoring-engine-plugin dev/plugin/strategy-plugin dev/plugin/cdmc-plugin dev/plugin/action-plugin dev/plugin/planner-plugin dev/plugins

Admin Guide

Introduction

deploy/installation deploy/user-guide deploy/policy deploy/gmr strategies/strategies

Watcher Manual Pages

man/*

api/autoindex

Indices and tables

  • genindex
  • modindex
  • search