From 45d18ddef8f8325dc4408794f193a41eddb79cdb Mon Sep 17 00:00:00 2001 From: Andrea Longo Date: Mon, 19 Jun 2023 09:56:14 -0600 Subject: [PATCH] Docs 860 part2: persistant queues (#883) 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 --- source/includes/common-mc-admin-config.rst | 22 +++++----- .../minio-mc-admin/mc-admin-config.rst | 43 +++++++++++++++++-- .../reference/minio-server/minio-server.rst | 34 +++++++++++++++ 3 files changed, 84 insertions(+), 15 deletions(-) diff --git a/source/includes/common-mc-admin-config.rst b/source/includes/common-mc-admin-config.rst index e566fff8..219d2b77 100644 --- a/source/includes/common-mc-admin-config.rst +++ b/source/includes/common-mc-admin-config.rst @@ -96,7 +96,7 @@ Specify the directory path to enable MinIO's persistent event store for undelivered messages, such as ``/home/events``. 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 @@ -205,7 +205,7 @@ Specify the directory path to enable MinIO's persistent event store for undelivered messages, such as ``/home/events``. 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 @@ -302,7 +302,7 @@ Specify the directory path to enable MinIO's persistent event store for undelivered messages, such as ``/home/events``. 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 @@ -360,7 +360,7 @@ Specify the directory path to enable MinIO's persistent event store for undelivered messages, such as ``/home/events``. 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 @@ -439,7 +439,7 @@ Specify the directory path to enable MinIO's persistent event store for undelivered messages, such as ``/home/events``. 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 @@ -584,7 +584,7 @@ Specify the directory path to enable MinIO's persistent event store for undelivered messages, such as ``/home/events``. 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 @@ -672,7 +672,7 @@ Specify the directory path to enable MinIO's persistent event store for undelivered messages, such as ``/home/events``. 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 @@ -771,7 +771,7 @@ Specify the directory path to enable MinIO's persistent event store for undelivered messages, such as ``/home/events``. 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 @@ -926,7 +926,7 @@ Specify the directory path to enable MinIO's persistent event store for undelivered messages, such as ``/home/events``. 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 @@ -992,7 +992,7 @@ Specify the directory path to enable MinIO's persistent event store for undelivered messages, such as ``/home/events``. 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 @@ -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. If you do not have another admin user, disabling the root account locks administrative access to the deployment. -.. end-minio-root-api-access \ No newline at end of file +.. end-minio-root-api-access diff --git a/source/reference/minio-mc-admin/mc-admin-config.rst b/source/reference/minio-mc-admin/mc-admin-config.rst index 44ca84de..f8499540 100644 --- a/source/reference/minio-mc-admin/mc-admin-config.rst +++ b/source/reference/minio-mc-admin/mc-admin-config.rst @@ -190,16 +190,30 @@ HTTP Webhook Log Target This setting corresponds to the :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 *Optional* An integer value to use for the queue size for logger webhook targets. + The default is ``100000`` events. This setting corresponds to the :envvar:`MINIO_LOGGER_WEBHOOK_QUEUE_SIZE` environment variable. - .. _minio-server-config-logging-audit: HTTP Webhook Audit Log Target @@ -278,8 +292,29 @@ HTTP Webhook Audit Log Target Requires specifying :mc-conf:`~audit_webhook.client_cert`. - This setting corresponds to the - :envvar:`MINIO_AUDIT_WEBHOOK_CLIENT_KEY` environment variable. + This setting corresponds to the :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: @@ -2498,4 +2533,4 @@ See :ref:`minio-external-identity-management-plugin` for a tutorial on using the .. include:: /includes/common-minio-external-auth.rst :start-after: start-minio-identity-management-comment - :end-before: end-minio-identity-management-comment \ No newline at end of file + :end-before: end-minio-identity-management-comment diff --git a/source/reference/minio-server/minio-server.rst b/source/reference/minio-server/minio-server.rst index d03ea32e..248135ef 100644 --- a/source/reference/minio-server/minio-server.rst +++ b/source/reference/minio-server/minio-server.rst @@ -677,6 +677,19 @@ server logs webhook endpoints: This variable corresponds to the :mc-conf:`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 ` configuration setting. + .. envvar:: MINIO_LOGGER_WEBHOOK_QUEUE_SIZE *Optional* @@ -766,6 +779,27 @@ audit log webhook endpoints: This variable corresponds to the :mc-conf:`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 ` 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 ` configuration setting. + Bucket Notifications ~~~~~~~~~~~~~~~~~~~~