diff --git a/README.md b/README.md index 6ded9a6..cd54623 100755 --- a/README.md +++ b/README.md @@ -19,8 +19,13 @@ SPDX-License-Identifier: Apache-2.0 Running Starlight
+ +[](https://github.com/telekom/pubsub-horizon-starlight/actions/workflows/gradle-build.yml) + ## Overview -Horizon's Starlight provides a REST endpoint allowing event providers to publish events. Its responsibilities include event acceptance, authentication/authorization, schema validation (optional), and publishing to Horizon's underlying message broker (Kafka). +Horizon's Starlight provides a REST endpoint allowing event providers to publish events. Its responsibilities include event acceptance, authentication/authorization, schema validation (optional), and publishing to [Horizon's](https://github.com/telekom/pubsub-horizon) underlying message broker (Kafka). We welcome and appreciate contributions from the developer community. Check our [contributing guide](LINK_TO_CONTRIBUTING_GUIDE.md) to get started! @@ -64,14 +69,20 @@ oidc: ./gradlew build ``` -### Docker build - The default docker base image is `azul/zulu-openjdk-alpine:21-jre`. This is customizable via the docker build arg `DOCKER_BASE_IMAGE`. -Please note that the default helm values configure the kafka compression type `snappy` whose dependencies have to be available in the result image. -So either provide a base image with snappy installed or change/disable the compression type in the helm values. +Please note that the default helm values configure the kafka compression type `snappy` which requires gcompat to be installed in the resulting image. +So either provide a base image with gcompat installed or change/disable the compression type in the helm values. ```bash -docker build -t horizon-starlight:latest --build-arg="DOCKER_BASE_IMAGE=