watcher/doc/source/index.rst
Vincent Françoise b94677c3ef Cluster data model collector plugin documentation
In this changeset, I wrote down the documentation on how to implement
a cluster data model collector plugin for Watcher.

This documentation corresponds to part 1 of the associated
specification.

Change-Id: Iac72b933df95252163033cd559d13348075a9b16
Partially-Implements: blueprint cluster-model-objects-wrapper
2016-08-02 12:07:35 +02:00

2.8 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/testing

API References

webapi/v1

Plugins

dev/plugin/base-setup dev/plugin/goal-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

Watcher Manual Pages

man/*

api/autoindex

Indices and tables

  • genindex
  • modindex
  • search