Skip to content

Commit

Permalink
Merge pull request #1315 from wallarm/feature/docs-release-5.0
Browse files Browse the repository at this point in the history
show the 5.0 version
  • Loading branch information
AnastasiaTWW authored Aug 21, 2024
2 parents 6ceaf03 + b0b7f73 commit 4b005d7
Show file tree
Hide file tree
Showing 48 changed files with 565 additions and 134 deletions.
2 changes: 2 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ WORKDIR /docs
COPY . .

FROM latest as all
RUN mkdocs build -f mkdocs-5.0.yml
RUN mkdocs build -f mkdocs-4.10.yml
RUN mkdocs build -f mkdocs-4.8.yml
RUN mkdocs build -f mkdocs-deprecated.yml
Expand Down Expand Up @@ -41,6 +42,7 @@ CMD ["nginx", "-g", "daemon off;"]
# COPY . .

# FROM latest as all
# RUN INSIDERS=true mkdocs build -f mkdocs-5.0.yml
# RUN INSIDERS=true mkdocs build -f mkdocs-4.10.yml
# RUN INSIDERS=true mkdocs build -f mkdocs-4.8.yml
# RUN INSIDERS=true mkdocs build -f mkdocs-deprecated.yml
Expand Down
274 changes: 273 additions & 1 deletion docs/4.10/admin-en/configure-wallarm-mode.md

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions docs/4.10/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ hide:

The Wallarm solution protects APIs, microservices and web applications from OWASP API Top 10 threats,<br>API abuse and other automated threats with no manual rule configuration and ultra‑low false positives.

!!! info "Newer version is available"
The newer version of the Wallarm node has been released. [What is new in the latest version](/updating-migrating/what-is-new/)

<div class="navigation">
<div class="navigation-card">
<h3 class="icon-homepage quick-start-title">Quick start</h3>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,11 @@ The **all-in-one installer** provides a simple node installation process by auto

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

--8<-- "../include/waf/installation/all-in-one-installer-download.md"
--8<-- "../include/waf/installation/all-in-one-installer-download-4.10.md"

## Step 4: Run all-in-one Wallarm installer

--8<-- "../include/waf/installation/all-in-one-installer-run.md"
--8<-- "../include/waf/installation/all-in-one-installer-run-4.10.md"

Commands in the further steps are the same for x86_64 and ARM64 installations.

Expand Down Expand Up @@ -114,7 +114,7 @@ Below there are a few of the typical settings that you can apply if needed:

## Launch options

--8<-- "../include/waf/installation/all-in-one/launch-options.md"
--8<-- "../include/waf/installation/all-in-one/launch-options-4.10.md"

## Starting the installation over

Expand Down
6 changes: 3 additions & 3 deletions docs/4.10/installation/nginx/all-in-one.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,11 @@ The **all-in-one installer** provides a simple node installation process by auto

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

--8<-- "../include/waf/installation/all-in-one-installer-download.md"
--8<-- "../include/waf/installation/all-in-one-installer-download-4.10.md"

## Step 4: Run all-in-one Wallarm installer

--8<-- "../include/waf/installation/all-in-one-installer-run.md"
--8<-- "../include/waf/installation/all-in-one-installer-run-4.10.md"

Commands in the further steps are the same for x86_64 and ARM64 installations.

Expand Down Expand Up @@ -113,7 +113,7 @@ Below there are a few of the typical settings that you can apply if needed:

## Launch options

--8<-- "../include/waf/installation/all-in-one/launch-options.md"
--8<-- "../include/waf/installation/all-in-one/launch-options-4.10.md"

## Starting the installation over

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,11 @@ The **all-in-one installer** provides a simple node installation process by auto

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

--8<-- "../include/waf/installation/all-in-one-installer-download.md"
--8<-- "../include/waf/installation/all-in-one-installer-download-4.10.md"

## Step 4: Run all-in-one Wallarm installer

--8<-- "../include/waf/installation/all-in-one-installer-run.md"
--8<-- "../include/waf/installation/all-in-one-installer-run-4.10.md"

Commands in the further steps are the same for x86_64 and ARM64 installations.

Expand Down Expand Up @@ -115,7 +115,7 @@ Below there are a few of the typical settings that you can apply if needed:

## Launch options

--8<-- "../include/waf/installation/all-in-one/launch-options.md"
--8<-- "../include/waf/installation/all-in-one/launch-options-4.10.md"

## Starting the installation over

