ctron/kura-emulator repository overview

Note: Starting with Kura 4.0, this repository is deprecated. The new repository is: https://hub.docker.com/r/ctron/kura/⁠

⁠Eclipse Kura™ emulator Docker image

This is a docker image running the Eclipse Kura™ emulator.

Use the following command to run it:

docker run -p 8080:8080 ctron/kura-emulator

Once the image is started you can navigate your browser to http://localhost:8080⁠ and log in using the credentials admin : admin.

⁠Enabling the interactive console

By default the Kura instance will run without an Equinox console on the TTY. You can enable the interactive console by passing the argument -console to the container, be sure to also enable the interactive TTY support for the container:

docker run -ti -p 8080:8080 ctron/kura-emulator -console

⁠Different tags/branches

The container image is provided in different branches:

develop

Points to some commit in the current development branch of Kura.

latest

Points to the latest released version of Kura (the default image).

x.y.z

Points to a specific release of Kura.

Also see: https://hub.docker.com/r/ctron/kura-emulator/tags⁠

⁠Making use of Apache Felix File Install

This image includes Apache Felix FileInstall⁠, which monitors a directory and loads all OSGi bundles it detects during runtime. Adding a new bundle is as easy as dropping an OSGi JAR file into a directory. Uninstalling is done by deleting the file and updates are simply done by overwriting the bundle with a newer version.

Note: The location of the directory changed from /opt/eclipse/kura/load to /load. The old path is deprecated. It might still work for a while, but it might break at any time.

File Install loads bundles from /load which is also defined as a docker volume, so that you can link this up with your container host:

docker run -ti -p 8080:8080 -v /home/user/path/to/bundles:/load:z ctron/kura-emulator

Now you can access /home/user/path/to/bundles on your host machine and bundles will be loaded by Kura inside the docker container.

Note: It may be that a bundle, which is first installed, needs to be manually started using the Kura Web UI.

⁠Running with JMX enabled

Running with JMX or debugging enabled can sometimes be quite helpful. However it is disabled by default.

⁠On Linux

If you want to run the image with JMX enabled use the following command on Linux:

docker run -ti -eJAVA_OPTS="-Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.port=9010 -Dcom.sun.management.jmxremote.local.only=false -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false -Xdebug -Xrunjdwp:transport=dt_socket,address=9011,server=y,suspend=n" -p 8080:8080 --expose 9010 --expose 9011 -p 9010:9010 -p 9011:9011 ctron/kura-emulator

⁠On Windows

If you want to run the image with JMX enabled use the following command on Windows:

docker run -ti -eJAVA_OPTS="-Dcom.sun.management.jmxremote -Djava.rmi.server.hostname=<IP> -Dcom.sun.management.jmxremote.port=9010 -Dcom.sun.management.jmxremote.rmi.port=9010 -Dcom.sun.management.jmxremote.local.only=false -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false -Xdebug -Xrunjdwp:transport=dt_socket,address=9011,server=y,suspend=n" -p 8080:8080 --expose 9010 --expose 9011 -p 9010:9010 -p 9011:9011 ctron/kura-emulator

Where <IP> is the Docker address, you can find it by using ipconfig and search for DockerNAT address, for instance:

Ethernet adapter vEthernet (DockerNAT):
Connection-specific DNS Suffix  . :
IPv4 Address. . . . . . . . . . . : 10.0.75.1
Subnet Mask . . . . . . . . . . . : 255.255.255.0
Default Gateway . . . . . . . . . :

The JMX port defined is 9010 and the Remote debug port is 9011. Both ports are not exposed by default and have to be exposed from the command line using --expose 9010 --expose 9011.

⁠Re-Building

This docker container is being built by re-using the Intel UP² CentOS 7 image of Kura. It makes a few adjustments to the Kura sources and performs a full build from a specified Git commit of Kura.

If you want to re-build this image, check out this repository and simply run docker build . on the command line.

If you want to re-base this image on another Kura commit, then you will need to change the environment variable in the Dockerfile or from the command line.

⁠Running in OpenShift

There also is an OpenShift template⁠, which can be used to deploy this image into OpenShift⁠.

⁠Building extended images

If you want to add additional content to the Kura installation inside the docker image, it is possible to extend the installation.

Also see: extensions/artemis/README.md⁠