NATS Notification Settings

This page documents settings for configuring an NATS service as a target for Bucket Notifications. See Publish Events to NATS 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_NATS_ENABLE_PRIMARY="on"
export MINIO_NOTIFY_NATS_ADDRESS_PRIMARY="nats-endpoint.example.net:4222"

export MINIO_NOTIFY_NATS_ENABLE_SECONDARY="on"
export MINIO_NOTIFY_NATS_ADDRESS_SECONDARY="nats-endpoint.example.net:4222"

mc admin config set notify_nats:primary \
   address="nats-endpoint.example.com:4222" \
   subject="minioevents" \
   [ARGUMENT=VALUE ...]

mc admin config set notify_nats:secondary \
   address="nats-endpoint.example.com:4222" \
   subject="minioevents" \
   [ARGUMENT=VALUE ...]

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

Specify the NATS service endpoint to which AIStor publishes bucket events. For example, nats-endpoint.example.com:4222.

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 subscription to which AIStor associates events published to the NATS endpoint.

Specify the username for connecting to the NATS service endpoint.

Specify the password for connecting to the NATS service endpoint.

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

Specify the token for connecting to the NATS service endpoint.

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

Specify the path to the user credentials file https://docs.nats.io/using-nats/developer/connecting/creds to use to connect to the NATS service endpoint.

Specify on to enable TLS connectivity to the NATS service endpoint.

Enables or disables TLS verification of the NATS service endpoint TLS certificates.

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

Specify the duration interval for client pings to the NATS server. AIStor supports the following time units:

• s - seconds, "60s"
• m - minutes, "5m"
• h - hours, "1h"
• d - days, "1d"

Specify on to enable JetStream support for streaming events to a NATS JetStream service endpoint.

Specify on to enable asynchronous publishing of events to the NATS service endpoint.

Specify on to enable asynchronous publishing of events to the NATS service endpoint.

Specify the number of messages to publish without waiting for an ACK response from the NATS service endpoint.

Specify the unique ID for the NATS streaming cluster.

Specify the path to the Certificate Authority chain used to sign the NATS service endpoint TLS certificates.

Specify the path to the client certificate to use for performing mTLS authentication to the NATS service endpoint.

Specify the path to the client private key to use for performing mTLS authentication to the NATS service endpoint.

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 NATS 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 NATS configuration.