Upgrading the EOL postanalytics module¶

These instructions describe the steps to upgrade the end‑of‑life postanalytics module (version 3.6 and lower) installed on a separate server. Postanalytics module must be upgraded before Upgrading Wallarm NGINX modules.

Upgrade methods¶

You can upgrade in two different ways:

• Migrate to the all-in-one installer usage during the upgrade procedure. This is the recommended approach as it automates various node installation and upgrade activities, such as NGINX and OS version identification, adding appropriate Wallarm repositories, installing packages, and others.

• Keep using the current manual installation method via individual DEB/RPM packages. However, it's important to note that in further upgrades this approach will require additional effort and manual configuration in comparison to the new method.

Upgrade with all-in-one installer¶

Use the procedure below to upgrade the end‑of‑life postanalytics module (version 3.6 and lower) installed on a separate server to version 4.6 using all-in-one installer.

Requirements for upgrade using all-in-one installer¶

• Access to the account with the Administrator role in Wallarm Console for the US Cloud or EU Cloud.

• Access to https://meganode.wallarm.com to download all-in-one Wallarm installer. Ensure the access is not blocked by a firewall.

• Access to https://us1.api.wallarm.com for working with US Wallarm Cloud or to https://api.wallarm.com for working with EU Wallarm Cloud. If access can be configured only via the proxy server, then use the instructions.

• Executing all commands as a superuser (e.g. root).

Step 1: Prepare clean machine¶

When upgrading modules 4.x or lower to 4.6 with all-in-one installer, you cannot upgrade an old package installation - instead you need to use a clean machine. Thus, as step 1, prepare a machine with one of the supported OS:

• Debian 10, 11 and 12.x

• Ubuntu LTS 18.04, 20.04, 22.04

• CentOS 7, 8 Stream, 9 Stream

• Alma/Rocky Linux 9

• Oracle Linux 8.x

• Redos

• SuSe Linux

• Others (the list is constantly widening, contact Wallarm support team to check if your OS is in the list)

Using new clean machine will lead to that at some moment you will have both old and new node, which is good: you can test the new one working properly without stopping the old one.

Step 2: Prepare Wallarm token¶

To install node, you will need a Wallarm token of the appropriate type. To prepare a token:

Step 3: Download all-in-one Wallarm installer¶

Wallarm suggests all-in-one installations for the following processors:

• x86_64

• ARM64 (beta)

To download all-in-one Wallarm installation script, execute the command:

curl -O https://meganode.wallarm.com/4.6/wallarm-4.6.12.x86_64-glibc.sh

curl -O https://meganode.wallarm.com/4.6/wallarm-4.6.12.aarch64-glibc.sh

Step 4: Run all-in-one Wallarm installer to install postanalytics¶

To install postanalytics separately with all-in-one installer, use:

# If using the x86_64 version:
sudo env WALLARM_LABELS='group=<GROUP>' sh wallarm-4.6.12.x86_64-glibc.sh postanalytics

# If using the ARM64 version:
sudo env WALLARM_LABELS='group=<GROUP>' sh wallarm-4.6.12.aarch64-glibc.sh postanalytics

# If using the x86_64 version:
sudo sh wallarm-4.6.12.x86_64-glibc.sh postanalytics

# If using the ARM64 version:
sudo sh wallarm-4.6.12.aarch64-glibc.sh postanalytics

Step 5: Update API port¶

Starting with version 4.0, the filtering node uploads data to the Cloud using the us1.api.wallarm.com:443 (US Cloud) and api.wallarm.com:443 (EU Cloud) API endpoints instead of us1.api.wallarm.com:444 and api.wallarm.com:444.

If you upgrade the node from the version 3.x or lower and your server with the deployed node has a limited access to the external resources and the access is granted to each resource separately, then after upgrade the synchronization between the filtering node and the Cloud will stop.

To restore the synchronization, in your configuration, change port 444 to 443 for API endpoint for each resource.

Step 6: Upgrade the NGINX-Wallarm module on a separate server¶

Once the postanalytics module is installed on the separate server, upgrade its related NGINX-Wallarm module running on a different server.

Step 7: Re-connect the NGINX-Wallarm module to the postanalytics module¶

On the machine with the NGINX-Wallarm module, in the NGINX configuration file, specify the postanalytics module server address:

upstream wallarm_tarantool {
    server <ip1>:3313 max_fails=0 fail_timeout=0 max_conns=1;
    server <ip2>:3313 max_fails=0 fail_timeout=0 max_conns=1;

    keepalive 2;
    }

    # omitted

