Configuration Reference

This page is the authoritative reference for the KubeMQ Spring Boot Starter's configuration surface: the module coordinates and every kubemq.* property bound from KubeMQProperties. For the runtime API (the KubeMQTemplate send methods, listener annotations, the Spring Cloud Stream binder, and Actuator endpoints), see the API reference.

Modules & Coordinates

The project is a multi-module Gradle build published under group io.kubemq at version 1.0.0. Most applications add only kubemq-spring-boot-starter; the binder, Kotlin, and test modules are added when you need them.

dependencies {
    implementation("io.kubemq:kubemq-spring-boot-starter:1.0.0")

    // Add only when you need them:
    implementation("io.kubemq:kubemq-spring-cloud-stream-binder:1.0.0")
    implementation("io.kubemq:kubemq-spring-boot-starter-kotlin:1.0.0")
    testImplementation("io.kubemq:kubemq-spring-boot-starter-test:1.0.0")
}

docker run -d \  --name kubemq \  -p 50000:50000 \  -p 9090:9090 \  -e KUBEMQ_TOKEN=YOUR_LICENSE_KEY \  europe-docker.pkg.dev/kubemq/images/kubemq:next

Configuration Properties

All properties are bound from KubeMQProperties under the kubemq.* prefix. Duration values accept Spring's duration syntax (30s, 5m, 100ms), and DataSize values accept sizes such as 100MB.

Top-Level Properties

kubemq:
  enabled: true
  address: localhost:50000
  client-id: my-app
  auth-token: ""

TLS — kubemq.tls.*

Bound from KubeMQProperties.Tls. Configures TLS/mTLS for the gRPC connection.

kubemq:
  tls:
    enabled: true
    cert-file: /etc/kubemq/tls/client.crt
    key-file: /etc/kubemq/tls/client.key
    ca-cert-file: /etc/kubemq/tls/ca.crt

Connection — kubemq.connection.*

Bound from KubeMQProperties.Connection and KubeMQProperties.KeepAlive. Tunes the gRPC channel.

kubemq:
  connection:
    timeout: 30s
    max-receive-size: 100MB
    keep-alive:
      time: 30s
      timeout: 10s

Listener — kubemq.listener.*

Bound from KubeMQProperties.Listener and the per-pattern nested classes. These are the defaults applied to every @KubeMQ*Listener / @KubeMQ*Handler; individual annotations can override them.

The top-level listener settings apply to all patterns:

Queue listeners add poll-loop and acknowledgement settings (KubeMQProperties.QueuesListener):

Command and query handlers add a response timeout (KubeMQProperties.CommandsListener / KubeMQProperties.QueriesListener):

kubemq:
  listener:
    concurrency: 1
    auto-startup: true
    shutdown-timeout: 30s
    queues:
      poll-timeout: 5s
      max-poll-messages: 1
      visibility-timeout: 30s
      auto-ack: false
      error-backoff-initial: 1s
      error-backoff-max: 30s
      error-backoff-multiplier: 2.0
    commands:
      timeout: 10s
    queries:
      timeout: 10s

Template, Health, Metrics & Kotlin

The remaining nested groups on KubeMQProperties control the send-side template, the Actuator health indicator, Micrometer metrics, and Kotlin coroutine support.

kubemq:
  template:
    observation-enabled: true
  health:
    enabled: true
    timeout: 5s
    cache-duration: 15s
  metrics:
    enabled: true
    scrape-interval: 30s
  kotlin:
    dispatcher: default

Requirements & Compatibility

The starter sets sourceCompatibility/targetCompatibility to Java 17 and imports the spring-boot-dependencies:3.2.0 BOM. The Spring Cloud Stream binder additionally imports the spring-cloud-dependencies:2023.0.0 BOM.

Related