minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-07-28 19:42:10 +03:00
Code Activity

Docs 860 part2: persistant queues (#883)

Browse Source 
Docs updates for persistent queues added in
https://github.com/minio/minio/pull/17121

Kafka bit needs additional attention, see
https://github.com/minio/docs/issues/886

Staged:

http://192.241.195.202:9000/staging/DOCS-860-part2/linux/html/reference/minio-server/minio-server.html#logging

http://192.241.195.202:9000/staging/DOCS-860-part2/linux/html/reference/minio-mc-admin/mc-admin-config.html#http-webhook-log-target

Partly addresses https://github.com/minio/docs/issues/860
This commit is contained in:
Andrea Longo
2023-06-19 09:56:14 -06:00
committed by GitHub
parent e7c314ccf6
commit 45d18ddef8
3 changed files with 84 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
source/includes/common-mc-admin-config.rst
View File

@ -96,7 +96,7 @@ Specify the directory path to enable MinIO's persistent event store for
undelivered messages, such as ``/home/events``. undelivered messages, such as ``/home/events``.
MinIO stores undelivered events in the specified store while the AMQP MinIO stores undelivered events in the specified store while the AMQP
service is offline and replays the directory when connectivity resumes. service is offline and replays the stored events when connectivity resumes.
.. end-minio-notify-amqp-queue-dir .. end-minio-notify-amqp-queue-dir
@ -205,7 +205,7 @@ Specify the directory path to enable MinIO's persistent event store for
undelivered messages, such as ``/home/events``. undelivered messages, such as ``/home/events``.
MinIO stores undelivered events in the specified store while the MQTT MinIO stores undelivered events in the specified store while the MQTT
server/broker is offline and replays the directory when connectivity resumes. server/broker is offline and replays the stored events when connectivity resumes.
.. end-minio-notify-mqtt-queue-dir .. end-minio-notify-mqtt-queue-dir
@ -302,7 +302,7 @@ Specify the directory path to enable MinIO's persistent event store for
undelivered messages, such as ``/home/events``. undelivered messages, such as ``/home/events``.
MinIO stores undelivered events in the specified store while the Elasticsearch MinIO stores undelivered events in the specified store while the Elasticsearch
service is offline and replays the directory when connectivity resumes. service is offline and replays the stored events when connectivity resumes.
.. end-minio-notify-elasticsearch-queue-dir .. end-minio-notify-elasticsearch-queue-dir
@ -360,7 +360,7 @@ Specify the directory path to enable MinIO's persistent event store for
undelivered messages, such as ``/home/events``. undelivered messages, such as ``/home/events``.
MinIO stores undelivered events in the specified store while the NSQ MinIO stores undelivered events in the specified store while the NSQ
server/broker is offline and replays the directory when connectivity resumes. server/broker is offline and replays the stored events when connectivity resumes.
.. end-minio-notify-nsq-queue-dir .. end-minio-notify-nsq-queue-dir
@ -439,7 +439,7 @@ Specify the directory path to enable MinIO's persistent event store for
undelivered messages, such as ``/home/events``. undelivered messages, such as ``/home/events``.
MinIO stores undelivered events in the specified store while the Redis MinIO stores undelivered events in the specified store while the Redis
server/broker is offline and replays the directory when connectivity resumes. server/broker is offline and replays the stored events when connectivity resumes.
.. end-minio-notify-redis-queue-dir .. end-minio-notify-redis-queue-dir
@ -584,7 +584,7 @@ Specify the directory path to enable MinIO's persistent event store for
undelivered messages, such as ``/home/events``. undelivered messages, such as ``/home/events``.
MinIO stores undelivered events in the specified store while the NATS MinIO stores undelivered events in the specified store while the NATS
server/broker is offline and replays the directory when connectivity resumes. server/broker is offline and replays the stored events when connectivity resumes.
.. end-minio-notify-nats-queue-dir .. end-minio-notify-nats-queue-dir
@ -672,7 +672,7 @@ Specify the directory path to enable MinIO's persistent event store for
undelivered messages, such as ``/home/events``. undelivered messages, such as ``/home/events``.
MinIO stores undelivered events in the specified store while the PostgreSQL MinIO stores undelivered events in the specified store while the PostgreSQL
server/broker is offline and replays the directory when connectivity resumes. server/broker is offline and replays the stored events when connectivity resumes.
.. end-minio-notify-postgresql-queue-dir .. end-minio-notify-postgresql-queue-dir
@ -771,7 +771,7 @@ Specify the directory path to enable MinIO's persistent event store for
undelivered messages, such as ``/home/events``. undelivered messages, such as ``/home/events``.
MinIO stores undelivered events in the specified store while the MySQL MinIO stores undelivered events in the specified store while the MySQL
server/broker is offline and replays the directory when connectivity resumes. server/broker is offline and replays the stored events when connectivity resumes.
.. end-minio-notify-mysql-queue-dir .. end-minio-notify-mysql-queue-dir
@ -926,7 +926,7 @@ Specify the directory path to enable MinIO's persistent event store for
undelivered messages, such as ``/home/events``. undelivered messages, such as ``/home/events``.
MinIO stores undelivered events in the specified store while the Kafka MinIO stores undelivered events in the specified store while the Kafka
server/broker is offline and replays the directory when connectivity resumes. server/broker is offline and replays the stored events when connectivity resumes.
.. end-minio-notify-kafka-queue-dir .. end-minio-notify-kafka-queue-dir
@ -992,7 +992,7 @@ Specify the directory path to enable MinIO's persistent event store for
undelivered messages, such as ``/home/events``. undelivered messages, such as ``/home/events``.
MinIO stores undelivered events in the specified store while the webhook MinIO stores undelivered events in the specified store while the webhook
service is offline and replays the directory when connectivity resumes. service is offline and replays the stored events when connectivity resumes.
.. end-minio-notify-webhook-queue-dir .. end-minio-notify-webhook-queue-dir
@ -1021,4 +1021,4 @@ Defaults to ``on``.
Ensure you have at least one other admin user, such as one with the :userpolicy:`consoleAdmin` policy, before disabling the root account. Ensure you have at least one other admin user, such as one with the :userpolicy:`consoleAdmin` policy, before disabling the root account.
If you do not have another admin user, disabling the root account locks administrative access to the deployment. If you do not have another admin user, disabling the root account locks administrative access to the deployment.
.. end-minio-root-api-access .. end-minio-root-api-access

43
source/reference/minio-mc-admin/mc-admin-config.rst
View File

@ -190,16 +190,30 @@ HTTP Webhook Log Target
This setting corresponds to the This setting corresponds to the
:envvar:`MINIO_LOGGER_WEBHOOK_PROXY` environment variable. :envvar:`MINIO_LOGGER_WEBHOOK_PROXY` environment variable.
.. mc-conf:: queue_dir
.. versionadded:: RELEASE.2023-05-18T00-05-36Z
*Optional*
Specify the directory path, such as ``/opt/minio/events``, to enable MinIO's persistent event store for undelivered messages.
The MinIO process must have read, write, and list access on the specified directory.
MinIO stores undelivered events in the specified store while the webhook service is offline and replays the stored events when connectivity resumes.
This setting corresponds to the
:envvar:`MINIO_LOGGER_WEBHOOK_QUEUE_DIR` environment variable.
.. mc-conf:: queue_size .. mc-conf:: queue_size
*Optional* *Optional*
An integer value to use for the queue size for logger webhook targets. An integer value to use for the queue size for logger webhook targets.
The default is ``100000`` events.
This setting corresponds to the This setting corresponds to the
:envvar:`MINIO_LOGGER_WEBHOOK_QUEUE_SIZE` environment variable. :envvar:`MINIO_LOGGER_WEBHOOK_QUEUE_SIZE` environment variable.
.. _minio-server-config-logging-audit: .. _minio-server-config-logging-audit:
HTTP Webhook Audit Log Target HTTP Webhook Audit Log Target
@ -278,8 +292,29 @@ HTTP Webhook Audit Log Target
Requires specifying :mc-conf:`~audit_webhook.client_cert`. Requires specifying :mc-conf:`~audit_webhook.client_cert`.
This setting corresponds to the This setting corresponds to the :envvar:`MINIO_AUDIT_WEBHOOK_CLIENT_KEY` environment variable.
:envvar:`MINIO_AUDIT_WEBHOOK_CLIENT_KEY` environment variable.
.. mc-conf:: queue_dir
.. versionadded:: RELEASE.2023-05-18T00-05-36Z
*Optional*
Specify the directory path, such as ``/opt/minio/events``, to enable MinIO's persistent event store for undelivered messages.
The MinIO process must have read, write, and list access on the specified directory.
MinIO stores undelivered events in the specified store while the webhook service is offline and replays the stored events when connectivity resumes.
This setting corresponds to the :envvar:`MINIO_AUDIT_WEBHOOK_QUEUE_DIR` environment variable.
.. mc-conf:: queue_size
*Optional*
An integer value to use for the queue size for webhook targets.
The default is ``100000`` events.
This setting corresponds to the :envvar:`MINIO_AUDIT_WEBHOOK_QUEUE_SIZE` environment variable.
.. _minio-server-config-bucket-notification-amqp: .. _minio-server-config-bucket-notification-amqp:
@ -2498,4 +2533,4 @@ See :ref:`minio-external-identity-management-plugin` for a tutorial on using the
.. include:: /includes/common-minio-external-auth.rst .. include:: /includes/common-minio-external-auth.rst
:start-after: start-minio-identity-management-comment :start-after: start-minio-identity-management-comment
:end-before: end-minio-identity-management-comment :end-before: end-minio-identity-management-comment

34
source/reference/minio-server/minio-server.rst
View File

@ -677,6 +677,19 @@ server logs webhook endpoints:
This variable corresponds to the :mc-conf:`logger_webhook proxy This variable corresponds to the :mc-conf:`logger_webhook proxy
<logger_webhook.proxy>` configuration setting. <logger_webhook.proxy>` configuration setting.
.. envvar:: MINIO_LOGGER_WEBHOOK_QUEUE_DIR
.. versionadded:: RELEASE.2023-05-18T00-05-36Z
*Optional*
Specify the directory path, such as ``/opt/minio/events``, to enable MinIO's persistent event store for undelivered messages.
The MinIO process must have read, write, and list access on the specified directory.
MinIO stores undelivered events in the specified store while the webhook service is offline and replays the stored events when connectivity resumes.
This variable corresponds to the :mc-conf:`logger_webhook queue_dir <logger_webhook.queue_dir>` configuration setting.
.. envvar:: MINIO_LOGGER_WEBHOOK_QUEUE_SIZE .. envvar:: MINIO_LOGGER_WEBHOOK_QUEUE_SIZE
*Optional* *Optional*
@ -766,6 +779,27 @@ audit log webhook endpoints:
This variable corresponds to the :mc-conf:`audit_webhook client_key This variable corresponds to the :mc-conf:`audit_webhook client_key
<audit_webhook.client_key>` configuration setting. <audit_webhook.client_key>` configuration setting.
.. envvar:: MINIO_AUDIT_WEBHOOK_QUEUE_DIR
.. versionadded:: RELEASE.2023-05-18T00-05-36Z
*Optional*
Specify the directory path, such as ``/opt/minio/events``, to enable MinIO's persistent event store for undelivered messages.
The MinIO process must have read, write, and list access on the specified directory.
MinIO stores undelivered events in the specified store while the webhook service is offline and replays the stored events when connectivity resumes.
This variable corresponds to the :mc-conf:`audit_webhook queue_dir <audit_webhook.queue_dir>` configuration setting.
.. envvar:: MINIO_AUDIT_WEBHOOK_QUEUE_SIZE
*Optional*
An integer value to use for the queue size for audit webhook targets.
This variable corresponds to the :mc-conf:`audit_webhook queue_size <audit_webhook.queue_size>` configuration setting.
Bucket Notifications Bucket Notifications
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~