Building from Source Code 4.4

This page will show you how to compile and install OpenNebula from the sources.

If you want to install it from your package manager, visit the software menu to find out if OpenNebula is included in your official distribution package repositories.

:!: Do not forget to check the Building Dependecies for a list of specific software requirements to build OpenNebula.

Compiling the Software

Follow these simple steps to install the OpenNebula software:

  • Download and untar the OpenNebula tarball.
  • Change to the created folder and run scons to compile OpenNebula<xterm>

$ scons [OPTION=VALUE] </xterm> the argument expression [OPTION=VALUE] is used to set non-default values for :

OPTION VALUE
syslog yes to compile syslog support. Needs log4cpp lib
sqlite_db path-to-sqlite-install
sqlite no if you don't want to build sqlite support
mysql yes if you want to build mysql support
xmlrpc path-to-xmlrpc-install
parsers yes if you want to rebuild flex/bison files
new_xmlrpc yes if you have an xmlrpc-c version >= 1.31

If the following error appears, then you need to remove the option 'new_xmlrpc=yes' or install xmlrpc-c version >= 1.31: 

error: 'class xmlrpc_c::serverAbyss::constrOpt' has no member named 'maxConn'
  • OpenNebula can be installed in two modes: system-wide, or in self-contained directory. In either case, you do not need to run OpenNebula as root. These options can be specified when running the install script:

<xterm> ./install.sh <install_options> </xterm> where <install_options> can be one or more of:

OPTION VALUE
-u user that will run OpenNebula, defaults to user executing install.sh
-g group of the user that will run OpenNebula, defaults to user executing install.sh
-k keep configuration files of existing OpenNebula installation, useful when upgrading. This flag should not be set when installing OpenNebula for the first time
-d target installation directory. If defined, it will specified the path for the self-contained install. If not defined, the installation will be performed system wide
-c only install client utilities: OpenNebula cli, occi and ec2 client files
-r remove Opennebula, only useful if -d was not specified, otherwise rm -rf $ONE_LOCATION would do the job
-h prints installer help

The packages do a system-wide installation. To create a similar environment, create a oneadmin user and group, and execute:

<xterm> oneadmin@frontend:~/ $> wget <opennebula tar gz> oneadmin@frontend:~/ $> tar xzf <opennebula tar gz> oneadmin@frontend:~/ $> cd one-4.0 oneadmin@frontend:~/one-4.0/ $> scons -j2 mysql=yes syslog=yes [ lots of compiling information ] scons: done building targets. oneadmin@frontend:~/one-4.0 $> sudo ./install.sh -u oneadmin -g oneadmin </xterm>

Ruby Dependencies

Ruby version needs to be:

  • ruby >= 1.8.7

Some OpenNebula components need ruby libraries. Some of these libraries are interfaces to binary libraries and the development packages should be installed in your machine. This is the list of the ruby libraries that need a development package:

  • sqlite3: sqlite3 development library
  • mysql: mysql client development library
  • curb: curl development library
  • nokogiri: expat development librarie
  • xmlparse: libxml2 and libxslt development libraries

You will also need ruby development package to be able to compile these gems.

We provide a script to ease the installation of these gems. it is located in /usr/share/one/install_gems (system-wide mode) or $ONE_LOCATION/share/install_gems (self-contained mode). It can be called with the components you want the gem dependencies to be installed. Here are the options:

  • optional: libraries that make CLI and OCA faster
  • quota: quota system
  • sunstone: sunstone graphical interface
  • cloud: ec2 and occi interfaces
  • ozones_client: CLI of ozones
  • ozones_server: server part of ozones, both mysql and sqlite support
  • ozones_server_sqlite: ozones server, only sqlite support
  • ozones_server_mysql: ozones server, only mysql support
  • acct: accounting collector, both mysql and sqlite support
  • acct_sqlite: accounting collector, only sqlite support
  • acct_mysql: accounting collector, only mysql support

The tool can be also called without parameters and all the packages will be installed.

For example, to install only requirements for sunstone, ec2 and occi interfaces you'll issue:

<xterm> oneadmin@frontend: $> ./install_gems sunstone cloud </xterm>