From a6d7efb8579bb98a540c82226044fd4c0389cbd3 Mon Sep 17 00:00:00 2001 From: Nikola Koevski Date: Fri, 9 Aug 2024 15:50:56 +0200 Subject: [PATCH] feat: add filter configuration docs Expand the gateway configuration docs with a section on how to configure REST API filters. --- .../zeebe-deployment/configuration/gateway.md | 47 +++++++++++++++++++ 1 file changed, 47 insertions(+) diff --git a/docs/self-managed/zeebe-deployment/configuration/gateway.md b/docs/self-managed/zeebe-deployment/configuration/gateway.md index 660e0947a00..2c43c323087 100644 --- a/docs/self-managed/zeebe-deployment/configuration/gateway.md +++ b/docs/self-managed/zeebe-deployment/configuration/gateway.md @@ -410,6 +410,53 @@ interceptors: className: null ``` +### zeebe.gateway.filters + +It is possible to filter REST API requests in the gateway, which can be configured via environment variables or the `application.yaml` file. For more details, read about [filters](/self-managed/zeebe-deployment/zeebe-gateway/filters.md). + +Each filter should be configured with the values described below: + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescriptionExample value
idIdentifier for this filter. This setting can also be overridden using the environment variable `ZEEBE_GATEWAY_FILTERS_0_ID`.
jarPathPath (relative or absolute) to the JAR file containing the filter class and its dependencies. All classes must be compiled for the same language version as Zeebe or lower. This setting can also be overridden using the environment variable `ZEEBE_GATEWAY_FILTERS_0_JARPATH`.
classNameEntry point of the filter, a class which must: +
  • implement jakarta.servlet.Filter
    • +
  • have public visibility
    • +
  • have a public default constructor (i.e. no-arg constructor)
    • + This setting can also be overridden using the environment variable `ZEEBE_GATEWAY_FILTERS_0_CLASSNAME`. +
    + +#### YAML snippet + +```yaml +filters: + id: null + jarPath: null + className: null +``` + ### zeebe.gateway.multiTenancy Multi-tenancy in Zeebe can be configured with the following configuration properties.