Kafka Notification Settings

This page documents settings for configuring an Kafka service as a target for Bucket Notifications. See Publish Events to Kafka for a tutorial on using these settings.

You can establish or modify settings by defining:

• an environment variable on the host system prior to starting or restarting the AIStor Server. Refer to your operating system’s documentation for how to define an environment variable.
• a configuration setting using mc admin config set.

If you define both an environment variable and the similar configuration setting, AIStor uses the environment variable value.

Some settings have only an environment variable or a configuration setting, but not both.

export MINIO_NOTIFY_KAFKA_ENABLE_PRIMARY="on"
export MINIO_NOTIFY_KAFKA_BROKERS_PRIMARY="https://kafka1.example.net:9200, https://kafka2.example.net:9200"

export MINIO_NOTIFY_KAFKA_ENABLE_SECONDARY="on"
export MINIO_NOTIFY_KAFKA_BROKERS_SECONDARY="https://kafka1.example.net:9200, https://kafka2.example.net:9200"

mc admin config set notify_kafka:primary \
   brokers="https://kafka1.example.net:9200, https://kafka2.example.net:9200"
   [ARGUMENT=VALUE ...]

mc admin config set notify_kafka:secondary \
   brokers="https://kafka1.example.net:9200, https://kafka2.example.net:9200"
   [ARGUMENT=VALUE ...]

Notice that for configuration settings, the unique identifier appends to notify_kafka only, not to each individual argument.

Specify on to enable publishing bucket notifications to a Kafka endpoint. Defaults to off.

Specify a comma-separated list of Kafka broker addresses. For example: "kafka1.example.com:2021,kafka2.example.com:2021"

AIStor checks the health of the specified URL (if it is resolvable and reachable) prior to adding the target. AIStor adds offline targets without blocking.

Specify the Kafka topic to which AIStor publishes events.

Specify the SASL username for authenticating to the Kafka service endpoint.

Specify the SASL password for authenticating to the Kafka service endpoint.

AIStor redacts this value when returned as part of mc admin config get.

Specify the directory path to enable a persistent event store for undelivered messages, such as /opt/minio/events.

AIStor stores undelivered events in the specified store while the Kafka server/broker is offline and replays the stored events when connectivity resumes.

Specify the maximum limit for undelivered messages. Defaults to 100000.

Specify a comment to associate with the Kafka configuration.

Specify the SASL mechanism to use for authenticating to the Kafka broker(s). AIStor supports the following mechanisms:

• PLAIN (Default)
• SHA256
• SHA512

Specify the client authentication type of the Kafka broker(s). The following table lists the supported values and their mappings:

See ClientAuthType for more information on each client auth type.

Specify on to enable TLS connectivity to the Kafka broker(s).

Enables or disables TLS verification of the Kafka broker(s) TLS certificates.

• Specify on to disable TLS verification (Default).
• Specify off to enable TLS verification.

Specify the path to the client certificate to use for performing mTLS authentication to the Kafka broker(s).

Specify the path to the client private key to use for performing mTLS authentication to the Kafka broker(s).

Specify the version of the Kafka cluster to assume when performing operations against that cluster. See the sarama reference documentation for more information on this field’s behavior.

Specify the integer value to use as the batch size for sending records to Kafka.

Specify the compression codec to use when sending records to Kafka.

Supports the following values:

• none
• snappy
• gzip
• lz4
• zstd

Controls the level of compression applied based on the configured compression codec.

Specify an integer value greater than or equal to 0. The effect of the value depends on the selected codec.