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

Removes some erroneous config options for webhook (#1444)

Browse Source 
Closes #1434

These config options were likely a copy/paste error from other target types.
Refer to
https://github.com/minio/minio/blob/master/internal/event/target/webhook.go#L64-L73
for the correct list.
This update matches that code.
This commit is contained in:
Daryl White
2025-04-01 15:32:11 -04:00
committed by GitHub
parent 3298919df0
commit 8969abda18
2 changed files with 2 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
source/administration/monitoring/publish-events-to-webhook.rst
View File

@@ -67,7 +67,6 @@ variables *or* by setting runtime configuration settings.
set MINIO_NOTIFY_WEBHOOK_QUEUE_LIMIT_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_WEBHOOK_CLIENT_CERT_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_WEBHOOK_CLIENT_KEY_<IDENTIFIER>="<string>"
set MINIO_NOTIFY_WEBHOOK_COMMENT_<IDENTIFIER>="<string>"
.. cond:: not windows
@@ -81,7 +80,6 @@ variables *or* by setting runtime configuration settings.
export MINIO_NOTIFY_WEBHOOK_QUEUE_LIMIT_<IDENTIFIER>="<string>"
export MINIO_NOTIFY_WEBHOOK_CLIENT_CERT_<IDENTIFIER>="<string>"
export MINIO_NOTIFY_WEBHOOK_CLIENT_KEY_<IDENTIFIER>="<string>"
export MINIO_NOTIFY_WEBHOOK_COMMENT_<IDENTIFIER>="<string>"
- Replace ``<IDENTIFIER>`` with a unique descriptive string for the
Webhook service endpoint. Use the same ``<IDENTIFIER>`` value for all
@@ -124,8 +122,7 @@ variables *or* by setting runtime configuration settings.
queue_dir="<string>" \
queue_limit="<string>" \
client_cert="<string>" \
client_key="<string>" \
comment="<string>"
client_key="<string>"
- Replace ``IDENTIFIER`` with a unique descriptive string for the
Webhook service endpoint. The following examples in this procedure
@@ -279,8 +276,7 @@ for the Webhook service endpoint:
queue_dir="<string>" \
queue_limit="<string>" \
client_cert="<string>" \
client_key="<string>" \
comment="<string>"
client_key="<string>"
The :mc-conf:`notify_webhook endpoint <notify_webhook.endpoint>` configuration
setting is the *minimum* required for an Webhook service endpoint. All other

62
source/reference/minio-server/settings/notifications/webhook-service.rst
View File

@@ -271,65 +271,3 @@ Client Key
:delimiter: " "
Specify the path to the client private key to use for performing mTLS authentication to the webhook service.
MaxRetry
~~~~~~~~
*Optional*
.. tab-set::
.. tab-item:: Environment Variable
:sync: envvar
.. envvar:: MINIO_NOTIFY_WEBHOOK_MAX_RETRY
.. tab-item:: Configuration Setting
:sync: config
.. mc-conf:: notify_webhook max_retry
:delimiter: " "
Maximum number of attempts to retry an event send.
By default, the max number of retries is set to ``0``.
RetryInterval
~~~~~~~~~~~~~
*Optional*
.. tab-set::
.. tab-item:: Environment Variable
:sync: envvar
.. envvar:: MINIO_NOTIFY_WEBHOOK_RETRY_INTERVAL
.. tab-item:: Configuration Setting
:sync: config
.. mc-conf:: notify_webhook retry_interval
:delimiter: " "
Length of time to wait between retry attempts.
The default value is ``3s``.
Comment
~~~~~~~
*Optional*
.. tab-set::
.. tab-item:: Environment Variable
:sync: envvar
.. envvar:: MINIO_NOTIFY_WEBHOOK_COMMENT
.. tab-item:: Configuration Setting
:sync: config
.. mc-conf:: notify_webhook comment
:delimiter: " "
Specify a comment to associate with the Webhook configuration.