1
0
mirror of https://github.com/minio/docs.git synced 2025-07-28 19:42:10 +03:00
Files
Daryl White eb94513104 Breaking up envvars and config settings into separate settings pages (#1028)
- Creates a slew of folders and pages nested under the mc-server page to store settings.
- Breaks up all of the environment variable options formerly in the mc-server page into these separate pages.
- Moves the config settings formerly in the mc admin config page to the appropriate new settings pages.
- Adds a MiniO Client settings page and document `mc-host-<alias>`

Closes #1017
2023-11-03 07:55:22 -04:00

11 KiB

NATS Notification Settings

minio

Table of Contents

NATS Streaming Deprecated

NATS Streaming is deprecated. Migrate to JetStream instead.

The related MinIO configuration options and environment variables are deprecated.

This page documents settings for configuring an NATS service as a target for Bucket Notifications <minio-bucket-notifications>. See minio-bucket-notifications-publish-nats for a tutorial on using these settings.

Multiple NATS Targets

You can specify multiple NATS service endpoints by appending a unique identifier _ID for each set of related NATS settings on to the top level key.

Example

For example, the following commands set two distinct NATS service endpoints as PRIMARY and SECONDARY respectively:

Environment Variables

set MINIO_NOTIFY_NATS_ENABLE_PRIMARY="on"
set MINIO_NOTIFY_NATS_ADDRESS_PRIMARY="https://nats-endpoint.example.net:4222"

set MINIO_NOTIFY_NATS_ENABLE_SECONDARY="on"
set MINIO_NOTIFY_NATS_ADDRESS_SECONDARY="https://nats-endpoint.example.net:4222"

With these settings, MINIO_NOTIFY_NATS_ENABLE_PRIMARY <MINIO_NOTIFY_NATS_ENABLE> indicates the environment variable is associated to an NATS service endpoint with ID of PRIMARY.

Configuration Settings

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

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

Settings

Enable

Required

Environment Variable

MINIO_NOTIFY_NATS_ENABLE

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

Defaults to off.

Configuration Setting

notify_nats

The top-level configuration key for defining an NATS service endpoint for use with MinIO bucket notifications <minio-bucket-notifications>.

Use mc admin config set to set or update an NATS service endpoint. The ~notify_nats.address and ~notify_nats.subject arguments are required for each target. Specify additional optional arguments as a whitespace (" ")-delimited list.

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

Address

Required

Environment Variable

MINIO_NOTIFY_NATS_ADDRESS

Configuration Setting

notify_nats address

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

Subject

Required

Environment Variable

MINIO_NOTIFY_NATS_SUBJECT

Configuration Setting

notify_nats subject

Specify the subscription to which MinIO associates events published to the NATS endpoint.

Username

Optional

Environment Variable

MINIO_NOTIFY_NATS_USERNAME

Configuration Setting

notify_nats username

Specify the username for connecting to the NATS service endpoint.

Password

Optional

Environment Variable

MINIO_NOTIFY_NATS_PASSWORD

Configuration Setting

notify_nats password

Specify the passport for connecting to the NATS service endpoint.

RELEASE.2023-06-23T20-26-00Z

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

Token

Optional

Environment Variable

MINIO_NOTIFY_NATS_TOKEN

Configuration Setting

notify_nats token

Specify the token for connecting to the NATS service endpoint.

RELEASE.2023-06-23T20-26-00Z

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

TLS

Optional

Environment Variable

MINIO_NOTIFY_NATS_TLS

Configuration Setting

notify_nats tls

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

TLS Skip Verify

Optional

Environment Variable

MINIO_NOTIFY_NATS_TLS_SKIP_VERIFY

Configuration Setting

notify_nats tls_skip_verify

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.

Ping Interval

Optional

Environment Variable

MINIO_NOTIFY_NATS_PING_INTERVAL

Configuration Setting

notify_nats ping_interval

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

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

Jetstream

Optional

Environment Variable

MINIO_NOTIFY_NATS_JETSTREAM

Configuration Setting

notify_nats jetstream

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

Streaming

Deprecated

Optional

Environment Variable

MINIO_NOTIFY_NATS_STREAMING

Configuration Setting

notify_nats streaming

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

Streaming Async

Deprecated

Optional

Environment Variable

MINIO_NOTIFY_NATS_STREAMING_ASYNC

Configuration Setting

notify_nats streaming_async

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

Max ACK Responses In Flight

Deprecated

Optional

Environment Variable

MINIO_NOTIFY_NATS_STREAMING_MAX_PUB_ACKS_IN_FLIGHT

Configuration Setting

notify_nats streaming_max_pub_acks_in_flight

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

Streaming Cluster ID

Deprecated

Optional

Environment Variable

MINIO_NOTIFY_NATS_STREAMING_CLUSTER_ID

Configuration Setting

notify_nats streaming_cluster_id

Specify the unique ID for the NATS streaming cluster.

Cert Authority

Optional

Environment Variable

MINIO_NOTIFY_NATS_CERT_AUTHORITY

Configuration Setting

notify_nats cert_authority

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

Client Cert

Optional

Environment Variable

MINIO_NOTIFY_NATS_CLIENT_CERT

Configuration Setting

notify_nats client_cert

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

Client Key

Optional

Environment Variable

MINIO_NOTIFY_NATS_CLIENT_KEY

Configuration Setting

notify_nats client_key

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

Queue Directory

Optional

Environment Variable

MINIO_NOTIFY_NATS_QUEUE_DIR

Configuration Setting

notify_nats queue_dir

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

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

Queue Limit

Optional

Environment Variable

MINIO_NOTIFY_NATS_QUEUE_LIMIT

Configuration Setting

notify_nats queue_limit

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

Comment

Optional

Environment Variable

MINIO_NOTIFY_NATS_COMMENT

Configuration Setting

notify_nats comment

Specify a comment to associate with the NATS configuration.