Skip to content

Latest commit

 

History

History
92 lines (75 loc) · 4.24 KB

BUILD.md

File metadata and controls

92 lines (75 loc) · 4.24 KB
Raw

Build

Dependencies

The build process of OpenIO SDS depends on several third-party projects.

When building only the SDK, OpenIO only depends on:

  • cmake, make : involved in the build process.
  • bison, flex : generates expression parsers.
  • glib2, glib2-devel
  • curl, libcurl, libcurl-devel
  • json-c, json-c-devel
  • asn1c : Now only necessary at the compile time, this is our ASN.1 codec forked from Lev Walkin's excellent ASN.1 codec. The purpose of our fork is simply to provide codec for explicitely sized integers (int{8,16,32,64} instead of long int) and GLib-2.0 memory allocations

Building the entire project will require the SDK dependencies, but also:

  • python: Pure python code generator (no dependency), and python modules.
  • python-distutils-extra: required for the installation process
  • httpd, httpd-devel : server base for RAWX and RAINX services
  • apr, apr-util-devel, apr-devel : internally used by RAINX and RAWX modules
  • attr, libattr-devel : we use xattr a lot to stamp RAWX chunks and repositories base directory.
  • gridinit
  • lzo, lzo-devel : RAWX compression
  • sqlite, sqlite-devel : base storage for META{0,1,2} and SQLX services.
  • zeromq3, zeromq3-devel : communication of events between services and forward agents.
  • zookeeper-devel, libzookeeper_mt.so : building with distribution's zookeeper client is OK, but the package ships with a lot of dependencies, including the openjdk. We recommand to use the official Oracle/Sun JDK, and to build your own zookeeper client from the source to avoid a huge waste of space and bandwith.
  • python-setuptools
  • python-pbr
  • beanstalkd: you need it to have the event-agent working

In addition, there some additional dependencies at runtime:

  • python-eventlet
  • python-werkzeug
  • python-gunicorn
  • python-redis
  • python-requests
  • python-simplejson
  • pyxattr (python-xattr on Debian/Ubuntu)
  • libapache2-mod-wsgi (as named on Ubuntu), the WSGI module pour apache2
  • python-cliff
  • python-pyeclib
  • python-futures

The account service will require an up and running backend:

  • redis

Generating the documentation will require:

  • epydoc: available in your python virtualenv

Configuration

The Makefile's generation is performed by cmake. The master CMake directives files accepts several options. Each option has to be specified on the cmake's command line with the following format:

cmake -D${K}=${V} ${SRCDIR}

In addition to common cmake options, these specific options are also available:

Directive Help
LD_LIBDIR Path suffix to the installation prefix, to define the default directory for libraries. E.g. "lib" or "lib64", depending on the architecture.
STACK_PROTECTOR Trigger stack protection code. Only active when CMAKE_BUILD_TYPE is set to "Debug" or "RelWithDebInfo"
GRIDD_PLUGINS Installation directory for gridd plugins.
APACHE2_MODDIR Installation directory for apache2 modules.
ALLOW_BACKTRACE generate backtraces in errors.
FORBID_DEPRECATED define it to turn into errors the warnings for deprecated symbols from the GLib2.
EXE_PREFIX Defines a prefix to all CLI tool. By default, set to "sds".
SOCKET_OPTIMIZED define if to use socket3 and accept4 syscalls
SOCKET_DEFAULT_LINGER_ONOFF (integer value) triggers the onoff value of the SO_LINGER configuration.
SOCKET_DEFAULT_LINGER_DELAY (integer value) set it to the delay in milliseconds, this will the delay part of the SO_LINGER configuration.
SOCKET_DEFAULT_QUICKACK boolean
SOCKET_DEFAULT_NODELAY boolean

In addition, some options axist to specify uncommon installation paths. Their format is ${DEP}_INCDIR or ${DEP}_LIBDIR, and DEP might take the given values APACHE2, ASN1C, ATTR, CURL, JSONC, LIBRAIN, LZO, ZK, ZLIB, ZMQ

Building

Now that cmake succeeded, it is time to build and install the binaries with make.

make
make test
make DESTDIR=${install_dir} install

Install python module (preferably inside a virtualenv):

python setup.py develop

A lot of variables are available, consider reading Variables.md for more information.