Установка на платформу Kong¶

Установка¶

Установка модуля Вебмониторэкс на платформу Kong проходит следующим образом:

1. Добавление репозиториев Вебмониторэкс.

2. Установка пакетов Вебмониторэкс.

3. Настройка постаналитики.

4. Настройка ноды для использования прокси‑сервера.

5. Подключение ноды к Вычислительному кластеру Вебмониторэкс.

6. Настройка адреса сервера постаналитики.

7. Настройка режима фильтрации.

8. Настройка логирования.

apt list wallarm-node

apt list wallarm-node

yum list wallarm-node

# выполните на сервере с нодой
apt list wallarm-node-nginx
# выполните на сервере с модулем постаналитики
apt list wallarm-node-tarantool

# выполните на сервере с нодой
apt list wallarm-node-nginx
# выполните на сервере с модулем постаналитики
apt list wallarm-node-tarantool

# выполните на сервере с нодой
yum list wallarm-node-nginx
# выполните на сервере с модулем постаналитики
yum list wallarm-node-tarantool

1. Добавьте репозитории Вебмониторэкс¶

Установка и обновление ноды Вебмониторэкс выполняются из репозиториев Вебмониторэкс.

В зависимости от вашей операционной системы, выполните одну из следующих команд:

curl -fsSL https://repo.webmonitorx.ru/wallarm.gpg | sudo apt-key add -
sh -c "echo 'deb http://repo.webmonitorx.ru/ubuntu/wallarm-node bionic/4.4/' | sudo tee /etc/apt/sources.list.d/wallarm.list"
sudo apt update

sudo yum install -y epel-release
sudo rpm -i https://repo.webmonitorx.ru/centos/wallarm-node/7/4.4/x86_64/wallarm-node-repo-4.4-0.el7.noarch.rpm

2. Установите пакеты Вебмониторэкс¶

Для установки ноды и модуля постаналитики на одном сервере выполните следующую команду:

sudo apt install --no-install-recommends wallarm-node kong-module-wallarm

sudo yum install wallarm-node kong-module-wallarm

Для установки только ноды выполните следующую команду:

sudo apt install --no-install-recommends wallarm-node-nginx kong-module-wallarm

sudo yum install wallarm-node-nginx kong-module-wallarm

3. Настройте постаналитику¶

Количество памяти влияет на качество работы статистических алгоритмов. В боевой среде мы рекомендуем выделять для модуля постаналитики 75% от общей памяти виртуальной машины. Например, если у сервера 32 ГБ памяти, оптимально выделить под хранилище 24 ГБ. На сервере с небольшим объемом памяти или для тестирования ноды вы можете выделить меньшее количество памяти (например, 25% от общего объема).

Укажите объем оперативной памяти для Tarantool:

Откройте конфигурационный файл Tarantool:

sudo vim /etc/default/wallarm-tarantool

sudo vim /etc/sysconfig/wallarm-tarantool

Укажите размер выделяемой памяти в конфигурационном файле Tarantool директивой SLAB_ALLOC_ARENA. Значение может быть целым или дробным (разделитель целой и дробной части — точка).

Например:

SLAB_ALLOC_ARENA=0.5

SLAB_ALLOC_ARENA=24

Перезапустите Tarantool:

sudo service wallarm-tarantool restart

sudo systemctl restart wallarm-tarantool

4. Настройте ноду для использования прокси‑сервера¶

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

Добавьте в файл /etc/environment новые значения переменных окружения:

• https_proxy — прокси для протокола HTTPS

• http_proxy — прокси для протокола HTTP

• no_proxy — ресурсы, для запросов к которым необходимо отключить проксирование

Присвойте переменным https_proxy и http_proxy строки вида <scheme>://<proxy_user>:<proxy_pass>@<host>:<port>, где:

• <scheme> — используемый протокол (должен совпадать с протоколом, для которого настраивается прокси в текущей переменной окружения)

• <proxy_user> — имя пользователя для авторизации на прокси‑сервере

• <proxy_pass> — пароль для авторизации на прокси‑сервере

• <host> — хост используемого прокси‑сервера

• <port> — порт используемого прокси‑сервера

Присвойте переменной no_proxy значение в виде массива IP‑адресов и/или доменов, к которым нужно обращаться без использования прокси: "<res_1>, <res_2>, <res_3>, <res_4>, ...", где <res_1>, <res_2>, <res_3> и <res_4> — IP‑адреса и/или домены.

Пример корректного содержимого файла /etc/environment ниже демонстрирует следующую конфигурацию:

• HTTPS‑ и HTTP‑запросы проксируются на хост 1.2.3.4 с портом 1234, используя для авторизации на прокси‑сервере имя пользователя admin и пароль 01234.

• Для запросов к 127.0.0.1, 127.0.0.8, 127.0.0.9 и localhost проксирование отключено.

https_proxy=http://admin:01234@1.2.3.4:1234
http_proxy=http://admin:01234@1.2.3.4:1234
no_proxy="127.0.0.1, 127.0.0.8, 127.0.0.9, localhost"

5. Подключите ноду к Вычислительному кластеру Вебмониторэкс¶

Если модуль постаналитики установлен на отдельный сервер

Если модули первичной обработки трафика и постаналитики установлены на разные серверы, рекомендуется регистрировать такие модули в Вычислительном кластере по одному токену ноды. Для каждого модуля в Консоли управления будет отображаться отдельный инстанс ноды. Например:

