Statistics
| Branch: | Tag: | Revision:

root / doc / devnotes.rst @ 2237687b

History | View | Annotate | Download (2 kB)

1
Developer notes
2
===============
3

    
4
Build dependencies
5
------------------
6

    
7
Most dependencies from :doc:`install-quick`, plus:
8

    
9
- `GNU make <http://www.gnu.org/software/make/>`_
10
- `GNU tar <http://www.gnu.org/software/tar/>`_
11
- `Gzip <http://www.gnu.org/software/gzip/>`_
12
- `pandoc <http://johnmacfarlane.net/pandoc/>`_
13
- `python-sphinx <http://sphinx.pocoo.org/>`_
14
  (tested with version 0.6.1)
15
- `graphviz <http://www.graphviz.org/>`_
16
- the `en_US.UTF-8` locale must be enabled on the system
17

    
18
To generate unittest coverage reports (``make coverage``), `coverage
19
<http://pypi.python.org/pypi/coverage>`_ needs to be installed.
20

    
21

    
22
Configuring for development
23
---------------------------
24

    
25
.. highlight:: sh
26

    
27
Run the following command (only use ``PYTHON=...`` if you need to use a
28
different python version)::
29

    
30
  ./autogen.sh && \
31
  ./configure --prefix=/usr/local --sysconfdir=/etc --localstatedir=/var
32

    
33

    
34
Packaging notes
35
===============
36

    
37
Ganeti is mostly developped and tested on `Debian
38
<http://www.debian.org/>`_-based distributions, while still keeping
39
adoptability to other Linux distributions in mind.
40

    
41
The ``doc/examples/`` directory contains a number of potentially useful
42
scripts and configuration files. Some of them might need adjustment
43
before use.
44

    
45
``daemon-util``
46
---------------
47

    
48
This script, in the source code as ``daemons/daemon-util.in``, is used
49
to start/stop Ganeti and do a few other things related to system
50
daemons. Is is recommended to use ``daemon-util`` also from the system's
51
init scripts. That way the code starting and stopping daemons is shared
52
and future changes have to be made in only one place.
53

    
54
``daemon-util`` reads extra arguments from variables (``*_ARGS``) in
55
``/etc/default/ganeti``. When modifying ``daemon-util``, keep in mind to
56
not remove support for the ``EXTRA_*_ARGS`` variables for starting
57
daemons. Some parts of Ganeti use them to pass additional arguments when
58
starting a daemon.
59

    
60
The ``reload_ssh_keys`` function can be adjusted to use another command
61
for reloading the OpenSSH daemon's host keys.
62

    
63
.. vim: set textwidth=72 :