Skip to content

Commit

Permalink
📝 [open-zaak/open-zaak#1203] Docs for setup config for retry notifs
Browse files Browse the repository at this point in the history
  • Loading branch information
stevenbal committed Apr 16, 2024
1 parent 55e6370 commit b959509
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 13 deletions.
12 changes: 1 addition & 11 deletions docs/installation/configuration/env_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.


Expand Down
21 changes: 19 additions & 2 deletions docs/installation/configuration/opennotifs_config_cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------------------
Expand Down Expand Up @@ -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
=========

Expand Down

0 comments on commit b959509

Please sign in to comment.