All the Eclipse Hono™ components can be deployed on OpenShift, thanks to the resources YAML files that are provided through the repository. These files describe such components in terms of deployments and services in order to have the right pods running in the OpenShift cluster so that they are able to communicate with each other.
The main prerequisite for this kind of deployment is to have an available OpenShift cluster. For a local development, it’s pretty simple having such cluster just using the OpenShift client tools that can be downloaded from the OpenShift Origin project repository. Follow this guide for setting up a local developer instance of OpenShift, for having an accessible registry for Docker and starting the cluster locally.
One script deployment
In order to deploy Eclipse Hono on OpenShift, a bunch of steps are needed as explained in the next chapter. If you want to avoid to do them, a one click deployment script is available in the repository. After having the OpenShift cluster up and running and the client tools in the PATH, the deployment can be executed launching the following bash script (from the “example/openshift” directory)
$ bash openshift_deploy.sh
When you want to shutdown the Eclipse Hono instance, there is the following useful script:
$ bash openshift_undeploy.sh
Step by step deployment
Creating a project
First, create a new project using the OpenShift client tools in the following way :
$ oc new-project hono
Preparing persistent volume
In order to handle the Device Registry and preserve the related file when pods go down for any reason (i.e. manual scale down to zero instances, crash, …),
a persistent volume is needed so that can be used, through a claim, by the Device Registry. In general, the persistent volume is deployed by the cluster
administrator but for development purposes, a local
/tmp/hono directory can be used on your local host but it needs to be created with read/write permissions in the following way :
$ mkdir /tmp/hono $ chmod 777 /tmp/hono
After that, it’s needed to log into the cluster as a system administrator in order to provision such persistent volume.
$ oc login -u system:admin $ oc create -f <path-to-repo>/example/target/fabric8/hono-pv.yml
When the persistent volume is provisioned, come back to use the default
$ oc login -u developer
Deploying Eclipse Hono components
developer user, it’s now possible to deploy all the other OpenShift resources related to :
- Artemis Broker (service and deployment)
- Qpid Dispatch Router (service and deployment)
- Auth Server (service and deployment)
- Device Registry (persistent volume claim, service and deployment)
- Hono Messaging (service and deployment)
- HTTP REST adapter (service and deployment)
- MQTT adapter (service and deployment)
In order to start deploy the Artemis Broker, the following resources needs to be created.
$ oc create -f <path-to-repo>/hono/broker/target/fabric8/artemis-svc.yml $ oc create -f <path-to-repo>/hono/broker/target/fabric8/artemis-dc.yml
Then the Qpid Dispatch Router.
$ oc create -f <path-to-repo>/hono/dispatchrouter/target/fabric8/dispatch-router-svc.yml $ oc create -f <path-to-repo>/hono/dispatchrouter/target/fabric8/dispatch-router-dc.yml
Then the Auth Server.
$ oc create -f <path-to-repo>/hono/services/auth/target/fabric8/hono-auth-svc.yml $ oc create -f <path-to-repo>/hono/services/auth/target/fabric8/hono-auth-dc.yml
Then the Device Registry, which needs a claim on the persistent volume already provisioned.
$ oc create -f <path-to-repo>/hono/services/device-registry/target/fabric8/hono-device-registry-svc.yml $ oc create -f <path-to-repo>/hono/services/device-registry/target/fabric8/hono-device-registry-pvc.yml $ oc create -f <path-to-repo>/hono/services/device-registry/target/fabric8/hono-device-registry-dc.yml
Then the Hono Messaging.
$ oc create -f <path-to-repo>/hono/services/messaging/target/fabric8/hono-messaging-svc.yml $ oc create -f <path-to-repo>/hono/services/messaging/target/fabric8/hono-messaging-dc.yml
Finally, both the adapters (HTTP REST and MQTT).
$ oc create -f <path-to-repo>/hono/adapters/rest-vertx/target/fabric8/hono-adapter-rest-vertx-svc.yml $ oc create -f <path-to-repo>/hono/adapters/rest-vertx/target/fabric8/hono-adapter-rest-vertx-dc.yml $ oc create -f <path-to-repo>/hono/adapters/mqtt-vertx/target/fabric8/hono-adapter-mqtt-vertx-svc.yml $ oc create -f <path-to-repo>/hono/adapters/mqtt-vertx/target/fabric8/hono-adapter-mqtt-vertx-dc.yml
In this way, all the components are accessible inside the cluster using the service addresses from the clients point of view.
In order to see the deployed components, you can use the OpenShift Web console that is accessible at https://localhost:8443/ using your preferred browser.
In the following pictures an Eclipse Hono deployment on OpenShift is running with all the provided components.