Running Docker Envoy‑based image¶

These instructions describe the steps to run the Wallarm Docker image based on Envoy 1.18.4. The image contains all systems required for correct Wallarm node operation:

• Envoy proxy services with the embedded Wallarm module

• Tarantool modules for postanalytics

• Other services and scripts

The Wallarm module is designed as an Envoy HTTP filter for requests proxying.

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

Options for running the container¶

The filtering node configuration parameters can be passed to the docker run command in the following ways:

• In the environment variables. This option allows for configuration of only basic filtering node parameters, the most parameters cannot be changed through environment variables.

• In the mounted configuration file. This option allows for configuration of all the filtering node parameters.

Run the container passing the environment variables¶

To run the container:

1. Get Wallarm token of the appropriate type:

   API tokenNode token

   1. Open Wallarm Console → Settings → API tokens in the US Cloud or EU Cloud.
   2. Find or create API token with the Deploy source role.
   3. Copy this token.

   1. Open Wallarm Console → Nodes in the US Cloud or EU Cloud.
   2. Do one of the following:
      • Create the node of the Wallarm node type and copy the generated token.
      • Use existing node group - copy token using node's menu → Copy token.

2. Run the container with the node:

   US CloudEU Cloud

   docker run -d -e WALLARM_API_TOKEN='XXXXXXX' -e ENVOY_BACKEND='example.com' -e WALLARM_API_HOST='us1.api.wallarm.com' -p 80:80 wallarm/envoy:4.6.1-1
   

   docker run -d -e WALLARM_API_TOKEN='XXXXXXX' -e ENVOY_BACKEND='example.com' -p 80:80 wallarm/envoy:4.6.1-1
   

You can pass the following basic filtering node settings to the container via the option -e:

The command does the following:

• Creates the file envoy.yaml with minimal Envoy configuration in the /etc/envoy container directory.

• Creates files with filtering node credentials to access the Wallarm Cloud in the /etc/wallarm container directory:

  • node.yaml with filtering node UUID and secret key
  • private.key with Wallarm private key

• Protects the resource http://ENVOY_BACKEND:80.

Run the container mounting envoy.yaml¶

You can mount the prepared file envoy.yaml to the Docker container via the -v option. The file must contain the following settings:

• Filtering node settings as described in the instructions

• Envoy settings as described in the Envoy instructions

To run the container:

1. Get Wallarm token of the appropriate type:

   API tokenNode token

   1. Open Wallarm Console → Settings → API tokens in the US Cloud or EU Cloud.
   2. Find or create API token with the Deploy source role.
   3. Copy this token.

   1. Open Wallarm Console → Nodes in the US Cloud or EU Cloud.
   2. Do one of the following:
      • Create the node of the Wallarm node type and copy the generated token.
      • Use existing node group - copy token using node's menu → Copy token.

2. Run the container with the node:

   US CloudEU Cloud

   docker run -d -e WALLARM_API_TOKEN='XXXXXXX' -e WALLARM_API_HOST='us1.api.wallarm.com' -v /configs/envoy.yaml:/etc/envoy/envoy.yaml -p 80:80 wallarm/envoy:4.6.1-1
   

   docker run -d -e WALLARM_API_TOKEN='XXXXXXX' -v /configs/envoy.yaml:/etc/envoy/envoy.yaml -p 80:80 wallarm/envoy:4.6.1-1
   

   • The -e option passes the following required environment variables to the container:

   Environment variable	Description	Required
   WALLARM_API_TOKEN	Wallarm node token. Using one token for several installations You can use one 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.	Yes
   WALLARM_API_HOST	Wallarm API server: us1.api.wallarm.com for the US Cloud api.wallarm.com for the EU Cloud By default: api.wallarm.com.	No

   • The -v option mounts the directory with the configuration file envoy.yaml to the /etc/envoy container directory.

The command does the following:

• Mounts the file envoy.yaml into the /etc/envoy container directory.

• Creates files with filtering node credentials to access the Wallarm Cloud in the /etc/wallarm container directory:

  • node.yaml with filtering node UUID and secret key
  • private.key with Wallarm private key

• Protects the resource specified in the mounted configuration file.

Configuration of log rotation (optional)¶

The log file rotation is preconfigured and enabled by default. You can adjust the rotation settings if necessary. These settings are located in the /etc/logrotate.d directory of the container.

Testing Wallarm node operation¶

1. Send the request with test Path Traversal attack to a protected resource address:

   curl http://localhost/etc/passwd
   

2. Open Wallarm Console → Events section in the US Cloud or EU Cloud and make sure the attack is displayed in the list.