wallarm_tarantool_upstream wallarm_tarantool;

• max_conns value must be specified for each of the upstream Tarantool servers to prevent the creation of excessive connections.

• keepalive value must not be lower than the number of the Tarantool servers.

• The # wallarm_tarantool_upstream wallarm_tarantool; string is commented by default - please delete #.

Once the configuration file changed, restart NGINX/NGINX Plus on the NGINX-Wallarm module server:

sudo systemctl restart nginx

sudo service nginx restart

sudo systemctl restart nginx

sudo systemctl restart nginx

Step 8: Check the NGINX‑Wallarm and separate postanalytics modules interaction¶

To check the NGINX‑Wallarm and separate postanalytics modules interaction, you can send the request with test attack to the address of the protected application:

curl http://localhost/etc/passwd

If the NGINX‑Wallarm and separate postanalytics modules are configured properly, the attack will be uploaded to the Wallarm Cloud and displayed in the Events section of Wallarm Console:

If the attack was not uploaded to the Cloud, please check that there are no errors in the services operation:

• Make sure that the postanalytics service wallarm-tarantool is in the status active

  sudo systemctl status wallarm-tarantool
  

  

• Analyze the postanalytics module logs

  sudo cat /var/log/wallarm/tarantool.log
  

  If there is the record like SystemError binary: failed to bind: Cannot assign requested address, make sure that the server accepts connection on specified address and port.

• On the server with the NGINX‑Wallarm module, analyze the NGINX logs:

  sudo cat /var/log/nginx/error.log
  

  If there is the record like [error] wallarm: <address> connect() failed, make sure that the address of separate postanalytics module is specified correctly in the NGINX‑Wallarm module configuration files and separate postanalytics server accepts connection on specified address and port.

• On the server with the NGINX‑Wallarm module, get the statistics on processed requests using the command below and make sure that the value of tnt_errors is 0

  curl http://127.0.0.8/wallarm-status
  

  Description of all parameters returned by the statistics service →

Step 9: Remove old postanalytics module¶

1. Delete old postanalytics module in Wallarm Console → Nodes by selecting your postanalytics module node and clicking Delete.

2. Confirm the action.

   When the postanalytics module node is deleted from Cloud, it will stop participation in filtration of requests to your applications. Deleting cannot be undone. The postanalytics module node will be deleted from the list of nodes permanently.

3. Delete machine with the old postanalytics module or just clean it from Wallarm postanalytics module components:

   DebianUbuntuCentOS or Amazon Linux 2.0.2021x and lowerAlmaLinux, Rocky Linux or Oracle Linux 8.x

   sudo apt remove wallarm-node-tarantool
   

   sudo apt remove wallarm-node-tarantool
   

   sudo yum remove wallarm-node-tarantool
   

   sudo yum remove wallarm-node-tarantool
   

Manual upgrade¶

Use the procedure below to manually upgrade the end‑of‑life postanalytics module (version 3.6 and lower) installed on a separate server to version 4.6.

Requirements¶

• Access to the account with the Administrator role in Wallarm Console in the US Cloud or EU Cloud

• Access to https://us1.api.wallarm.com if working with US Wallarm Cloud or to https://api.wallarm.com if working with EU Wallarm Cloud. Please ensure the access is not blocked by a firewall

Step 1: Update API port¶

Starting with version 4.0, the filtering node uploads data to the Cloud using the us1.api.wallarm.com:443 (US Cloud) and api.wallarm.com:443 (EU Cloud) API endpoints instead of us1.api.wallarm.com:444 and api.wallarm.com:444.

If you upgrade the node from the version 3.x or lower and your server with the deployed node has a limited access to the external resources and the access is granted to each resource separately, then after upgrade the synchronization between the filtering node and the Cloud will stop.

To restore the synchronization, in your configuration, change port 444 to 443 for API endpoint for each resource.

Step 2: Add new Wallarm repository¶

Delete the previous Wallarm repository address and add a repository with a new Wallarm node version packages. Please use the commands for the appropriate platform.

CentOS and Amazon Linux 2.0.2021x and lower

sudo yum remove wallarm-node-repo
sudo yum clean all
sudo rpm -i https://repo.wallarm.com/centos/wallarm-node/7/4.6/x86_64/wallarm-node-repo-4.6-0.el7.noarch.rpm

sudo yum remove wallarm-node-repo
sudo yum clean all
sudo rpm -i https://repo.wallarm.com/centos/wallarm-node/8/4.6/x86_64/wallarm-node-repo-4.6-0.el8.noarch.rpm

