Building from Source Code¶
This page will show you how to compile and install OpenNebula from the sources.
Do not forget to check the Building Dependencies for a list of specific software requirements to build OpenNebula.
If you need to build customized OpenNebula packages you can find the source packages for publicly released versions available in the download repositories for easy rebuilds and customizations. If you need to access the packaging tools, please expose your case to <email@example.com>.
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
$ scons [OPTION=VALUE] the argument expression [OPTION=VALUE] is used to set non-default values for :
|sqlite||no if you don’t want to build sqlite support|
|mysql||yes if you want to build mysql support|
|postgresql||yes if you want to build PostgreSQL support|
|parsers||yes if you want to rebuild flex/bison files|
|new_xmlrpc||yes if you have an xmlrpc-c version >= 1.31|
|sunstone||yes if you want to build sunstone minified files|
|fireedge||yes if you want to build fireedge minified files|
|systemd||yes if you want to build systemd support|
|docker_machine||yes if you want to build the docker-machine driver|
|rubygems||yes if you want to generate ruby gems|
|svncterm||no to skip building vnc support for LXD drivers|
|context||no Download guest contextualization packages|
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-containeddirectory. In either case, you do not need to run OpenNebula as root. These options can be specified when running the install script:
To install OpenNebula with the
system-wide mode you should have super user privileges.
$ sudo ./install.sh <install_options>
where <install_options> can be one or more of:
|-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 and ec2 client files|
|-s||install OpenNebula Sunstone|
|-p||do not install OpenNebula Sunstone non-minified files|
|-G||install OpenNebula Gate|
|-f||install OpenNebula Flow|
|-r||remove Opennebula, only useful if -d was not specified, otherwise
|-l||creates symlinks instead of copying files, useful for development|
|-h||prints installer help|
|-e||install Docker Machine plugin|
- If you choose the
system-wideinstallation, OpenNebula will be installed in the following folders:
./install.sh -r, dinamically generated files will not be removed.
The packages do a
system-wide installation. To create a similar environment, create a
oneadmin user and group, and execute:
oneadmin@frontend:~/ $> wget <opennebula tar gz> oneadmin@frontend:~/ $> tar xzf <opennebula tar gz> oneadmin@frontend:~/ $> cd opennebula-x.y.z oneadmin@frontend:~/opennebula-x.y.z/ $> scons -j2 mysql=yes syslog=yes [ lots of compiling information ] scons: done building targets. oneadmin@frontend:~/opennebula-x.y.z $> sudo ./install.sh -u oneadmin -g oneadmin
Please follow the installation guide, for a detailed description on how to install the Ruby dependencies.
Building Python Bindings from source¶
In order to build the OpenNebula python components it is required to install pip package manager and following pip packages:
- generateds: to generate the python OCA
- pdoc: to generate the API documentation
- setuptools: to generate python package
- wheel: to generate the python package
- aenum: python OCA support
- dicttoxml: python OCA support
- feature: python OCA support
- lxml: python OCA support
- six: python OCA support
- tblib’: python OCA support
- xmltodict: python OCA support
To build run following:
root@frontend:~/ $> cd src/oca/python root@frontend:~/ $> make root@frontend:~/ $> make dist root@frontend:~/ $> make install