mirror of
https://github.com/minio/docs.git
synced 2025-07-30 07:03:26 +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:
Daryl White
GitHub
@ -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
|
||||
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
|
||||
|
||||
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
|
||||
: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
|
||||
:delimiter: " "
|
||||
|
||||
*Deprecated*
|
||||
|
||||
*Optional*
|
||||
|
||||
.. include:: /includes/common-mc-admin-config.rst
|
||||
@ -1495,6 +1516,8 @@ using these environment variables.
|
||||
.. mc-conf:: streaming_async
|
||||
:delimiter: " "
|
||||
|
||||
*Deprecated*
|
||||
|
||||
*Optional*
|
||||
|
||||
.. include:: /includes/common-mc-admin-config.rst
|
||||
@ -1507,6 +1530,8 @@ using these environment variables.
|
||||
.. mc-conf:: streaming_max_pub_acks_in_flight
|
||||
:delimiter: " "
|
||||
|
||||
*Deprecated*
|
||||
|
||||
*Optional*
|
||||
|
||||
.. include:: /includes/common-mc-admin-config.rst
|
||||
@ -1519,6 +1544,8 @@ using these environment variables.
|
||||
.. mc-conf:: streaming_cluster_id
|
||||
:delimiter: " "
|
||||
|
||||
*Deprecated*
|
||||
|
||||
*Optional*
|
||||
|
||||
.. 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-nsq`
|
||||
- :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-mysql`
|
||||
- :ref:`minio-server-envvar-bucket-notification-kafka`
|
||||
@ -1713,30 +1714,30 @@ endpoints as ``PRIMARY`` and ``SECONDARY`` respectively:
|
||||
NATS Service for Bucket Notifications
|
||||
+++++++++++++++++++++++++++++++++++++
|
||||
|
||||
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.
|
||||
.. admonition:: NATS Streaming Deprecated
|
||||
:class: important
|
||||
|
||||
You can specify multiple NATS service endpoints by appending a unique identifier
|
||||
``_ID`` for each set of related NATS environment variables:
|
||||
the top level key. For example, the following commands set two distinct NATS
|
||||
service endpoints as ``PRIMARY`` and ``SECONDARY`` respectively:
|
||||
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.
|
||||
|
||||
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
|
||||
:class: copyable
|
||||
|
||||
set MINIO_NOTIFY_NATS_ENABLE_PRIMARY="on"
|
||||
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_ADDRESS_SECONDARY="https://nats-endpoint.example.net:4222"
|
||||
set MINIO_NOTIFY_NATS_SUBJECT="minioevents"
|
||||
|
||||
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``.
|
||||
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``.
|
||||
|
||||
.. 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>`
|
||||
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
|
||||
|
||||
*Deprecated*
|
||||
|
||||
*Optional*
|
||||
|
||||
.. 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
|
||||
|
||||
*Deprecated*
|
||||
|
||||
*Optional*
|
||||
|
||||
.. 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
|
||||
|
||||
*Deprecated*
|
||||
|
||||
*Optional*
|
||||
|
||||
.. 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
|
||||
|
||||
*Deprecated*
|
||||
|
||||
*Optional*
|
||||
|
||||
.. include:: /includes/common-mc-admin-config.rst
|
||||
|
||||
Reference in New Issue
Block a user