Revision 29e8788e INSTALL

b/INSTALL
34 34
- `ctypes Python module
35 35
  <http://starship.python.net/crew/theller/ctypes/>`_, if running on
36 36
  python 2.4 (optional, used for node daemon memory locking)
37
- `socat <http://www.dest-unreach.org/socat/>`_
37
- `socat <http://www.dest-unreach.org/socat/>`_, see :ref:`note
38
  <socat-note>` below
38 39
- `Paramiko <http://www.lag.net/paramiko/>`_, if you want automated SSH
39 40
  setup; optional otherwise but manual setup of the nodes required
40 41

  
......
52 53
If you want to build from source, please see doc/devnotes.rst for more
53 54
dependencies.
54 55

  
56
.. _socat-note:
57
.. note::
58
  Ganeti's import/export functionality uses ``socat`` with OpenSSL for
59
  transferring data between nodes. By default, OpenSSL 0.9.8 and above
60
  employ transparent compression of all data using zlib if supported by
61
  both sides of a connection. In cases where a lot of data is
62
  transferred, this can lead to an increased CPU usage. Additionally,
63
  Ganeti already compresses all data using ``gzip`` where it makes sense
64
  (for inter-cluster instance moves).
65

  
66
  To remedey this situation, patches implementing a new ``socat`` option
67
  for disabling OpenSSL compression have been contributed and will
68
  likely be included in the next feature release. Until then, users or
69
  distributions need to apply the patches on their own.
70

  
71
  Ganeti will use the option if it's detected by the ``configure``
72
  script; auto-detection can be disabled by explicitely passing
73
  ``--enable-socat-compress`` (use the option to disable compression) or
74
  ``--disable-socat-compress`` (don't use the option).
75

  
76
  The patches and more information can be found on
77
  http://www.dest-unreach.org/socat/contrib/socat-opensslcompress.html.
78

  
55 79

  
56 80
Installation of the software
57 81
----------------------------

Also available in: Unified diff