Statistics
| Branch: | Tag: | Revision:

root / doc / devnotes.rst @ 2237687b

History | View | Annotate | Download (2 kB)

1 832aef24 Michael Hanselmann
Developer notes
2 832aef24 Michael Hanselmann
===============
3 832aef24 Michael Hanselmann
4 b2fc7ea1 Michael Hanselmann
Build dependencies
5 b2fc7ea1 Michael Hanselmann
------------------
6 b2fc7ea1 Michael Hanselmann
7 cbf3d64b Michael Hanselmann
Most dependencies from :doc:`install-quick`, plus:
8 cbf3d64b Michael Hanselmann
9 c27ba1cc Michael Hanselmann
- `GNU make <http://www.gnu.org/software/make/>`_
10 c27ba1cc Michael Hanselmann
- `GNU tar <http://www.gnu.org/software/tar/>`_
11 c27ba1cc Michael Hanselmann
- `Gzip <http://www.gnu.org/software/gzip/>`_
12 18e2b6e4 Iustin Pop
- `pandoc <http://johnmacfarlane.net/pandoc/>`_
13 c27ba1cc Michael Hanselmann
- `python-sphinx <http://sphinx.pocoo.org/>`_
14 c27ba1cc Michael Hanselmann
  (tested with version 0.6.1)
15 c27ba1cc Michael Hanselmann
- `graphviz <http://www.graphviz.org/>`_
16 1de45c78 Guido Trotter
- the `en_US.UTF-8` locale must be enabled on the system
17 b2fc7ea1 Michael Hanselmann
18 27e336af Michael Hanselmann
To generate unittest coverage reports (``make coverage``), `coverage
19 27e336af Michael Hanselmann
<http://pypi.python.org/pypi/coverage>`_ needs to be installed.
20 27e336af Michael Hanselmann
21 b2fc7ea1 Michael Hanselmann
22 832aef24 Michael Hanselmann
Configuring for development
23 832aef24 Michael Hanselmann
---------------------------
24 832aef24 Michael Hanselmann
25 c27ba1cc Michael Hanselmann
.. highlight:: sh
26 c27ba1cc Michael Hanselmann
27 d17e74b4 Iustin Pop
Run the following command (only use ``PYTHON=...`` if you need to use a
28 d17e74b4 Iustin Pop
different python version)::
29 d17e74b4 Iustin Pop
30 62947ebb Michael Hanselmann
  ./autogen.sh && \
31 b3a8bebf Michael Hanselmann
  ./configure --prefix=/usr/local --sysconfdir=/etc --localstatedir=/var
32 558fd122 Michael Hanselmann
33 94338f0a Michael Hanselmann
34 94338f0a Michael Hanselmann
Packaging notes
35 94338f0a Michael Hanselmann
===============
36 94338f0a Michael Hanselmann
37 94338f0a Michael Hanselmann
Ganeti is mostly developped and tested on `Debian
38 94338f0a Michael Hanselmann
<http://www.debian.org/>`_-based distributions, while still keeping
39 94338f0a Michael Hanselmann
adoptability to other Linux distributions in mind.
40 94338f0a Michael Hanselmann
41 94338f0a Michael Hanselmann
The ``doc/examples/`` directory contains a number of potentially useful
42 94338f0a Michael Hanselmann
scripts and configuration files. Some of them might need adjustment
43 94338f0a Michael Hanselmann
before use.
44 94338f0a Michael Hanselmann
45 94338f0a Michael Hanselmann
``daemon-util``
46 94338f0a Michael Hanselmann
---------------
47 94338f0a Michael Hanselmann
48 94338f0a Michael Hanselmann
This script, in the source code as ``daemons/daemon-util.in``, is used
49 94338f0a Michael Hanselmann
to start/stop Ganeti and do a few other things related to system
50 94338f0a Michael Hanselmann
daemons. Is is recommended to use ``daemon-util`` also from the system's
51 94338f0a Michael Hanselmann
init scripts. That way the code starting and stopping daemons is shared
52 94338f0a Michael Hanselmann
and future changes have to be made in only one place.
53 94338f0a Michael Hanselmann
54 94338f0a Michael Hanselmann
``daemon-util`` reads extra arguments from variables (``*_ARGS``) in
55 94338f0a Michael Hanselmann
``/etc/default/ganeti``. When modifying ``daemon-util``, keep in mind to
56 94338f0a Michael Hanselmann
not remove support for the ``EXTRA_*_ARGS`` variables for starting
57 94338f0a Michael Hanselmann
daemons. Some parts of Ganeti use them to pass additional arguments when
58 94338f0a Michael Hanselmann
starting a daemon.
59 94338f0a Michael Hanselmann
60 94338f0a Michael Hanselmann
The ``reload_ssh_keys`` function can be adjusted to use another command
61 94338f0a Michael Hanselmann
for reloading the OpenSSH daemon's host keys.
62 94338f0a Michael Hanselmann
63 558fd122 Michael Hanselmann
.. vim: set textwidth=72 :