..
      Licensed under the Apache License, Version 2.0 (the "License"); you may
      not use this file except in compliance with the License. You may obtain
      a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
      License for the specific language governing permissions and limitations
      under the License.

============================================
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`