This document describes how to setup a local build environment to build OSC as a Docker image in a tar format.
OSC image is built on Ubuntu Linux Operating system. Java related application in OSC can be compiled using Maven in windows using CYGWIN tool. Following tools and packages are required and mandatory for OSC image builds.
- Any Linux OS distribution
- Java 8
- Apache Maven 3.3
- Apache Ant 1.9.X
- Docker 17.12.x
- Access to OSC source code
This document assumes that user is performing following installation steps on Ubuntu 16.04 LTS Linux OS. And examples in this section are with reference to Ubuntu Desktop Linux OS.
Install Java on your system also make sure to installed JDK and JRE both. For example to install Java Development Kit on a local Ubuntu Linux OS. Visit install Java 8 on Ubuntu.
Verify Java version and make sure the version is 1.8.xxx.
After verifying java version on your system. Download Apache Maven from its official website or use following command to download Apache Maven 3.3.9.
$ cd /usr/local
$ wget http://www-eu.apache.org/dist/maven/maven-3/3.3.9/binaries/apache-maven-3.3.9-bin.tar.gz
Now extract downloaded archive using following command.
$ sudo tar xzf apache-maven-3.3.9-bin.tar.gz
$ sudo ln -s apache-maven-3.3.9 apache-maven
Make sure you have a Java environment installed before installing Ant.
Following command is an example to download Ant on Ubuntu14.04:
$ sudo apt-get update
$ sudo apt-get install antRefer to your Linux OS guide on how to download Ant.
Install Docker on your system. Visit install Docker on Ubuntu.
Configure the proxy settings. Visit Proxy settings for docker.
As you have downloaded pre compiled Apache Maven files on your system, you must set the environments variables by creating new file apache-maven.sh.
$ sudo vi /etc/profile.d/apache-maven.sh
And add following content.
export JAVA_HOME=/usr/lib/jvm/java-8-oracle
export M2_HOME=/usr/local/apache-maven
export MAVEN_HOME=/usr/local/apache-maven
export PATH=${M2_HOME}/bin:${PATH}$ source /etc/profile.d/apache-maven.sh
Verify the Maven version and required version should be 3.3.xxx
If connecting through a proxy create or modify ~/.m2/settings.xml providing the proxy settings.
This section explains build command formats required to generate docker image as a tar file. OSC virtual appliance will be packaged and distributed in tar format.
Go to osc-core directory
$ cd /home/local-working-directory/osc-core/
$ ant dockerimage
The docker image will be copied in following build location
$ cd /home/local-working-directory/osc-core/BuildXX-XXXXXX
For any "network unreachable :" issues check the following on build machine:
- Proxy setting, if the system is behind a proxy.
- General network issues like ipaddress, mask, gateway and default route.
For Maven build related issues, see the Building and Running OSC documentation.
If the command create-centos is run prior to all pre-requisites installation following error might occur.
org.apache.tools.ant.launch.Launcher
[ERROR] Failed to execute goal biz.aQute.bnd:bnd-export-maven-plugin:3.3.0:export (default) on project osc-export: Default handler for Launcher-Plugin not found in biz.aQute.launcher -> [Help 1]
Work around for this compile error is execute following command
mkdir -p $HOME/.bnd/default-ws/cnf/cache/3.3.0/bnd-cache/biz.aQute.launcher
wget -O $HOME/.bnd/default-ws/cnf/cache/3.3.0/bnd-cache/biz.aQute.launcher/biz.aQute.launcher-3.3.0.jar http://central.maven.org/maven2/biz/aQute/bnd/biz.aQute.launcher/3.3.0/biz.aQute.launcher-3.3.0.jar
For now OSC build environment requires Ubuntu Linux Operating System.