Expand Down
6 changes: 3 additions & 3 deletions docs/4.10/updating-migrating/all-in-one.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ To upgrade node, you will need a Wallarm token of [one of the types](../user-gui

### Step 2: Download newest version of all-in-one Wallarm installer

--8<-- "../include/waf/installation/all-in-one-installer-download.md"
--8<-- "../include/waf/installation/all-in-one-installer-download-4.10.md"

### Step 3: Run all-in-one Wallarm installer

Expand Down Expand Up @@ -112,7 +112,7 @@ To upgrade node, you will need a Wallarm token of [one of the types](../user-gui
This step is performed on the postanalytics machine.
--8<-- "../include/waf/installation/all-in-one-installer-download.md"
--8<-- "../include/waf/installation/all-in-one-installer-download-4.10.md"
### Step 3: Run all-in-one Wallarm installer to upgrade postanalytics
Expand Down Expand Up @@ -143,7 +143,7 @@ This step is performed on the postanalytics machine.
This step is performed on the filtering node machine.
--8<-- "../include/waf/installation/all-in-one-installer-download.md"
--8<-- "../include/waf/installation/all-in-one-installer-download-4.10.md"
### Step 5: Run all-in-one Wallarm installer to upgrade filtering node
Expand Down
4 changes: 2 additions & 2 deletions docs/4.10/updating-migrating/nginx-modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,13 @@ To upgrade the end‑of‑life node (3.6 or lower), please use the [different in

## Step 4: Download all-in-one Wallarm installer

--8<-- "../include/waf/installation/all-in-one-installer-download.md"
--8<-- "../include/waf/installation/all-in-one-installer-download-4.10.md"

## Step 5: Run all-in-one Wallarm installer

### Filtering node and postanalytics on the same server

--8<-- "../include/waf/installation/all-in-one-installer-run.md"
--8<-- "../include/waf/installation/all-in-one-installer-run-4.10.md"

### Filtering node and postanalytics on different servers

Expand Down
4 changes: 2 additions & 2 deletions docs/4.10/updating-migrating/older-versions/nginx-modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,13 +86,13 @@ The module operation can cause [false positives](../../about-wallarm/protecting-

## Step 5: Download all-in-one Wallarm installer

--8<-- "../include/waf/installation/all-in-one-installer-download.md"
--8<-- "../include/waf/installation/all-in-one-installer-download-4.10.md"

## Step 6: Run all-in-one Wallarm installer

### Filtering node and postanalytics on the same server

--8<-- "../include/waf/installation/all-in-one-installer-run.md"
--8<-- "../include/waf/installation/all-in-one-installer-run-4.10.md"

### Filtering node and postanalytics on different servers

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,11 @@ These instructions describe the steps to upgrade the end‑of‑life postanalyti

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

--8<-- "../include/waf/installation/all-in-one-installer-download.md"
--8<-- "../include/waf/installation/all-in-one-installer-download-4.10.md"

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

--8<-- "../include/waf/installation/all-in-one-postanalytics.md"
--8<-- "../include/waf/installation/all-in-one-postanalytics-4.10.md"

## Step 5: Update API port

Expand Down
4 changes: 2 additions & 2 deletions docs/4.10/updating-migrating/separate-postanalytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ To upgrade the end‑of‑life module (3.6 or lower), please use the [different

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

--8<-- "../include/waf/installation/all-in-one-installer-download.md"
--8<-- "../include/waf/installation/all-in-one-installer-download-4.10.md"

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

--8<-- "../include/waf/installation/all-in-one-postanalytics.md"
--8<-- "../include/waf/installation/all-in-one-postanalytics-4.10.md"

## Step 5: Upgrade the NGINX-Wallarm module on a separate server

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ To deploy the Wallarm Ingress controller and chain it with additional controller
To learn more configuration options, please use the [link](configure-kubernetes-en.md).
1. Install the Wallarm Ingress Helm chart:
``` bash
helm install --version 4.10.9 internal-ingress wallarm/wallarm-ingress -n wallarm-ingress -f values.yaml --create-namespace
helm install --version 5.0.1 internal-ingress wallarm/wallarm-ingress -n wallarm-ingress -f values.yaml --create-namespace
```
* `internal-ingress` is the name of Helm release
Expand Down
2 changes: 1 addition & 1 deletion docs/latest/admin-en/configure-wallarm-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Note that described configuration is applicable only for [in-line](../installati
When deploying the NGINX-based Wallarm nodes via docker containers, [pass](../admin-en/installation-docker-en.md#run-the-container-passing-the-environment-variables) the `WALLARM_MODE` environment variable:

```
docker run -d -e WALLARM_API_TOKEN='XXXXXXX' -e WALLARM_LABELS='group=<GROUP>' -e NGINX_BACKEND='example.com' -e WALLARM_API_HOST='us1.api.wallarm.com' -e WALLARM_MODE='monitoring' -p 80:80 wallarm/node:4.10.6-1
docker run -d -e WALLARM_API_TOKEN='XXXXXXX' -e WALLARM_LABELS='group=<GROUP>' -e NGINX_BACKEND='example.com' -e WALLARM_API_HOST='us1.api.wallarm.com' -e WALLARM_MODE='monitoring' -p 80:80 wallarm/node:5.0.1-1
```

Alternatively, [include](../admin-en/installation-docker-en.md#run-the-container-mounting-the-configuration-file) the corresponding parameter in the configuration file and run the container mounting this file.
Expand Down
14 changes: 7 additions & 7 deletions docs/latest/admin-en/installation-docker-en.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The Wallarm NGINX-based filtering node can be deployed using a [Docker image](https://hub.docker.com/r/wallarm/node). This node supports both x86_64 and ARM64 processor operating systems, which are automatically identified during installation. This article provides guidance on how to run the node from the Docker image.

The Docker image is based on Alpine Linux and the NGINX version provided by Alpine. Currently, the latest image uses Alpine Linux version 3.20, which includes NGINX stable 1.26.1.
The Docker image is based on Alpine Linux and the NGINX version provided by Alpine. Currently, the latest image uses Alpine Linux version 3.20, which includes NGINX stable 1.26.2.

## Use cases

Expand All @@ -26,11 +26,11 @@ To run the container:

=== "US Cloud"
```bash
docker run -d -e WALLARM_API_TOKEN='XXXXXXX' -e WALLARM_LABELS='group=<GROUP>' -e NGINX_BACKEND='example.com' -e WALLARM_API_HOST='us1.api.wallarm.com' -p 80:80 wallarm/node:4.10.9-1
docker run -d -e WALLARM_API_TOKEN='XXXXXXX' -e WALLARM_LABELS='group=<GROUP>' -e NGINX_BACKEND='example.com' -e WALLARM_API_HOST='us1.api.wallarm.com' -p 80:80 wallarm/node:5.0.1-1
```
=== "EU Cloud"
```bash
docker run -d -e WALLARM_API_TOKEN='XXXXXXX' -e WALLARM_LABELS='group=<GROUP>' -e NGINX_BACKEND='example.com' -p 80:80 wallarm/node:4.10.9-1
docker run -d -e WALLARM_API_TOKEN='XXXXXXX' -e WALLARM_LABELS='group=<GROUP>' -e NGINX_BACKEND='example.com' -p 80:80 wallarm/node:5.0.1-1
```

You can pass the following basic filtering node settings to the container via the option `-e`:
Expand Down Expand Up @@ -60,11 +60,11 @@ To run the container:

=== "US Cloud"
```bash
docker run -d -e WALLARM_API_TOKEN='XXXXXXX' -e WALLARM_LABELS='group=<GROUP>' -e WALLARM_API_HOST='us1.api.wallarm.com' -v /configs/default:/etc/nginx/sites-enabled/default -p 80:80 wallarm/node:4.10.9-1
docker run -d -e WALLARM_API_TOKEN='XXXXXXX' -e WALLARM_LABELS='group=<GROUP>' -e WALLARM_API_HOST='us1.api.wallarm.com' -v /configs/default:/etc/nginx/sites-enabled/default -p 80:80 wallarm/node:5.0.1-1
```
=== "EU Cloud"
```bash
docker run -d -e WALLARM_API_TOKEN='XXXXXXX' -e WALLARM_LABELS='group=<GROUP>' -v /configs/default:/etc/nginx/sites-enabled/default -p 80:80 wallarm/node:4.10.9-1
docker run -d -e WALLARM_API_TOKEN='XXXXXXX' -e WALLARM_LABELS='group=<GROUP>' -v /configs/default:/etc/nginx/sites-enabled/default -p 80:80 wallarm/node:5.0.1-1
```

* The `-e` option passes the following required environment variables to the container:
Expand Down Expand Up @@ -127,8 +127,8 @@ To run the container:
return 500 "API FW fallback";
}
```
1. Mount the `/etc/nginx/conf.d/wallarm-status.conf` file, ensuring its contents align with the [template](https://github.com/wallarm/docker-wallarm-node/blob/stable/4.10/conf/nginx_templates/wallarm-status.conf.tmpl).
1. Within the NGINX configuration files, set up the configuration for the [`/wallarm-status` service][node-status-docs] according to the [template](https://github.com/wallarm/docker-wallarm-node/blob/stable/4.10/conf/nginx_templates/default.conf.tmpl#L32).
1. Mount the `/etc/nginx/conf.d/wallarm-status.conf` file, ensuring its contents align with the [template](https://github.com/wallarm/docker-wallarm-node/blob/stable/5.0/conf/nginx_templates/wallarm-status.conf.tmpl).
1. Within the NGINX configuration files, set up the configuration for the [`/wallarm-status` service][node-status-docs] according to the [template](https://github.com/wallarm/docker-wallarm-node/blob/stable/5.0/conf/nginx_templates/default.conf.tmpl#L32).
* `/etc/nginx/conf.d` — common settings
* `/etc/nginx/sites-enabled` — virtual host settings
* `/opt/wallarm/usr/share/nginx/html` — static files
Expand Down
2 changes: 1 addition & 1 deletion docs/latest/admin-en/installation-kubernetes-en.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ To install the Wallarm Ingress Controller:
1. Install the Wallarm packages:
``` bash
helm install --version 4.10.9 <RELEASE_NAME> wallarm/wallarm-ingress -n <KUBERNETES_NAMESPACE> -f <PATH_TO_VALUES>
helm install --version 5.0.1 <RELEASE_NAME> wallarm/wallarm-ingress -n <KUBERNETES_NAMESPACE> -f <PATH_TO_VALUES>
```
* `<RELEASE_NAME>` is the name for the Helm release of the Ingress controller chart
Expand Down
20 changes: 10 additions & 10 deletions docs/latest/admin-en/installation-postanalytics-en.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ To download all-in-one Wallarm installation script, execute the command:

=== "x86_64 version"
```bash
curl -O https://meganode.wallarm.com/4.10/wallarm-4.10.9.x86_64-glibc.sh
curl -O https://meganode.wallarm.com/5.0/wallarm-5.0.1.x86_64-glibc.sh
```
=== "ARM64 version"
```bash
curl -O https://meganode.wallarm.com/4.10/wallarm-4.10.9.aarch64-glibc.sh
curl -O https://meganode.wallarm.com/5.0/wallarm-5.0.1.aarch64-glibc.sh
```

## Step 2: Prepare Wallarm token
Expand All @@ -63,21 +63,21 @@ To install postanalytics separately with all-in-one installer, use:
=== "API token"
```bash
# If using the x86_64 version:
sudo env WALLARM_LABELS='group=<GROUP>' sh wallarm-4.10.9.x86_64-glibc.sh postanalytics
sudo env WALLARM_LABELS='group=<GROUP>' sh wallarm-5.0.1.x86_64-glibc.sh postanalytics

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

The `WALLARM_LABELS` variable sets group into which the node will be added (used for logical grouping of nodes in the Wallarm Console UI).

=== "Node token"
```bash
# If using the x86_64 version:
sudo sh wallarm-4.10.9.x86_64-glibc.sh postanalytics
sudo sh wallarm-5.0.1.x86_64-glibc.sh postanalytics

# If using the ARM64 version:
sudo sh wallarm-4.10.9.aarch64-glibc.sh postanalytics
sudo sh wallarm-5.0.1.aarch64-glibc.sh postanalytics
```

## Step 4: Configure the postanalytics module
Expand Down Expand Up @@ -157,21 +157,21 @@ Once the postanalytics module is installed on the separate server:
=== "API token"
```bash
# If using the x86_64 version:
sudo env WALLARM_LABELS='group=<GROUP>' sh wallarm-4.10.9.x86_64-glibc.sh filtering
sudo env WALLARM_LABELS='group=<GROUP>' sh wallarm-5.0.1.x86_64-glibc.sh filtering
# If using the ARM64 version:
sudo env WALLARM_LABELS='group=<GROUP>' sh wallarm-4.10.9.aarch64-glibc.sh filtering
sudo env WALLARM_LABELS='group=<GROUP>' sh wallarm-5.0.1.aarch64-glibc.sh filtering
```

The `WALLARM_LABELS` variable sets group into which the node will be added (used for logical grouping of nodes in the Wallarm Console UI).

=== "Node token"
```bash
# If using the x86_64 version:
sudo sh wallarm-4.10.9.x86_64-glibc.sh filtering
sudo sh wallarm-5.0.1.x86_64-glibc.sh filtering
# If using the ARM64 version:
sudo sh wallarm-4.10.9.aarch64-glibc.sh filtering
sudo sh wallarm-5.0.1.aarch64-glibc.sh filtering
```

## Step 8: Connect the NGINX-Wallarm module to the postanalytics module
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,11 @@ To deploy the containerized Wallarm filtering node configured only through envir

=== "Command for the Wallarm US Cloud"
```bash
docker run -d -e WALLARM_API_TOKEN=${WALLARM_API_TOKEN} -e WALLARM_LABELS='group=<GROUP>' -e NGINX_BACKEND=<HOST_TO_PROTECT_WITH_WALLARM> -e WALLARM_API_HOST='us1.api.wallarm.com' -p 80:80 wallarm/node:4.10.9-1
docker run -d -e WALLARM_API_TOKEN=${WALLARM_API_TOKEN} -e WALLARM_LABELS='group=<GROUP>' -e NGINX_BACKEND=<HOST_TO_PROTECT_WITH_WALLARM> -e WALLARM_API_HOST='us1.api.wallarm.com' -p 80:80 wallarm/node:5.0.1-1
```
=== "Command for the Wallarm EU Cloud"
```bash
docker run -d -e WALLARM_API_TOKEN=${WALLARM_API_TOKEN} -e WALLARM_LABELS='group=<GROUP>' -e NGINX_BACKEND=<HOST_TO_PROTECT_WITH_WALLARM> -p 80:80 wallarm/node:4.10.9-1
docker run -d -e WALLARM_API_TOKEN=${WALLARM_API_TOKEN} -e WALLARM_LABELS='group=<GROUP>' -e NGINX_BACKEND=<HOST_TO_PROTECT_WITH_WALLARM> -p 80:80 wallarm/node:5.0.1-1
```

* `-p`: port the filtering node listens to. The value should be the same as the instance port.
Expand Down Expand Up @@ -117,11 +117,11 @@ To deploy the containerized Wallarm filtering node configured through environmen

=== "Command for the Wallarm US Cloud"
```bash
docker run -d -e WALLARM_API_TOKEN=${WALLARM_API_TOKEN} -e WALLARM_LABELS='group=<GROUP>' -e WALLARM_API_HOST='us1.api.wallarm.com' -v <INSTANCE_PATH_TO_CONFIG>:<DIRECTORY_FOR_MOUNTING> -p 80:80 wallarm/node:4.10.9-1
docker run -d -e WALLARM_API_TOKEN=${WALLARM_API_TOKEN} -e WALLARM_LABELS='group=<GROUP>' -e WALLARM_API_HOST='us1.api.wallarm.com' -v <INSTANCE_PATH_TO_CONFIG>:<DIRECTORY_FOR_MOUNTING> -p 80:80 wallarm/node:5.0.1-1
```
=== "Command for the Wallarm EU Cloud"
```bash
docker run -d -e WALLARM_API_TOKEN=${WALLARM_API_TOKEN} -e WALLARM_LABELS='group=<GROUP>' -v <INSTANCE_PATH_TO_CONFIG>:<CONTAINER_PATH_FOR_MOUNTING> -p 80:80 wallarm/node:4.10.9-1
docker run -d -e WALLARM_API_TOKEN=${WALLARM_API_TOKEN} -e WALLARM_LABELS='group=<GROUP>' -v <INSTANCE_PATH_TO_CONFIG>:<CONTAINER_PATH_FOR_MOUNTING> -p 80:80 wallarm/node:5.0.1-1
```

* `<INSTANCE_PATH_TO_CONFIG>`: path to the configuration file created in the previous step. For example, `configs`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ To deploy the containerized Wallarm filtering node configured only through envir
}
],
"name": "wallarm-container",
"image": "registry-1.docker.io/wallarm/node:4.10.9-1"
"image": "registry-1.docker.io/wallarm/node:5.0.1-1"
}
],
"family": "wallarm-api-security-node"
Expand Down Expand Up @@ -128,7 +128,7 @@ To deploy the containerized Wallarm filtering node configured only through envir
}
],
"name": "wallarm-container",
"image": "registry-1.docker.io/wallarm/node:4.10.9-1"
"image": "registry-1.docker.io/wallarm/node:5.0.1-1"
}
],
"family": "wallarm-api-security-node"
Expand Down Expand Up @@ -262,7 +262,7 @@ To deploy the container with environment variables and configuration file mounte
}
],
"name": "wallarm-container",
"image": "registry-1.docker.io/wallarm/node:4.10.9-1"
"image": "registry-1.docker.io/wallarm/node:5.0.1-1"
}
],
"volumes": [
Expand Down Expand Up @@ -311,7 +311,7 @@ To deploy the container with environment variables and configuration file mounte
}
],
"name": "wallarm-container",
"image": "registry-1.docker.io/wallarm/node:4.10.9-1"
"image": "registry-1.docker.io/wallarm/node:5.0.1-1"
}
],
"volumes": [
Expand Down
Loading

0 comments on commit 4b005d7

Please sign in to comment.