Axual kafka Helm Readme

Version: 0.2.0 Type: application AppVersion: 0.2.0

Helm Charts that deploy Axual Kafka

Configuration

The chart includes a wide range of configuration options available in the values.yaml. Below are all the configurable parameters:

General Settings

Parameter Description Default

fullnameOverride

Fully override the full resource names

""

nameOverride

Override the base name of the chart

""

Axual Settings

Parameter Description Default

axual.sslPrincipalBuilder.enabled

Enable Axual SSL Principal Builder

false

axual.sslPrincipalBuilder.addChainedSuperUsers

Add chained super users to the SSL Principal Builder

false

axual.sslPrincipalBuilder.chain

List of additional chained super users

[]

Kafka Settings

Parameter Description Default

kafka.enabled

Enable Kafka deployment

true

kafka.version

Kafka version

""

kafka.rack.enabled

Enable rack awareness

false

kafka.rack.topologyKey

Kubernetes topology key for rack awareness

topology.kubernetes.io/zone

kafka.metrics

Enable Kafka metrics for Prometheus

false

kafka.logging.type

Kafka logging type: inline or external

inline

kafka.logging.externalConfig

External logging configuration (only used if logging.type is external)

See values.yaml

kafka.logging.loggers

Inline logger configuration

{}

kafka.kafkaExporter.enabled

Enable the Kafka Exporter for metrics

false

kafka.kafkaExporter.spec

Specification for the Kafka Exporter

Defaults from Strimzi

kafka.authorization.superUsers

List of superusers for Kafka authorization

[]

kafka.listeners

List of Kafka listeners defined per your requirements

{}

kafka.config

Kafka configuration properties

See below:

kafka.config.auto.create.topics.enable

Automatically create topics

false

kafka.config.offsets.topic.replication.factor

Replication factor for offsets topic

1

kafka.config.transaction.state.log.replication.factor

Replication factor for transaction state

1

kafka.config.transaction.state.log.min.isr

Minimum in-sync replicas for transaction state

1

kafka.config.default.replication.factor

Default replication factor for topics

1

kafka.config.min.insync.replicas

Minimum in-sync replicas for producing

1

kafka.config.allow.everyone.if.no.acl.found

Allow everyone when ACL is not found

false

kafka.clientsCa.generateCertificateAuthority

Generate a Clients Certificate Authority

true

kafka.clusterCa.generateCertificateAuthority

Generate a Cluster Certificate Authority

true

kafka.entityOperator

Config for the Kafka Entity Operator

{}

kafka.cruiseControl.enabled

Enable Cruise Control for dynamic optimization

true

kafka.cruiseControl.jmxPrometheusMetricsEnabled

Enable JMX Prometheus metrics for Cruise Control

true

kafka.cruiseControl.spec

Additional specifications for Cruise Control

{}

kafka.templ

Additional templ section for custom Kafka specs

{}

kafka.extendSpec

Additional Kafka spec values

{}

Monitoring & Observability

Parameter Description Default

podMonitor.kafka.enabled

Enable PodMonitor for Kafka

false

podMonitor.kafka.labels

Labels for the Kafka PodMonitor

{}

podMonitor.kafka.scrapeTimeout

Scrape timeout for Kafka Prometheus metrics

20s

podMonitor.kafka.interval

Scrape interval for Kafka Prometheus metrics

30s

podMonitor.entityOperator.enabled

Enable PodMonitor for Kafka Entity Operator

false

podMonitor.entityOperator.labels

Labels for the Entity Operator PodMonitor

{}

podMonitor.entityOperator.scrapeTimeout

Scrape timeout for Entity Operator Prometheus metrics

20s

podMonitor.entityOperator.interval

Scrape interval for Entity Operator Prometheus metrics

30s

prometheusRule.enabled.kafka

Enable Prometheus Rules for Kafka alerts

false

prometheusRule.labels

Labels for Prometheus Rules

{}

Node Pool Settings

Parameter Description Default

kafkaNodePools

Object containing one or more KafkaNodePool resources

{}

Values Examples

Basic Kafka Cluster with Kraft

kafka:
  enabled: true
  version: 4.1.1
  metrics: true
  logging:
    type: inline
    loggers:
      root: "INFO"
prometheusRule:
  enabled:
    kafka: true

KafkaNodePool with Kraft

In the following KafkaNodePool example, we are creating a combined broker/controller role. Alternatively, you can create two separate KafkaNodePools—one with the broker role and another with the controller role. This setup is recommended for production clusters.

kafkaNodePools:
  kafka:
    name: "kafka"
    # number of replicas
    replicas: 1
    # KafkaNodePool roles
    roles:
      - "controller"
      - "broker"
    # resources limits and requests
    resources: {}
    # storage config
    storage:
      type: jbod
      volumes:
        - id: 0
          type: persistent-claim
          size: 1Gi
          deleteClaim: false
kafka:
  listeners:
    - name: tlsint
    port: 9092
    type: internal
    tls: true
    authentication:
        type: tls

Kafka with External Logging Config

kafka:
  enabled: true
  kraft: true
  logging:
    type: external

where the external config is already defined in the values and can be copied and modified as needed.

Observability & Prometheus Alerts

The chart configures Prometheus alerts for Kafka. Example of configured alerts:

  • KafkaRunningOutOfSpace: Indicates low disk space on Kafka brokers.

  • UnderReplicatedPartitions: Triggers when Kafka partitions are under-replicated.

  • OfflinePartitions: Alerts when certain Kafka partitions do not have an active leader.

For additional information, refer to the official Strimzi documentation: https://strimzi.io/documentation/.