root / doc / devnotes.rst @ 1de45c78
History | View | Annotate | Download (2.1 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 |
- `Docbook tools <http://sources.redhat.com/docbook-tools/>`_ |
| 13 |
(docbook2html and docbook2man) |
| 14 |
- `python-sphinx <http://sphinx.pocoo.org/>`_ |
| 15 |
(tested with version 0.6.1) |
| 16 |
- `graphviz <http://www.graphviz.org/>`_ |
| 17 |
- the `en_US.UTF-8` locale must be enabled on the system |
| 18 |
|
| 19 |
To generate unittest coverage reports (``make coverage``), `coverage |
| 20 |
<http://pypi.python.org/pypi/coverage>`_ needs to be installed. |
| 21 |
|
| 22 |
|
| 23 |
Configuring for development |
| 24 |
--------------------------- |
| 25 |
|
| 26 |
.. highlight:: sh |
| 27 |
|
| 28 |
Run the following command (only use ``PYTHON=...`` if you need to use a |
| 29 |
different python version):: |
| 30 |
|
| 31 |
./autogen.sh && \ |
| 32 |
./configure PYTHON=python2.4 \ |
| 33 |
--prefix=/usr/local --sysconfdir=/etc --localstatedir=/var |
| 34 |
|
| 35 |
|
| 36 |
Packaging notes |
| 37 |
=============== |
| 38 |
|
| 39 |
Ganeti is mostly developped and tested on `Debian |
| 40 |
<http://www.debian.org/>`_-based distributions, while still keeping |
| 41 |
adoptability to other Linux distributions in mind. |
| 42 |
|
| 43 |
The ``doc/examples/`` directory contains a number of potentially useful |
| 44 |
scripts and configuration files. Some of them might need adjustment |
| 45 |
before use. |
| 46 |
|
| 47 |
``daemon-util`` |
| 48 |
--------------- |
| 49 |
|
| 50 |
This script, in the source code as ``daemons/daemon-util.in``, is used |
| 51 |
to start/stop Ganeti and do a few other things related to system |
| 52 |
daemons. Is is recommended to use ``daemon-util`` also from the system's |
| 53 |
init scripts. That way the code starting and stopping daemons is shared |
| 54 |
and future changes have to be made in only one place. |
| 55 |
|
| 56 |
``daemon-util`` reads extra arguments from variables (``*_ARGS``) in |
| 57 |
``/etc/default/ganeti``. When modifying ``daemon-util``, keep in mind to |
| 58 |
not remove support for the ``EXTRA_*_ARGS`` variables for starting |
| 59 |
daemons. Some parts of Ganeti use them to pass additional arguments when |
| 60 |
starting a daemon. |
| 61 |
|
| 62 |
The ``reload_ssh_keys`` function can be adjusted to use another command |
| 63 |
for reloading the OpenSSH daemon's host keys. |
| 64 |
|
| 65 |
.. vim: set textwidth=72 : |