4 .. highlight:: shell-example
9 Most dependencies from :doc:`install-quick`, including ``qemu-img``
10 (marked there as optional) plus (for Python):
12 - `GNU make <http://www.gnu.org/software/make/>`_
13 - `GNU tar <http://www.gnu.org/software/tar/>`_
14 - `Gzip <http://www.gnu.org/software/gzip/>`_
15 - `pandoc <http://johnmacfarlane.net/pandoc/>`_
16 - `python-epydoc <http://epydoc.sourceforge.net/>`_
17 - `python-sphinx <http://sphinx.pocoo.org/>`_
18 (tested with version 1.1.3)
19 - `graphviz <http://www.graphviz.org/>`_
20 - the `en_US.UTF-8` locale must be enabled on the system
21 - `pylint <http://www.logilab.org/857>`_ and its associated
23 - `pep8 <https://github.com/jcrocholl/pep8/>`_
25 For older developement (Ganeti < 2.4) ``docbook`` was used instead
28 Note that for pylint, at the current moment the following versions
33 astng 0.20.1, common 0.50.3
35 The same with pep8, other versions may give you errors::
40 To generate unittest coverage reports (``make coverage``), `coverage
41 <http://pypi.python.org/pypi/coverage>`_ needs to be installed.
43 Installation of all dependencies listed here::
45 $ apt-get install python-setuptools
46 $ apt-get install pandoc python-epydoc graphviz
47 $ cd / && sudo easy_install \
49 logilab-astng==0.20.1 \
50 logilab-common==0.50.3 \
55 For Haskell development, again all things from the quick install
58 - `haddock <http://www.haskell.org/haddock/>`_, documentation
59 generator (equivalent to epydoc for Python)
60 - `HsColour <http://hackage.haskell.org/package/hscolour>`_, again
61 used for documentation (it's source-code pretty-printing)
62 - `hlint <http://community.haskell.org/~ndm/hlint/>`_, a source code
63 linter (equivalent to pylint for Python), recommended version 1.8 or
64 above (tested with 1.8.15)
65 - the `QuickCheck <http://hackage.haskell.org/package/QuickCheck>`_
67 - the `HUnit <http://hunit.sourceforge.net/>`_ library (tested with
70 <http://batterseapower.github.com/test-framework/>`_ libraries,
71 tested versions: ``test-framework``: 0.6, ``test-framework-hunit``:
72 0.2.7, ``test-framework-quickcheck2``: 0.2.12.1
73 - ``hpc``, which comes with the compiler, so you should already have
75 - `shelltestrunner <http://joyful.com/shelltestrunner>`_, used for
76 running shell-based unit-tests
77 - `temporary <https://github.com/batterseapower/temporary/>`_ library,
78 tested with version 1.1.2.3
80 Under Debian Wheezy or later, these can be installed (on top of the
81 required ones from the quick install document) via::
83 $ apt-get install libghc-quickcheck2-dev libghc-hunit-dev \
84 libghc-test-framework-dev \
85 libghc-test-framework-quickcheck2-dev \
86 libghc-test-framework-hunit-dev \
87 libghc-temporary-dev \
90 Or alternatively via ``cabal``::
92 $ cabal install QuickCheck HUnit \
93 test-framework test-framework-quickcheck2 test-framework-hunit \
94 temporary hscolour hlint shelltestrunner
97 Configuring for development
98 ---------------------------
100 Run the following command (only use ``PYTHON=...`` if you need to use a
101 different python version)::
104 ./configure --prefix=/usr/local --sysconfdir=/etc --localstatedir=/var
106 Note that doing development on a machine which already has Ganeti
107 installed is problematic, as ``PYTHONPATH`` behaviour can be confusing
108 (see Issue 170 for a bit of history/details; in general it works if
109 the installed and developed versions are very similar, and/or if
110 PYTHONPATH is customised correctly). As such, in general it's
111 recommended to use a "clean" machine for ganeti development.
113 Haskell development notes
114 -------------------------
116 There are a few things which can help writing or debugging the Haskell
119 You can run the Haskell linter :command:`hlint` via::
123 This is not enabled by default (as the htools component is
124 optional). The above command will generate both output on the terminal
125 and, if any warnings are found, also an HTML report at
126 ``doc/hs-lint.html``.
128 When writing or debugging TemplateHaskell code, it's useful to see
129 what the splices are converted to. This can be done via::
131 $ make HEXTRA="-ddump-splices"
133 Or, more interactively::
136 λ> :set -ddump-splices
137 λ> :l src/Ganeti/Objects.hs
139 And you will get the spliced code as the module is loaded.
141 To build profiling code you must install the ``ghc-prof`` (or
142 ``gch6-prof``) package, and all the relevant libraries with their
143 ``-prof`` counterparts. If installing libraries through cabal the config
144 file should include ``library-profiling: True`` or the ``-p`` flag
145 should be used. Any library already installed can be updated by passing
146 ``--reinstall`` as well.
148 Due to the way TemplateHaskell works, it's not straightforward to
149 build profiling code. The recommended way is to run ``make hs-prof``,
150 or alternatively the manual sequence is::
153 $ make src/htools HEXTRA="-osuf .o"
155 $ make src/htools HEXTRA="-osuf .prof_o -prof -auto-all"
157 This will build the binary twice, per the TemplateHaskell
158 documentation, the second one with profiling enabled.
160 The binary files generated by compilation and the profiling/coverage
161 files can "break" tab-completion in the sources; they can be ignored,
162 for example, in bash via ``.bashrc``::
164 FIGNORE='.o:.hi:.prof_o:.tix'
166 or in emacs via ``completion-ignored-extensions`` (run ``M-x
167 customize-var completion-ignored-extensions``).
169 Running individual tests
170 ~~~~~~~~~~~~~~~~~~~~~~~~
172 When developing code, running the entire test suite can be
173 slow. Running individual tests is possible easily for unit-tests, less
174 so for shell-tests (but these are faster, so it shouldn't be needed).
178 $ export PYTHONPATH=$PWD
179 $ python ./test/py/ganeti.%mytest%
183 $ make test/hs/test && ./test/hs/test -t %pattern%
185 Where ``pattern`` can be a simple test pattern (e.g. ``comma``,
186 matching any test whose name contains ``comma``), a test pattern
187 denoting a group (ending with a slash, e.g. ``Utils/``), or more
188 complex glob pattern. For more details, see the documentation (on the
189 `test-framework homepage
190 <http://batterseapower.github.com/test-framework/>`_).
195 Ganeti is mostly developed and tested on `Debian
196 <http://www.debian.org/>`_-based distributions, while still keeping
197 adaptability to other Linux distributions in mind.
199 The ``doc/examples/`` directory contains a number of potentially useful
200 scripts and configuration files. Some of them might need adjustment
206 This script, in the source code as ``daemons/daemon-util.in``, is used
207 to start/stop Ganeti and do a few other things related to system
208 daemons. It is recommended to use ``daemon-util`` also from the system's
209 init scripts. That way the code starting and stopping daemons is shared
210 and future changes have to be made in only one place.
212 ``daemon-util`` reads extra arguments from variables (``*_ARGS``) in
213 ``/etc/default/ganeti``. When modifying ``daemon-util``, keep in mind to
214 not remove support for the ``EXTRA_*_ARGS`` variables for starting
215 daemons. Some parts of Ganeti use them to pass additional arguments when
218 The ``reload_ssh_keys`` function can be adjusted to use another command
219 for reloading the OpenSSH daemon's host keys.
221 .. vim: set textwidth=72 :