BUILD.md

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 : 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).

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
• librain
• 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

In addition, a few python modules are required at runtime:

• python-eventlet
• python-flask
• python-gunicorn
• python-plyvel
• python-redis
• python-requests
• python-simplejson
• pyxattr (python-xattr on Debian/Ubuntu)
• python-zmq

The account service will require an up and running backend:

• redis

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_LINGER_ONOFF	(integer value) triggers the onoff value of the SO_LINGER configuration.
SOCKET_LINGER_DELAY	(integer value) set it to the delay in milliseconds, this will the delay part of the SO_LINGER configuration.

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, DB, GRIDINIT, JSONC, LIBRAIN, LZO, MICROHTTPD, 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:

cd ${SRCDIR}/python; sudo python setup.py develop; cd -

Compile-time configuration

Used by cmake

Macro	Default	Description
OIOSDS_RELEASE	"master"	Global release name
OIOSDS_API_VERSION_SHORT	"1.0"	Minor version number

Used by gcc

Macro	Default	Description
SERVER_DEFAULT_CNX_IDLE	"5 * G_TIME_SPAN_MINUTE"	How long (in microseconds) a connection might stay idle between two requests
SERVER_DEFAULT_CNX_LIFETIME	"2 * G_TIME_SPAN_HOUR"	How long (in microseconds) a connection might exist since its creation (whatever it is active or not)
SERVER_DEFAULT_CNX_INACTIVE	"30 * G_TIME_SPAN_SECOND"	How long (in microseconds) a connection might exist since its creation when it received no request at all.
DAEMON_DEFAULT_TIMEOUT_READ	1000	How long a gridd will block on a recv() (in milliseconds)
DAEMON_DEFAULT_TIMEOUT_ACCEPT	1000	How long a gridd will block on a accept() (in milliseconds)

Macro	Default	Description
GCLUSTER_RUN_DIR	"/var/run"	Prefix to spool.
GCLUSTER_CONFIG_FILE_PATH	"/etc/oio/sds.conf"	System-wide configuration file
GCLUSTER_CONFIG_DIR_PATH	"/etc/oio/sds.conf.d"	System-wide configuration directory for additional files.
GCLUSTER_CONFIG_LOCAL_PATH	".oio/sds.conf"	Local configuration directory.
GCLUSTER_AGENT_SOCK_PATH	"/var/run/oio-sds-agent.sock"	Default path for agent's socket.
GS_CONFIG_NSINFO_REFRESH	"nsinfo_refresh"	Default refresh period for

Macro	Default	Description
RAWX_HEADER_PREFIX	"X-oio-chunk-meta-"	Prefix applied to proxyd's URL, second version (with accounts)
PROXYD_PREFIX	"v3.0"	Prefix applied to proxyd's URL, second version (with accounts)
PROXYD_HEADER_PREFIX	"X-oio-"	Prefix for all the headers sent to the proxy
PROXYD_HEADER_REQID	PROXYD_HEADER_PREFIX "req-id"	Header whose value is printed in access log, destined to agregate several requests belonging to the same session.
PROXYD_HEADER_NOEMPTY	PROXYD_HEADER_PREFIX "no-empty-list"	Flag sent to the proxy to turn empty list (results) into 404 not found.
PROXYD_PATH_MAXLEN	2048	Maximum length for path to be accepted in requests.
PROXYD_DEFAULT_TTL_SERVICES	3600	Idem for services entries.
PROXYD_DEFAULT_MAX_SERVICES	200000	Idem for service entries.
PROXYD_DEFAULT_TTL_CSM0	0	Maximum TTL (in seconds) for conscience entries in the proxyd cache.
PROXYD_DEFAULT_MAX_CSM0	0	Maximum number of conscience's items in the proxyd cache.
PROXYD_PERIOD_RELOAD_NSINFO	30
PROXYD_PERIOD_RELOAD_M0INFO	30
PROXYD_TTL_DEAD_LOCAL_SERVICES	30
PROXYD_TTL_DOWN_SERVICES	5
PROXYD_DEFAULT_TIMEOUT_CONSCIENCE	5000
PROXYD_DEFAULT_PERIOD_DOWNSTREAM	10
PROXYD_DEFAULT_PERIOD_UPSTREAM	1
OIO_M2V2_LISTRESULT_BATCH	1000
OIO_EVTQ_MAXPENDING	1000	Default queue length for services emitting events (meta1, meta2). Beyond this limit, the queue will be reported as 'stalled' so that the services can properly manage this.
SQLX_DIR_SCHEMAS	NULL	Default directory used to gather applicative schema of SQLX bases. NULL by default, meaning that no directory is set, so that there is no attempt to load a schema.
SQLX_ADMIN_PREFIX_SYS	"sys."	Prefix used for keys used in admin table of sqlite bases
SQLX_ADMIN_PREFIX_USER	"user."	Prefix used for keys used in admin table of sqlite bases
SQLX_ADMIN_INITFLAG	SQLX_ADMIN_PREFIX_SYS "sqlx.init"	Key used in admin table of sqlite bases
SQLX_ADMIN_STATUS	SQLX_ADMIN_PREFIX_SYS "sqlx.flags"	Key used in admin table of sqlite bases
SQLX_ADMIN_REFERENCE	SQLX_ADMIN_PREFIX_SYS "sqlx.reference"	Key used in admin table of sqlite bases
SQLX_ADMIN_BASENAME	SQLX_ADMIN_PREFIX_SYS "sqlx.name"	Key used in admin table of sqlite bases
SQLX_ADMIN_BASETYPE	SQLX_ADMIN_PREFIX_SYS "sqlx.type"	Key used in admin table of sqlite bases
SQLX_ADMIN_NAMESPACE	SQLX_ADMIN_PREFIX_SYS "sqlx.ns"	Key used in admin table of sqlite bases
M2V2_ADMIN_PREFIX_SYS	SQLX_ADMIN_PREFIX_SYS "m2."
M2V2_ADMIN_PREFIX_USER	SQLX_ADMIN_PREFIX_USER "m2."
M2V2_ADMIN_VERSION	M2V2_ADMIN_PREFIX_SYS "version"
M2V2_ADMIN_QUOTA	M2V2_ADMIN_PREFIX_SYS "quota"
M2V2_ADMIN_SIZE	M2V2_ADMIN_PREFIX_SYS "usage"
M2V2_ADMIN_CTIME	M2V2_ADMIN_PREFIX_SYS "ctime"
M2V2_ADMIN_VERSIONING_POLICY	M2V2_ADMIN_PREFIX_SYS "policy.version"
M2V2_ADMIN_STORAGE_POLICY	M2V2_ADMIN_PREFIX_SYS "policy.storage"
M2V2_ADMIN_KEEP_DELETED_DELAY	M2V2_ADMIN_PREFIX_SYS "keep_deleted_delay"
META2_INIT_FLAG	M2V2_ADMIN_PREFIX_SYS "init"
CS_CLIENT_TIMEOUT	10.0	value telling the default timeout for conscience requests, in seconds.
M0V2_CLIENT_TIMEOUT	10.0	value telling the default timeout for meta0 requests, in seconds.
M1V2_CLIENT_TIMEOUT	10.0	value telling the default timeout for meta1 requests, in seconds.
M2V2_CLIENT_TIMEOUT	10.0	value telling the default timeout for meta2 requests, in seconds.