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

Деплой Docker‑образа ноды Валарм в Alibaba Cloud

Данная инструкция содержит краткое руководство по деплою Docker‑образа ноды Валарм (NGINX) с помощью облачной платформы Alibaba Cloud. Для деплоя Docker-образа используется сервис Alibaba Cloud Elastic Compute Service (ECS).

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

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

Требования

  • Доступ к Консоли Alibaba Cloud

  • Доступ к аккаунту с ролью Деплой или Администратор и отключенная двухфакторная аутентификация в Консоли управления Валарм для RU‑Облака или EU‑Облака

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

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

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

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

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

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

  1. Перейдите в Консоль Alibaba Cloud → список сервисов → Elastic Compute ServiceInstances.

  2. Создайте инстанс по инструкции Alibaba Cloud. При создании необходимо учесть следующие особенности:

    • Инстанс может быть создан на основе образа любой операционной системы.
    • Инстанс должен быть доступен для внешних ресурсов (необходимо настроить публичный IP-адрес или домен).
    • Настройки инстанса должны учитывать способ, с помощью которого вы планируете подключаться к инстансу.
  3. Подключитесь к инстансу одним из способов, описанных в документации Alibaba Cloud.

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

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

    export DEPLOY_USER='<DEPLOY_USER>'
    export DEPLOY_PASSWORD='<DEPLOY_PASSWORD>'
    
    • <DEPLOY_USER>: email для аккаунта пользователя Деплой или Администратор в Консоли управления Валарм.
    • <DEPLOY_PASSWORD>: пароль для аккаунта пользователя Деплой или Администратор в Консоли управления Валарм.
  6. Запустите Docker-контейнер с настройками ноды Валарм через переменными окружения.

    docker run -d -e DEPLOY_USER=${DEPLOY_USER} -e DEPLOY_PASSWORD=${DEPLOY_PASSWORD} -e NGINX_BACKEND=<HOST_TO_PROTECT_WITH_WALLARM> -p 80:80 wallarm/node:3.4.1-1
    
    docker run -d -e DEPLOY_USER=${DEPLOY_USER} -e DEPLOY_PASSWORD=${DEPLOY_PASSWORD} -e NGINX_BACKEND=<HOST_TO_PROTECT_WITH_WALLARM> -e WALLARM_API_HOST='api.wallarm.ru' -p 80:80 wallarm/node:3.4.1-1
    
    • -p: порт, через который нода принимает запросы. Значение должно совпадать с портом инстанса.
    • -e: переменные окружения с настройками ноды Валарм из таблицы ниже. Не рекомендуется передавать значения переменных DEPLOY_USER и DEPLOY_PASSWORD в явном виде.

      Переменная окружения Описание Обязательная?
      DEPLOY_USER Email для аккаунта пользователя Деплой или Администратор в Консоли управления Валарм. Да
      DEPLOY_PASSWORD Пароль для аккаунта пользователя Деплой или Администратор в Консоли управления Валарм. Да
      NGINX_BACKEND Домен или IP‑адрес ресурса, который необходимо защитить с помощью Валарм. Да
      WALLARM_API_HOST Адрес Валарм API:
      • api.wallarm.com для EU‑Облака
      • api.wallarm.ru для RU‑Облака
      По умолчанию: api.wallarm.com.
      Нет
      WALLARM_MODE Режим работы ноды Валарм:
      • block, чтобы блокировать вредоносные запросы
      • safe_blocking, чтобы блокировать только те вредоносные запросы, которые отправлены с IP‑адресов из серого списка
      • monitoring, чтобы анализировать, но не блокировать запросы
      • off, чтобы не обрабатывать входящий трафик
      По умолчанию: monitoring.
      Подробное описание режимов работы
      Нет
      WALLARM_APPLICATION Уникальный идентификатор для обозначения защищенного приложения в Облаке Валарм. Значение может быть любым целым положительным числом, кроме 0.

      По умолчанию (если переменная не указана явно): -1 (приложение default в Консоли управления → Настройки → Приложения).

      Подробнее о настройке приложений →

      Поддержка переменной WALLARM_APPLICATION

      Переменная WALLARM_APPLICATION поддерживается, начиная с Docker‑образа версии 3.4.1-1.

      Нет
      TARANTOOL_MEMORY_GB Размер оперативной памяти для Tarantool в гигабайтах. Значение может быть целым или дробным (разделитель целой и дробной части — точка). По умолчанию: 0.2 гигабайта. Нет
      DEPLOY_FORCE Заменяет существующую ноду Валарм на новую, если название ноды соответствует идентификатору контейнера, который вы запускаете. Принимает значения:
      • true, чтобы заменить ноду
      • false, чтобы отключить замену ноды
      По умолчанию (если переменная не указана явно): false.
      Ноде Валарм присваивается название, соответствующее идентификатору контейнера. Данная опция полезна, если идентификаторы Docker‑контейнеров в вашей среде статичные и вы повторно запускаете Docker‑контейнер с нодой Валарм (например, с новой версией образа). Если в этом случае значение переменной равно false, процесс создания ноды завершится с ошибкой.
      Нет
  7. Протестируйте работу ноды Валарм.

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

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

  1. Перейдите в Консоль Alibaba Cloud → список сервисов → Elastic Compute ServiceInstances.

  2. Создайте инстанс по инструкции Alibaba Cloud. При создании необходимо учесть следующие особенности:

    • Инстанс может быть создан на основе образа любой операционной системы.
    • Инстанс должен быть доступен для внешних ресурсов (необходимо настроить публичный IP-адрес или домен).
    • Настройки инстанса должны учитывать способ, с помощью которого вы планируете подключаться к инстансу.
  3. Подключитесь к инстансу одним из способов, описанных в документации Alibaba Cloud.

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

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

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

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

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

    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:3.4.1-1
    
    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:3.4.1-1
    
    • <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: переменные окружения с настройками ноды Валарм из таблицы ниже. Не рекомендуется передавать значения переменных DEPLOY_USER и DEPLOY_PASSWORD в явном виде.

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

Тестирование работы ноды Валарм

  1. Перейдите в Консоль Alibaba Cloud → список сервисов → Elastic Compute ServiceInstances и скопируйте публичный IP-адрес инстанса из столбца IP Address.

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

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

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

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

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

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