Ana içeriğe geç

Wallarm Docker İmajının Alibaba Cloud’a Dağıtımı

Bu hızlı kılavuz, NGINX tabanlı Wallarm düğümünün Docker imajını Alibaba Cloud Elastic Compute Service (ECS) platformuna dağıtma adımlarını sağlar.

Talimatların sınırlamaları

Bu talimatlar, yük dengeleme ve düğüm otomatik ölçeklendirme yapılandırmasını kapsamaz. Bu bileşenleri kendiniz kuracaksanız, ilgili Alibaba Cloud dokümantasyonunu okumanızı öneririz.

Kullanım senaryoları

Among all supported Wallarm deployment options, Wallarm deployment on Alibaba Cloud ECS using the Docker image is recommended in these use cases:

  • If your applications leverage a microservices architecture, and are already containerized and operational on Alibaba Cloud ECS.

  • 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.

Gereksinimler

  • Alibaba Cloud Console erişimi

  • Wallarm Console’da US Cloud veya EU Cloud için Administrator rolüne sahip hesaba erişim

  • Saldırı tespit kuralları ve API spesifikasyonları güncellemelerini indirmek, ayrıca allowlist’e, denylist’e veya graylist’e alınmış ülkeleriniz, bölgeleriniz veya veri merkezleriniz için kesin IP’leri almak amacıyla aşağıdaki IP adreslerine erişim

    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
    
    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
    

Wallarm düğümü Docker konteyneri yapılandırma seçenekleri

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.

Ortam değişkenleri ile yapılandırılmış Wallarm düğümü Docker konteynerini dağıtma

Yalnızca ortam değişkenleri ile yapılandırılmış konteynerleştirilmiş Wallarm filtreleme düğümünü dağıtmak için Alibaba Cloud örneğini oluşturmanız ve bu örnekte Docker konteynerini çalıştırmanız gerekir. Bu adımları Alibaba Cloud Console veya Alibaba Cloud CLI üzerinden gerçekleştirebilirsiniz. Bu talimatta Alibaba Cloud Console kullanılmıştır.

  1. Get Wallarm token of the appropriate type:

    1. Open Wallarm Console → SettingsAPI 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.
  2. Alibaba Cloud Console’u açın → servis listesi → Elastic Compute ServiceInstances.

  3. Örneği Alibaba Cloud talimatlarını ve aşağıdaki yönergeleri izleyerek oluşturun:

    • Örnek, herhangi bir işletim sistemi imajına dayanabilir.
    • Örnek harici kaynaklar tarafından erişilebilir olacağından, örnek ayarlarında public IP address veya alan adı yapılandırılmalıdır.
    • Örnek ayarları, örneğe bağlanmak için kullanılan yöntemi yansıtmalıdır.
  4. Alibaba Cloud dokümantasyonunda açıklanan yöntemlerden biriyle örneğe bağlanın.

  5. Örnek üzerinde uygun işletim sistemi için talimatları izleyerek Docker paketlerini kurun.

  6. Örneği Wallarm Cloud’a bağlamak için kullanılacak kopyalanmış Wallarm jetonuyla örnek ortam değişkenini ayarlayın:

    export WALLARM_API_TOKEN='<WALLARM_API_TOKEN>'
    
  7. Geçilen ortam değişkenleri ve bağlanmış yapılandırma dosyası ile docker run komutunu kullanarak Wallarm düğümü Docker konteynerini çalıştırın:

    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:6.5.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:6.5.1
    
    • -p: filtreleme düğümünün dinlediği bağlantı noktası. Değer, örneğin bağlantı noktasıyla aynı olmalıdır.
    • -e: filtreleme düğümü yapılandırmasına ait ortam değişkenleri (kullanılabilir değişkenler aşağıdaki tabloda listelenmiştir). Lütfen WALLARM_API_TOKEN değerinin açıkça iletilmesi önerilmez.

      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) Amount of memory allocated to wstore. The value can be a float (a dot . is a decimal separator). By default: 1.0 (1 gygabyte).
      Note that when passing this variable in Docker run command with the -e, the variable is not recorded in any configuration file within the container, but it is still used when wstore starts.
      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
      APIFW_METRICS_ENABLED (6.4.1 and higher) Enables Prometheus metrics for the API Specification Enforcement module.
      By default: false (disabled).
      No
      APIFW_METRICS_HOST (6.4.1 and higher) Defines the host and port on which the API Specification Enforcement exposes metrics.
      By default: :9010.
      No
      APIFW_METRICS_ENDPOINT_NAME (6.4.1 and higher) Defines the HTTP path of the API Specification Enforcement metrics endpoint
      By default: metrics.
      No
      WALLARM_WSTORE__METRICS__LISTEN_ADDRESS Defines the host and port on which [Postanalytics and general system metrics][wstore-metrics] are exposed.
      By default: http://localhost:9001/metrics.
      No
      WALLARM_WSTORE__SERVICE__PROTOCOL (6.6.0 and higher) Specifies the protocol family that wstore uses for incoming connections. Possible values:
      • "tcp" - dual-stack mode (listens on both IPv4 and IPv6)
      • "tcp4" - IPv4 only
      • "tcp6" - IPv6 only
      By default: "tcp4".
      No
  8. Filtreleme düğümünün çalışmasını test edin.

Bağlanmış dosya ile yapılandırılmış Wallarm düğümü Docker konteynerini dağıtma

