..
      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 Poppy's developer documentation!
===========================================

Poppy is an OpenStack-related project to provide a generic and modular vendor-neutral API which wraps provisioning instructions for CDN vendors that support it.

Poppy, as with all OpenStack projects, is written with the following design
guidelines in mind:

* **Component-based architecture**: Quickly add new behaviors
* **Highly available**: Scale to very serious workloads
* **Fault tolerant**: Isolated processes avoid cascading failures
* **Recoverable**: Failures should be easy to diagnose, debug, and rectify
* **Open standards**: Be a reference implementation for a community-driven api

This documentation is generated by the Sphinx toolkit and lives in the source
tree. Additional draft and project documentation on Poppy and other components of OpenStack can
be found on the `OpenStack wiki`_. Cloud administrators, refer to `docs.openstack.org`_.


Concepts
========

.. toctree::
   :maxdepth: 1

   glossary
   provider_details

Getting Started
===============

.. toctree::
   :maxdepth: 1

   gettingstarted_installing
   gettingstarted_testing
   gettingstarted_contributing
   gettingstarted_gerrit


Operating Poppy
===============

.. toctree::
   :maxdepth: 1

   ops


Developer Docs
==============

.. toctree::
   :maxdepth: 3

   poppy


Using Poppy's API
=================

.. toctree::
   :maxdepth: 1

.. _`OpenStack wiki`: http://wiki.openstack.org
.. _`docs.openstack.org`: http://docs.openstack.org