Re-structure docs
Change-Id: I10ee0df7c185baf237eb367aceba805e0844e810
This commit is contained in:
@@ -1,3 +1,5 @@
|
|||||||
|
.. _libra-admin-api:
|
||||||
|
|
||||||
Libra Admin API Server
|
Libra Admin API Server
|
||||||
======================
|
======================
|
||||||
|
|
||||||
|
|||||||
@@ -1,3 +1,5 @@
|
|||||||
|
.. _libra-api:
|
||||||
|
|
||||||
Libra API Server
|
Libra API Server
|
||||||
================
|
================
|
||||||
|
|
||||||
|
|||||||
9
doc/architecture/index.rst
Normal file
9
doc/architecture/index.rst
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
.. _architecture:
|
||||||
|
|
||||||
|
Architecture
|
||||||
|
==================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
logical
|
||||||
@@ -1,23 +1,21 @@
|
|||||||
Introduction
|
=============
|
||||||
============
|
Logical architecture
|
||||||
|
=============
|
||||||
|
|
||||||
Libra is a Load Balancer as a Service (LBaaS) system originally designed by
|
See information for each component for more information.
|
||||||
Hewlett-Packard Cloud Services. It consists of five core components
|
|
||||||
required to get LBaaS working:
|
|
||||||
|
|
||||||
* A node pool manager to keep a warm spare pool of load balancers ready
|
* :ref:`libra-pool-mgr` - A node pool manager to keep a warm spare pool of load balancers ready
|
||||||
* A node worker to asynchronously communicate to the API server
|
* :ref:`libra-worker` - A node worker to asynchronously communicate to the API server
|
||||||
* A monitoring system for the load balancers
|
* :ref:`libra-api` - A customer API server
|
||||||
* A customer API server
|
* :ref:`libra-admin-api` - An administrative API server
|
||||||
* An administrative API server
|
|
||||||
|
|
||||||
The API server is based on a modified version of the `Atlas API specification
|
The API server is based on a modified version of the `Atlas API specification
|
||||||
<https://wiki.openstack.org/wiki/Atlas-LB>`_.
|
<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
|
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
|
the load balancer image. It then hands the details of these nodes over to the
|
||||||
11
doc/getting-started.rst
Normal file
11
doc/getting-started.rst
Normal 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`.
|
||||||
|
|
||||||
|
|
||||||
|
Before Width: | Height: | Size: 64 KiB After Width: | Height: | Size: 64 KiB |
@@ -2,9 +2,10 @@ Load Balancer as a Service Device Tools
|
|||||||
=======================================
|
=======================================
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 3
|
:maxdepth: 2
|
||||||
|
|
||||||
introduction
|
getting-started
|
||||||
|
architecture/index
|
||||||
worker/index
|
worker/index
|
||||||
pool_mgm/index
|
pool_mgm/index
|
||||||
api/index
|
api/index
|
||||||
|
|||||||
@@ -1,3 +1,5 @@
|
|||||||
|
.. _libra-pool-mgr:
|
||||||
|
|
||||||
Libra Node Pool Manager
|
Libra Node Pool Manager
|
||||||
=======================
|
=======================
|
||||||
|
|
||||||
|
|||||||
@@ -1,3 +1,5 @@
|
|||||||
|
.. _libra-worker:
|
||||||
|
|
||||||
Libra Gearman Worker
|
Libra Gearman Worker
|
||||||
====================
|
====================
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user