Skip to content

Latest commit

 

History

History
executable file
·
61 lines (46 loc) · 3.8 KB

README.md

File metadata and controls

executable file
·
61 lines (46 loc) · 3.8 KB
Raw

Steadybit extension-kafka

A Steadybit extension to integrate Kafka into Steadybit.

Learn about the capabilities of this extension in our Reliability Hub.

Prerequisites

The extension-kafka is using these capacities, thus may need elevated rights on kafka side :

  • List brokers / topics / consumer groups / offsets
  • Elect leaders for partitions
  • Alter broker configuration
  • Create / Delete ACLs
  • Delete Records

Configuration

Environment Variable Helm value Meaning Required Default
STEADYBIT_EXTENSION_SEED_BROKERS kafka.seedBrokers Brokers hosts (without scheme) with port separated by comma (example: "localhost:9092,localhost:9093" yes
STEADYBIT_EXTENSION_SASL_MECHANISM kafka.auth.saslMechanism PLAIN, SCRAM-SHA-256, or SCRAM-SHA-512 no
STEADYBIT_EXTENSION_SASL_USER kafka.auth.saslUser Sasl User no
STEADYBIT_EXTENSION_SASL_PASSWORD kafka.auth.saslPassword Sasl Password no
STEADYBIT_EXTENSION_DISCOVERY_ATTRIBUTES_EXCLUDES_BROKERS discovery.attributes.excludes.broker List of Broker Attributes which will be excluded during discovery. Checked by key equality and supporting trailing "*" no
STEADYBIT_EXTENSION_DISCOVERY_ATTRIBUTES_EXCLUDES_TOPICS discovery.attributes.excludes.topic List of Broker Attributes which will be excluded during discovery. Checked by key equality and supporting trailing "*" no
STEADYBIT_EXTENSION_DISCOVERY_ATTRIBUTES_EXCLUDES_CONSUMER_GROUPS discovery.attributes.excludes.consumer List of Broker Attributes which will be excluded during discovery. Checked by key equality and supporting trailing "*" no

The extension supports all environment variables provided by steadybit/extension-kit.

Installation

Using Docker

docker run \
  --rm \
  -p 8080 \
  --name steadybit-extension-kafka \
  --env STEADYBIT_EXTENSION_SEED_BROKERS="localhost:9092" \
  ghcr.io/steadybit/extension-kafka:latest

Using Helm in Kubernetes

helm repo add steadybit-extension-kafka https://steadybit.github.io/extension-kafka
helm repo update
helm upgrade steadybit-extension-kafka \
    --install \
    --wait \
    --timeout 5m0s \
    --create-namespace \
    --namespace steadybit-agent \
    --set kafka.seedBrokers="localhost:9092" \
    steadybit-extension-kafka/steadybit-extension-kafka

Register the extension

Make sure to register the extension on the Steadybit platform. Please refer to the documentation for more information.