To learn more on how to run Kapua in Minishift, please consult developer manual.
The most recent version of the documentation can be viewed online at:
- http://download.eclipse.org/kapua/docs/develop/user-manual/en/
- http://download.eclipse.org/kapua/docs/develop/developer-guide/en/
You are required to have Docker, Minishift and VirtualBox installed.
VirtualBox will be used as VM driver for Minishift.
You'll need to have the images on your local Docker registry.
You can pull them from a Docker registry or build them from the code.
If you choose to build them from the code please go to Building containers from scratch section.
If you want to pull them from a Docker registry, run:
./minishift-pull-images.sh
First, you need the create and start the Minishift VM.
Run:
./minishift-initialize.sh
This script will set VirtualBox as VM driver of Minishift and start a Minishift VM with 6GB of RAM, 3 CPUs and 20GB of storage.
After the Minishift VM has started you can deploy the Kapua components by running:
./minishift-deploy.sh
This script will create new apps for each Kapua component.
After deployment and startup of containers, they can be accessed at the following endpoints
Application/Service | Endpoint | User | Password | Others |
---|---|---|---|---|
H2 SQL | None | None | None | This service is not exposed |
Elasticsearch | None | None | None | This service is not exposed |
Broker | broker-eclipse-kapua.192.168.99.100.nip.io:31883 | kapua-broker | kapua-password | |
Admin WEB Console | console-eclipse-kapua.192.168.99.100.nip.io:80 | kapua-sys | kapua-password | |
REST API endpoint | api-eclipse-kapua.192.168.99.100.nip.io:80 | kapua-sys | kapua-password | API KEY: 12345678kapua-password |
Please note that endpoints are available only from the host machine.
You can check the status of the pods using the OpenShift Client from the command line or accessing the OpenShift Web Console.
To access the OpenShift Web Console you can run:
minishift dashboard
To stop and remove the Eclipse Kapua project from OpenShift, run:
./minishift-undeploy.sh
This command can take a while to be executed. Even if the Eclipse Kapua
project has disappeared, processing still going on underneath.
To destroy the Minishift VM, runL
./minishift-destroy.sh
Other than the default deployment it is possible to run other versions of Kapua.
By default the latest
version of Kapua will be brought up.
You can change the version of Kapua by exporting the environment variable IMAGE_VERSION
.
Example:
export IMAGE_VERSION=1.0.0
If you want to pass to the JVM additional optional parameters you can set the JAVA_OPTS_EXTRA
environment variable.
Example:
export JAVA_OPTS_EXTRA="-Ddevice.management.request.timeout=60000"
If you want to build containers from the code, you'll need to build the whole Kapua Project.
From the project root directory, run:
mvn clean install -Pdocker
To build also the Admin Web Console container, which is excluded by default, add the console
profile:
mvn clean install -Pconsole,docker
After the build has completed follow the steps from the Running section.