devnotes.rst 2.07 KB
Newer Older
1 2 3
Developer notes
===============

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

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

Michael Hanselmann's avatar
Michael Hanselmann committed
9 10 11 12 13 14 15 16
- `GNU make <http://www.gnu.org/software/make/>`_
- `GNU tar <http://www.gnu.org/software/tar/>`_
- `Gzip <http://www.gnu.org/software/gzip/>`_
- `Docbook tools <http://sources.redhat.com/docbook-tools/>`_
  (docbook2html and docbook2man)
- `python-sphinx <http://sphinx.pocoo.org/>`_
  (tested with version 0.6.1)
- `graphviz <http://www.graphviz.org/>`_
Guido Trotter's avatar
Guido Trotter committed
17
- the `en_US.UTF-8` locale must be enabled on the system
18

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

22

23 24 25
Configuring for development
---------------------------

Michael Hanselmann's avatar
Michael Hanselmann committed
26 27
.. highlight:: sh

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

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

34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63

Packaging notes
===============

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

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

``daemon-util``
---------------

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

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

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

64
.. vim: set textwidth=72 :