Files
watcher/doc/source/index.rst
Taylor Peoples 6c1769a15e Implement DevStack plugin
Use DevStack's plugin model to allow for developers to easily set up
the Watcher services within DevStack.

Provides documentation on how to use the plugin as well as documentation
on how to configure a multi-node DevStack installation to use.  Also
provides an example local.conf for both the controller and compute
nodes.

Implements blueprint devstack-plugin

Change-Id: Ide663813f7a49d645877a21a0d1914be3218385e
2016-01-06 17:05:40 +01:00

83 lines
1.3 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's developer documentation
============================================
Mission
=======
Provide an auditing service for OpenStack to improve workload placement
on-the-go.
The developer 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
------------
.. toctree::
:maxdepth: 1
glossary
architecture
dev/environment
dev/contributing
dev/plugins
DevStack Plugin
---------------
You can configure DevStack to set up the Watcher services easily using
Watcher's DevStack plugin.
.. toctree::
:maxdepth: 1
dev/devstack-plugin
API References
--------------
.. toctree::
:maxdepth: 1
webapi/v1
Admin Guide
===========
Overview
--------
.. toctree::
:maxdepth: 1
deploy/user-guide
deploy/installation
Commands
--------
.. toctree::
:maxdepth: 1
cmds/watcher-db-manage
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`