Statistics
| Branch: | Tag: | Revision:

root / snf-cyclades-app / docs / index.rst @ 34e79416

History | View | Annotate | Download (3 kB)

1
.. _snf-cyclades-app:
2

    
3
Component snf-cyclades-app
4
==========================
5

    
6
synnefo component :ref:`snf-cyclades-app <snf-cyclades-app>` defines
7
the web application for cyclades. It includes the following:
8

    
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
15

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

    
18
.. _snf-dispatcher:
19

    
20
snf-dispatcher
21
--------------
22

    
23
The logic dispatcher provides the context to run the business logic layer of
24
:ref:`cyclades <snf-cyclades>`. It must run on :ref:`LOGIC <LOGIC_NODE>` nodes.
25

    
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

    
29
.. _snf-admin:
30

    
31
snf-admin
32
---------
33

    
34
command :command:`snf-admin` provides the command-line admin interface
35
for :ref:`cyclades <snf-cyclades>`.
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-cyclades-app==x.y.z``.
44

    
45
.. code-block:: console
46

    
47
   $ pip install snf-cyclades-app -f https://www.synnefo.org/packages/pypi
48

    
49
On Debian Squeeze, install the ``snf-cyclades-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-cyclades-app <snf-cyclades-app>` as part of a
59
Django project.
60

    
61
snf-dispatcher
62
**************
63

    
64
.. note:: 
65
    The Debian package configures the init script for
66
    ``snf-dispatcher`` automatically, see ``/etc/default/snf-dispatcher``.
67

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

    
70
Make sure the logic dispatcher starts automatically on system boot of
71
:ref:`LOGIC <LOGIC_NODE>` nodes. Initscript ``conf/init.d/snf-dispatcher``
72
is provided for your convenience.
73

    
74
You may also start the dispatcher by hand:
75

    
76
.. code-block:: console
77

    
78
  $ snf-dispatcher
79

    
80
The dispatcher should run in at least 2 instances to ensure high
81
(actually, increased) availability.
82

    
83
Package settings
84
----------------
85

    
86
Component :ref:`snf-cyclades-app <snf-cyclades-app>` requires the following
87
settings, as managed by :ref:`snf-common <snf-common>`:
88

    
89
.. literalinclude:: ../synnefo/app_settings/default/api.py
90
    :lines: 4-
91
.. literalinclude:: ../synnefo/app_settings/default/logging.py
92
    :lines: 4-
93
.. literalinclude:: ../synnefo/app_settings/default/backend.py
94
    :lines: 4-
95
.. literalinclude:: ../synnefo/app_settings/default/plankton.py
96
    :lines: 4-
97
.. literalinclude:: ../synnefo/app_settings/default/queues.py
98
    :lines: 4-
99
.. literalinclude:: ../synnefo/app_settings/default/ui.py
100
    :lines: 4-
101
.. literalinclude:: ../synnefo/app_settings/default/userdata.py
102
    :lines: 4-
103

    
104
.. todo:: make sure the file headers are included properly in documentation.
105
          If not change the :lines setting accordingly.