Ortam değişkenleri ve bağlanmış dosya ile yapılandırılmış konteynerleştirilmiş Wallarm filtreleme düğümünü dağıtmak için Alibaba Cloud örneğini oluşturmanız, filtreleme düğümü yapılandırma dosyasını bu örneğin dosya sistemine yerleştirmeniz ve Docker konteynerini bu örnek üzerinde çalıştırmanız gerekir. Bu adımları Alibaba Cloud Console veya Alibaba Cloud CLI üzerinden gerçekleştirebilirsiniz. Bu talimatta Alibaba Cloud Console kullanılmıştır.

  1. Get Wallarm token of the appropriate type:

    1. Open Wallarm Console → SettingsAPI 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.
  2. Alibaba Cloud Console’u açın → servis listesi → Elastic Compute ServiceInstances.

  3. Örneği Alibaba Cloud talimatlarını ve aşağıdaki yönergeleri izleyerek oluşturun:

    • Örnek, herhangi bir işletim sistemi imajına dayanabilir.
    • Örnek harici kaynaklar tarafından erişilebilir olacağından, örnek ayarlarında public IP address veya alan adı yapılandırılmalıdır.
    • Örnek ayarları, örneğe bağlanmak için kullanılan yöntemi yansıtmalıdır.
  4. Alibaba Cloud dokümantasyonunda açıklanan yöntemlerden biriyle örneğe bağlanın.

  5. Örnek üzerinde uygun işletim sistemi için talimatları izleyerek Docker paketlerini kurun.

  6. Örneği Wallarm Cloud’a bağlamak için kullanılacak kopyalanmış Wallarm jetonuyla örnek ortam değişkenini ayarlayın:

    export WALLARM_API_TOKEN='<WALLARM_API_TOKEN>'
    
  7. Örnek içinde, filtreleme düğümü yapılandırmasını içeren default dosyasına sahip bir dizin oluşturun (örneğin dizin adı configs olabilir). Asgari ayarlara sahip dosya örneği:

    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;
        # wallarm_application 1;
    
        location / {
                proxy_pass http://example.com;
                include proxy_params;
        }
    }
    

    Yapılandırma dosyasında belirtilebilecek filtreleme düğümü direktifleri seti →

  8. Geçilen ortam değişkenleri ve bağlanmış yapılandırma dosyası ile docker run komutunu kullanarak Wallarm düğümü Docker konteynerini çalıştırın:

    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:6.5.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:6.5.1
    
    • <INSTANCE_PATH_TO_CONFIG>: önceki adımda oluşturulan yapılandırma dosyasının yolu. Örneğin, configs.
    • <DIRECTORY_FOR_MOUNTING>: yapılandırma dosyasının bağlanacağı konteyner dizini. Yapılandırma dosyaları NGINX tarafından kullanılan aşağıdaki konteyner dizinlerine bağlanabilir:

      • /etc/nginx/conf.d — genel ayarlar
      • /etc/nginx/http.d — sanal host ayarları
      • /var/www/html — statik dosyalar

      Filtreleme düğümü direktifleri /etc/nginx/http.d/default.conf dosyasında tanımlanmalıdır.

    • -p: filtreleme düğümünün dinlediği bağlantı noktası. Değer, örneğin bağlantı noktasıyla aynı olmalıdır.

    • -e: filtreleme düğümü yapılandırmasına ait ortam değişkenleri (kullanılabilir değişkenler aşağıdaki tabloda listelenmiştir). Lütfen WALLARM_API_TOKEN değerinin açıkça iletilmesi önerilmez.

      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) 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
      APIFW_METRICS_ENABLED (6.4.1 and higher) Enables Prometheus metrics for the API Specification Enforcement module.
      By default: false (disabled).
      No
      APIFW_METRICS_HOST (6.4.1 and higher) Defines the host and port on which the API Specification Enforcement exposes metrics.
      By default: :9010.
      No
      APIFW_METRICS_ENDPOINT_NAME (6.4.1 and higher) Defines the HTTP path of the API Specification Enforcement metrics endpoint
      By default: metrics.
      No
      WALLARM_WSTORE__METRICS__LISTEN_ADDRESS Defines the host and port on which [Postanalytics and general system metrics][wstore-metrics-mount] are exposed.
      By default: http://localhost:9001/metrics.
      No
      WALLARM_WSTORE__SERVICE__PROTOCOL (6.6.0 and higher) Specifies the protocol family that wstore uses for incoming connections. Possible values:
      • "tcp" - dual-stack mode (listens on both IPv4 and IPv6)
      • "tcp4" - IPv4 only
      • "tcp6" - IPv6 only
      By default: "tcp4".
      No
  9. Filtreleme düğümünün çalışmasını test edin.

Filtreleme düğümünün çalışmasını test etme

  1. Alibaba Cloud Console’u açın → servis listesi → Elastic Compute ServiceInstances ve IP address sütunundan örneğin public IP address değerini kopyalayın.

    Kapsayıcı örneğini ayarlama

    IP address boş ise, lütfen örneğin Running durumda olduğundan emin olun.

  2. Kopyalanan adrese test Path Traversal saldırısı isteğini gönderin:

    curl http://<COPIED_IP>/etc/passwd
    
  3. Wallarm Console’u açın → Attacks bölümüne gidin; US Cloud veya EU Cloud içinde saldırının listede göründüğünden emin olun.
    UI'de Attacks

  4. İsteğe bağlı olarak, düğümün çalışmasının diğer yönlerini test edin.

Konteyner dağıtımı sırasında oluşan hatalara ilişkin ayrıntıları görüntülemek için lütfen yöntemlerden biriyle örneğe bağlanın ve konteyner günlüklerini inceleyin. Örnek erişilemiyorsa, gerekli filtreleme düğümü parametrelerinin doğru değerlerle konteynere iletildiğinden emin olun.