Apache Kafka QuotaAlter
CertifiedAlter a Kafka client quota
Apache Kafka QuotaAlter
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.
type: io.kestra.plugin.kafka.QuotaAlterExamples
Cap a tenant's produce/consume throughput and controller mutation rate
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.
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150callTimeout string
PT30SAdminClient call timeout
Maximum duration to wait for each AdminClient operation to complete before failing the task. Defaults to PT30S (30 seconds). Distinct from the task-level timeout, which lets the worker kill the task without retrying it.
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
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.
Outputs
appliedQuotas object
Quotas that were set
Keys among producer_byte_rate, consumer_byte_rate, request_percentage, controller_mutation_rate.
entity object
Quota entity
Keys among user, client-id, ip.
