root / snf-ganeti-tools / docs / index.rst @ 9940eacf
History | View | Annotate | Download (3.3 kB)
1 | 99644884 | Vangelis Koukis | .. _snf-asterias-ganeti-tools: |
---|---|---|---|
2 | e609b1ba | Vangelis Koukis | |
3 | 99644884 | Vangelis Koukis | Component snf-asterias-ganeti-tools |
4 | 99644884 | Vangelis Koukis | =================================== |
5 | e609b1ba | Vangelis Koukis | |
6 | 99644884 | Vangelis Koukis | synnefo component :ref:`snf-asterias-ganeti-tools <snf-asterias-ganeti-tools>` is a set of |
7 | e609b1ba | Vangelis Koukis | tools that need to be installed on all Ganeti nodes: |
8 | e609b1ba | Vangelis Koukis | |
9 | e609b1ba | Vangelis Koukis | * :ref:`event daemon <eventd>` |
10 | e609b1ba | Vangelis Koukis | * :ref:`hook <hook>` |
11 | e609b1ba | Vangelis Koukis | * :ref:`progress-monitor <progress_monitor>` |
12 | e609b1ba | Vangelis Koukis | |
13 | e609b1ba | Vangelis Koukis | .. _eventd: |
14 | e609b1ba | Vangelis Koukis | |
15 | e609b1ba | Vangelis Koukis | Event daemon |
16 | e609b1ba | Vangelis Koukis | ------------ |
17 | e609b1ba | Vangelis Koukis | |
18 | 99644884 | Vangelis Koukis | synnefo component :ref:`snf-asterias-ganeti-tools <snf-asterias-ganeti-tools>` includes |
19 | e609b1ba | Vangelis Koukis | ``snf-ganeti-eventd``, the synnefo-specific Ganeti event daemon. |
20 | e609b1ba | Vangelis Koukis | It monitors the Ganeti job queue and produces notifications to the rest of |
21 | e609b1ba | Vangelis Koukis | the synnefo infrastructure over AMQP whenever a Ganeti job makes progress. |
22 | e609b1ba | Vangelis Koukis | |
23 | e609b1ba | Vangelis Koukis | .. todo:: Document the event daemon, assemble things from other sources. |
24 | e609b1ba | Vangelis Koukis | |
25 | e609b1ba | Vangelis Koukis | .. _hook: |
26 | e609b1ba | Vangelis Koukis | |
27 | e609b1ba | Vangelis Koukis | Hook |
28 | e609b1ba | Vangelis Koukis | ---- |
29 | e609b1ba | Vangelis Koukis | |
30 | 99644884 | Vangelis Koukis | synnefo component :ref:`snf-asterias-ganeti-tools <snf-asterias-ganeti-tools>` defines |
31 | e609b1ba | Vangelis Koukis | a synnefo-specific hook, running inside Ganeti. |
32 | e609b1ba | Vangelis Koukis | |
33 | e609b1ba | Vangelis Koukis | .. _progress_monitor: |
34 | e609b1ba | Vangelis Koukis | |
35 | e609b1ba | Vangelis Koukis | Progress monitor |
36 | e609b1ba | Vangelis Koukis | ---------------- |
37 | e609b1ba | Vangelis Koukis | |
38 | e609b1ba | Vangelis Koukis | A small Python tool to monitor the progress of image deployment. |
39 | e609b1ba | Vangelis Koukis | |
40 | e609b1ba | Vangelis Koukis | .. todo:: Document the synnefo-specific progress monitor. |
41 | e609b1ba | Vangelis Koukis | |
42 | e609b1ba | Vangelis Koukis | Package source |
43 | 252bb277 | Vangelis Koukis | -------------- |
44 | e609b1ba | Vangelis Koukis | |
45 | 99644884 | Vangelis Koukis | The source for component :ref:`snf-asterias-ganeti-tools <snf-asterias-ganeti-tools>` |
46 | 99644884 | Vangelis Koukis | lives under ``snf-asterias-ganeti-tools/`` at ``git://code.grnet.gr/git/synnefo``, |
47 | e609b1ba | Vangelis Koukis | also accessible at |
48 | 99644884 | Vangelis Koukis | `code.grnet.gr <https://code.grnet.gr/projects/synnefo/repository/revisions/master/show/snf-asterias-ganeti-tools>`_. |
49 | e609b1ba | Vangelis Koukis | |
50 | e609b1ba | Vangelis Koukis | Package installation |
51 | 252bb277 | Vangelis Koukis | -------------------- |
52 | e609b1ba | Vangelis Koukis | |
53 | e609b1ba | Vangelis Koukis | .. todo:: kpap: verify instructions for installation from source. |
54 | e609b1ba | Vangelis Koukis | |
55 | e609b1ba | Vangelis Koukis | Use ``pip`` to install the latest version of the package from source, |
56 | 99644884 | Vangelis Koukis | or request a specific version as ``snf-asterias-ganeti-tools==x.y.z``. |
57 | e609b1ba | Vangelis Koukis | |
58 | 252bb277 | Vangelis Koukis | .. code-block:: console |
59 | e609b1ba | Vangelis Koukis | |
60 | 99644884 | Vangelis Koukis | pip install snf-asterias-ganeti-tools -f https://code.grnet.gr/projects/synnefo/files |
61 | e609b1ba | Vangelis Koukis | |
62 | 99644884 | Vangelis Koukis | On Debian Squeeze, install the ``snf-asterias-ganeti-tools`` Debian package. |
63 | e609b1ba | Vangelis Koukis | |
64 | e609b1ba | Vangelis Koukis | Package configuration |
65 | 252bb277 | Vangelis Koukis | --------------------- |
66 | e609b1ba | Vangelis Koukis | |
67 | e609b1ba | Vangelis Koukis | .. note:: The Debian package does the following configuration steps |
68 | e609b1ba | Vangelis Koukis | automatically, see ``/etc/default/snf-ganeti-eventd``. |
69 | e609b1ba | Vangelis Koukis | |
70 | e609b1ba | Vangelis Koukis | Event daemon |
71 | 252bb277 | Vangelis Koukis | ************ |
72 | e609b1ba | Vangelis Koukis | |
73 | e609b1ba | Vangelis Koukis | Make sure the event daemon starts automatically on system boot. |
74 | e609b1ba | Vangelis Koukis | Initscript ``conf/init.d/snf-ganeti-eventd`` is provided for your convenience. |
75 | e609b1ba | Vangelis Koukis | |
76 | e609b1ba | Vangelis Koukis | Hook |
77 | 252bb277 | Vangelis Koukis | **** |
78 | e609b1ba | Vangelis Koukis | The hook needs to be enabled for phases ``post-{add,modify,reboot,start,stop}`` |
79 | e609b1ba | Vangelis Koukis | by *symlinking* in |
80 | e609b1ba | Vangelis Koukis | ``/etc/ganeti/hooks/instance-{add,modify,reboot,start,stop}-post.d`` |
81 | e609b1ba | Vangelis Koukis | on :ref:`GANETI-MASTER <GANETI_MASTER>`, e.g.: |
82 | e609b1ba | Vangelis Koukis | |
83 | 252bb277 | Vangelis Koukis | .. code-block:: console |
84 | e609b1ba | Vangelis Koukis | |
85 | e609b1ba | Vangelis Koukis | root@ganeti-master:/etc/ganeti/hooks/instance-start-post.d# ls -l |
86 | e609b1ba | Vangelis Koukis | lrwxrwxrwx 1 root root 45 May 3 13:45 00-snf-ganeti-hook -> /home/devel/synnefo/snf-ganeti-hook/snf-ganeti-hook.py |
87 | e609b1ba | Vangelis Koukis | |
88 | e609b1ba | Vangelis Koukis | .. todo:: fix the actual location of the link target above. |
89 | e609b1ba | Vangelis Koukis | |
90 | e609b1ba | Vangelis Koukis | .. note:: |
91 | e609b1ba | Vangelis Koukis | The link name may only contain "upper and lower case, digits, |
92 | e609b1ba | Vangelis Koukis | underscores and hyphens. In other words, the regexp ^[a-zA-Z0-9\_-]+$." |
93 | e609b1ba | Vangelis Koukis | |
94 | e609b1ba | Vangelis Koukis | .. seealso:: |
95 | e609b1ba | Vangelis Koukis | `Ganeti customisation using hooks <http://docs.ganeti.org/ganeti/master/html/hooks.html?highlight=hooks#naming>`_ |
96 | e609b1ba | Vangelis Koukis | |
97 | e609b1ba | Vangelis Koukis | Package settings |
98 | 252bb277 | Vangelis Koukis | ---------------- |
99 | e609b1ba | Vangelis Koukis | |
100 | 99644884 | Vangelis Koukis | Component :ref:`snf-asterias-ganeti-tools <snf-asterias-ganeti-tools>` requires the following |
101 | e609b1ba | Vangelis Koukis | settings, as managed by :ref:`snf-common <snf-common>`: |
102 | e609b1ba | Vangelis Koukis | |
103 | 99644884 | Vangelis Koukis | .. literalinclude:: ../../../snf-asterias-ganeti-tools/synnefo/settings.py |
104 | e609b1ba | Vangelis Koukis | |
105 | e609b1ba | Vangelis Koukis | .. todo:: make sure the settings are included properly. |