Revision 252bb277 snf-app/docs/src/snf-ganeti-tools.rst

b/snf-app/docs/src/snf-ganeti-tools.rst
40 40
.. todo:: Document the synnefo-specific progress monitor.
41 41

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

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

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

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

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

  
58
.. code-block:: bash
58
.. code-block:: console
59 59

  
60 60
   pip install snf-ganeti-tools -f https://code.grnet.gr/projects/synnefo/files
61 61

  
62 62
On Debian Squeeze, install the ``snf-ganeti-tools`` Debian package.
63 63

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

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

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

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

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

  
83
.. code-block:: bash
83
.. code-block:: console
84 84

  
85 85
    root@ganeti-master:/etc/ganeti/hooks/instance-start-post.d# ls -l
86 86
    lrwxrwxrwx 1 root root 45 May   3 13:45 00-snf-ganeti-hook -> /home/devel/synnefo/snf-ganeti-hook/snf-ganeti-hook.py
......
95 95
   `Ganeti customisation using hooks <http://docs.ganeti.org/ganeti/master/html/hooks.html?highlight=hooks#naming>`_
96 96

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

  
100 100
Component :ref:`snf-ganeti-tools <snf-ganeti-tools>` requires the following
101 101
settings, as managed by :ref:`snf-common <snf-common>`:

Also available in: Unified diff