mirror of
https://github.com/minio/docs.git
synced 2025-07-25 21:22:11 +03:00
Updates NATS notification docs to point to JetStream service (#937)
Streaming configs and envvars are deprecated. Closes #903
This commit is contained in:
@ -12,16 +12,21 @@ Publish Events to NATS
|
|||||||
:local:
|
:local:
|
||||||
:depth: 1
|
:depth: 1
|
||||||
|
|
||||||
MinIO supports publishing :ref:`bucket notification
|
MinIO supports publishing :ref:`bucket notification <minio-bucket-notifications>` events to a `NATS <https://nats.io/>`__ service endpoint.
|
||||||
<minio-bucket-notifications>` events to a
|
|
||||||
`NATS <https://nats.io/>`__ service endpoint.
|
.. admonition:: NATS Streaming Deprecated
|
||||||
|
:class: important
|
||||||
|
|
||||||
|
NATS Streaming is deprecated.
|
||||||
|
Migrate to `JetStream <https://docs.nats.io/nats-concepts/jetstream>`__ instead.
|
||||||
|
|
||||||
|
The related MinIO configuration options and environment variables are deprecated.
|
||||||
|
|
||||||
|
|
||||||
Add a NATS Endpoint to a MinIO Deployment
|
Add a NATS Endpoint to a MinIO Deployment
|
||||||
-----------------------------------------
|
-----------------------------------------
|
||||||
|
|
||||||
The following procedure adds a new NATS service endpoint for supporting
|
The following procedure adds a new NATS service endpoint for supporting :ref:`bucket notifications <minio-bucket-notifications>` in a MinIO deployment.
|
||||||
:ref:`bucket notifications <minio-bucket-notifications>` in a MinIO
|
|
||||||
deployment.
|
|
||||||
|
|
||||||
Prerequisites
|
Prerequisites
|
||||||
~~~~~~~~~~~~~
|
~~~~~~~~~~~~~
|
||||||
@ -35,25 +40,17 @@ See the ``mc`` :ref:`Quickstart <mc-install>` for installation instructions.
|
|||||||
1) Add the NATS Endpoint to MinIO
|
1) Add the NATS Endpoint to MinIO
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
You can configure a new NATS service endpoint using either environment variables
|
You can configure a new NATS service endpoint using either environment variables *or* by setting runtime configuration settings.
|
||||||
*or* by setting runtime configuration settings.
|
|
||||||
|
|
||||||
.. tab-set::
|
.. tab-set::
|
||||||
|
|
||||||
.. tab-item:: Environment Variables
|
.. tab-item:: Environment Variables
|
||||||
|
|
||||||
MinIO supports specifying the NATS service endpoint and associated
|
MinIO supports specifying the NATS service endpoint and associated configuration settings using :ref:`environment variables <minio-server-envvar-bucket-notification-nats>`.
|
||||||
configuration settings using
|
The :mc:`minio server` process applies the specified settings on its next startup.
|
||||||
:ref:`environment variables
|
|
||||||
<minio-server-envvar-bucket-notification-nats>`. The
|
|
||||||
:mc:`minio server` process applies the specified settings on its
|
|
||||||
next startup.
|
|
||||||
|
|
||||||
The following example code sets *all* environment variables
|
The following example code sets *all* environment variables related to configuring an NATS service endpoint.
|
||||||
related to configuring an NATS service endpoint. The minimum
|
The minimum *required* variables are :envvar:`MINIO_NOTIFY_NATS_ADDRESS` and :envvar:`MINIO_NOTIFY_NATS_SUBJECT`:
|
||||||
*required* variables are
|
|
||||||
:envvar:`MINIO_NOTIFY_NATS_ADDRESS` and
|
|
||||||
:envvar:`MINIO_NOTIFY_NATS_SUBJECT`:
|
|
||||||
|
|
||||||
.. code-block:: shell
|
.. code-block:: shell
|
||||||
:class: copyable
|
:class: copyable
|
||||||
@ -67,34 +64,25 @@ You can configure a new NATS service endpoint using either environment variables
|
|||||||
set MINIO_NOTIFY_NATS_TLS_<IDENTIFIER>="<string>"
|
set MINIO_NOTIFY_NATS_TLS_<IDENTIFIER>="<string>"
|
||||||
set MINIO_NOTIFY_NATS_TLS_SKIP_VERIFY_<IDENTIFIER>="<string>"
|
set MINIO_NOTIFY_NATS_TLS_SKIP_VERIFY_<IDENTIFIER>="<string>"
|
||||||
set MINIO_NOTIFY_NATS_PING_INTERVAL_<IDENTIFIER>="<string>"
|
set MINIO_NOTIFY_NATS_PING_INTERVAL_<IDENTIFIER>="<string>"
|
||||||
set MINIO_NOTIFY_NATS_STREAMING_<IDENTIFIER>="<string>"
|
set MINIO_NOTIFY_NATS_QUEUE_DIR_<IDENTIFIER>="<string>"
|
||||||
set MINIO_NOTIFY_NATS_STREAMING_ASYNC_<IDENTIFIER>="<string>"
|
set MINIO_NOTIFY_NATS_QUEUE_LIMIT_<IDENTIFIER>="<string>"
|
||||||
set MINIO_NOTIFY_NATS_STREAMING_MAX_PUB_ACKS_IN_FLIGHT_<IDENTIFIER>="<string>"
|
|
||||||
set MINIO_NOTIFY_NATS_STREAMING_CLUSTER_ID_<IDENTIFIER>="<string>"
|
|
||||||
set MINIO_NOTIFY_NATS_CERT_AUTHORITY_<IDENTIFIER>="<string>"
|
set MINIO_NOTIFY_NATS_CERT_AUTHORITY_<IDENTIFIER>="<string>"
|
||||||
set MINIO_NOTIFY_NATS_CLIENT_CERT_<IDENTIFIER>="<string>"
|
set MINIO_NOTIFY_NATS_CLIENT_CERT_<IDENTIFIER>="<string>"
|
||||||
set MINIO_NOTIFY_NATS_CLIENT_KEY_<IDENTIFIER>="<string>"
|
set MINIO_NOTIFY_NATS_CLIENT_KEY_<IDENTIFIER>="<string>"
|
||||||
set MINIO_NOTIFY_NATS_QUEUE_DIR_<IDENTIFIER>="<string>"
|
|
||||||
set MINIO_NOTIFY_NATS_QUEUE_LIMIT_<IDENTIFIER>="<string>"
|
|
||||||
set MINIO_NOTIFY_NATS_COMMENT_<IDENTIFIER>="<string>"
|
set MINIO_NOTIFY_NATS_COMMENT_<IDENTIFIER>="<string>"
|
||||||
|
set MINIO_NOTIFY_NATS_JETSTREAM_<IDENTIFIER>="<string>"
|
||||||
|
|
||||||
- Replace ``<IDENTIFIER>`` with a unique descriptive string for the
|
- Replace ``<IDENTIFIER>`` with a unique descriptive string for the NATS service endpoint.
|
||||||
NATS service endpoint. Use the same ``<IDENTIFIER>`` value for all
|
Use the same ``<IDENTIFIER>`` value for all environment variables related to the new target service endpoint.
|
||||||
environment variables related to the new target service endpoint.
|
|
||||||
The following examples assume an identifier of ``PRIMARY``.
|
The following examples assume an identifier of ``PRIMARY``.
|
||||||
|
|
||||||
If the specified ``<IDENTIFIER>`` matches an existing NATS service
|
If the specified ``<IDENTIFIER>`` matches an existing NATS service endpoint on the MinIO deployment, the new settings *override* any existing settings for that endpoint.
|
||||||
endpoint on the MinIO deployment, the new settings *override*
|
Use :mc-cmd:`mc admin config get notify_nats <mc admin config get>` to review the currently configured NATS endpoints on the MinIO deployment.
|
||||||
any existing settings for that endpoint. Use
|
|
||||||
:mc-cmd:`mc admin config get notify_nats <mc admin config get>` to
|
|
||||||
review the currently configured NATS endpoints on the MinIO deployment.
|
|
||||||
|
|
||||||
- Replace ``<ENDPOINT>`` with the URL of the NATS service endpoint.
|
- Replace ``<ENDPOINT>`` with the URL of the NATS service endpoint.
|
||||||
For example: ``htpps://nats-endpoint.example.com:4222``
|
For example: ``htpps://nats-endpoint.example.com:4222``
|
||||||
|
|
||||||
See :ref:`NATS Service for Bucket Notifications
|
See :ref:`NATS Service for Bucket Notifications <minio-server-envvar-bucket-notification-nats>` for complete documentation on each environment variable.
|
||||||
<minio-server-envvar-bucket-notification-nats>` for complete documentation
|
|
||||||
on each environment variable.
|
|
||||||
|
|
||||||
.. tab-item:: Configuration Settings
|
.. tab-item:: Configuration Settings
|
||||||
|
|
||||||
@ -118,13 +106,10 @@ You can configure a new NATS service endpoint using either environment variables
|
|||||||
username="<string>" \
|
username="<string>" \
|
||||||
password="<string>" \
|
password="<string>" \
|
||||||
token="<string>" \
|
token="<string>" \
|
||||||
|
nats_jetstream="<string>" \
|
||||||
tls="<string>" \
|
tls="<string>" \
|
||||||
tls_skip_verify="<string>" \
|
tls_skip_verify="<string>" \
|
||||||
ping_interval="<string>" \
|
ping_interval="<string>" \
|
||||||
streaming="<string>" \
|
|
||||||
streaming_async="<string>" \
|
|
||||||
streaming_max_pub_acks_in_flight="<string>" \
|
|
||||||
streaming_cluster_id="<string>" \
|
|
||||||
cert_authority="<string>" \
|
cert_authority="<string>" \
|
||||||
client_cert="<string>" \
|
client_cert="<string>" \
|
||||||
client_key="<string>" \
|
client_key="<string>" \
|
||||||
@ -133,24 +118,18 @@ You can configure a new NATS service endpoint using either environment variables
|
|||||||
comment="<string>"
|
comment="<string>"
|
||||||
|
|
||||||
|
|
||||||
- Replace ``IDENTIFIER`` with a unique descriptive string for the
|
- Replace ``IDENTIFIER`` with a unique descriptive string for the NATS service endpoint.
|
||||||
NATS service endpoint. The following examples in this procedure
|
The following examples in this procedure assume an identifier of ``PRIMARY``.
|
||||||
assume an identifier of ``PRIMARY``.
|
|
||||||
|
|
||||||
If the specified ``IDENTIFIER`` matches an existing NATS service
|
If the specified ``IDENTIFIER`` matches an existing NATS service endpoint on the MinIO deployment, the new settings *override* any existing settings for that endpoint.
|
||||||
endpoint on the MinIO deployment, the new settings *override*
|
Use :mc-cmd:`mc admin config get notify_nats <mc admin config get>` to review the currently configured NATS endpoints on the MinIO deployment.
|
||||||
any existing settings for that endpoint. Use
|
|
||||||
:mc-cmd:`mc admin config get notify_nats <mc admin config get>` to
|
|
||||||
review the currently configured NATS endpoints on the MinIO deployment.
|
|
||||||
|
|
||||||
- Replace ``ENDPOINT`` with the URL of the NATS service endpoint.
|
- Replace ``ENDPOINT`` with the URL of the NATS service endpoint.
|
||||||
For example: ``htpps://nats-endpoint.example.com:4222``.
|
For example: ``htpps://nats-endpoint.example.com:4222``.
|
||||||
|
|
||||||
See :ref:`NATS Bucket Notification Configuration Settings
|
See :ref:`NATS Bucket Notification Configuration Settings <minio-server-config-bucket-notification-nats>` for complete documentation on each setting.
|
||||||
<minio-server-config-bucket-notification-nats>` for complete
|
|
||||||
documentation on each setting.
|
|
||||||
|
|
||||||
2) Restart the MinIO Deployment
|
1) Restart the MinIO Deployment
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
You must restart the MinIO deployment to apply the configuration changes.
|
You must restart the MinIO deployment to apply the configuration changes.
|
||||||
@ -242,8 +221,7 @@ See the ``mc`` :ref:`Quickstart <mc-install>` for installation instructions.
|
|||||||
1) List Configured NATS Endpoints In The Deployment
|
1) List Configured NATS Endpoints In The Deployment
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
Use the :mc-cmd:`mc admin config get` command to list the currently
|
Use the :mc-cmd:`mc admin config get` command to list the currently configured NATS service endpoints in the deployment:
|
||||||
configured NATS service endpoints in the deployment:
|
|
||||||
|
|
||||||
.. code-block:: shell
|
.. code-block:: shell
|
||||||
:class: copyable
|
:class: copyable
|
||||||
@ -256,23 +234,19 @@ The command output resembles the following:
|
|||||||
|
|
||||||
.. code-block:: shell
|
.. code-block:: shell
|
||||||
|
|
||||||
notify_nats:primary password="yoursecret" streaming_max_pub_acks_in_flight="10" subject="" address="nats-endpoint.example.com:4222" token="" username="yourusername" ping_interval="0" queue_limit="0" tls="off" tls_skip_verify="off" streaming_async="on" queue_dir="" streaming_cluster_id="test-cluster" streaming_enable="on"
|
notify_nats:primary password="yoursecret" subject="" address="nats-endpoint.example.com:4222" token="" username="yourusername" ping_interval="0" queue_limit="0" tls="off" tls_skip_verify="off" queue_dir="" streaming_enable="on" nats_jetstream="on"
|
||||||
notify_nats:secondary password="yoursecret" streaming_max_pub_acks_in_flight="10" subject="" address="nats-endpoint.example.com:4222" token="" username="yourusername" ping_interval="0" queue_limit="0" tls="off" tls_skip_verify="off" streaming_async="on" queue_dir="" streaming_cluster_id="test-cluster" streaming_enable="on"
|
notify_nats:secondary password="yoursecret" subject="" address="nats-endpoint.example.com:4222" token="" username="yourusername" ping_interval="0" queue_limit="0" tls="off" tls_skip_verify="off" queue_dir="" streaming_enable="on" nats_jetstream="on"
|
||||||
|
|
||||||
The :mc-conf:`notify_nats` key is the top-level configuration key for an
|
The :mc-conf:`notify_nats` key is the top-level configuration key for an :ref:`minio-server-config-bucket-notification-nats`.
|
||||||
:ref:`minio-server-config-bucket-notification-nats`. The
|
The :mc-conf:`address <notify_nats.address>` key specifies the NATS service endpoint for the given ``notify_nats`` key.
|
||||||
:mc-conf:`address <notify_nats.address>` key specifies the NATS service endpoint
|
The ``notify_nats:<IDENTIFIER>`` suffix describes the unique identifier for that NATS service endpoint.
|
||||||
for the given ``notify_nats`` key. The ``notify_nats:<IDENTIFIER>`` suffix
|
|
||||||
describes the unique identifier for that NATS service endpoint.
|
|
||||||
|
|
||||||
Note the identifier for the NATS service endpoint you want to update for
|
Note the identifier for the NATS service endpoint you want to update for the next step.
|
||||||
the next step.
|
|
||||||
|
|
||||||
2) Update the NATS Endpoint
|
2) Update the NATS Endpoint
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
Use the :mc-cmd:`mc admin config set` command to set the new configuration
|
Use the :mc-cmd:`mc admin config set` command to set the new configuration for the NATS service endpoint:
|
||||||
for the NATS service endpoint:
|
|
||||||
|
|
||||||
.. code-block:: shell
|
.. code-block:: shell
|
||||||
:class: copyable
|
:class: copyable
|
||||||
@ -286,10 +260,7 @@ for the NATS service endpoint:
|
|||||||
tls="<string>" \
|
tls="<string>" \
|
||||||
tls_skip_verify="<string>" \
|
tls_skip_verify="<string>" \
|
||||||
ping_interval="<string>" \
|
ping_interval="<string>" \
|
||||||
streaming="<string>" \
|
nats_jetstream="<string>" \
|
||||||
streaming_async="<string>" \
|
|
||||||
streaming_max_pub_acks_in_flight="<string>" \
|
|
||||||
streaming_cluster_id="<string>" \
|
|
||||||
cert_authority="<string>" \
|
cert_authority="<string>" \
|
||||||
client_cert="<string>" \
|
client_cert="<string>" \
|
||||||
client_key="<string>" \
|
client_key="<string>" \
|
||||||
@ -297,10 +268,9 @@ for the NATS service endpoint:
|
|||||||
queue_limit="<string>" \
|
queue_limit="<string>" \
|
||||||
comment="<string>"
|
comment="<string>"
|
||||||
|
|
||||||
The :mc-conf:`notify_nats address <notify_nats.address>` configuration setting
|
The :mc-conf:`notify_nats address <notify_nats.address>` configuration setting is the *minimum* required for an NATS service endpoint.
|
||||||
is the *minimum* required for an NATS service endpoint. All other configuration
|
All other configuration settings are *optional*.
|
||||||
settings are *optional*. See :ref:`minio-server-config-bucket-notification-nats`
|
See :ref:`minio-server-config-bucket-notification-nats` for a complete list of NATS configuration settings.
|
||||||
for a complete list of NATS configuration settings.
|
|
||||||
|
|
||||||
3) Restart the MinIO Deployment
|
3) Restart the MinIO Deployment
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
@ -313,28 +283,21 @@ Use the :mc-cmd:`mc admin service restart` command to restart the deployment.
|
|||||||
|
|
||||||
mc admin service restart ALIAS
|
mc admin service restart ALIAS
|
||||||
|
|
||||||
Replace ``ALIAS`` with the :ref:`alias <alias>` of the deployment to
|
Replace ``ALIAS`` with the :ref:`alias <alias>` of the deployment to restart.
|
||||||
restart.
|
|
||||||
|
|
||||||
The :mc:`minio server` process prints a line on startup for each configured NATS
|
The :mc:`minio server` process prints a line on startup for each configured NATS target similar to the following:
|
||||||
target similar to the following:
|
|
||||||
|
|
||||||
.. code-block:: shell
|
.. code-block:: shell
|
||||||
|
|
||||||
SQS ARNs: arn:minio:sqs::primary:nats
|
SQS ARNs: arn:minio:sqs::primary:nats
|
||||||
|
|
||||||
3) Validate the Changes
|
4) Validate the Changes
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
Perform an action on a bucket which has an event configuration using the updated
|
Perform an action on a bucket which has an event configuration using the updated NATS service endpoint and check the NATS service for the notification data.
|
||||||
NATS service endpoint and check the NATS service for the notification data. The
|
The action required depends on which :mc-cmd:`events <mc event add --event>` were specified when configuring the bucket notification.
|
||||||
action required depends on which :mc-cmd:`events <mc event add --event>` were
|
|
||||||
specified when configuring the bucket notification.
|
|
||||||
|
|
||||||
For example, if the bucket notification configuration includes the
|
For example, if the bucket notification configuration includes the ``s3:ObjectCreated:Put`` event, you can use the :mc:`mc cp` command to create a new object in the bucket and trigger a notification.
|
||||||
``s3:ObjectCreated:Put`` event, you can use the
|
|
||||||
:mc:`mc cp` command to create a new object in the bucket and trigger
|
|
||||||
a notification.
|
|
||||||
|
|
||||||
.. code-block:: shell
|
.. code-block:: shell
|
||||||
:class: copyable
|
:class: copyable
|
||||||
|
@ -533,10 +533,17 @@ MinIO supports the following time units:
|
|||||||
|
|
||||||
.. start-minio-notify-nats-streaming
|
.. start-minio-notify-nats-streaming
|
||||||
|
|
||||||
Specify ``on`` to enable streaming events to the NATS service endpoint.
|
Specify ``on`` to enable JetStream support for streaming events to a NATS JetStream service endpoint.
|
||||||
|
|
||||||
.. end-minio-notify-nats-streaming
|
.. end-minio-notify-nats-streaming
|
||||||
|
|
||||||
|
.. start-minio-notify-nats-jetstream
|
||||||
|
|
||||||
|
Specify ``on`` to enable asynchronous publishing of events to the NATS service endpoint.
|
||||||
|
|
||||||
|
.. end-minio-notify-nats-jetstream
|
||||||
|
|
||||||
|
|
||||||
.. start-minio-notify-nats-streaming-async
|
.. start-minio-notify-nats-streaming-async
|
||||||
|
|
||||||
Specify ``on`` to enable asynchronous publishing of events to the NATS service
|
Specify ``on`` to enable asynchronous publishing of events to the NATS service
|
||||||
|
@ -1342,6 +1342,14 @@ service as a target for :ref:`Bucket Nofitications <minio-bucket-notifications>`
|
|||||||
:ref:`minio-bucket-notifications-publish-nats` for a tutorial on
|
:ref:`minio-bucket-notifications-publish-nats` for a tutorial on
|
||||||
using these environment variables.
|
using these environment variables.
|
||||||
|
|
||||||
|
.. admonition:: NATS Streaming Deprecated
|
||||||
|
:class: important
|
||||||
|
|
||||||
|
NATS Streaming is deprecated.
|
||||||
|
Migrate to `JetStream <https://docs.nats.io/nats-concepts/jetstream>`__ instead.
|
||||||
|
|
||||||
|
The related MinIO configuration options and environment variables are deprecated.
|
||||||
|
|
||||||
.. mc-conf:: notify_nats
|
.. mc-conf:: notify_nats
|
||||||
|
|
||||||
The top-level configuration key for defining an NATS service endpoint for use
|
The top-level configuration key for defining an NATS service endpoint for use
|
||||||
@ -1480,9 +1488,22 @@ using these environment variables.
|
|||||||
This configuration setting corresponds with the environment variable
|
This configuration setting corresponds with the environment variable
|
||||||
:envvar:`MINIO_NOTIFY_NATS_PING_INTERVAL`.
|
:envvar:`MINIO_NOTIFY_NATS_PING_INTERVAL`.
|
||||||
|
|
||||||
|
.. mc-conf:: jetstream
|
||||||
|
:delimiter: " "
|
||||||
|
|
||||||
|
*Optional*
|
||||||
|
|
||||||
|
.. include:: /includes/common-mc-admin-config.rst
|
||||||
|
:start-after: start-minio-notify-nats-jetstream
|
||||||
|
:end-before: end-minio-notify-nats-jetstream
|
||||||
|
|
||||||
|
This configuration setting corresponds with the environment variable :envvar:`MINIO_NOTIFY_NATS_JETSTREAM`.
|
||||||
|
|
||||||
.. mc-conf:: streaming
|
.. mc-conf:: streaming
|
||||||
:delimiter: " "
|
:delimiter: " "
|
||||||
|
|
||||||
|
*Deprecated*
|
||||||
|
|
||||||
*Optional*
|
*Optional*
|
||||||
|
|
||||||
.. include:: /includes/common-mc-admin-config.rst
|
.. include:: /includes/common-mc-admin-config.rst
|
||||||
@ -1495,6 +1516,8 @@ using these environment variables.
|
|||||||
.. mc-conf:: streaming_async
|
.. mc-conf:: streaming_async
|
||||||
:delimiter: " "
|
:delimiter: " "
|
||||||
|
|
||||||
|
*Deprecated*
|
||||||
|
|
||||||
*Optional*
|
*Optional*
|
||||||
|
|
||||||
.. include:: /includes/common-mc-admin-config.rst
|
.. include:: /includes/common-mc-admin-config.rst
|
||||||
@ -1507,6 +1530,8 @@ using these environment variables.
|
|||||||
.. mc-conf:: streaming_max_pub_acks_in_flight
|
.. mc-conf:: streaming_max_pub_acks_in_flight
|
||||||
:delimiter: " "
|
:delimiter: " "
|
||||||
|
|
||||||
|
*Deprecated*
|
||||||
|
|
||||||
*Optional*
|
*Optional*
|
||||||
|
|
||||||
.. include:: /includes/common-mc-admin-config.rst
|
.. include:: /includes/common-mc-admin-config.rst
|
||||||
@ -1519,6 +1544,8 @@ using these environment variables.
|
|||||||
.. mc-conf:: streaming_cluster_id
|
.. mc-conf:: streaming_cluster_id
|
||||||
:delimiter: " "
|
:delimiter: " "
|
||||||
|
|
||||||
|
*Deprecated*
|
||||||
|
|
||||||
*Optional*
|
*Optional*
|
||||||
|
|
||||||
.. include:: /includes/common-mc-admin-config.rst
|
.. include:: /includes/common-mc-admin-config.rst
|
||||||
|
@ -998,6 +998,7 @@ These environment variables configure notification targets for use with
|
|||||||
- :ref:`minio-server-envvar-bucket-notification-elasticsearch`
|
- :ref:`minio-server-envvar-bucket-notification-elasticsearch`
|
||||||
- :ref:`minio-server-envvar-bucket-notification-nsq`
|
- :ref:`minio-server-envvar-bucket-notification-nsq`
|
||||||
- :ref:`minio-server-envvar-bucket-notification-redis`
|
- :ref:`minio-server-envvar-bucket-notification-redis`
|
||||||
|
- :ref:`minio-server-envvar-bucket-notification-nats`
|
||||||
- :ref:`minio-server-envvar-bucket-notification-postgresql`
|
- :ref:`minio-server-envvar-bucket-notification-postgresql`
|
||||||
- :ref:`minio-server-envvar-bucket-notification-mysql`
|
- :ref:`minio-server-envvar-bucket-notification-mysql`
|
||||||
- :ref:`minio-server-envvar-bucket-notification-kafka`
|
- :ref:`minio-server-envvar-bucket-notification-kafka`
|
||||||
@ -1713,30 +1714,30 @@ endpoints as ``PRIMARY`` and ``SECONDARY`` respectively:
|
|||||||
NATS Service for Bucket Notifications
|
NATS Service for Bucket Notifications
|
||||||
+++++++++++++++++++++++++++++++++++++
|
+++++++++++++++++++++++++++++++++++++
|
||||||
|
|
||||||
The following section documents environment variables for configuring an NATS
|
.. admonition:: NATS Streaming Deprecated
|
||||||
service as a target for :ref:`Bucket Nofitications <minio-bucket-notifications>`. See
|
:class: important
|
||||||
:ref:`minio-bucket-notifications-publish-nats` for a tutorial on
|
|
||||||
using these environment variables.
|
|
||||||
|
|
||||||
You can specify multiple NATS service endpoints by appending a unique identifier
|
NATS Streaming is deprecated.
|
||||||
``_ID`` for each set of related NATS environment variables:
|
Migrate to `JetStream <https://docs.nats.io/nats-concepts/jetstream>`__ instead.
|
||||||
the top level key. For example, the following commands set two distinct NATS
|
|
||||||
service endpoints as ``PRIMARY`` and ``SECONDARY`` respectively:
|
The related MinIO configuration options and environment variables are deprecated.
|
||||||
|
|
||||||
|
The following section documents environment variables for configuring an NATS service as a target for :ref:`Bucket Nofitications <minio-bucket-notifications>`.
|
||||||
|
See :ref:`minio-bucket-notifications-publish-nats` for a tutorial on using these environment variables.
|
||||||
|
|
||||||
|
You can specify multiple NATS service endpoints by appending a unique identifier ``_ID`` for each set of related NATS environment variables no to the top level key.
|
||||||
|
For example, the following commands set two distinct NATS service endpoints as ``PRIMARY`` and ``SECONDARY`` respectively:
|
||||||
|
|
||||||
.. code-block:: shell
|
.. code-block:: shell
|
||||||
:class: copyable
|
:class: copyable
|
||||||
|
|
||||||
set MINIO_NOTIFY_NATS_ENABLE_PRIMARY="on"
|
set MINIO_NOTIFY_NATS_ENABLE_PRIMARY="on"
|
||||||
set MINIO_NOTIFY_NATS_ADDRESS_PRIMARY="https://nats-endpoint.example.net:4222"
|
set MINIO_NOTIFY_NATS_ADDRESS_PRIMARY="https://nats-endpoint.example.net:4222"
|
||||||
set MINIO_NOTIFY_NATS_SUBJECT="minioevents"
|
|
||||||
|
|
||||||
set MINIO_NOTIFY_NATS_ENABLE_SECONDARY="on"
|
set MINIO_NOTIFY_NATS_ENABLE_SECONDARY="on"
|
||||||
set MINIO_NOTIFY_NATS_ADDRESS_SECONDARY="https://nats-endpoint.example.net:4222"
|
set MINIO_NOTIFY_NATS_ADDRESS_SECONDARY="https://nats-endpoint.example.net:4222"
|
||||||
set MINIO_NOTIFY_NATS_SUBJECT="minioevents"
|
|
||||||
|
|
||||||
For example, :envvar:`MINIO_NOTIFY_NATS_ENABLE_PRIMARY
|
For example, :envvar:`MINIO_NOTIFY_NATS_ENABLE_PRIMARY <MINIO_NOTIFY_NATS_ENABLE>` indicates the environment variable is associated to an NATS service endpoint with ID of ``PRIMARY``.
|
||||||
<MINIO_NOTIFY_NATS_ENABLE>` indicates the environment variable is associated to
|
|
||||||
an NATS service endpoint with ID of ``PRIMARY``.
|
|
||||||
|
|
||||||
.. envvar:: MINIO_NOTIFY_NATS_ENABLE
|
.. envvar:: MINIO_NOTIFY_NATS_ENABLE
|
||||||
|
|
||||||
@ -1843,8 +1844,20 @@ an NATS service endpoint with ID of ``PRIMARY``.
|
|||||||
:mc-conf:`notify_nats ping_interval <notify_nats.ping_interval>`
|
:mc-conf:`notify_nats ping_interval <notify_nats.ping_interval>`
|
||||||
configuration setting.
|
configuration setting.
|
||||||
|
|
||||||
|
.. envvar:: MINIO_NOTIFY_NATS_JETSTREAM
|
||||||
|
|
||||||
|
*Optional*
|
||||||
|
|
||||||
|
.. include:: /includes/common-mc-admin-config.rst
|
||||||
|
:start-after: start-minio-notify-nats-jetstream
|
||||||
|
:end-before: end-minio-notify-nats-jetstream
|
||||||
|
|
||||||
|
This environment variable corresponds with the :mc-conf:`notify_nats jetstream <notify_nats.jetstream>` configuration setting.
|
||||||
|
|
||||||
.. envvar:: MINIO_NOTIFY_NATS_STREAMING
|
.. envvar:: MINIO_NOTIFY_NATS_STREAMING
|
||||||
|
|
||||||
|
*Deprecated*
|
||||||
|
|
||||||
*Optional*
|
*Optional*
|
||||||
|
|
||||||
.. include:: /includes/common-mc-admin-config.rst
|
.. include:: /includes/common-mc-admin-config.rst
|
||||||
@ -1857,6 +1870,8 @@ an NATS service endpoint with ID of ``PRIMARY``.
|
|||||||
|
|
||||||
.. envvar:: MINIO_NOTIFY_NATS_STREAMING_ASYNC
|
.. envvar:: MINIO_NOTIFY_NATS_STREAMING_ASYNC
|
||||||
|
|
||||||
|
*Deprecated*
|
||||||
|
|
||||||
*Optional*
|
*Optional*
|
||||||
|
|
||||||
.. include:: /includes/common-mc-admin-config.rst
|
.. include:: /includes/common-mc-admin-config.rst
|
||||||
@ -1869,6 +1884,8 @@ an NATS service endpoint with ID of ``PRIMARY``.
|
|||||||
|
|
||||||
.. envvar:: MINIO_NOTIFY_NATS_STREAMING_MAX_PUB_ACKS_IN_FLIGHT
|
.. envvar:: MINIO_NOTIFY_NATS_STREAMING_MAX_PUB_ACKS_IN_FLIGHT
|
||||||
|
|
||||||
|
*Deprecated*
|
||||||
|
|
||||||
*Optional*
|
*Optional*
|
||||||
|
|
||||||
.. include:: /includes/common-mc-admin-config.rst
|
.. include:: /includes/common-mc-admin-config.rst
|
||||||
@ -1881,6 +1898,8 @@ an NATS service endpoint with ID of ``PRIMARY``.
|
|||||||
|
|
||||||
.. envvar:: MINIO_NOTIFY_NATS_STREAMING_CLUSTER_ID
|
.. envvar:: MINIO_NOTIFY_NATS_STREAMING_CLUSTER_ID
|
||||||
|
|
||||||
|
*Deprecated*
|
||||||
|
|
||||||
*Optional*
|
*Optional*
|
||||||
|
|
||||||
.. include:: /includes/common-mc-admin-config.rst
|
.. include:: /includes/common-mc-admin-config.rst
|
||||||
|
Reference in New Issue
Block a user