تشغيل صورة Docker المبنية على NGINX¶

يمكن نشر عقدة التصفية المبنية على NGINX من Wallarm باستخدام صورة Docker. تدعم هذه العقدة أنظمة تشغيل المعالجات x86_64 وARM64، والتي يتم التعرف عليها تلقائيًا أثناء التثبيت. توفر هذه المقالة إرشادات حول كيفية تشغيل العقدة من صورة Docker.

حالات الاستخدام¶

Among all supported Wallarm deployment options, NGINX-based Docker image is recommended for Wallarm deployment in these use cases:

If your organization utilizes Docker-based infrastructure, Wallarm Docker image is the ideal choice. It integrates effortlessly into your existing setup, whether you are employing a microservice architecture running on AWS ECS, Alibaba ECS, or other similar services. This solution also applies to those using virtual machines seeking a more streamlined management through Docker containers.
If you require fine-grained control over each container, the Docker image excels. It affords a greater level of resource isolation than typically possible with traditional VM-based deployments.

For more information on running Wallarm's NGINX-based Docker image on popular public cloud container orchestration services, refer to our guides: AWS ECS, GCP GCE, Azure Container Instances, Alibaba ECS.

المتطلبات¶

Docker installed on your host system
Access to https://hub.docker.com/r/wallarm/node to download the Docker image. Please ensure the access is not blocked by a firewall
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
Access to the IP addresses below for downloading updates to attack detection rules, as well as retrieving precise IPs for your allowlisted, denylisted, or graylisted countries, regions, or data centers
US CloudEU Cloud
34.96.64.17 34.110.183.149 35.235.66.155 34.102.90.100 34.94.156.115 35.235.115.105
34.160.38.183 34.144.227.90 34.90.110.226

خيارات تشغيل الحاوية¶

The filtering node configuration parameters should be passed to the deployed Docker container in one of the following ways:

In the environment variables. This option allows for the configuration of only basic filtering node parameters. Most directives cannot be configured through environment variables.
In the mounted configuration file. This option allows full filtering node configuration via any directives. With this configuration method, environment variables with the filtering node and Wallarm Cloud connection settings are also passed to the container.

تشغيل الحاوية مع إرسال المتغيرات البيئية¶

لتشغيل الحاوية:

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 Node deployment/Deployment usage type.
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.

تشغيل الحاوية مع العقدة:

US CloudEU Cloud

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.4-1

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.4-1

يمكنك إرسال الإعدادات الأساسية لعقدة التصفية التالية إلى الحاوية عن طريق الخيار -e:

Environment variable	Description	Required
`WALLARM_API_TOKEN`	Wallarm node or API token.	Yes
`WALLARM_LABELS`	Available starting from node 4.6. Works only if `WALLARM_API_TOKEN` is set to API token with the `Deploy` role. Sets the `group` label for node instance grouping, for example: `WALLARM_LABELS="group=<GROUP>"` ...will place node instance into the `<GROUP>` instance group (existing, or, if does not exist, it will be created).	Yes (for API tokens)
`NGINX_BACKEND`	Domain or IP address of the resource to protect with the Wallarm solution.	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
`WALLARM_MODE`	Node mode: `block` to block malicious requests `safe_blocking` to block only those malicious requests originated from graylisted IP addresses `monitoring` to analyze but not block requests `off` to disable traffic analyzing and processing By default: `monitoring`. Detailed description of filtration modes →	No
`WALLARM_APPLICATION`	Unique identifier of the protected application to be used in the Wallarm Cloud. The value can be a positive integer except for `0`. Default value (if the variable is not passed to the container) is `-1` which indicates the default application displayed in Wallarm Console → Settings → Application. More details on setting up applications →	No
`SLAB_ALLOC_ARENA` (`TARANTOOL_MEMORY_GB` [NGINX Node 5.x and earlier][what-is-new-wstore])	Amount of memory allocated to wstore. The value can be a float (a dot `.` is a decimal separator). By default: 1.0 (1 gygabyte).	No
`NGINX_PORT`	Sets a port that NGINX will use inside the Docker container. Starting from the Docker image `4.0.2-1`, the `wallarm-status` service automatically runs on the same port as NGINX. Default value (if the variable is not passed to the container) is `80`. Syntax is `NGINX_PORT='443'`.	No
`WALLARM_STATUS_ALLOW`	Custom CIDRs that are allowed to access the `/wallarm-status` endpoint from outside the Docker container. Example value: `10.0.0.0/8`. If you need to pass several values, use a comma `,` as a separator. To access the service externally, use the Docker container's IP, specifying the `/wallarm-status` endpoint path.	No
`DISABLE_IPV6`	The variable with any value except for an empty one deletes the `listen [::]:80 default_server ipv6only=on;` line from the NGINX configuration file which will stop NGINX from IPv6 connection processing. If the variable is not specified explicitly or has an empty value `""`, NGINX processes both IPv6 and IPv4 connections.	No
`WALLARM_APIFW_ENABLE`	This setting toggles API Specification Enforcement on or off, available from release 4.10 onwards. Please note that activating this feature does not substitute for the required subscription and configuration through the Wallarm Console UI. Its default value is `true`, enabling the functionality.	No
`WALLARM_APID_ONLY` (5.3.7 and higher)	In this mode, attacks detected in your traffic are blocked locally by the node (if enabled) but not exported to Wallarm Cloud. Meanwhile, API Discovery and some other features remain fully functional, detecting your API inventory and uploading it to the Cloud for visualization. This mode is for those who want to review their API inventory and identify sensitive data first, and plan controlled attack data export accordingly. However, disabling attack export is rare, as Wallarm securely processes attack data and provides sensitive attack data masking if needed. More details By default: `false`.	No

