From b959509a64cee6abf3fb01dff5d2bed6628d93a0 Mon Sep 17 00:00:00 2001 From: Steven Bal Date: Tue, 16 Apr 2024 12:57:35 +0200 Subject: [PATCH] :memo: [open-zaak/open-zaak#1203] Docs for setup config for retry notifs --- docs/installation/configuration/env_config.md | 12 +---------- .../configuration/opennotifs_config_cli.rst | 21 +++++++++++++++++-- 2 files changed, 20 insertions(+), 13 deletions(-) diff --git a/docs/installation/configuration/env_config.md b/docs/installation/configuration/env_config.md index 4f08563f..db0dfa91 100644 --- a/docs/installation/configuration/env_config.md +++ b/docs/installation/configuration/env_config.md @@ -100,16 +100,6 @@ on Docker, since `localhost` is contained within the container: * `CELERY_RESULT_BACKEND`: the backend where the results of tasks will be stored (default: `redis://localhost:6379/1`) -* `NOTIFICATION_DELIVERY_MAX_RETRIES`: the maximum number of retries Celery will do if sending a notification failed. - -* `NOTIFICATION_DELIVERY_RETRY_BACKOFF`: a boolean or a number. If this option is set to - `True`, autoretries will be delayed following the rules of exponential backoff. If - this option is set to a number, it is used as a delay factor. - -* `NOTIFICATION_DELIVERY_RETRY_BACKOFF_MAX`: an integer, specifying number of seconds. - If ``retry_backoff`` is enabled, this option will set a maximum delay in seconds - between task autoretries. By default, this option is set to 48 seconds. - ### Cross-Origin-Resource-Sharing The following parameters control the CORS policy. @@ -130,7 +120,7 @@ The following parameters control the CORS policy. ### Initial configuration Open Notificaties supports `setup_configuration` management command, which allows configuration via -environment variables. +environment variables. All these environment variables are described at CLI configuration. diff --git a/docs/installation/configuration/opennotifs_config_cli.rst b/docs/installation/configuration/opennotifs_config_cli.rst index f05059d9..d5224915 100644 --- a/docs/installation/configuration/opennotifs_config_cli.rst +++ b/docs/installation/configuration/opennotifs_config_cli.rst @@ -27,8 +27,8 @@ Preparation The command executes the list of pluggable configuration steps, and each step requires specific environment variables, that should be prepared. -Here is the description of all available configuration steps and the environment variables, -use by each step. +Here is the description of all available configuration steps and the environment variables, +use by each step. Sites configuration ------------------- @@ -65,6 +65,23 @@ Make sure that the correct permissions are configured in Open Zaak Autorisaties for example, ``open-zaak``. Required. * ``OPENZAAK_NOTIF_SECRET``: some random string. Required. +Notification retry configuration +-------------------------------- + +Open Notifications has a retry mechanism to guarantee notification delivery, this mechanism +is described in :ref:`delivery_guarantees`. The parameters for this behavior can be configured via the +following environment variables. + +* ``NOTIFICATION_DELIVERY_MAX_RETRIES``: the maximum number of retries Celery will do if sending a notification failed. +* ``NOTIFICATION_DELIVERY_RETRY_BACKOFF``: a boolean or a number. If this option is set to + ``True``, autoretries will be delayed following the rules of exponential backoff. If + this option is set to a number, it is used as a delay factor. +* ``NOTIFICATION_DELIVERY_RETRY_BACKOFF_MAX``: an integer, specifying number of seconds. + If ``retry_backoff`` is enabled, this option will set a maximum delay in seconds + between task autoretries. By default, this option is set to 48 seconds. + +These settings can also later be changed via the admin interface, under ``Configuration > Notification component configuration``. + Execution =========