From 1ba5b5ca4eec47bf327f3933a199daf8533ffca8 Mon Sep 17 00:00:00 2001 From: Michael Pleshakov Date: Thu, 14 Jan 2021 15:00:25 -0800 Subject: [PATCH] Document increased reload time for APUserSig Co-authored-by: Jodie Putrino --- docs-web/app-protect/configuration.md | 4 +++- docs-web/app-protect/troubleshooting.md | 2 ++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs-web/app-protect/configuration.md b/docs-web/app-protect/configuration.md index 52919ea8cf..ed605e0064 100644 --- a/docs-web/app-protect/configuration.md +++ b/docs-web/app-protect/configuration.md @@ -132,6 +132,8 @@ You can define App Protect [User Defined Signatures](https://docs.nginx.com/ngin > **Note**: The field `revisionDatetime` is not currently supported. +> **Note**: `APUserSig` resources increase the reload time of NGINX Plus compared with `APPolicy` and `APLogConf` resources. Refer to [NGINX Fails to Start or Reload](/nginx-ingress-controller/app-protect/troubleshooting/#nginx-fails-to-start-or-reload) for more information. + To add the [User Defined Signatures](https://docs.nginx.com/nginx-app-protect/configuration/#user-defined-signature-definitions) to an Ingress resource: 1. Create an `APUserSig` Custom resource manifest. @@ -186,4 +188,4 @@ spec: - name: Unix/Linux softwareVersion: 15.1.0 tag: Fruits -``` \ No newline at end of file +``` diff --git a/docs-web/app-protect/troubleshooting.md b/docs-web/app-protect/troubleshooting.md index 44a3f7d739..7acf6300fc 100644 --- a/docs-web/app-protect/troubleshooting.md +++ b/docs-web/app-protect/troubleshooting.md @@ -130,4 +130,6 @@ This timeout should be more than enough to verify configurations. However, when You can increase this timeout by setting the `nginx-reload-timeout` [cli-argument](/nginx-ingress-controller/configuration/global-configuration/command-line-arguments/#cmdoption-nginx-reload-timeout). +When using the User Defined Signature feature, an update to an `APUserSig` requires more reload time from NGINX Plus compared with the other AppProtect resources. As a consequence, we recommend increasing the `nginx-reload-timeout` to 30 seconds if you're planning to use this feature. + If you are using external references in your Nginx App Protect policies, verify if the servers hosting the referenced resources are available and that their response time is as short as possible (see the Check the Availability of APPolicy External References section). If the references are not available during the Ingress Controller startup, the pod will fail to start. In case the resources are not available during a reload, the reload will fail, and NGINX Plus will use the previous correct configuration.