Skip to main contentIBM Garage Event-Driven Reference Architecture - Reefer Container Shipment reference implementation

Vessel Simulator

This a simple vessel source events generator taking into account the route from two harbors, the vessel characteristic and the geodetic curve shortest path.


Description: This microservice has been implemented using the Appsody Microprofile 3.2 OpenLiberty stack.

Github repository: refarch-kc-vessel-simulator

Kafka topics consumed from: TBD

Kafka topics produced to: TBD

Events reacted to: TBD

Events produced: TBD

EDA Patterns implemented: TBD


This microservice is built using the Appsody development framework. The Appsody CLI is a required prerequisite for building the application locally.

Appsody will build the application by pulling the contents of the Appsody Stack it is based on and then performing the local application build inside the containerized environment:

appsody build -t <yournamespace>/kcontainer-vessel-simulator[:tag] [--push]

  • You can optionally specify a container tag. If left blank, latest will be used.
  • You can optionally supply the --push flag to automatically push the built image to specified remote repository.

Performing an Appsody build will update the app-deploy.yaml file in the same directory with current information for the application image, labels, and annotations fields.


Deployment parameters

The following deployment parameters are defined in the app-deploy.yaml file:

KAFKA_BROKERSYESComma-separated list of Kafka brokers to connect to
KAFKA_APIKEYNOAPI Key used to connect to SASL-secured Kafka brokers. This is required when connecting to IBM Event Streams clusters.
TRUSTSTORE_PATHNOThe local path to the required truststore file when connecting to IBM Event Streams on CP4I. See Volume Mounts below.
CONTAINER_TOPICYESThe topic name used for communication relating to the containers entity.

Running the microservice locally

The Vessel Simulator microservice requires up to one file to be injected at runtime for proper operation. As noted in the TRUSTSTORE_PATH parameter above, these files are SSL-based certificates which are required to verfiy the identity of the external service when calling it. These files are provided as --docker-options "-v host-src:container-dest ..." when running the microservice locally and as a Volume Mount when running the microservice on a Kubernetes cluster.

The TRUSTSTORE_PATH parameter is documented in the Event Streams Certificates section of the Prerequisites page. The Appsody run command should include a parameter similar to -v /Users/myuser/Downloads/es-cert.pem:/config/resources/security/es-ssl/es-cert.jks in its --docker-options string to run this microservice locally.

Example: appsody run --docker-options "-v /Users/myuser/Downloads/es-cert.pem:/config/resources/security/es-ssl/es-cert.jks" ...

Running the microservice remotely

The Appsody Operator is a required prerequisite for deploying the microservice to a remote Kubernetes or OpenShift cluster.

To deploy the microservice to a remote cluster:

appsody deploy <yournamespace>/kcontainer-vessel-simulator[:tag] --no-build

  • You can omit the --no-build flag to have Appsody perform a build before deploying the application.
  • Note: Performing a build at deploy time requires specifying the absolute container reference path, as well as the --push flag.
  • The neccesary deployment parameter information will be read from the app-deploy.yaml file in the same directory.

Usage Details