Debian and Ubuntu

1. Open the file with the Wallarm repository address in the installed text editor. In this instruction, vim is used.

   sudo vim /etc/apt/sources.list.d/wallarm.list
   

2. Comment out or delete the previous repository address.

3. Add a new repository address:

   Debian 10.x (buster)Debian 11.x (bullseye)Ubuntu 18.04 LTS (bionic)Ubuntu 20.04 LTS (focal)

   Unsupported by NGINX stable and NGINX Plus

   Official NGINX versions (stable and Plus) and, as a result, Wallarm node 4.4 and above cannot be installed on Debian 10.x (buster). Please use this OS only if NGINX is installed from Debian/CentOS repositories.

   deb https://repo.wallarm.com/debian/wallarm-node buster/4.6/
   

   deb https://repo.wallarm.com/debian/wallarm-node bullseye/4.6/
   

   deb https://repo.wallarm.com/ubuntu/wallarm-node bionic/4.6/
   

   deb https://repo.wallarm.com/ubuntu/wallarm-node focal/4.6/
   

Step 3: Upgrade the Tarantool packages¶

sudo apt update
sudo apt dist-upgrade

W: GPG error: https://repo.wallarm.com/ubuntu/wallarm-node focal/4.6/ Release:The following
signatures couldn't be verified because the public key is not available: NO_PUBKEY 1111FQQW999
E: The repository 'https://repo.wallarm.com/ubuntu/wallarm-node focal/4.6/ Release' is not signed.
N: Updating from such a repository can't be done securely, and is therefore disabled by default.
N: See apt-secure(8) manpage for repository creation and user configuration details.

curl -fsSL https://repo.wallarm.com/wallarm.gpg | sudo apt-key add -
sudo apt update
sudo apt dist-upgrade

sudo apt update
sudo apt dist-upgrade

W: GPG error: https://repo.wallarm.com/ubuntu/wallarm-node focal/4.6/ Release:The following
signatures couldn't be verified because the public key is not available: NO_PUBKEY 1111FQQW999
E: The repository 'https://repo.wallarm.com/ubuntu/wallarm-node focal/4.6/ Release' is not signed.
N: Updating from such a repository can't be done securely, and is therefore disabled by default.
N: See apt-secure(8) manpage for repository creation and user configuration details.

curl -fsSL https://repo.wallarm.com/wallarm.gpg | sudo apt-key add -
sudo apt update
sudo apt dist-upgrade

sudo yum update

sudo yum update

Step 4: Update the node type¶

The deployed postanalytics node 3.6 or lower has the deprecated regular type that is now replaced with the new Wallarm node type.

It is recommended to install the new node type instead of the deprecated one during migration to the version 4.6. The regular node type will be removed in future releases, please migrate before.

To replace the regular postanalytics node with the Wallarm node:

1. Open Wallarm Console → Nodes in the US Cloud or EU Cloud and create the node of the Wallarm node type.

   

2. Copy the generated token.

3. Execute the register-node script to run the Wallarm node:

   US CloudEU Cloud

   sudo /usr/share/wallarm-common/register-node -t <TOKEN> -H us1.api.wallarm.com --force --no-sync --no-sync-acl
   

   sudo /usr/share/wallarm-common/register-node -t <TOKEN> --force --no-sync --no-sync-acl
   

   • <TOKEN> is the copied value of the node token or API token with the Deploy role.
   • The --force option forces rewriting of the Wallarm Cloud access credentials specified in the /etc/wallarm/node.yaml file.

   Using one token for several installations

   You have two options for using one token for several installations:

   • For all node versions, you can use one node token in several installations regardless of the selected platform. It allows logical grouping of node instances in the Wallarm Console UI. Example: you deploy several Wallarm nodes to a development environment, each node is on its own machine owned by a certain developer.

   • Starting from node 4.6, for nodes grouping, you can use one API token with the Deploy role together with the --labels 'group=<GROUP>' flag, for example:

     
     

     sudo /usr/share/wallarm-common/register-node -t <API TOKEN WITH DEPLOY ROLE> --labels 'group=<GROUP>'
     

     
     

Step 5: Restart the postanalytics module¶

sudo systemctl restart wallarm-tarantool

sudo service wallarm-tarantool restart

sudo systemctl restart wallarm-tarantool

sudo systemctl restart wallarm-tarantool

Upgrade Wallarm NGINX modules