Upgrading the Docker NGINX- or Envoy-based image of Wallarm node 2.18 or lower¶

These instructions describe the steps to upgrade the running Docker NGINX- or Envoy-based image 2.18 or lower to the version 3.6.

Using credentials of already existing Wallarm node

We do not recommend using the already existing Wallarm node of the previous version. Please follow these instructions to create a new filtering node of the version 3.6 and deploy it as the Docker container.

Wallarm nodes 3.6 and lower are not supported

You are recommended to upgrade the Wallarm nodes 3.6 and lower since these versions are not supported, they are end-of-life.

Node configuration and traffic filtration have been significantly simplified in the Wallarm node of the latest versions. Before upgrading the modules, please carefully review the list of changes and general recommendations. Please note that some settings of the latest node are incompatible with the nodes 3.6 and lower.

Requirements¶

Access to the account with the Deploy or Administrator role and two‑factor authentication disabled in Wallarm Console in the US Cloud or EU Cloud
Access to https://us1.api.wallarm.com:444 if working with US Wallarm Cloud or to https://api.wallarm.com:444 if working with EU Wallarm Cloud. Please ensure the access is not blocked by a firewall

Step 1: Inform Wallarm technical support that you are upgrading filtering node modules¶

Please inform Wallarm technical support that you are upgrading filtering node modules up to 3.6 and ask to enable new IP list logic for your Wallarm account. When new IP list logic is enabled, please ensure the section IP lists of Wallarm Console is available.

Step 2: Disable the Active threat verification module (if upgrading node 2.16 or lower)¶

If upgrading Wallarm node 2.16 or lower, please disable the Active threat verification module in Wallarm Console → Scanner → Settings.

The module operation can cause false positives during the upgrade process. Disabling the module minimizes this risk.

Step 3: Download the updated filtering node image¶

NGINX-based imageEnvoy-based image

docker pull wallarm/node:3.6.2-1

docker pull wallarm/envoy:3.6.1-1

Step 4: Stop the running container¶

docker stop <RUNNING_CONTAINER_NAME>

Step 5: Migrate allowlists and denylists from the previous Wallarm node version to 3.6¶

Migrate allowlist and denylist configuration from previous Wallarm node version to 3.6.

Step 6: Switch from deprecated configuration options¶

There are the following deprecated configuration options:

The WALLARM_ACL_ENABLE environment variable has been deprecated. If IP lists are migrated to the new node version, remove this variable from the docker run command.
The following NGINX directives have been renamed:
- wallarm_instance → wallarm_application
- wallarm_local_trainingset_path → wallarm_custom_ruleset_path
- wallarm_global_trainingset_path → wallarm_protondb_path
We only changed the names of the directives, their logic remains the same. Directives with former names will be deprecated soon, so you are recommended to rename them before.

Please check if the directives with former names are explicitly specified in the mounted configuration files. If so, rename them.
The following Envoy parameters have been renamed:
- lom → custom_ruleset
- instance → application
We only changed the names of the directives, their logic remains the same. Directives with former names will be deprecated soon, so you are recommended to rename them before.

Please check if the directives with former names are explicitly specified in the mounted configuration files. If so, rename them.

Step 7: Update the Wallarm blocking page (if upgrading NGINX-based image)¶

In new node version, the Wallarm sample blocking page has been changed. The logo and support email on the page are now empty by default.

If the Docker container 2.18 or lower was configured to return the &/usr/share/nginx/html/wallarm_blocked.html page to blocked requests, change this configuration as follows:

Copy and customize the new version of a sample page.
Mount the customized page and the NGINX configuration file to a new Docker container in the next step.

Step 8: Transfer the `overlimit_res` attack detection configuration from directives to the rule¶

Starting from the version 3.6, you can fine-tune the overlimit_res attack detection using the rule in Wallarm Console.

Earlier, the following options have been used:

