Statistics
| Branch: | Tag: | Revision:

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

History | View | Annotate | Download (3.2 kB)

1
.. _snf-cyclades-gtools:
2

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

    
6
synnefo component :ref:`snf-cyclades-gtools <snf-cyclades-gtools>` is a set of
7
tools that need to be installed on all Ganeti nodes:
8

    
9
    * :ref:`event daemon <eventd>`
10
    * :ref:`hook <hook>`
11
    * :ref:`progress-monitor <progress_monitor>`
12

    
13
.. _eventd:
14

    
15
Event daemon
16
------------
17

    
18
synnefo component :ref:`snf-cyclades-gtools <snf-cyclades-gtools>` includes
19
``snf-ganeti-eventd``, the synnefo-specific Ganeti event daemon.
20
It monitors the Ganeti job queue and produces notifications to the rest of
21
the synnefo infrastructure over AMQP whenever a Ganeti job makes progress.
22

    
23
.. todo:: Document the event daemon, assemble things from other sources.
24

    
25
.. _hook:
26

    
27
Hook
28
----
29

    
30
synnefo component :ref:`snf-cyclades-gtools <snf-cyclades-gtools>` defines
31
a synnefo-specific hook, running inside Ganeti.
32

    
33
.. _progress_monitor:
34

    
35
Progress monitor
36
----------------
37

    
38
A small Python tool to monitor the progress of image deployment.
39

    
40
.. todo:: Document the synnefo-specific progress monitor.
41

    
42
Package source
43
--------------
44

    
45
The source for component :ref:`snf-cyclades-gtools <snf-cyclades-gtools>`
46
lives under ``snf-cyclades-gtools/`` at ``git://code.grnet.gr/git/synnefo``,
47
also accessible at
48
`code.grnet.gr <https://code.grnet.gr/projects/synnefo/repository/revisions/master/show/snf-cyclades-gtools>`_.
49

    
50
Package installation
51
--------------------
52

    
53
.. todo:: kpap: verify instructions for installation from source.
54

    
55
Use ``pip`` to install the latest version of the package from source,
56
or request a specific version as ``snf-cyclades-gtools==x.y.z``.
57

    
58
.. code-block:: console
59

    
60
   pip install snf-cyclades-gtools -f https://www.synnefo.org/packages/pypi
61

    
62
On Debian Squeeze, install the ``snf-cyclades-gtools`` Debian package.
63

    
64
Package configuration
65
---------------------
66

    
67
.. note:: The Debian package does the following configuration steps
68
   automatically, see ``/etc/default/snf-ganeti-eventd``.
69

    
70
Event daemon
71
************
72

    
73
Make sure the event daemon starts automatically on system boot.
74
Initscript ``conf/init.d/snf-ganeti-eventd`` is provided for your convenience.
75

    
76
Hook
77
****
78
The hook needs to be enabled for phases ``post-{add,modify,reboot,start,stop}``
79
by *symlinking* in
80
``/etc/ganeti/hooks/instance-{add,modify,reboot,start,stop}-post.d`` 
81
on :ref:`GANETI-MASTER <GANETI_MASTER>`, e.g.:
82

    
83
.. code-block:: console
84

    
85
    root@ganeti-master:/etc/ganeti/hooks/instance-start-post.d# ls -l
86
    lrwxrwxrwx 1 root root 45 May   3 13:45 00-snf-ganeti-hook -> /home/devel/synnefo/snf-ganeti-hook/snf-ganeti-hook.py
87

    
88
.. todo:: fix the actual location of the link target above.
89

    
90
.. note::
91
    The link name may only contain "upper and lower case, digits,
92
    underscores and hyphens. In other words, the regexp ^[a-zA-Z0-9\_-]+$."
93

    
94
.. seealso::
95
   `Ganeti customisation using hooks <http://docs.ganeti.org/ganeti/master/html/hooks.html?highlight=hooks#naming>`_
96

    
97
Package settings
98
----------------
99

    
100
Component :ref:`snf-cyclades-gtools <snf-cyclades-gtools>` requires the following
101
settings, as managed by :ref:`snf-common <snf-common>`:
102

    
103
.. literalinclude:: ../../../snf-cyclades-gtools/synnefo/settings.py
104

    
105
.. todo:: make sure the settings are included properly.