Apache Kafka QuotaAlter

Apache Kafka QuotaAlter
Certified
Alter a Kafka client quota

Sets throughput and rate quotas for a user, client-id, ip entity (or a combination of them) using the Kafka AdminClient. Valid on an entity that doesn't have quotas set yet — Kafka creates them on first alteration. At least one quota value must be provided.

yaml
type: io.kestra.plugin.kafka.QuotaAlter

Examples

Cap a tenant's produce/consume throughput and controller mutation rate

yaml
id: kafka_quota_alter
namespace: company.team

tasks:
  - id: alter_quota
    type: io.kestra.plugin.kafka.QuotaAlter
    properties:
      bootstrap.servers: localhost:9092
    entityUser: tenant-acme-svc
    producerByteRate: 1048576
    consumerByteRate: 2097152
    controllerMutationRate: 10

Properties

properties *object

Kafka AdminClient properties

Must include bootstrap.servers; accepts any Kafka AdminClient config. Provide base64-encoded content for ssl.keystore.location and ssl.truststore.location when using SSL.

consumerByteRate numberstring

Consumer byte rate

Maps to Kafka's consumer_byte_rate quota, in bytes/second.

controllerMutationRate numberstring

Controller mutation rate

Maps to Kafka's controller_mutation_rate quota, in mutations/second.

entityClientId string

Client ID entity name

entityIp string

IP entity name

entityUser string

User entity name

pluginDefaultsRef string

Reference (ref) of the pluginDefaults to apply to this task.

producerByteRate numberstring

Producer byte rate

Maps to Kafka's producer_byte_rate quota, in bytes/second.

requestPercentage numberstring

Request percentage

Maps to Kafka's request_percentage quota, as a percentage of request handler thread time.

timeout string

DefaultPT30S

AdminClient call timeout

Maximum duration to wait for each AdminClient operation to complete before failing the task. Defaults to PT30S (30 seconds).

Outputs

appliedQuotas object

SubTypenumber

Quotas that were set

Keys among producer_byte_rate, consumer_byte_rate, request_percentage, controller_mutation_rate.

entity object

SubTypestring

Quota entity

Keys among user, client-id, ip.

Liquibase

Tasks that run Liquibase change management commands.

Data

OPA (Open Policy Agent)

Enterprise

Tasks to manage Open Policy Agent policies and decisions, including upload, evaluation, and partial evaluation.

Infrastructure

Apache Kafka QuotaAlterCertifiedAlter a Kafka client quota

Apache Kafka QuotaAlter

More Plugins in this Category

Liquibase

OPA (Open Policy Agent)

Apache Kafka QuotaAlter
Certified
Alter a Kafka client quota