При установке модуля постаналитики вы уже создали ноду Вебмониторэкс. Для установки следующих модулей ноды:

1. Скопируйте токен ноды, созданной при установке модуля постаналитики.
2. Перейдите к выполнению шага 4 из списка ниже.

В процессе работы нода Вебмониторэкс взаимодействует с Вычислительным кластером Вебмониторэкс. Чтобы подключить ноду к Вычислительному кластеру, выполните следующие действия:

1. Убедитесь, что роль вашего пользователя в Консоли управления Вебмониторэкс — Администратор.

   Для этого перейдите к списку пользователей в Консоли управления и проверьте столбец Роль:

   

2. Перейдите в Консоль управления → Ноды и создайте ноду.

   

3. Скопируйте сгенерированный токен.

4. В системе с установленной нодой запустите скрипт register-node:

   sudo /usr/share/wallarm-common/register-node -t <WALLARM_API_TOKEN> -H api.wallarm.ru
   

   Где <WALLARM_API_TOKEN> — скопированный токен.

   Если модуль постаналитики установлен на отдельный сервер

   Если модуль постаналитики установлен на отдельный сервер, рекомендуется использовать токен ноды, созданной при отдельной установке модуля постаналитики.

6. Настройте адреса сервера постаналитики¶

Добавьте в /etc/kong/nginx-wallarm.template адреса серверов постаналитики:

upstream wallarm_tarantool {
    server <ip1>:3313 max_fails=0 fail_timeout=0 max_conns=1;
    server <ip2>:3313 max_fails=0 fail_timeout=0 max_conns=1;

    keepalive 2;

    }

    # omitted

wallarm_tarantool_upstream wallarm_tarantool;

7. Настройте режим фильтрации¶

Для настройки правил проксирования и фильтрации необходимо отредактировать файл конфигурации /etc/kong/nginx-wallarm.template.

Подробную информацию о конфигурации NGINX вы можете найти в официальной документации NGINX.

Логика работы ноды Вебмониторэкс настраивается при помощи директив Вебмониторэкс. Список доступных директив Вебмониторэкс доступен по ссылке.

Пример файла конфигурации

Предположим, что вам необходимо настроить сервер для работы по следующим принципам:

• Обработка HTTPS‑трафика не настроена

• Запросы осуществляются к двум доменам: example.com и www.example.com

• Все запросы нужно передавать на сервер 10.80.0.5

• Все входящие запросы меньше 1 МБ (значение по умолчанию)

• Нет запросов, которые обрабатываются дольше 60 секунд (значение по умолчанию)

• Система должна работать в режиме мониторинга

• Клиенты обращаются к ноде напрямую, не через промежуточный HTTP‑балансировщик

Файл конфигурации в этом случае будет выглядеть следующим образом:

    server {
      listen 80;
      listen [::]:80 ipv6only=on;

      # the domains for which traffic is processed
      server_name example.com; 
      server_name www.example.com;

      # turn on the monitoring mode of traffic processing
      wallarm_mode monitoring; 

      location / {
        # setting the address for request forwarding
        proxy_pass http://10.80.0.5; 
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
      }
    }

8. Настройте логирование¶

Настройте логирование переменных ноды Вебмониторэкс с помощью NGINX. Это позволит провести быструю диагностику состояния ноды в случае необходимости, основываясь на содержимом лог‑файла NGINX.

Запуск Kong¶

Запуск Kong с установленным модулем Вебмониторэкс выполняется следующей командой:

kong start --nginx-conf /etc/kong/nginx-wallarm.template

Установка завершена¶

На этом установка завершена.

Проверьте, что нода работает и пропускает через себя трафик. Подробнее по ссылке.

Дополнительные настройки¶

После установки нода Вебмониторэкс может потребовать дополнительной настройки.

Далее приводится несколько типовых настроек, которые вы можете выполнить, если это требуется.

Для получения информации о других доступных настройках, обратитесь к разделу Настройка руководства администратора.

Настройка отображения реального IP‑адреса клиента¶

Если нода Вебмониторэкс развернута за прокси‑сервером или балансировщиком нагрузки, то при такой схеме развертывания без дополнительной настройки адрес источника на ноде может совпадать с одним из IP‑адресов прокси‑сервера или балансировщика нагрузки, а не с IP‑адресом клиента.

В этом случае, если вы хотите, чтобы на ноду передавался IP‑адрес клиента в качестве адреса источника, то требуется дополнительная настройка прокси‑сервера или балансировщика.

Ограничение времени обработки единичного запроса¶

Используйте директиву Вебмониторэкс wallarm_process_time_limit, чтобы задать ограничение времени обработки единичного запроса нодой.

Если запрос обрабатывается за большее время, чем указано в директиве, то в лог‑файл заносится информация об ошибке, а запрос помечается как атака overlimit_res.

Ограничение времени ожидания ответа сервера¶

Используйте директиву NGINX proxy_read_timeout, чтобы задать таймаут чтения ответа проксированного сервера.

Если за это время сервер ничего не передаст, то соединение будет закрыто.

Ограничение максимального размера запроса¶

Используйте директиву NGINX client_max_body_size, чтобы задать ограничение на максимальный размер тела запроса клиента.

В случае превышения этого ограничения NGINX вернет клиенту ответ с кодом 413 (Payload Too Large, также известный как Request Entity Too Large).