Skip to content

brokers

A definition representing cluster-wide configuration for all Kafka brokers.

Definition

  • apiVersion: v1
  • kind: brokers
  • metadata (Metadata)
  • spec (Spec)

Metadata

  • name (string), required

    An identifier for the definition.

    This is not used directly by kdef and can be any meaningful value for reference.

  • labels (map[string]string)

    Labels are key-value pairs associated with the definition.

    Labels are not directly used by kdef and have no remote state. They are purely for the purposes of storing meaningful attributes with the definition that would be relevant to users.

Spec

  • configs (map[string]string)

    A map of key-value config pairs.

  • deleteUndefinedConfigs (bool)

    Allows kdef to delete configs that are not defined in configs.

    Caution

    Enabling allows kdef to permanently delete configs. Always confirm operations with --dry-run.

Examples

apiVersion: v1
kind: brokers
metadata:
  name: store-cluster
spec:
  configs:
    leader.replication.throttled.rate: "700000000"
    follower.replication.throttled.rate: "700000000"

Schema

Definition:

{
    "apiVersion": string,
    "kind": string,
    "metadata": {
        "name": string,
        "labels": [
            string
        ]
    },
    "spec": {
        "configs": {
            string: string
        },
        "deleteUndefinedConfigs": bool
    }
}