コンテンツにスキップ

Alibaba CloudへのWallarm Docker画像のデプロイ

このクイックガイドでは、NGINXベースのWallarmノードのDocker画像Alibaba Cloud Elastic Compute Service (ECS)を使用してAlibaba Cloudプラットフォームにデプロイする手順を説明します。

手順の制限事項

本手順では、ロードバランシングやノードの自動スケーリングの構成については扱っておりません。これらのコンポーネントをご自身で設定する場合は、適切なAlibaba Cloudのドキュメントをお読みになることを推奨します。

ユースケース

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.

必要条件

  • Alibaba Cloud Consoleへのアクセス

  • US CloudまたはEU CloudのWallarm ConsoleでAdministratorロールが与えられており、二要素認証が無効化されたアカウントへのアクセス

  • 下記のIPアドレスへ、攻撃検出ルールおよびAPI仕様のアップデートのダウンロード、ならびにallowlisted, denylisted, or graylistedの国、地域、またはデータセンターの正確なIP取得のためのアクセス

    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
    

WallarmノードDockerコンテナの構成オプション

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.

環境変数によって構成されたWallarmノードDockerコンテナのデプロイ

環境変数のみで構成されたコンテナ化されたWallarmフィルタリングノードをデプロイするには、Alibaba Cloudインスタンスを作成し、このインスタンス上でDockerコンテナを実行します。これらの手順はAlibaba Cloud ConsoleまたはAlibaba Cloud CLIを使用して実行できます。本手順ではAlibaba Cloud Consoleを使用します。

  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を開き、サービス一覧からElastic Compute ServiceInstancesに進みます。

  3. 以下のガイドラインおよびAlibaba Cloudの手順に従ってインスタンスを作成します:

    • インスタンスは、任意のオペレーティングシステムのイメージに基づいて構築可能です。
    • インスタンスは外部リソースからアクセス可能である必要があるため、パブリックIPアドレスまたはドメインがインスタンス設定に構成される必要があります。
    • インスタンス設定は、インスタンスに接続するために使用される方法を反映する必要があります。
  4. Alibaba Cloudのドキュメントに記載されているいずれかの方法でインスタンスに接続します。

  5. 該当するオペレーティングシステムの手順に従って、インスタンスにDockerパッケージをインストールします。

  6. Wallarm Cloudにインスタンスを接続するために使用する、コピー済みのWallarmトークンを使用してインスタンスの環境変数を設定します:

    export WALLARM_API_TOKEN='<WALLARM_API_TOKEN>'
    
  7. 環境変数を渡し、構成ファイルをマウントして、docker runコマンドを使用してWallarmノードDockerコンテナを実行します:

    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.3.0
    
    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.3.0
    
    • -p: フィルタリングノードがリッスンするポートです。値はインスタンスのポートと同じである必要があります。
    • -e: フィルタリングノードの構成を含む環境変数です(使用可能な変数は以下の表に記載されています)。なお、WALLARM_API_TOKENの値を明示的に渡すことは推奨されません。

      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
  8. フィルタリングノードの稼働確認を行います。

構成ファイルをマウントして構成されたWallarmノードDockerコンテナのデプロイ

環境変数および構成ファイルのマウントによって構成されたコンテナ化されたWallarmフィルタリングノードをデプロイするには、Alibaba Cloudインスタンスを作成し、このインスタンスのファイルシステム上にフィルタリングノードの構成ファイルを配置した上で、インスタンス上でDockerコンテナを実行します。これらの手順はAlibaba Cloud ConsoleまたはAlibaba Cloud CLIを使用して実行できます。本手順ではAlibaba Cloud Consoleを使用します。

  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を開き、サービス一覧からElastic Compute ServiceInstancesに進みます。

  3. 以下のガイドラインおよびAlibaba Cloudの手順に従ってインスタンスを作成します:

    • インスタンスは、任意のオペレーティングシステムのイメージに基づいて構築可能です。
    • インスタンスは外部リソースからアクセス可能である必要があるため、パブリックIPアドレスまたはドメインがインスタンス設定に構成される必要があります。
    • インスタンス設定は、インスタンスに接続するために使用される方法を反映する必要があります。
  4. Alibaba Cloudのドキュメントに記載されているいずれかの方法でインスタンスに接続します。

  5. 該当するオペレーティングシステムの手順に従って、インスタンスにDockerパッケージをインストールします。

  6. Wallarm Cloudにインスタンスを接続するために使用する、コピー済みのWallarmトークンを使用してインスタンスの環境変数を設定します:

    export WALLARM_API_TOKEN='<WALLARM_API_TOKEN>'
    
  7. インスタンス内で、フィルタリングノードの構成を含むdefaultファイルを配置したディレクトリを作成します(例:ディレクトリ名をconfigsとします)。最小限の設定を記述したファイルの例は以下の通りです:

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

    構成ファイルに指定可能なフィルタリングノードディレクティブのセット →

  8. 環境変数を渡し、構成ファイルをマウントしてdocker runコマンドを使用し、WallarmノードDockerコンテナを実行します:

    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.3.0
    
    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.3.0
    
    • <INSTANCE_PATH_TO_CONFIG>: 前の手順で作成した構成ファイルのパスです。例:configs
    • <DIRECTORY_FOR_MOUNTING>: コンテナ内で構成ファイルをマウントするディレクトリです。構成ファイルはNGINXが使用する以下のコンテナディレクトリにマウントできます:

      • /etc/nginx/conf.d — 共通設定
      • /etc/nginx/sites-enabled — 仮想ホスト設定
      • /var/www/html — 静的ファイル

      フィルタリングノードディレクティブは、/etc/nginx/sites-enabled/defaultファイルに記述する必要があります。

    • -p: フィルタリングノードがリッスンするポートです。値はインスタンスのポートと同じである必要があります。

    • -e: フィルタリングノードの構成を含む環境変数です(使用可能な変数は以下の表に記載されています)。なお、WALLARM_API_TOKENの値を明示的に渡すことは推奨されません。

      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
  9. フィルタリングノードの稼働確認を行います。

フィルタリングノードの稼働確認

  1. Alibaba Cloud Consoleを開き、サービス一覧からElastic Compute ServiceInstancesに進み、IP address欄からインスタンスのパブリックIPアドレスをコピーします。

    Settig up container instance

    もしIPアドレスが空の場合は、インスタンスがRunning状態であることをご確認ください。

  2. コピーしたアドレスに対して、テストのPath Traversal攻撃のリクエストを送信します:

    curl http://<COPIED_IP>/etc/passwd
    
  3. Wallarm ConsoleのUS CloudまたはEU CloudAttacksにアクセスし、攻撃がリストに表示されていることを確認します。
    Attacks in UI

コンテナのデプロイ中に発生したエラーの詳細を表示するには、Alibaba Cloudのドキュメントに記載されているいずれかの方法でインスタンスに接続し、コンテナログを確認してください。インスタンスが利用できない場合は、必要なフィルタリングノードパラメータが正しい値でコンテナに渡されていることをご確認ください。