Topic Browse Chart Values Reference

This reference lists the Topic Browse values the Axual Governance Helm chart exposes: the image and pull secrets, the server TLS bundle, the Spring Boot application configuration, and the browse and consumer limits.

Type

Reference

Goal

Look up a Topic Browse chart value while writing the Axual Governance values file.

Audience

Platform Operator deploying Topic Browse as part of Axual Governance.

When to use

While configuring Topic Browse, alongside the procedure that installs Axual Governance.

Contents

The sections below cover each area in this reference:

About Topic Browse

Topic Browse is a runtime server that lets Self-Service browse a target Kafka topic. It is built on Spring Boot 3.x.

Topic Browse Configuration

Topic Browse needs little configuration, because Self-Service sends most of the Kafka settings at runtime. The values below cover the image, the server TLS bundle, and the browse and consumer limits.

For the full list of configuration options, see the Configuration section of the Topic Browse page.

Topic Browse Repository Configuration

You can override registry, tag, and pullPolicy for the Topic Browse pod. By default these values come from the Axual Governance chart. You can also override imagePullSecrets; if you leave it unset, the Topic Browse pod uses global.imagePullSecrets.

values.yaml
topic-browse:

  image:
    registry: "registry.axual.io"
    pullPolicy: "Always"
    tag: "0.3.3"

  imagePullSecrets:
    - name: axualdockercred

Server Security Configuration

To secure incoming connections with SSL, point Topic Browse at existing Kubernetes Secrets that hold the Privacy Enhanced Mail (PEM) certificates.

values.yaml
topic-browse:

  env:
    - name: SPRING_SSL_BUNDLE_PEM_TOPIC-BROWSE_KEYSTORE_CERTIFICATE
      valueFrom:
        secretKeyRef:
          # key identifying the server-certificate within the k8s-secret
          key: <server-certificate-name>
          name: <k8s-secret-name>
    - name: SPRING_SSL_BUNDLE_PEM_TOPIC-BROWSE_KEYSTORE_PRIVATE_KEY
      valueFrom:
        secretKeyRef:
          # key identifying the server-key within the k8s-secret
          key: <server-key-name>
          name: <k8s-secret-name>

  config:
    server:
      ssl:
        enabled: true
        # name referring to the bundle-pem
        bundle: "topic-browse"

Application Configuration

Topic Browse is a Spring Boot application, so it reads its settings from an application.yml file. Whatever you put under config is injected into a ConfigMap and mounted as that file.

values.yaml
topic-browse:
  config: {}

Browse and Consumer Configuration

Topic Browse exposes separate settings for browsing behaviour and for the Kafka consumers it starts.

Browse Configuration

These values cap how much data a single browse request returns and how long it waits:

values.yaml
topic-browse:
  config:
    browse-config:
      max-message-bytes: 104857600  # Maximum size in bytes for messages to retrieve (100MB)
      max-message-count: 1000       # Maximum number of messages to retrieve per browse request
      max-response-time-seconds: 3  # Maximum time in seconds to wait for browse response before returning collected messages

Consumer Configuration

These values control the Kafka consumers Topic Browse starts to read the topic:

values.yaml
topic-browse:
  config:
    consumer-config:
      partitions-per-consumer: 5      # Maximum number of partitions assigned per consumer instance
      poll-timeout-millis: 500        # Polling timeout in milliseconds for Kafka consumer
      request-timeout-seconds: 60     # Request timeout in seconds for Kafka operations