# Deploying NGINX Ingress Controller with Integrated Wallarm Services These instructions provide you with the steps to deploy the Wallarm NGINX-based Ingress controller to your K8s cluster. The solution is deployed from the Wallarm Helm chart. The solution is built on the [Community Ingress NGINX Controller](https://github.com/kubernetes/ingress-nginx) with integrated Wallarm services. The latest version uses Community Ingress NGINX Controller 1.11.5 with NGINX stable 1.25.5. !!! warning The Kubernetes community will [retire the Community Ingress NGINX in March 2026](https://blog.nginx.org/blog/the-ingress-nginx-alternative-open-source-nginx-ingress-controller-for-the-long-term). The Wallarm NGINX Ingress Controller based on this project will be supported through the same date. You can continue using it until then, and it will remain fully functional during the support window. Wallarm will provide alternative deployment options and migration guidance as they become available. [Details](https://docs.wallarm.com/5.x/updating-migrating/nginx-ingress-retirement.md) An [Envoy/Istio-based connector](https://docs.wallarm.com/5.x/installation/connectors/istio.md) is also available today for environments already using Envoy. It has the following architecture: ![Solution architecture](https://docs.wallarm.com/5.x/images/waf-installation/kubernetes/nginx-ingress-controller.png) ## Use cases Among all supported [Wallarm deployment options](https://docs.wallarm.com/5.x/installation/supported-deployment-options.md), this solution is the recommended one for the following **use cases**: * There is no Ingress controller and security layer routing traffic to Ingress resources compatible with [Community Ingress NGINX Controller](https://github.com/kubernetes/ingress-nginx). * You are currently using the Community Ingress NGINX Controller and are in search of a security solution that offers both the standard controller functionality and enhanced security features. In this case, you can effortlessly switch to the Wallarm-NGINX Ingress Controller detailed in these instructions. Simply migrate your existing configuration to a new deployment to complete the replacement. For simultaneous use of both the existing Ingress controller and the Wallarm controller, refer to the [Ingress Controller chaining guide](https://docs.wallarm.com/5.x/admin-en/chaining-wallarm-and-other-ingress-controllers.md) for configuration details. ## Requirements * Kubernetes platform version 1.26-1.30 * [Helm](https://helm.sh/) package manager * Compatibility of your services with the [Community Ingress NGINX Controller](https://github.com/kubernetes/ingress-nginx) version 1.11.8 * Access to the account with the **Administrator** role in Wallarm Console for the [US Cloud](https://us1.my.wallarm.com/) or [EU Cloud](https://my.wallarm.com/), or [ME Cloud](https://me1.my.wallarm.com/) * Access to the Wallarm API host for your Cloud: `https://us1.api.wallarm.com`, `https://api.wallarm.com`, or `https://me1.api.wallarm.com` * Access to `https://charts.wallarm.com` to add the Wallarm Helm charts. Ensure the access is not blocked by a firewall * Access to the Wallarm repositories on Docker Hub `https://hub.docker.com/r/wallarm`. Make sure the access is not blocked by a firewall * Access to the IP addresses and their corresponding hostnames (if any) listed below. This is needed for downloading updates to attack detection rules and [API specifications](https://docs.wallarm.com/5.x/api-specification-enforcement/overview.md), as well as retrieving precise IPs for your [allowlisted, denylisted, or graylisted](https://docs.wallarm.com/5.x/user-guides/ip-lists/overview.md) countries, regions, or data centers **US Cloud:** ``` node-data0.us1.wallarm.com - 34.96.64.17 node-data1.us1.wallarm.com - 34.110.183.149 us1.api.wallarm.com - 35.235.66.155 34.102.90.100 34.94.156.115 35.235.115.105 ``` **EU Cloud:** ``` node-data1.eu1.wallarm.com - 34.160.38.183 node-data0.eu1.wallarm.com - 34.144.227.90 api.wallarm.com - 34.90.110.226 ``` **ME Cloud:** ``` node-data0.me1.wallarm.com - 34.166.82.208 node-data1.me1.wallarm.com - 34.166.82.208 me1.api.wallarm.com - 34.166.82.208 ``` !!! info "See also" * [What is Ingress?](https://kubernetes.io/docs/concepts/services-networking/ingress/) * [Installation of Helm](https://helm.sh/docs/intro/install/) ## Known restrictions * Operation without the postanalytics module is not supported. * Scaling down postanalytics module may result in a partial loss of attack data. ## Installation 1. [Install](#step-1-installing-the-wallarm-ingress-controller) the Wallarm Ingress controller. 2. [Enable](#step-2-enabling-traffic-analysis-for-your-ingress) traffic analysis for your Ingress. 3. [Check](#step-3-checking-the-wallarm-ingress-controller-operation) the Wallarm Ingress controller operation. ### Step 1: Installing the Wallarm Ingress Controller To install the Wallarm Ingress Controller: 1. Generate a filtering node token of the [appropriate type](https://docs.wallarm.com/5.x/user-guides/nodes/nodes.md#api-and-node-tokens-for-node-creation): **API token (Helm chart 4.6.8 and above):** 1. Open Wallarm Console → **Settings** → **API tokens** in the [US Cloud](https://us1.my.wallarm.com/settings/api-tokens) or [EU Cloud](https://my.wallarm.com/settings/api-tokens), or [ME Cloud](https://me1.my.wallarm.com/settings/api-tokens). 1. Find or create API token with the `Node deployment/Deployment` usage type. 1. Copy this token. **Node token:** 1. Open Wallarm Console → **Nodes** in either the [US Cloud](https://us1.my.wallarm.com/nodes) or [EU Cloud](https://my.wallarm.com/nodes), or [ME Cloud](https://me1.my.wallarm.com/nodes). 1. Create a filtering node with the **Wallarm node** type and copy the generated token. ![Creation of a Wallarm node](https://docs.wallarm.com/5.x/images/user-guides/nodes/create-wallarm-node-name-specified.png) 1. Create a Kubernetes namespace to deploy the Helm chart with the Wallarm Ingress controller: ```bash kubectl create namespace ``` 1. Add the [Wallarm chart repository](https://charts.wallarm.com/): ``` helm repo add wallarm https://charts.wallarm.com helm repo update wallarm ``` 1. Create the `values.yaml` file with the [Wallarm configuration](https://docs.wallarm.com/5.x/admin-en/configure-kubernetes-en.md). Example of the file with the minimum configuration is below. When using an API token, specify a node group name in the `nodeGroup` parameter. Your node will be assigned to this group, shown in the Wallarm Console's **Nodes** section. The default group name is `defaultIngressGroup`. **US Cloud:** ```yaml controller: wallarm: enabled: "true" token: "" apiHost: "us1.api.wallarm.com" # nodeGroup: defaultIngressGroup ``` **EU Cloud:** ```yaml controller: wallarm: enabled: "true" token: "" # nodeGroup: defaultIngressGroup ``` **ME Cloud:** ```yaml controller: wallarm: enabled: "true" token: "" apiHost: "me1.api.wallarm.com" # nodeGroup: defaultIngressGroup ``` You can also store the Wallarm node token in Kubernetes secrets and pull it to the Helm chart. [Read more](https://docs.wallarm.com/5.x/admin-en/configure-kubernetes-en.md#controllerwallarmexistingsecret) !!! info "Deployment from your own registries" You can overwrite elements of the `values.yaml` file to install the Wallarm Ingress controller from the images stored [in your own registries](#deployment-from-your-own-registries). 1. Install the Wallarm packages: ``` bash helm install --version 5.3.18 wallarm/wallarm-ingress -n -f ``` * `` is the name for the Helm release of the Ingress controller chart * `` is the Kubernetes namespace you have created for the Helm chart with the Wallarm Ingress controller * `` is the path to the `values.yaml` file ### Step 2: Enabling traffic analysis for your Ingress ``` bash kubectl annotate ingress -n nginx.ingress.kubernetes.io/wallarm-mode=monitoring kubectl annotate ingress -n nginx.ingress.kubernetes.io/wallarm-application="" ``` * `` is the name of your Ingress * `` is the namespace of your Ingress * `` is a positive number that is unique to each of [your applications or application groups](https://docs.wallarm.com/5.x/user-guides/settings/applications.md). This will allow you to obtain separate statistics and to distinguish between attacks aimed at the corresponding applications ### Step 3: Checking the Wallarm Ingress Controller operation 1. Get the list of pods: ``` kubectl get pods -n -l app.kubernetes.io/name=wallarm-ingress ``` Each pod should display the following: **STATUS: Running** and **READY: N/N**. For example: ``` NAME READY STATUS RESTARTS AGE ingress-controller-nginx-ingress-controller-675c68d46d-cfck8 3/3 Running 0 5m ingress-controller-nginx-ingress-controller-wallarm-tarantljj8g 4/4 Running 0 5m ``` 2. Send the request with the test [Path Traversal](https://docs.wallarm.com/5.x/attacks-vulns-list.md#path-traversal) attack to the Ingress Controller Service: ```bash curl http:///etc/passwd ``` If the filtering node is working in the `block` mode, the code `403 Forbidden` will be returned in the response to the request and the attack will be displayed in Wallarm Console → **Attacks**. ## ARM64 deployment With the NGINX Ingress controller's Helm chart version 4.8.2, ARM64 processor compatibility is introduced. Initially set for x86 architectures, deploying on ARM64 nodes involves modifying the Helm chart parameters. In ARM64 settings, Kubernetes nodes often carry an `arm64` label. To assist the Kubernetes scheduler in allocating the Wallarm workload to the appropriate node type, reference this label using `nodeSelector`, `tolerations`, or affinity rules in the Wallarm Helm chart configuration. Below is the Wallarm Helm chart example for Google Kubernetes Engine (GKE), which uses the `kubernetes.io/arch: arm64` label for relevant nodes. This template is modifiable for compatibility with other cloud setups, respecting their ARM64 labeling conventions. **nodeSelector:** ```yaml controller: nodeSelector: kubernetes.io/arch: arm64 admissionWebhooks: nodeSelector: kubernetes.io/arch: arm64 patch: nodeSelector: kubernetes.io/arch: arm64 wallarm: tarantool: nodeSelector: kubernetes.io/arch: arm64 enabled: true token: "" apiHost: "us1.api.wallarm.com" # if using EU Cloud, comment out this line; if using ME Cloud, set to "me1.api.wallarm.com" # If using an API token, uncomment the following line and specify your node group name # nodeGroup: defaultIngressGroup ``` **tolerations:** ```yaml controller: tolerations: - key: kubernetes.io/arch operator: Equal value: arm64 effect: NoSchedule admissionWebhooks: patch: tolerations: - key: kubernetes.io/arch operator: Equal value: arm64 effect: NoSchedule wallarm: tarantool: tolerations: - key: kubernetes.io/arch operator: Equal value: arm64 effect: NoSchedule enabled: true token: "" apiHost: "us1.api.wallarm.com" # if using EU Cloud, comment out this line; if using ME Cloud, set to "me1.api.wallarm.com" # If using an API token, uncomment the following line and specify your node group name # nodeGroup: defaultIngressGroup ``` ## Deployment from your own registries If you cannot pull the Docker images from the Wallarm public repository due to some reasons, for example because you company security policy restricts usage of any external resources, instead you can: 1. Clone these images to your private registry. 1. Install Wallarm NGINX-based Ingress controller using them. The following Docker images are used by the Helm chart for NGINX-based Ingress Controller deployment: * [wallarm/ingress-controller](https://hub.docker.com/r/wallarm/ingress-controller) * [wallarm/node-helpers](https://hub.docker.com/r/wallarm/node-helpers) To install Wallarm NGINX-based Ingress controller using images stored in your registry, overwrite the `values.yaml` file of Wallarm Ingress controller Helm chart: ```yaml controller: image: ## The image and tag for wallarm nginx ingress controller ## registry: image: wallarm/ingress-controller tag: wallarm: helpers: ## The image and tag for the helper image ## image: /wallarm/node-helpers tag: ``` Then run installation using your modified `values.yaml`. ## Configuration After the Wallarm Ingress controller is successfully installed and checked, you can make advanced configurations to the solution such as: * [Proper reporting of end user public IP address](https://docs.wallarm.com/5.x/admin-en/configuration-guides/wallarm-ingress-controller/best-practices/report-public-user-ip.md) * [Management of IP addresses blocking](https://docs.wallarm.com/5.x/user-guides/ip-lists/overview.md) * [High availability considerations](https://docs.wallarm.com/5.x/admin-en/configuration-guides/wallarm-ingress-controller/best-practices/high-availability-considerations.md) * [Ingress Controller monitoring](https://docs.wallarm.com/5.x/admin-en/configuration-guides/wallarm-ingress-controller/best-practices/ingress-controller-monitoring.md) To find parameters used for advanced configuration and appropriate instructions, please follow the [link](https://docs.wallarm.com/5.x/admin-en/configure-kubernetes-en.md).