Revision 9940eacf snf-app/docs/index.rst

b/snf-app/docs/index.rst
1 
synnefo
2 
=======
1 
.. _snf-asterias-app:
3 2 

  		





  4
  
  
    
.. image:: /images/synnefo-logo.png


  		





  
  3
  
    
Component snf-asterias-app


  		





  
  4
  
    
==========================


  		





  5
  5
  
    

  		





  6
  
  
    
synnefo is software to create massively scalable IaaS clouds.


  		





  
  6
  
    
synnefo component :ref:`snf-asterias-app <snf-asterias-app>` defines


  		





  
  7
  
    
the web application for asterias. It includes the following:


  		





  7
  8
  
    

  		





  8
  
  
    
It powers GRNET's `~okeanos cloud service <https://okeanos.grnet.gr>`_.


  		





  
  9
  
    
    * A set of Django applications that define among others:


  		





  
  10
  
    
        * web UI


  		





  
  11
  
    
        * API implementation


  		





  
  12
  
    
        * business logic layer


  		





  
  13
  
    
        * admin web UI


  		





  
  14
  
    
    * :ref:`snf-dispatcher <snf-dispatcher>`, the logic dispatcher


  		





  9
  15
  
    

  		





  10
  
  
    
This is the main synnefo documentation page.


  		





  
  16
  
    
.. todo:: make this section more complete.


  		





  11
  17
  
    

  		





  12
  
  
    
synnefo comprises the following major components:


  		





  
  18
  
    
.. _snf-dispatcher:


  		





  13
  19
  
    

  		





  14
  
  
    
.. todo:: turn all of the following to links to the documentation, with


  		





  15
  
  
    
   intersphinx links.


  		





  
  20
  
    
snf-dispatcher


  		





  
  21
  
    
--------------


  		





  16
  22
  
    

  		





  17
  
  
    
.. toctree::


  		





  18
  
  
    
   :maxdepth: 1


  		





  
  23
  
    
The logic dispatcher provides the context to run the business logic layer of


  		





  
  24
  
    
:ref:`asterias <snf-asterias>`. It must run on :ref:`LOGIC <LOGIC_NODE>` nodes.


  		





  19
  25
  
    

  		





  20
  
  
    
   asterias (name TBD): Compute Service <src/asterias.rst>


  		





  21
  
  
    
   pithos+: File storage service <http://docs.dev.grnet.gr/pithos>


  		





  22
  
  
    
   plankton: Image registry <src/plankton.rst>


  		





  23
  
  
    
   archipelagos: Volume storage service <http://docs.dev.grnet.gr/archipelagos>


  		





  24
  
  
    
   astakos: Identity management module <http://docs.dev.grnet.gr/astakos>


  		





  25
  
  
    
   aquarium: Billing module <http://docs.dev.grnet.gr/aquarium>


  		





  26
  
  
    
   image: Secure image deployment tool <http://docs.dev.grnet.gr/snf-image>


  		





  27
  
  
    
   kamaki: Command-line cloud management tool <http://docs.dev.grnet.gr/kamaki>


  		





  
  26
  
    
The dispatcher retrieves messages from the queue, over AMQP, and calls the


  		





  
  27
  
    
appropriate handler function, based on the type of the message.


  		





  28
  28
  
    

  		





  29
  
  
    
You may also see the detailed configuration for all


  		





  30
  
  
    
:ref:`synnefo software components <components>`.


  		





  
  29
  
    
.. _snf-admin:


  		





  31
  30
  
    

  		





  32
  
  
    
Indices and tables


  		





  33
  
  
    
------------------


  		





  
  31
  
    
snf-admin


  		





  
  32
  
    
---------


  		





  34
  33
  
    

  		





  
  34
  
    
command :command:`snf-admin` provides the command-line admin interface


  		





  
  35
  
    
for :ref:`asterias <snf-asterias>`.


  		





  
  36
  
    

  		





  
  37
  
    
Package installation


  		





  
  38
  
    
--------------------


  		





  
  39
  
    

  		





  
  40
  
    
.. todo:: kpap: verify instructions for installation from source.


  		





  
  41
  
    

  		





  
  42
  
    
Use ``pip`` to install the latest version of the package from source,


  		





  
  43
  
    
