Описание
Модуль Eltex-APB предназначен для обмена информацией между точками доступа. Обеспечивает:
- Роуминг пользователей, подключившихся при помощи авторизации на WEB-портале
- Настройку и передачу списков белых адресов при портальной авторизации
Управление сервисом
Установка сервиса
apt-get install eltex-apb
Способ запуска/остановки:
Действие | Команда | Ответ |
---|---|---|
Проверка состояния | service eltex-apb status | Сервис работает eltex-apb is running with pid <pid> Сервис не работает eltex-apb is not running |
Запуск сервиса | service eltex-apb start | Сервис запустился Starting eltex-apb ... eltex-apb started Сервис уже работает eltex-apb is already running |
Остановка сервиса | service eltex-apb stop | Сервис успешно остановлен Stopping eltex-apb ... eltex-apb stopped Сервис не остановлен, т.к. не был запущен eltex-apb is not running rm: cannot remove '/var/run/eltex-apb.pid': No such file or directory |
Перезапуск сервиса | service eltex-apb restart | Сервис успешно перезапущен Stopping eltex-apb ... eltex-apb stopped Starting eltex-apb ... eltex-apb started |
Просмотр точек доступа, которые находятся под управлением сервиса:
http://localhost:8090/apb/ap.jsp
Просмотр пользователей, которые находятся под управлением сервиса:
http://localhost:8090/apb/users.jsp
Просмотр числа пользователей, которые находятся под управлением сервиса:
http://localhost:8090/apb/users.jsp?short
Конфигурация
/etc/default/eltex-apb
Содержит параметры, необходимые для инициализации сервиса.
- Слушаемый порт:
PORT=8090
- Длина очереди запросов. При заполнении очереди, новые запросы будут игнорироваться сервером, пока старые запросы не будут обработаны (по дефолту очередь не будет накапливаться):
ACCEPT_QUEUE_SIZE=0
- Максимальный размер буфера сообщения, в байтах:
MAX_TEXT_MESSAGE_BUFFER_SIZE=262144
Настройка памяти, выделяемой на работу сервиса (память выделяется на сам процесс, а не на кэш, прописанный в /etc/eltex-apb/ehcache.xml):
JAVA_INIT_HEAP=128m JAVA_MAX_HEAP=2048m
/etc/eltex-apb/application.conf
Содержит основные настройки сервиса.
Важно!
Файл настроек /etc/eltex-apb/application.conf используется начиная с версии SoftWLC 1.20. В предыдущих версиях использовался файл /etc/eltex-apb/apb.properties .
Основные настройки сервиса.
- Настройки для подключения к сервису Mercury:
mercury { host = localhost port = 6565 poolSize = 50 }
- Расположение необходимых файлов:
# cache config file path cacheConfigFile = /etc/eltex-apb/ehcache.xml # path to the file with permitted hosts hostsFile = /etc/eltex-apb/hosts.json
- Интервал запуска службы по выполнению websocket-пингов:
# ping job interval interval = 60s
- Время ожидания запроса подписки после подключения точки доступа к серверу, в секундах (если ТД подключается, но не шлёт subscribe в течение данного интервала, то при очередном запуске службы websocket-пингов такая сессия ТД будет отключена):
# timeout waiting for subscribe-request after connecting the access point to the server subscribeIdleTimeout = 60s
- Время, в течение которого сессия остается открытой без отправки сообщений:
# timeout during that the session will stay opened without receiving any message messageIdleTimeout = 90s
- Интервал между последним полученным сообщением от ТД и выполнением websocket-пинга к ней. В случае неответа ТД, её сессия будет отключена от сервиса:
# interval of ping to be sent to the websocket session pingIdleTimeout = 30s
- Максимальное количество исходящих сообщений для очереди на каждый сеанс:
# maximum number of outgoing messages in queue for each session sessionMessageQueueSize = 100
/etc/eltex-apb/ehcache.xml
Содержит системные настройки хранения данных о Wi-Fi-пользователях, подключенных на портале. При необходимости название и расположение файла может быть изменено в /etc/eltex-apb/application.conf .
- Количество оперативной памяти, выделяемое для хранения таблицы авторизованных пользователей настраивается параметром "maxBytesLocalHeap" в разделе:
<cache name="users" maxBytesLocalHeap="1G" eternal="false" timeToLiveSeconds="43200" memoryStoreEvictionPolicy="LRU"> . . . </cache>
- Количество оперативной памяти, выделяемое для хранения таблицы с белыми списками настраивается параметром "maxBytesLocalHeap" в разделе:
<cache name="hosts" maxBytesLocalHeap="128M" eternal="true"> <persistence strategy="none"/> </cache>
/etc/eltex-apb/hosts.json
Cодержит набор списков белых адресов. В данном конфигурационном файле выполняется настройка белых списков (списки IP-адресов, на который можно перейти до авторизации на портале). При необходимости название и расположение файла может быть изменено в /etc/eltex-apb/application.conf. По умолчанию данный список является пустым.
Пример заполнения файла:
[ { "mobility-domain-list": [ { "mobility-domain": "eltex.root", "radius-domain": "root", "ssid": "Eltex-Local" } ], "permitted-ip-list": [ "eltex-co.ru", "eltex.org" ] }, { "permitted-ip-list": [ "esia-portal1.test.gosuslugi.ru", "esia.gosuslugi.ru", ] } ]
- Белый список, общий для всех подключенных точек задается в формате:
[{ "permitted-ip-list": [ "esia-portal1.test.gosuslugi.ru", "esia.gosuslugi.ru", ] }]
- Белый список, который назначается на точки с определенным SSID и доменом, записывается в следующем формате:
[{ "mobility-domain-list": [ { "mobility-domain": "eltex.root", "radius-domain": "root", "ssid": "Eltex-Local" } ], "permitted-ip-list": [ "eltex-co.ru", "eltex.org" ] }]
Запись в приведенном выше конфигурационном файле говорит о том, что если на сервис поступит информация о пользователе, чьим mobility-domain является eltex.root, radius-domain является root, а ssid – Eltex-Local, то данному пользователю до авторизации на портале помимо адресов из общего белого списка, будут доступны адреса eltex-co.ru и eltex.org. Другими словами, адреса, находящиеся в «permitted-ip-list», будут доступны пользователю, в случае полного совпадения всех ключей, описанных в рамках одного «mobility-domain-list».
Если параметры пользователя удовлетворяют критериям нескольких правил, ему будут разрешены для доступа IP-адреса из всех таких правил.
В параметр "mobility-domain" вносится значение параметра "ap-location" точки доступа, который находится в разделе сетевых настроек.
/etc/eltex-apb/log4j2.xml
Содержит настройки логирования.
- Автоматическое перечитывание конфигурации логгера:
<Configuration status="OFF" monitorInterval="10">
- Уровень логирования:
<Property name="rootLevel">${env:LOG_LEVEL:-INFO}</Property>
- Базовая директория хранения логов:
<Property name="baseDir">/var/log/eltex-apb</Property>
- Максимально допустимый размер файла (при его превышении создается новый файл. а старый архивируется):
<Property name="maxFileSize">20 MB</Property>
- Суммарный размер логов (текущий файл + архивные). При его превышении наиболее старые файлы будут удаляться:
<Property name="accumulatedFileSize">100 MB</Property>
- Срок хранения логов, файлы модифицированные раннее этого срока будут удаляться:
<Property name="lastModified">4d</Property>
- Максимальное количество архивных файлов, при его превышении наиболее старые файлы будут перезаписываться:
<Property name="maxCount">7</Property>
- Блок настройки перенаправления логов в Graylog (уровень логирования, адрес, порт):
<Property name="gelfLevel">${env:GELF_LEVEL:-OFF}</Property> <Property name="gelfHost">${env:GELF_HOST:-udp:lab3-test.eltex.loc}</Property> <Property name="gelfPort">${env:GELF_PORT:-12201}</Property>
Мониторинг
Для мониторинга сервиса APB поддержаны совместимые с Prometheus метрики. Для просмотра списка метрик надо открыть:
http://<адрес сервера APB>:<порт>/apb/api/metrics
Для запуска мониторинга со стороны Prometheus надо добавить в файл его конфигурации:
- job_name: 'apb' metrics_path: '/apb/api/metrics' static_configs: - targets: ['<адрес сервера APB>:<порт>']
Порт соответствует рабочему порту сервера APB, по умолчанию 8090.
Настройка подключения точек доступа к сервису APB
Подключение к сервису APB на точке доступа можно настроить через GUI EMS.
Для настройки роуминга пользователей при портальной авторизации необходимо перейти в раздел Конфигурация → Captive Portal.Global, указать адрес Roaming Service URL в формате: «<IP-aдрес_apb>:8090». IP-aдрес APB должен быть доступным из сети управления точками доступа.
Настройте «Roaming no action timeout» (время, через которое ТД удалит устаревшие/неактивные записи о клиентах в роуминге). Параметр «Roaming no action timeout» должен быть не меньше максимальной длительности тарифного плана.
Существует возможность выполнить настройку с помощью шаблона, используемого в правиле инициализации ТД.
Начиная с версии ПО ТД 1.10.0 WEP/WOP-12/12 rev.C/2ac в качестве мобильного домена («User Mobility Domain») используется параметр «AP location, domain», который соответствует домену, в который была инициализирована ТД. Он задается при инициализации ТД и не требует настройки.
Так же можно выполнить его настройку во вкладке ТД Конфигурация → Сеть:
Нажимаем Редактировать:
И в открывшемся окне, нажав кнопку справа от настройки «AP location, domain», выбираем нужный домен:
Потом нажимаем Принять и еще раз Принять.
Для сохранения настроек на ТД нажимаем сверху-слева кнопку Сохранить (
).Докеризация сервиса
Сервис может быть запущен в docker-контейнере. Для этого необходимо подготовить docker-compose.yml.
На данный момент конфигурирование сервиса происходит через маппинг настроек сервиса, запущенного ранее в deb-пакете.
version: "2.4" volumes: softwlc_logs: driver: local services: apb: container_name: apb image: hub.eltex-co.ru/softwlc/eltex-apb:1.20-<tag> ports: - 8090:8090 - 8092:8092 volumes: - "/etc/eltex-apb:/etc/eltex-apb" - "softwlc_logs:/var/log" environment: - "JAVA_OPTS=-Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.port=8092 -Dcom.sun.management.jmxremote.rmi.port=8092 -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.local.only=false -Djava.rmi.server.hostname=<IP-address>"
В параметре "-Djava.rmi.server.hostname=<IP-address>" вместо <IP-address> нужно указать ip-адрес сервера, где запущен сервис.
Контейнеры могут быть сконфигурированы, путем передачи переменных окружения:
- PORT - порт, на котором будет слушать сервис,
- JAVA_INIT_HEAP - a.k.a. -Xms JVM опция,
- JAVA_MAX_HEAP - a.k.a. -Xmx JVM опция,
- DEBUG_PORT - порт для JMX,
- JAVA_OPTS - JVM опции (может переопределить все остальные дефолтные параметры).
Для задания параметров через переменные окружения, необходимо подготовить файл .env, в котором указываются переменные окружения и их значения, например:
PORT=8090 JAVA_INIT_HEAP=128m JAVA_MAX_HEAP=2048m DEBUG_PORT=8092 JAVA_OPTS=-Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.local.only=false -Djava.rmi.server.hostname=<IP-address>
В таком случае блок "environment" будет записан следующим образом:
environment: - JAVA_OPTS=${JAVA_OPTS} - PORT=${PORT} - JAVA_INIT_HEAP=${JAVA_INIT_HEAP} - JAVA_MAX_HEAP=${JAVA_MAX_HEAP} - DEBUG_PORT=${DEBUG_PORT}
Файл переменных окружения .env должен находиться в одной папке с docker-compose.yml