Skip to content

Removes some erroneous config options for webhook #1444

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 1, 2025
Merged

Removes some erroneous config options for webhook #1444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions source/administration/monitoring/publish-events-to-webhook.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
62 changes: 0 additions & 62 deletions source/reference/minio-server/settings/notifications/webhook-service.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.