watcher/doc/source/index.rst
Vincent Françoise de7b0129a1 Doc on how to set up a thirdparty project
This documentation is a pre-requisite to all plugin documentation
as it guides you through the creation of a project from scratch
instead of simply forcusing on the implementation of the plugin
itself.

Change-Id: Id2e09b3667390ee6c4be42454c41f9d266fdfac2
Related-Bug: #1534639
Related-Bug: #1533739
Related-Bug: #1533740
2016-03-04 12:07:41 +01:00

2.7 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 dev/testing

API References

webapi/v1

Plugins

dev/plugin/base-setup dev/plugin/strategy-plugin dev/plugin/action-plugin dev/plugin/planner-plugin dev/plugins

Admin Guide

Introduction

deploy/installation deploy/user-guide

Watcher Manual Pages

man/*

api/autoindex

Indices and tables

  • genindex
  • modindex
  • search