x
/
bareon-allocator
Code Issues Proposed changes

Doc. Fix usage example

This commit is contained in:
Evgeniy L 2016-01-11 16:25:31 +03:00
parent 4234aa4e24
commit 4f5098bb95
3 changed files with 7 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/architecture.rst
View File

@ -44,7 +44,7 @@ High level architecture
+--------------------------+
* **Dynamic schema parser** - parses an input from the user and prepares the data which can be consumed by Allocation solver
* **Allocation solver** - an algorithm which takes dynamic schema and produces a static schema
* **Allocation solver** - algorithm which takes dynamic schema and produces a static schema
* **Solution convertor** - a result which is produced by solver, should be parsed and converted into `Bareon <https://wiki.openstack.org/wiki/Bareon>`_ consumable format, for example for `Logical Volume <https://en.wikipedia.org/wiki/Logical_Volume_Manager_(Linux)>`_ Solution convertor should generate a physical volume for each disk, where it's allocated
Dynamic schema parser
@ -122,7 +122,7 @@ From Hardware Information example we can see that the node has 4096 megabytes of
$ram / 2,
4096)
In order to implement an algorithm of swap size calculation we use `YAQL <https://github.com/openstack/yaql>`_, which is small but powerful enough query language. Any value of the parameter which matches to **yaql=yaql expression** will be evaluated using YAQL, execution result will be passed as is to the Solver.
In order to implement algorithm of swap size calculation we use `YAQL <https://github.com/openstack/yaql>`_, which is small but powerful enough query language. Any value of the parameter which matches to **yaql=yaql expression** will be evaluated using YAQL, execution result will be passed as is to the Solver.
Allocation solver
-----------------

4
doc/source/index.rst
View File

@ -3,8 +3,8 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to bareon-dynamic-allocator's documentation!
========================================================
Welcome to bareon-allocator's documentation!
============================================
Contents:

8
doc/source/usage.rst
View File

@ -1,7 +1,5 @@
========
=====
Usage
========
=====
To use bareon-dynamic-allocator in a project::
import bareon_dynamic_allocator
Has not been released yet, see example of usage in **run.sh** file.