The wallarm_process_time_limit and wallarm_process_time_limit_block NGINX directives
The process_time_limit and process_time_limit_block Envoy parameters

The listed directives and parameters are considered to be deprecated with the new rule release and will be deleted in future releases.

If the overlimit_res attack detection settings are customized via the listed parameters, it is recommended to transfer them to the rule as follows:

Open Wallarm Console → Rules and proceed to the Fine-tune the overlimit_res attack detection rule setup.
Configure the rule as done in the mounted configuration files:
- The rule condition should match the NGINX or Envoy configuration block with the wallarm_process_time_limit and wallarm_process_time_limit_block directives or the process_time_limit and process_time_limit_block parameters specified.
- The time limit for the node to process a single request (milliseconds): the value of wallarm_process_time_limit or process_time_limit.
- Request processing: the Stop processing option is recommended.
  
  Risk of running out of system memory
  
  The high time limit and/or continuation of request processing after the limit is exceeded can trigger memory exhaustion or out-of-time request processing.
- Register the overlimit_res attack: the Register and display in the events option is recommended.
  
  If the wallarm_process_time_limit_block or process_time_limit_block value is off, choose the Do not create attack event option.
- The rule does not have the explicit equivalent option for the wallarm_process_time_limit_block (process_time_limit_block in Envoy) directive. If the rule sets Register and display in the events, the node will either block or pass the overlimit_res attack depending on the node filtration mode:
  - In the monitoring mode, the node forwards the original request to the application address. The application has the risk to be exploited by the attacks included in both processed and unprocessed request parts.
  - In the safe blocking mode, the node blocks the request if it is originated from the graylisted IP address. Otherwise, the node forwards the original request to the application address. The application has the risk to be exploited by the attacks included in both processed and unprocessed request parts.
  - In the block mode, the node blocks the request.
Delete the wallarm_process_time_limit, wallarm_process_time_limit_block NGINX directives and the process_time_limit, process_time_limit_block Envoy parameters from the mounted configuration file.

If the overlimit_res attack detection is fine-tuned using both the parameters and the rule, the node will process requests as the rule sets.

Step 9: Run the container using the updated image¶

Run the container using the updated image. You can pass the same configuration parameters that were passed when running a previous image version except for the ones listed in the previous steps.

There are two options for running the container using the updated image:

With the environment variables specifying basic filtering node configuration
- Instructions for the NGINX-based Docker container →
- Instructions for the Envoy-based Docker container →
In the mounted configuration file specifying advanced filtering node configuration
- Instructions for the NGINX-based Docker container →
- Instructions for the Envoy-based Docker container →

Step 10: Adjust Wallarm node filtration mode settings to changes released in the latest versions¶

Ensure that the expected behavior of settings listed below corresponds to the changed logic of the off and monitoring filtration modes:
- Environment variable WALLARM_MODE or the directive wallarm_mode of the NGINX‑based Docker container
- Environment variable WALLARM_MODE or the directive mode of the Envoy‑based Docker container
- General filtration rule configured in Wallarm Console
- Low-level filtration rules configured in Wallarm Console
If the expected behavior does not correspond to the changed filtration mode logic, please adjust the filtration mode settings to released changes using the instructions.

Step 11: Test the filtering node operation¶

Send the request with test SQLI and XSS attacks to the protected resource address:
```
curl http://localhost/?id='or+1=1--a-<script>prompt(1)</script>'
```
Open the Wallarm Console → Attacks section in the US Cloud or EU Cloud and ensure attacks are displayed in the list.

Step 12: Delete the filtering node of the previous version¶

If the deployed image of the version 3.6 operates correctly, you can delete the filtering node of the previous version in the Wallarm Console → Nodes section.

Step 13: Re-enable the Active threat verification module (if upgrading node 2.16 or lower)¶

Learn the recommendation on the Active threat verification module setup and re-enable it if required.

After a while, ensure the module operation does not cause false positives. If discovering false positives, please contact the Wallarm technical support.