Re-structure docs

Change-Id: I10ee0df7c185baf237eb367aceba805e0844e810
This commit is contained in:
Endre Karlson 2013-09-20 13:17:18 +02:00
parent fd8e226cbe
commit 831f414a62
9 changed files with 42 additions and 15 deletions

View File

@ -1,3 +1,5 @@
.. _libra-admin-api:
Libra Admin API Server
======================

View File

@ -1,3 +1,5 @@
.. _libra-api:
Libra API Server
================

View File

@ -0,0 +1,9 @@
.. _architecture:
Architecture
==================
.. toctree::
:maxdepth: 2
logical

View File

@ -1,23 +1,21 @@
Introduction
============
=============
Logical architecture
=============
Libra is a Load Balancer as a Service (LBaaS) system originally designed by
Hewlett-Packard Cloud Services. It consists of five core components
required to get LBaaS working:
See information for each component for more information.
* A node pool manager to keep a warm spare pool of load balancers ready
* A node worker to asynchronously communicate to the API server
* A monitoring system for the load balancers
* A customer API server
* An administrative API server
* :ref:`libra-pool-mgr` - A node pool manager to keep a warm spare pool of load balancers ready
* :ref:`libra-worker` - A node worker to asynchronously communicate to the API server
* :ref:`libra-api` - A customer API server
* :ref:`libra-admin-api` - An administrative API server
The API server is based on a modified version of the `Atlas API specification
<https://wiki.openstack.org/wiki/Atlas-LB>`_.
Layout
------
High level overview
-------------------
.. image:: libralayout.png
.. image:: /img/libralayout.png
Here you can see that the pool manager spins up the required Nova nodes with
the load balancer image. It then hands the details of these nodes over to the

11
doc/getting-started.rst Normal file
View File

@ -0,0 +1,11 @@
===============
Getting started
===============
Libra is a system to provide LoadBalancing as a Service on top of
various platforms. It is comprised of four components :ref:`libra-api`,
:ref:`libra-admin-api`, :ref:`libra-pool-mgr` and :ref:`libra-worker`,
supported by a few other open source components. For more information see
:doc:`architecture/index`.

View File

Before

Width:  |  Height:  |  Size: 64 KiB

After

Width:  |  Height:  |  Size: 64 KiB

View File

@ -2,9 +2,10 @@ Load Balancer as a Service Device Tools
=======================================
.. toctree::
:maxdepth: 3
:maxdepth: 2
introduction
getting-started
architecture/index
worker/index
pool_mgm/index
api/index

View File

@ -1,3 +1,5 @@
.. _libra-pool-mgr:
Libra Node Pool Manager
=======================

View File

@ -1,3 +1,5 @@
.. _libra-worker:
Libra Gearman Worker
====================