Kafka Add-On Module

Kafka Add-On provides the Kafka add-on for SIGHUP Distribution (SD).

If you are new to SD please refer to the official documentation on how to get started with SD.

Overview

Kafka Add-On uses the Strimzi operator to install and manage Kafka clusters in a Kubernetes environment.

All the components are deployed in the kafka-operator namespace in the cluster.

Packages

The following packages are included in the SIGHUP Distribution Logging katalog:

Package	Version	Description
strimzi-cluster-operator	v0.31.1	Strimzi provides a way to run an Apache Kafka® cluster on Kubernetes in various deployment configurations, deployed in cluster-wide configuration.
monitoring-configs	-	Monitoring configurations for Strimzi Kafka Operator

Click on each package to see its full documentation.

Compatibility

Kubernetes Version	Compatibility	Notes
1.22.x	✅	No known issues
1.23.x	✅	No known issues
1.24.x	✅	No known issues

Check the compatibility matrix for additional information about previous releases of the modules.

The module is still in version 0.X.X but can be used in production, we are strictly following the possible breaking changes that can be introduced by the Strimzi operator.

Usage

Prerequisites

Tool	Version	Description
furyctl	>=0.6.0	The recommended tool to download and manage SD modules and their packages. To learn more about furyctl read the official documentation.
kustomize	>=3.5.3	Packages are customized using kustomize. To learn how to create your customization layer with kustomize, please refer to the repository.

Deployment

1. List the packages you want to deploy and their version in a Furyfile.yml

bases:
  - name: kafka/strimzi-cluster-operator
    version: "v0.1.0"
  - name: kafka/monitoring-configs
    version: "v0.1.0"

See furyctl documentation for additional details about Furyfile.yml format.

2. Execute furyctl vendor -H to download the packages

3. Inspect the download packages under ./vendor/katalog/logging.

4. Define a kustomization.yaml that includes the ./vendor/katalog/kafka directory as resource.

resources:
- ./vendor/katalog/kafka/strimzi-cluster-operator
- ./vendor/katalog/kafka/monitoring-configs

5. To deploy the packages to your cluster, execute:

kustomize build . | kubectl apply -f -

Examples

Deploying a Kafka cluster

Check the example in the example folder kafka-standard to have an overview on how to deploy a complete Kafka Cluster using the operator.

Contributing

Before contributing, please read first the Contributing Guidelines.

Reporting Issues

In case you experience any problem with the module, please open a new issue.

License

This module is open-source and it's released under the following LICENSE