stock-common-model project

This project uses Quarkus, the Supersonic Subatomic Java Framework, and KafkaStreams.

If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ . Or KafkaStreams: https://kafka.apache.org/documentation/streams/ .

Library

This library packages common classes used by the inventory demo components.

Objects

A Product represents the sku and human-readable name of a product tracked by the inventory system.
A SupplyUpdate represents one or more updates to Products / quantities tracked by the inventory system. Each product included in an Update is represented as the
key / value pair as a SupplyUpdateEntry.
An Order represents quantities of one or more products reserved by a downstream customer. Each product type and quantity is represented as a key / value pair by
class OrderEntry.
A Shipment represents a realized transfer of products / quantities into the transportation system that are no longer available in the inventory system. Each
product included with a shipment is represented by ShipmentLineEntry as a key / value pair, with Product as the key and Quantity as the value.

Quickstart

Requirements

A kafka cluster configured to use OAUTHBEARER authentication.
A service account with OAUTHBEARER credentials and an oauth token endpoint.

The following topics are required in your kafka cluster for this app to run:

stock-levels
updated-stock

Run

To run the app, add the following vars to your environment:

export BOOTSTRAP_SERVERS=<KAFKA_BOOTSTRAP_SERVERS>
export CLIENT_ID=<KAFKA_CLIENT_ID>
export CLIENT_SECRET=<KAFKA_CLIENT_SECRET>
export TOKEN_ENDPOINT_URI=<OAUTH_TOKEN_ENDPOINT_URI>

Then run one of the ./mvnw commands, below, e.g.

./mvnw compile quarkus:dev

The app will connect to your kafka cluster and consume and produce records from topics, according to its KafkaStreams topology, until it is exited.

Running the application in dev mode

You can run your application in dev mode that enables live coding using:

./mvnw compile quarkus:dev

NOTE: Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8070/q/dev/.

Packaging and running the application

The application can be packaged using:

./mvnw package

It produces the quarkus-run.jar file in the target/quarkus-app/ directory.

The application is now runnable using java -jar target/quarkus-app/quarkus-run.jar.

Be aware that it’s not an über-jar as the dependencies are copied into the target/quarkus-app/lib/ directory.

If you want to build an über-jar, execute the following command:

./mvnw package -Dquarkus.package.type=uber-jar

The über-jar is runnable using java -jar target/resupply-stock-processor-<maven_version>-runner.jar.

Creating a native executable

You can create a native executable using:

./mvnw package -Pnative

Or, if you don't have GraalVM installed, and/or you want to build for a different native target (e.g. building for linux when running on a mac), you can run the native executable build in a container using:

./mvnw package -Pnative -Dquarkus.native.container-build=true

Use this command (or the next variation) if you want to build an executable suitable for running in a linux-based docker image (see below).

If you want to specify that docker is the container runtime, rather than podman, the default, do:

./mvnw package -Pnative -Dnative-image.container-runtime=docker -Dquarkus.native.container-build=true

You can then execute your native executable with: ./target/resupply-stock-processor-1.0.0-SNAPSHOT-runner

If you want to learn more about building native executables, please consult https://quarkus.io/guides/maven-tooling.html.

Running in docker

Build

Jvm image build (if you ran ./mvnw package [...] without -Pnative):

docker build -f src/main/docker/Dockerfile.jvm -t [repo_name]resupply-stock-processor .

Native image build (if you ran ./mvnw package -Pnative [...]):

docker build -f src/main/docker/Dockerfile.native -t [repo_name]resupply-stock-processor .

[repo_name] could be something like "quay.io/myaccount/", with quay.io being a pushable remote repository at quay.io, or it can be blank, with only a local name of, say, "resupply-stock-processor", needed.

To push to a remote:

docker push [repo_name]resupply-stock-processor .

Run

docker run --rm [repo_name]resupply-stock-processor .

Related guides

Apache Kafka Streams (guide): Implement stream processing applications based on Apache Kafka

hawkdshrh/stock-common-model