تقوم الأمر بما يلي:

يُنشئ ملف default بإعدادات NGINX الدنيا ويمرر تكوين عقدة التصفية في دليل الحاوية /etc/nginx/sites-enabled.
يُنشئ ملفات بمعلومات اعتماد عقدة التصفية للوصول إلى سحابة Wallarm في دليل الحاوية /opt/wallarm/etc/wallarm:
- node.yaml بمعرف عقدة التصفية UUID ومفتاح السر
- private.key بمفتاح Wallarm الخاص
يحمي المورد http://NGINX_BACKEND:80.

تشغيل الحاوية مع تركيب ملف التكوين¶

يمكنك تركيب ملف التكوين المُحضر إلى الحاوية Docker عبر الخيار -v. يجب أن يحتوي الملف على الإعدادات التالية:

لتشغيل الحاوية:

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 Node deployment/Deployment usage type.
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.

تشغيل الحاوية مع العقدة:

US CloudEU Cloud

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.4-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:4.10.4-1

خيار -e يمرر المتغيرات البيئية المطلوبة التالية إلى الحاوية:

Environment variable	Description	Required
`WALLARM_API_TOKEN`	Wallarm node or API token.	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
`WALLARM_LABELS`	Available starting from node 4.6. Works only if `WALLARM_API_TOKEN` is set to API token with the `Deploy` role. Sets the `group` label for node instance grouping, for example: `WALLARM_LABELS="group=<GROUP>"` ...will place node instance into the `<GROUP>` instance group (existing, or, if does not exist, it will be created).	Yes (for API tokens)
`SLAB_ALLOC_ARENA` (`TARANTOOL_MEMORY_GB` [NGINX Node 5.x and earlier][what-is-new-wstore])	Amount of memory allocated to wstore. The value can be a float (a dot `.` is a decimal separator). By default: 1.0 (1 gygabyte).	No
`WALLARM_APID_ONLY` (5.3.7 and higher)	In this mode, attacks detected in your traffic are blocked locally by the node (if enabled) but not exported to Wallarm Cloud. Meanwhile, API Discovery and some other features remain fully functional, detecting your API inventory and uploading it to the Cloud for visualization. This mode is for those who want to review their API inventory and identify sensitive data first, and plan controlled attack data export accordingly. However, disabling attack export is rare, as Wallarm securely processes attack data and provides sensitive attack data masking if needed. More details By default: `false`.	No

خيار -v يركب الدليل بملف التكوين default إلى دليل الحاوية /etc/nginx/sites-enabled.
شاهد مثالاً على الملف المركب بالإعدادات الدنيا
```
server {
        listen 80 default_server;
        listen [::]:80 default_server ipv6only=on;
        #listen 443 ssl;

        server_name localhost;

        #ssl_certificate cert.pem;
        #ssl_certificate_key cert.key;

        root /usr/share/nginx/html;

        index index.html index.htm;

        wallarm_mode monitoring;

        location / {

                proxy_pass http://example.com;
                include proxy_params;
        }
}
```
تركيب ملفات تكوين أخرى

الدلائل التي يستخدمها NGINX في الحاوية:
- /etc/nginx/nginx.conf - هو ملف إعدادات NGINX الرئيسي. إذا قررت تركيب هذا الملف، خطوات إضافية ضرورية لإعدادات Wallarm الصحيحة:
  1. تركيب ملف /etc/nginx/conf.d/wallarm-status.conf، مع التأكد من مطابقة محتوياته لـالنموذج.
  2. ضمن ملفات تكوين NGINX، تعيين تكوين الخدمة /wallarm-status وفقًا لـالنموذج.
- /etc/nginx/conf.d — الإعدادات الشائعة
- /etc/nginx/sites-enabled — إعدادات الاستضافة الافتراضية
- /opt/wallarm/usr/share/nginx/html — الملفات الثابتة
إذا لزم الأمر، يمكنك تركيب أي ملفات إلى دلائل الحاوية المذكورة. يجب وصف توجيهات عقدة التصفية في ملف /etc/nginx/sites-enabled/default.

تقوم الأمر بما يلي:

يركب ملف default داخل دليل الحاوية /etc/nginx/sites-enabled.
يُنشئ ملفات بمعلومات اعتماد عقدة التصفية للوصول إلى سحابة Wallarm في دليل الحاوية /opt/wallarm/etc/wallarm:
- node.yaml بمعرف عقدة التصفية UUID ومفتاح السر
- private.key بمفتاح Wallarm الخاص
يحمي المورد http://example.com.

تكوين التسجيل¶

يكون التسجيل مُفعلاً بشكل افتراضي. دلائل التسجيل هي:

/var/log/nginx — سجلات NGINX
/opt/wallarm/var/log/wallarm — سجلات عقدة Wallarm

اختبار عمل عقدة Wallarm¶

Send the request with test Path Traversal attack to a protected resource address:
```
curl http://localhost/etc/passwd
```
If traffic is configured to be proxied to example.com, include the -H "Host: example.com" header in the request.
Open Wallarm Console → Attacks section in the US Cloud or EU Cloud and make sure the attack is displayed in the list.
Optionally, test other aspects of the node functioning.

تكوين حالات الاستخدام¶

يجب أن يصف ملف التكوين المركب إلى الحاوية Docker تكوين عقدة التصفية في التوجيهات المتاحة. فيما يلي بعض خيارات تكوين عقدة التصفية المُستخدمة بشكل شائع: