Перейти к содержанию

Деплой Docker‑образа WAF‑ноды в Яндекс.Облако

Данная инструкция содержит краткое руководство по деплою Docker‑образа WAF‑ноды (NGINX) с помощью облачной платформы Яндекс.Облако. Для деплоя Docker-образа используется сервис Yandex Container Solution.

Ограничение инструкции

В данной инструкции не описана конфигурация для балансировки нагрузки и автоматического масштабирования WAF‑нод. Чтобы выполнить конфигурацию самостоятельно, рекомендуем ознакомиться с документацией Яндекс.Облака.

Требования

Способы конфигурации Docker-контейнера с WAF-нодой

При деплое необходимо передать в Docker‑контейнер параметры WAF‑ноды одним из способов:

  • Через доступные переменные окружения. С помощью переменных окружения задаются базовые настройки WAF-ноды. Большинство доступных директив не могут быть переданы через переменные.

  • В примонтированном конфигурационном файле. С помощью конфигурационного файла можно выполнить полную настройку WAF-ноды, используя любые доступные директивы. При этом способе конфигурации параметры для подключения к Облаку Валарм передаются в переменных окружения.

Деплой контейнера с настройкой WAF-ноды через переменные окружения

Для деплоя контейнера с настройками WAF-ноды, переданными только в переменных окружения, вы можете использовать консоль управления Яндекс.Облаком или CLI. В данной инструкции используется CLI.

  1. Запишите данные от аккаунта Валарм в локальные переменные окружения, чтобы передать чувствительные данные в Яндекс.Облако более безопасным образом:

    export DEPLOY_USER='<DEPLOY_USER>'
    export DEPLOY_PASSWORD='<DEPLOY_PASSWORD>'
    
    • <DEPLOY_USER>: email для аккаунта пользователя Деплой или Администратор в Консоли управления Валарм.
    • <DEPLOY_PASSWORD>: пароль для аккаунта пользователя Деплой или Администратор в Консоли управления Валарм.
  2. Создайте инстанс с запущенным Docker-контейнером с помощью команды yc compute instance create-with-container:

    yc compute instance create-with-container \
        --name <INSTANCE_NAME> \
        --zone=<DEPLOYMENT_ZONE> \
        --public-ip \
        --container-image=wallarm/node:2.18.1-3 \
        --container-env=DEPLOY_USER=${DEPLOY_USER},DEPLOY_PASSWORD=${DEPLOY_PASSWORD},NGINX_BACKEND=<HOST_TO_PROTECT_WITH_WAF>
    
    yc compute instance create-with-container \
        --name <INSTANCE_NAME> \
        --zone=<DEPLOYMENT_ZONE> \
        --public-ip \
        --container-image=wallarm/node:2.18.1-3 \
        --container-env=DEPLOY_USER=${DEPLOY_USER},DEPLOY_PASSWORD=${DEPLOY_PASSWORD},NGINX_BACKEND=<HOST_TO_PROTECT_WITH_WAF>,WALLARM_API_HOST=api.wallarm.ru
    
    • --name: название инстанса, например: wallarm-waf.
    • --zone: зона, в которой будет запущен инстанс.
    • --public-ip: флаг, указывающий, что необходимо создать публичный IP-адрес для инстанса, чтобы он принимал запросы из внешних ресурсов.
    • --container-image: ссылка на Docker-образ с WAF-нодой.
    • --container-env: переменные окружения с настройками WAF-ноды из таблицы ниже. Не рекомендуется передавать значения переменных DEPLOY_USER и DEPLOY_PASSWORD в явном виде.

      Переменная окружения Описание Обязательная?
      DEPLOY_USER Email для аккаунта пользователя Деплой или Администратор в Консоли управления Валарм. Да
      DEPLOY_PASSWORD Пароль для аккаунта пользователя Деплой или Администратор в Консоли управления Валарм. Да
      NGINX_BACKEND Домен или IP‑адрес ресурса, который необходимо защитить с помощью WAF. Да
      WALLARM_API_HOST Адрес Валарм API:
      • api.wallarm.com для EU‑облака
      • api.wallarm.ru для RU‑облака
      По умолчанию: api.wallarm.com.
      Нет
      WALLARM_MODE Режим работы WAF‑ноды:
      • block, чтобы блокировать вредоносные запросы
      • monitoring, чтобы анализировать, но не блокировать запросы
      • off, чтобы не обрабатывать входящий трафик
      По умолчанию: monitoring.
      Нет
      TARANTOOL_MEMORY_GB Размер оперативной памяти для Tarantool в гигабайтах. Значение может быть целым или дробным (разделитель целой и дробной части — точка). По умолчанию: 0.2 гигабайта. Нет
      WALLARM_ACL_ENABLE Включает блокировку IP‑адресов с настройками по умолчанию. Принимает значения:
      • true, чтобы включить блокировку
      • false, чтобы отключить блокировку
      По умолчанию (если переменная не указана явно): false.
      Чтобы включить блокировку IP‑адресов с другими настройками, необходимо определить соответствующие директивы NGINX и запустить контейнер с примонтированным конфигурационным файлом.

      Значения on / enabled / ok / yes

      Начиная с образа WAF‑ноды 2.16.0-8, значения переменной on / enabled / ok / yes отключают блокировку по IP‑адресам. Мы рекомендуем использовать последнюю версию образа, указанную в данном документе, и передавать в переменной значение true или false.

      Нет
      DEPLOY_FORCE Заменяет существующую WAF‑ноду на новую, если название WAF‑ноды соответствует идентификатору контейнера, который вы запускаете. Принимает значения:
      • true, чтобы заменить WAF‑ноду
      • false, чтобы отключить замену WAF‑ноды
      По умолчанию (если переменная не указана явно): false.
      WAF‑ноде Валарм присваивается название, соответствующее идентификатору контейнера. Данная опция полезна, если идентификаторы Docker‑контейнеров в вашей среде статичные и вы повторно запускаете Docker‑контейнер с WAF‑нодой Валарм (например, с новой версией образа). Если в этом случае значение переменной равно false, процесс создания WAF‑ноды завершится с ошибкой.
      Нет
    • Описание всех параметров команды yc compute instance create-with-container приведено в документации Яндекс.Облака.

  3. Перейдите в консоль управления Яндекс.Облаком → Compute CloudVirtual machines и убедитесь, что инстанс появился в списке.

  4. Протестируйте работу WAF-ноды.

Деплой контейнера с настройкой WAF-ноды через примонтированный файл

Для деплоя контейнера с настройками WAF-ноды, переданными через переменные окружения и примонтированный конфигурационный файл, необходимо создать инстанс с конфигурационным файлом и запустить Docker-контейнер в этом же инстансе. Для этого вы можете использовать консоль управления Яндекс.Облаком или CLI. В данной инструкции используется консоль управления.

  1. Создайте инстанс на основе образа любой операционной системы по инструкции. Пример настроек инстанса:

    Настройка экземпляра контейнера

  2. Подключитесь к инстансу по SSH, используя инструкцию Яндекс.Облака.

  3. Установите в инстансе пакеты Docker по инструкции для подходящей ОС.

  4. Запишите данные от аккаунта Валарм в локальные переменные окружения инстанса:

    export DEPLOY_USER='<DEPLOY_USER>'
    export DEPLOY_PASSWORD='<DEPLOY_PASSWORD>'
    
    • <DEPLOY_USER>: email для аккаунта пользователя Деплой или Администратор в Консоли управления Валарм.
    • <DEPLOY_PASSWORD>: пароль для аккаунта пользователя Деплой или Администратор в Консоли управления Валарм.
  5. Создайте в инстансе директорию с конфигурационным файлом default с настройками WAF-ноды (например, директорию 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_instance 1;
        # wallarm_acl default;
    
        location / {
                proxy_pass http://example.com;
                include proxy_params;
        }
    }
    

    Набор директив, которые могут быть указаны в конфигурационном файле →

  6. Запустите Docker-контейнер с WAF-нодой с примонтированным конфигурационным файлом и переменными окружения.

    docker run -d -e DEPLOY_USER=${DEPLOY_USER} -e DEPLOY_PASSWORD=${DEPLOY_PASSWORD} -v <INSTANCE_PATH_TO_CONFIG>:<CONTAINER_PATH_FOR_MOUNTING> -p 80:80 wallarm/node:2.18.1-3
    
    docker run -d -e DEPLOY_USER=${DEPLOY_USER} -e DEPLOY_PASSWORD=${DEPLOY_PASSWORD} -e WALLARM_API_HOST='api.wallarm.ru' -v <INSTANCE_PATH_TO_CONFIG>:<DIRECTORY_FOR_MOUNTING> -p 80:80 wallarm/node:2.18.1-3
    
    • <INSTANCE_PATH_TO_CONFIG>: путь до конфигурационного файла, созданного на предыдущем шаге. Например: configs.
    • <DIRECTORY_FOR_MOUNTING>: директория контейнера, в которую монтируется конфигурационный файл. Конфигурационный файл может быть примонтирован в директории контейнера, которые использует NGINX:

      • /etc/nginx/conf.d — общие настройки
      • /etc/nginx/sites-enabled — настройки виртуальных хостов
      • /var/www/html — статические файлы

      Директивы WAF‑ноды описываются в файле контейнера /etc/nginx/sites-enabled/default.

    • -p: порт, через который WAF-нода принимает запросы. Значение должно совпадать с портом инстанса.

    • -e: переменные окружения из таблицы ниже.

      Переменная окружения Описание Обязательная?
      DEPLOY_USER Email для аккаунта пользователя Деплой или Администратор в Консоли управления Валарм. Да
      DEPLOY_PASSWORD Пароль для аккаунта пользователя Деплой или Администратор в Консоли управления Валарм. Да
      WALLARM_API_HOST Адрес Валарм API:
      • api.wallarm.com для EU‑облака
      • api.wallarm.ru для RU‑облака
      По умолчанию: api.wallarm.com.
      Нет
      DEPLOY_FORCE Заменяет существующую WAF‑ноду на новую, если название WAF‑ноды соответствует идентификатору контейнера, который вы запускаете. Принимает значения:
      • true, чтобы заменить WAF‑ноду
      • false, чтобы отключить замену WAF‑ноды
      По умолчанию (если переменная не указана явно): false.
      WAF‑ноде Валарм присваивается название, соответствующее идентификатору контейнера. Данная опция полезна, если идентификаторы Docker‑контейнеров в вашей среде статичные и вы повторно запускаете Docker‑контейнер с WAF‑нодой Валарм (например, с новой версией образа). Если в этом случае значение переменной равно false, процесс создания WAF‑ноды завершится с ошибкой.
      Нет
  7. Протестируйте работу WAF-ноды.

Тестирование работы WAF-ноды

  1. Перейдите в консоль управления Яндекс.Облаком → Compute CloudVirtual machines и скопируйте IP-адрес инстанса из столбца Public IPv4.

    Настройка экземпляра контейнера

    Если IP-адрес отсутствует, убедитесь, что инстанс находится в статусе Running.

  2. Отправьте тестовый запрос с атаками SQLI и XSS на скопированный адрес:

    curl http://<COPIED_IP>/?id='or+1=1--a-<script>prompt(1)</script>'
    
  3. Перейдите в Консоль управления Валарм → секция События для EU‑облака или для RU‑облака и убедитесь, что атаки появились в списке.

    Атаки в интерфейсе

Чтобы посмотреть сообщения об ошибках запуска контейнера, необходимо подключиться к инстансу по SSH и проверить логи контейнера. Если инстанс недоступен, убедитесь, что в контейнер переданы корректные значения всех обязательных параметров WAF-ноды.