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

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

7
Most dependencies from :doc:`install-quick`, plus (for Python):
8

Michael Hanselmann's avatar
Michael Hanselmann committed
9 10 11
- `GNU make <http://www.gnu.org/software/make/>`_
- `GNU tar <http://www.gnu.org/software/tar/>`_
- `Gzip <http://www.gnu.org/software/gzip/>`_
Iustin Pop's avatar
Iustin Pop committed
12
- `pandoc <http://johnmacfarlane.net/pandoc/>`_
Michael Hanselmann's avatar
Michael Hanselmann committed
13 14 15
- `python-sphinx <http://sphinx.pocoo.org/>`_
  (tested with version 0.6.1)
- `graphviz <http://www.graphviz.org/>`_
Guido Trotter's avatar
Guido Trotter committed
16
- the `en_US.UTF-8` locale must be enabled on the system
17 18
- `pylint <http://www.logilab.org/857>`_ and its associated
  dependencies
19
- `pep8 <https://github.com/jcrocholl/pep8/>`_
20 21 22 23 24 25 26

Note that for pylint, at the current moment the following versions
need to be used::

    $ pylint --version
    pylint 0.21.1,
    astng 0.20.1, common 0.50.3
27

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

31 32 33 34 35 36 37 38 39 40
For Haskell development, again all things from the quick install
document, plus:

- `haddock <http://www.haskell.org/haddock/>`_, documentation
  generator (equivalent to epydoc for Python)
- `HsColour <http://hackage.haskell.org/package/hscolour>`_, again
  used for documentation (it's source-code pretty-printing)
- `hlint <http://community.haskell.org/~ndm/hlint/>`_, a source code
  linter (equivalent to pylint for Python)
- the `QuickCheck <http://hackage.haskell.org/package/QuickCheck>`_
Iustin Pop's avatar
Iustin Pop committed
41
  library, version 2.x
42 43 44 45 46 47
- ``hpc``, which comes with the compiler, so you should already have
  it

Under Debian, these can be installed (on top of the required ones from
the quick install document) via::

48
  apt-get install libghc-quickcheck2-dev hscolour hlint
49

50

51 52 53
Configuring for development
---------------------------

Michael Hanselmann's avatar
Michael Hanselmann committed
54 55
.. highlight:: sh

56 57 58
Run the following command (only use ``PYTHON=...`` if you need to use a
different python version)::

59
  ./autogen.sh && \
60
  ./configure --prefix=/usr/local --sysconfdir=/etc --localstatedir=/var
61

Iustin Pop's avatar
Iustin Pop committed
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
Haskell development notes
-------------------------

There are a few things which can help writing or debugging the Haskell
code.

You can run the Haskell linter :command:`hlint` via::

  make hlint

This is not enabled by default as it gets many false positives, and
thus the normal output is not “clean”. The above command will generate
both output on the terminal and also a HTML report at
``doc/hs-lint.html``.

When writing or debugging TemplateHaskell code, it's useful to see
what the splices are converted to. This can be done via::

  make HEXTRA="-ddump-splices"

Due to the way TemplateHaskell works, it's not straightforward to
build profiling code. The recommended way is::

  make clean
  make htools/htools HEXTRA="-osuf .o"
  rm htools/htools
  make htools/htools HEXTRA="-osuf .prof_o -prof -auto-all"

This will build the binary twice, per the TemplateHaskell
documentation, the second one with profiling enabled.

93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109

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
110
daemons. It is recommended to use ``daemon-util`` also from the system's
111 112 113 114 115 116 117 118 119 120 121 122
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.

123
.. vim: set textwidth=72 :