MQTT Notification Settings

This page documents settings for configuring an MQTT service as a target for Bucket Notifications. See Publish Events to MQTT 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_MQTT_ENABLE_PRIMARY="on"
export MINIO_NOTIFY_MQTT_BROKER_PRIMARY="tcp://user:password@mqtt-endpoint.example.net:1883"

export MINIO_NOTIFY_MQTT_ENABLE_SECONDARY="on"
export MINIO_NOTIFY_MQTT_BROKER_SECONDARY="tcp://user:password@mqtt-endpoint.example.net:1883"

mc admin config set notify_mqtt:primary \
   broker="tcp://endpoint:port" \
   topic="minio/bucket-name/events/" \
   username="username" \
   password="password" \
   [ARGUMENT="VALUE"] ... \

mc admin config set notify_mqtt:secondary \
   broker="tcp://endpoint:port" \
   topic="minio/bucket-name/events/" \
   username="username" \
   password="password" \
   [ARGUMENT="VALUE"] ... \

With these settings, MINIO_NOTIFY_MQTT_ENABLE_PRIMARY indicates the environment variable is associated to an MQTT service endpoint with an ID of PRIMARY.

Specify on to enable publishing bucket notifications to an MQTT endpoint. Defaults to off.

Specify the MQTT server/broker endpoint. AIStor supports TCP, TLS, or Websocket connections to the server/broker URL. For example:

• tcp://mqtt.example.net:1883
• tls://mqtt.example.net:1883
• ws://mqtt.example.net:1883

Specify the name of the MQTT topic to associate with events published by AIStor to the MQTT endpoint.

Specify the MQTT username AIStor should use to authenticate to the MQTT server/broker.

Specify the password for the MQTT username AIStor uses to authenticate to the MQTT server/broker.

Specify the Quality of Service priority for the published events. Defaults to 0.

Specify the keep-alive interval for the MQTT connections. AIStor supports the following units of time measurement:

• s - seconds, “60s”
• m - minutes, “60m”
• h - hours, “24h”
• d - days, “7d”

Specify the reconnect interval for the MQTT connections. AIStor supports the following units of time measurement:

• s - seconds, “60s”
• m - minutes, “60m”
• h - hours, “24h”
• d - days, “7d”

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

AIStor stores undelivered events in the specified store while the MQTT 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 MQTT configuration.