Building
We use Apache Maven as the build tool of choice.
We use gitbook to build the documentation.
Kapua
Kapua is being compiled with Maven. In order to perform a full build of Kapua simply issue the following command in the root of the Git repository:
mvn clean install
If you only want to run Kapua locally for testing you can speed up the build by using:
mvn clean install -Pdev -DskipTests=true
Documentation
Before you can build documentation, you need to install gitbook
gitbook
To install gitbook run
$ npm install -g gitbook-cli
If you don't have npm installed then you would need to install it first.
Install npm On Fedora
$ yum install npm
Install npm On Fedora 24
This is what you should do if you are using Fedora 24+.
$ dnf install nodejs
Install npm On Mac-OS
The easiest way would be through brew brew
You first install brew using the instructions on the Brew website.
After you installed brew you can install npm by:
brew install npm
Building the docs
To build documentation, run gitbook build from either docs/developer-guide/en or docs/user-manual/en
Continuous integration
Kapua is running CI builds against two public environments:
- Travis CI
- Eclipse Hudson
Please be sure that both environments are "green" (i.e. all tests pass) after you commit any changes into develop branch.
We also use CI server sponsored by Red Hat to automatically push latest Docker images to Kapua DockerHub account. Red Hat CI server checks for code changes every 15 minutes and pushes updated version of images if needed.
Building Kapua Docker images
Kapua Docker images are hosted under Kapua DockerHub account. The latest snapshots of images are updated every 15 minutes.
In order to build Kapua Docker images yourself, execute Maven build with docker profile enabled:
cd kapua
mvn
cd assembly
mvn -Pdocker
In order to build and push images into DockerHub registry, execute build with Maven with docker-push profile enabled:
cd kapua
mvn
cd assembly
mvn -Pdocker-push
If you would like to change account name (for example to push to your own account, instead of kapua) use docker.account property:
mvn -Ddocker.account=henry -Pdocker-push
By default Kapua applies the following tags to the published images:
latest- daily timestamp in format
YYYY-MM-DD - current project version (for example
0.0.1or0.1.2-SNAPSHOT)