eeeb3efca1
This patch set updates docs structure and adds contributing page. Change-Id: I7ec68524e91e1bf42754802e7ea79086e301c836
58 lines
1.8 KiB
ReStructuredText
58 lines
1.8 KiB
ReStructuredText
..
|
|
Except where otherwise noted, this document is licensed under Creative
|
|
Commons Attribution 3.0 License. You can view the license at:
|
|
|
|
https://creativecommons.org/licenses/by/3.0/
|
|
|
|
==========================================
|
|
Welcome to Watcher Dashboard 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.
|
|
|
|
.. _watcher: https://git.openstack.org/cgit/openstack/watcher/
|
|
.. _python-watcherclient: https://git.openstack.org/cgit/openstack/python-watcherclient/
|
|
.. _watcher-dashboard: https://git.openstack.org/cgit/openstack/watcher-dashboard/
|
|
|
|
|
|
Install Guide
|
|
=============
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
install/index
|
|
|
|
Developer Guide
|
|
===============
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
contributor/index
|
|
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`search`
|