or request a specific version as ``snf-asterias-app==x.y.z``.


  		





  
  44
  
    

  		





  
  45
  
    
.. code-block:: console


  		





  
  46
  
    

  		





  
  47
  
    
   $ pip install snf-asterias-app -f https://code.grnet.gr/projects/synnefo/files


  		





  
  48
  
    

  		





  
  49
  
    
On Debian Squeeze, install the ``snf-asterias-app`` Debian package.


  		





  
  50
  
    

  		





  
  51
  
    
Package configuration


  		





  
  52
  
    
---------------------


  		





  
  53
  
    

  		





  
  54
  
    
Web application


  		





  
  55
  
    
***************


  		





  
  56
  
    

  		





  
  57
  
    
Please see the configuration section of :ref:`snf-webproject <snf-webproject>`


  		





  
  58
  
    
on how to serve :ref:`snf-asterias-app <snf-asterias-app>` as part of a


  		





  
  59
  
    
Django project.


  		





  
  60
  
    

  		





  
  61
  
    
snf-dispatcher


  		





  
  62
  
    
**************


  		





  
  63
  
    

  		





  
  64
  
    
.. note:: The Debian package configures the init script for


  		





  
  65
  
    
   :command:`snf-dispatcher` automatically, see ``/etc/default/snf-dispatcher``.


  		





  
  66
  
    

  		





  
  67
  
    
.. todo:: package an initscript for :command:`snf-dispatcher`


  		





  
  68
  
    

  		





  
  69
  
    
Make sure the logic dispatcher starts automatically on system boot of


  		





  
  70
  
    
:ref:`LOGIC <LOGIC_NODE>` nodes. Initscript ``conf/init.d/snf-dispatcher``


  		





  
  71
  
    
is provided for your convenience.


  		





  
  72
  
    

  		





  
  73
  
    
You may also start the dispatcher by hand:


  		





  
  74
  
    

  		





  
  75
  
    
.. code-block:: console


  		





  
  76
  
    

  		





  
  77
  
    
  $ snf-dispatcher


  		





  
  78
  
    

  		





  
  79
  
    
The dispatcher should run in at least 2 instances to ensure high


  		





  
  80
  
    
(actually, increased) availability.


  		





  
  81
  
    

  		





  
  82
  
    
Package settings


  		





  
  83
  
    
----------------


  		





  
  84
  
    

  		





  
  85
  
    
Component :ref:`snf-asterias-app <snf-asterias-app>` requires the following


  		





  
  86
  
    
settings, as managed by :ref:`snf-common <snf-common>`:


  		





  
  87
  
    

  		





  
  88
  
    
.. literalinclude:: ../synnefo/app_settings/default/api.py


  		





  
  89
  
    
    :lines: 4-


  		





  
  90
  
    
.. literalinclude:: ../synnefo/app_settings/default/logging.py


  		





  
  91
  
    
    :lines: 4-


  		





  
  92
  
    
.. literalinclude:: ../synnefo/app_settings/default/backend.py


  		





  
  93
  
    
    :lines: 4-


  		





  
  94
  
    
.. literalinclude:: ../synnefo/app_settings/default/plankton.py


  		





  
  95
  
    
    :lines: 4-


  		





  
  96
  
    
.. literalinclude:: ../synnefo/app_settings/default/queues.py


  		





  
  97
  
    
    :lines: 4-


  		





  
  98
  
    
.. literalinclude:: ../synnefo/app_settings/default/reconsiliation.py


  		





  
  99
  
    
    :lines: 4-


  		





  
  100
  
    
.. literalinclude:: ../synnefo/app_settings/default/ui.py


  		





  
  101
  
    
    :lines: 4-


  		





  
  102
  
    
.. literalinclude:: ../synnefo/app_settings/default/userdata.py


  		





  
  103
  
    
    :lines: 4-


  		





  
  104
  
    

  		





  
  105
  
    
.. todo:: make sure the file headers are included properly in documentation.


  		





  
  106
  
    
          If not change the :lines setting accordingly.


  		





  35
  107
  
    

  		





  36
  
  
    
* :ref:`genindex`


  		





  37
  
  
    
* :ref:`modindex`


  		





  38
  
  
    
* :ref:`search`


  		












Also available in:
  Unified diff