7710b1670e
Added new global architecture diagram using Dia tool and a more detailed description of each component. Exported this diagram in SVG format. The source code of the diagram is stored in /doc/images_src/ folder. Moved also the architecture.rst file from the /dev folder to the root folder of the Watcher doc. Change-Id: I74379390178673dcb6a043967b31e38ca9560bb3
66 lines
942 B
ReStructuredText
66 lines
942 B
ReStructuredText
============================================
|
|
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
|
|
|
|
dev/glossary
|
|
architecture
|
|
dev/environment
|
|
dev/contributing
|
|
dev/plugins
|
|
|
|
|
|
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`
|