From ac25949bccc057cd8a380157e8325626ea1d5a84 Mon Sep 17 00:00:00 2001 From: Andrea Longo Date: Thu, 15 Jun 2023 16:03:20 -0600 Subject: [PATCH] new envvars and settings --- .../minio-mc-admin/mc-admin-config.rst | 59 +++++++++++++++++-- .../reference/minio-server/minio-server.rst | 46 +++++++++++++++ 2 files changed, 101 insertions(+), 4 deletions(-) diff --git a/source/reference/minio-mc-admin/mc-admin-config.rst b/source/reference/minio-mc-admin/mc-admin-config.rst index 44ca84de..5c5ef901 100644 --- a/source/reference/minio-mc-admin/mc-admin-config.rst +++ b/source/reference/minio-mc-admin/mc-admin-config.rst @@ -190,16 +190,31 @@ 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 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 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. + + Requires specifying :mc-conf:`~logger_webhook.queue_dir`. 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 +293,44 @@ 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 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 stored events when connectivity resumes. + + This setting corresponds to the :envvar:`MINIO_AUDIT_WEBHOOK_QUEUE_DIR` environment variable. + + .. mc-conf:: kafka_queue_dir + + .. versionadded:: RELEASE.2023-05-18T00-05-36Z + + *Optional* + + 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 service is offline and replays the stored events when connectivity resumes. + + This setting corresponds to the :envvar:`MINIO_AUDIT_KAFKA_QUEUE_DIR` environment variable. + + .. mc-conf:: kafka_queue_size + + .. versionadded:: RELEASE.2023-05-18T00-05-36Z + + *Optional* + + An integer value to use for the queue size for Kafka targets. + The default is ``100000`` events. + + Requires specifying :mc-conf:`~audit_webhook.kafka_queue_dir`. + + This setting corresponds to the :envvar:`MINIO_AUDIT_KAFKA_QUEUE_SIZE` environment variable. .. _minio-server-config-bucket-notification-amqp: @@ -2498,4 +2549,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..fba0639c 100644 --- a/source/reference/minio-server/minio-server.rst +++ b/source/reference/minio-server/minio-server.rst @@ -677,6 +677,18 @@ 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 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 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 +778,40 @@ 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 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 stored events when connectivity resumes. + + This variable corresponds to the :mc-conf:`audit_webhook queue_dir ` configuration setting. + +.. envvar:: MINIO_AUDIT_KAFKA_QUEUE_DIR + + .. versionadded:: RELEASE.2023-05-18T00-05-36Z + + *Optional* + + 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 service is offline and replays the stored events when connectivity resumes. + + This variable corresponds to the :mc-conf:`audit_webhook kafka_queue_dir ` configuration setting. + +.. envvar:: MINIO_AUDIT_KAFKA_QUEUE_SIZE + + .. versionadded:: RELEASE.2023-05-18T00-05-36Z + + *Optional* + + An integer value to use for the queue size for audit Kafka targets. + + This variable corresponds to the :mc-conf:`audit_webhook kafka_queue_dir ` configuration setting. + Bucket Notifications ~~~~~~~~~~~~~~~~~~~~