| Переменная | Значение по умолчанию | Описание |
|---|
Переменные для дистрибуции  |
BACKEND_VERSION_TAG | 0.8 | Версия сервисов бэкенда (naice-gavia, naice-lemmus, naice-ovis, naice-ursus). |
FRONTEND_VERSION_TAG | 0.8 | Версия сервиса фронтенда (naice-web, известный как larus). |
| POSTGRES_VERSION_TAG | 0.8.4 | Версия контейнерезированного образа БД postgres. |
| RADIUS_VERSION_TAG | 0.8 | Версия контейнерезированного образа FreeRadius. |
| NATS_VERSION_TAG | 0.7.1 | Версия контейнерезированного образа NATS. |
| ELTEX_HUB | hub.eltex-co.ru/naice | Внешний репозиторий со стабильными версиями сборок ПО. |
BACKEND_HUB | ELTEX_HUB | Переменная, хранящая текущий выбранный репозиторий для загрузки сервисов бэкенда. |
FRONTEND_HUB | ELTEX_HUB | Переменная, хранящая текущий выбранный репозиторий для загрузки сервиса фронтенда. |
| RADIUS_HUB | ELTEX_HUB | Переменная, хранящая текущий выбранный репозиторий для загрузки контейнера с FreeRADIUS. |
| CI_HUB | hub.eltex-co.ru | Внешний репозиторий для сборок сопутствующих продуктов (PostgreSQL). |
| HOSTNAME | Берется значение имени хоста из /etc/hostname при установке плейбуком ansible | Имя хоста, на котором развернута система NAICE. Необходимо для лицензирования. Менять его после активации лицензии запрещено. |
Переменные Gavia |
| GAVIA_PORT | 8080 | Порт, на котором работает сервис внутри контейнера. |
| GAVIA_HOST_PORT | 8080 | Порт, в который пробрасывается порт сервиса из контейнера на хостовую машину. Используется для взаимодействия с сервисом. |
Переменные Ursus |
URSUS_PORT | 8081 | Порт, на котором работает сервис внутри контейнера. |
URSUS_HOST_PORT | 8081 | Порт, в который пробрасывается порт сервиса из контейнера на хостовую машину. Используется для взаимодействия с сервисом. |
URSUS_GRPC_PORT | 8082 | Порт, на котором работает GRPC для сервиса внутри контейнера. |
URSUS_GRPC_HOST_PORT | 8082 | Порт, в который пробрасывается порт GRPC для сервиса из контейнера на хостовую машину. Используется для взаимодействия с сервисом. |
URSUS_POSTGRES_USERNAME | ursus | Пользователь для доступа сервиса в СУБД PostgreSQL. |
URSUS_POSTGRES_PASSWORD | ursus | Пароль пользователя для доступа сервиса в СУБД PostgreSQL. |
| URSUS_POSTGRES_DB | ursus | Наименование БД, используемой сервисом. |
URSUS_POSTGRES_JDBC_URL | jdbc:postgresql://{{ ansible_host }}:5432/ursus | URL для взаимодействия с БД с помощью JDBC. |
| URSUS_GRPC_ADMIN_SERVICE_ADDRESS | dns:/naice-ursus:8082 | Адрес GRPC-сервера сервиса naice-ursus. По этому адресу происходит взаимодействие naice-gavia и naice-ursus. |
| URSUS_OUI_UPDATE_TIME_S | 86400 | Периодичность обновления списка MAC OUI, с. |
| URSUS_OUI_UPDATE | True | Включить/выключить обновление списка MAC OUI. |
| URSUS_OUI_UPLOAD_FILE_URL | https://standards-oui.ieee.org/oui/oui.csv | Адрес списка MAC OUI, который используется для обновления. |
| URSUS_DEFAULTEVENTS_EVENTCLEAN_LOG_LOCALE | ru | Язык журнала событий, может принимать значения ru, en. |
Переменные Lemmus |
| CRON | 0 0 3 * * * | Настройка интервала очистки таблицы событий в БД, по умолчанию раз в сутки в 3 часа. |
| URSUS_EVENTS_TO_DELETE_DAYS | 14 | Количество дней, в течении которых события храняться в БД. |
| URSUS_DEFAULT_EVENT_LOG_LOCALE | ru | Язык журнала событий, может принимать значения ru, en. |
Переменные Lemmus |
| LEMMUS_PORT | 8083 | Порт, | LEMMUS_PORT | 8083 | Порт, на котором работает сервис внутри контейнера. |
| LEMMUS_HOST_PORT | 8083 | Порт, в который пробрасывается порт сервиса из контейнера на хостовую машину. Используется для взаимодействия с сервисом. |
| LEMMUS_POSTGRES_USERNAME | ursus | Пользователь для доступа сервиса в СУБД PostgreSQL. |
| LEMMUS_POSTGRES_PASSWORD | ursus | Пароль пользователя для доступа сервиса в СУБД PostgreSQL. |
| LEMMUS_ISSUER_URL | https://{{ ansible_host }}:8083 | URL для запроса токена другими сервисами. |
| LEMMUS_REDIRECTS | https://{{ ansible_host }}:8080/actuator/health, https://{{ ansible_host }}:443/login | URL для перенаправления клиента после получения токена. |
| LEMMUS_ACCESS_TTL_S | 3600 | Время жизни токена в секундах. |
| LEMMUS_REFRESH_TTL_S | 7200 | Время в секундах, в течение которого токен можно продлить. |
Переменные PostgreSQL |
| POSTGRES_USER | postgres | Пользователь, создаваемый при установке и настройке СУБД. |
| POSTGRES_PASSWORD | postgres | Пароль пользователя, создаваемый при установке и настройке СУБД. |
Переменные Ovis |
| OVIS_PORT | 8084 | Порт, на котором работает сервис внутри контейнера. |
| OVIS_HOST_PORT | 8084 | Порт, в который пробрасывается порт сервиса из контейнера на хостовую машину. Используется для взаимодействия с сервисом. |
| OVIS_GRPC_PORT | 8085 | Порт, на котором работает GRPC для сервиса внутри контейнера. |
| OVIS_GRPC_HOST_PORT | 8085 | Порт, в который пробрасывается порт GRPC для сервиса из контейнера на хостовую машину. Используется для взаимодействия с сервисом. |
| OVIS_GRPC_SERVICE_ADDRESS | dns:/naice-ovis:${OVIS_GRPC_PORT} | Адрес, на который выполняется запрос о состоянии сервиса. |
| OVIS_CACHE_TTL_S | 86400 | Время жизни кэша naice-ovis в секундах, в течение которого он хранит настройки аутентификации и авторизации. По истечении этого времени настройки перечитываются. |
| OVIS_SESSION_IDLE_S | 86400 | Время жизни неактивных сессии пользователей, с. |
| OVIS_POSTGRES_JDBC_URL | jdbc:postgresql://{{ ansible_host }}:5432/ursus | Адрес подключения к БД. |
| OVIS_POSTGRES_USERNAME | ovis | Логин подключения к БД. |
| OVIS_POSTGRES_PASSWORD | ovis | Пароль подключения к БД. |
| OVIS_LDAP_ENABLE_CACHE | true | Включить кэширование атрибутов пользователя при обращении к внешнему источнику идентификации по протоколу LDAP. |
| OVIS_LDAP_CACHE_TTL_S | 10 | Время хранения в кэше информации об атрибутах пользователя, с. |
| OVIS_LDAP_CONNECT_TIMEOUT_MS | 3000 | Таймаут подключения к внешнему источнику идентификации по протоколу LDAP, мс. |
| OVIS_LDAP_READ_TIMEOUT_MS | 7000 | Таймаут чтения данных из внешнего источника идентификации по протоколу LDAP, мс. |
| OVIS_LDAP_REFERRAL_VALUE | ignore | Возможность перехода по реферальным ссылкам полученным от LDAP. Возможные значения: ignore - не следовать, follow - следовать. |
| OVIS_LDAP_POOL_SIZE | 10 | Размер пула коннектов к внешнему источнику идентификации типа LDAP. |
| OVIS_LDAP_POOL_MAX_SIZE | 10 | Максимально допустимое количество коннектов к внешнему источнику идентификаций типа LDAP. |
| OVIS_NODE_INTERFACE | {{ ansible_host }} | IP-адрес/DNS-имя интерфейса для взаимодействие с соседним инстансом при работе в схеме с резервированием. |
| OVIS_NODE_MEMBERS | 127.0.0.1 | IP-адреса/DNS-имена инстансов участвующих в резервировании. |
| OVIS_NODE_PORT | 5701 | Порт для взаимодействия с соседним инстансов при работе в схеме с резервирвоанием. |
| OVIS_NETLOGON_LIB_SOCKET_TIMEOUT_MS | 5000 | Таймаут обмена данными с внешним источником идентификации (типа Active Directory) по протоколу netlogon, мс. |
| OVIS_NETLOGON_LIB_CONNECT_TIMEOUT_MS | 5000 | Таймаут подключения к внешнему источнику идентификации (типа Active Directory) по протоколу netlogon, мс. |
| OVIS_NETLOGON_LIB_CLIENT_CACHE_ENABLED | true | Включить кэширование сессии компьютера при обращении к внешнему источнику идентификации (типа Active Directory) по протоколу netlogon, мс. |
| OVIS_NETLOGON_LIB_CLIENT_CACHE_TTL_S | 1800 | Время хранения в кэше сессии компьютера, с. |
| OVIS_NETLOGON_LIB_CLIENT_CACHE_PERIOD_S | 180 | Интервал проверки наличия в кэше сессии компьютера, с. |
| OVIS_NETLOGON_LIB_DNS_CACHE_TTL_S | 3600 | Время хранения в кэше информации о контроллерах домена после выполнения DNS-запроса типа SRV, с. |
| OVIS_NETLOGON_LIB_DNS_CACHE_PERIOD_S | 360 | Интервал проверки наличия в кэше информации о контроллерах домена после выполнения DNS-запроса типа SRV, с. |
Переменные Larus (WEB) |
| LARUS_PORT | 4200 | Порт, на котором работает сервис внутри контейнера. |
| LARUS_HOST_PORT | 80 | Порт, в который пробрасывается порт сервиса из контейнера на хостовую машину. Используется для взаимодействия с сервисом. |
| FRONTEND_API_URL | https://{{ ansible_host }}:8080/api/v1 | URL для взаимодействия с сервисом naice-gavia. |
| FRONTEND_AUTHORIZATION_URL | https://{{ ansible_host }}:8083 | URL для редиректа на страницу авторизации. |
| FRONTEND_WEB_URL | https://{{ ansible_host }}:443 | URL на котором работает WEB-интерфейс. |
Переменные NATS |
| NATS_PORT | 4222 | Порт, на котором работает сервис. |
| NATS_MONITORING_PORT | 8222 | Порт, через который выполняется мониторинг сервиса. |
| NATS_EXPORTER_PORT | 7777 | Порт, через который сервис отдает метрики в формате prometheus. |
| NATS_ADDRESS | nats://naice-nats:${NATS_PORT} | Адрес, на котором работает сервис. |
| NATS_PROMETHEUS_EXPORTER_ARGS | "-connz -varz -channelz -serverz -subz" | Аргументы командной строки, которые используется при формировании метрик prometheus. |
NATS_CLUSTER_PORT | 6222 | Порт для взаимодействия nats в кластере. |
Переменные Vulpus |
| VULPUS_PORT | 8086 | Порт, на котором работает сервис внутри контейнера. |
| VULPUS_HOST_PORT | 8086 | Порт, в который пробрасывается порт сервиса из контейнера на хостовую машину. Используется для взаимодействия с сервисом. |
| VULPUS_GRPC_PORT | 8088 | Порт, в который пробрасывается порт сервиса из контейнера на хостовую машину. Используется для взаимодействия по gRpc. |
| VULPUS_POSTGRES_USERNAME | vulpus | Логин для подключения к БД. |
| VULPUS_POSTGRES_PASSWORD | vulpus | Пароль для подключения к БД. |
| VULPUS_POSTGRES_JDBC_URL | jdbc:postgresql://{{ ansible_host }}:5432/lepus | Адрес БД для подключения. |
| VULPUS_GRPC_SERVICE_ADDRESS | dns:/naice-vulpus:${VULPUS_GRPC_PORT} | Порт, на котором внутри контейнера работает gRpc-сервер. |
Переменные Lepus |
| LEPUS_PORT | 8087 | Порт, на котором работает сервис внутри контейнера. |
| LEPUS_HOST_PORT | 8087 | Порт, в который пробрасывается порт сервиса из контейнера на хостовую машину. Используется для взаимодействия с сервисом. |
| LEPUS_REPOSITORY_BATCH_SIZE | 500 | Размер пакета сохранения проб в БД (количество). |
| LEPUS_POSTGRES_USERNAME | lepus | Логин для подключения к БД. |
| LEPUS_POSTGRES_PASSWORD | lepus | Пароль для подключения к БД. |
| LEPUS_POSTGRES_JDBC_URL | jdbc:postgresql://{{ ansible_host }}:5432/lepus | Адрес БД для подключения. |
| LEPUS_DHCP_PROBE_ENABLED | true | Включение/отключение сбора DHCP-проб. |
| LEPUS_DHCP_PROBE_PORT | 1024 | Внутренний порт в контейнере для сбора DHCP-проб. В него пробрасывается порт сервиса из контейнера на хостовую машину. |
| LEPUS_DHCP_PROBE_HOST_PORT | 67 | Внешний порт сервиса для сбора DHCP-проб. |
| LEPUS_DHCP_PROBE_SCHEDULE_CLEAR_PROBES_AFTER_DAYS | 30 | Время хранения DHCP-проб в БД. |
| LEPUS_DHCP_PROBE_SCHEDULE_CLEAN_EXPIRED_CRON | 0 0 * * * * | Расписание для запуска задачи по очистке устаревших DHCP-проб в БД. |
Переменные Gulo |
| GULO_PORT | 8089 | Порт, на котором работает сервис внутри контейнера. |
| GULO_HOST_PORT | 8089 | Порт, в который пробрасывается порт сервиса из контейнера на хостовую машину. Используется для взаимодействия с сервисом. |
| GULO_GRPC_PORT | 8090 | Порт, на котором работает GRPC для сервиса внутри контейнера. |
| GULO_GRPC_HOST_PORT | 8090 | Порт, в который пробрасывается порт сервиса из контейнера на хостовую машину. Используется для взаимодействия с сервисом. |
| GULO_GRPC_SERVICE_ADDRESS | dns:/naice-gulo:${GULO_GRPC_PORT} | Адрес, на который выполняется запрос о состоянии сервиса. |
| GULO_ELM_SERVER_URL | https://elm.eltex-co.ru:8099 | URL до сервера ELM. |
| GULO_ELM_PROXY_HOST |
| Адрес HTTP-proxy сервера |
| GULO_ELM_PROXY_PORT |
| Порт HTTP-proxy сервера |
| GULO_ELM_PROXY_LOGIN |
| Логин для аутентификации на HTTP-proxy сервере |
| GULO_ELM_PROXY_PASSWORD |
| Пароль для аутентификации на HTTP-proxy сервере |
| GULO_EPG_URL | https://epg-service:8100 | Адрес сервиса EPG |
Переменные Aquila |
| AQUILA_PORT | 8091 | Порт, на котором работает сервис внутри контейнера. |
| AQUILA_HOST_PORT | 8091 | Порт, в который пробрасывается порт сервиса из контейнера на хостовую машину. Используется для взаимодействия с сервисом. |
| AQUILA_TACACS_PORT | 49 | Порт для обработки входящих запросов по протоколу TACACS+. |
| AQUILA_GRPC_PORT | 8092 | Порт, на котором работает GRPC сервиса. |
| AQUILA_GRPC_SERVICE_ADDRESS | dns:/naice-aquila:${AQUILA_GRPC_PORT} | Адрес, на котором работает GRPC сервиса. |
| AQUILA_CACHE_TTL_S | 300 | Время жизни кэша naice-ovis в секундах, в течение которого он хранит настройки аутентификации и авторизации. По истечении этого времени настройки перечитываются. |
| AQUILA_POSTGRES_JDBC_URL | jdbc:postgresql://{{ ansible_host }}:5432/aquila | Адрес БД для подключения. |
| AQUILA_POSTGRES_USERNAME | aquila | Логин для подключения к БД. |
| AQUILA_POSTGRES_PASSWORD | aquila | Пароль для подключения к БД. |
| AQUILA_POSTGRES_DB | aquila | Имя БД для подключения |
| AQUILA_DB_POOL_SIZE | 25 | Количество коннектов для подключения к БД. |
| AQUILA_DB_POOL_MIN_IDLE | 5 | Минимальное количество коннектов для подлючения БД в режиме ожидания. |
| AQUILA_DB_POOL_IDLE_TIMEOUT | 60000 | Время ожидания ответа при подключении к БД, мс. |
| AQUILA_DB_POOL_CONNECTION_LIFETIME | 1800000 | Время жизни соединения к БД, с. |
| AQUILA_FLUSH_SEC | 60 | Интервал сохранения сессий и аккаунтинга в БД, с. |
| AQUILA_SESSIONS_CLEAN_CRON | 0 0 * * * * | Интервал очистки сессий и аккаунтинга из БД, по умолчанию каждый час. |
| AQUILA_SESSION_TO_DELETE_DAYS | 31 | Срок хранения информации о сессиях в БД. |
| AQUILA_ACCOUNTING_TO_DELETE_DAYS | 31 | Срок хранения информации об аккаунтинге в БД. |
Переменные EPG |
| EPG_TAG | 1.0-1 | Версия сервиса EPG |
| EPG_LOG_FILE_MAX_SIZE | 10 | Максимальный размер одного log файла в МБ |
| EPG_LOG_FILE_MAX_COUNT | 4 | Максимальное количество log файлов в ротации |
| EPG_KERNEL_LOG_LEVEL | info | Уровень логирования для логов типа "kernel" сервиса EPG |
| EPG_DEBUG_LOG_LEVEL | off | Уровень логирования для логов типа "debug" сервиса EPG |
| EPG_NETWORKING_LOG_LEVEL | info | Уровень логирования для логов типа "networking" сервиса EPG |
| EPG_HOST_PORT | 8100 | Порт, в который пробрасывается порт сервиса из контейнера на хостовую машину. Используется для взаимодействия с сервисом. |
Переменные для настройки сертификата для HTTPS |
| SSL_CERT | /etc/docker-naice/https/server.crt | Путь до файла сертификата. |
| SSL_CERT_KEY | /etc/docker-naice/https/server.key | Путь до файла закрытого ключа сертификата. |
| SSL_CERT_PASS |
| Пароль от закрытого ключа; по умолчанию без пароля. |
Переменные RADIUS |
| Общие переменные |
| RADIUS_AUTH_PORT | 1812 | Порт аутентификации для обработки RADIUS-запросов аутентификации. |
| RADIUS_ACCT_PORT | 1813 | Порт для обработки RADIUS-аккаунтинга. |
| RADIUS_EXPORTER_PORT | 9812 | Порт, через который сервис отдает метрики в формате prometheus. |
| RADIUS_LOG_PATH | /var/log/radius | Файл на хостовой машине для хранения логов работы сервиса. |
| RADIUS_REST_OVIS_IP | {{ ansible_host }} | IP-адрес для подключения к сервису NAICE-Ovis. |
| RADIUS_REST_OVIS_PORT | 8084 | Порт для подключения к сервису NAICE-Ovis. |
| RADIUS_POSTGRES_DB_HOST | {{ ansible_host }} | IP-адрес подключения к БД. |
| RADIUS_POSTGRES_DB_PORT | 5432 | Порт подключения к БД. |
| RADIUS_POSTGRES_DB_LOGIN | radius | Логин для подключения к БД. |
| RADIUS_POSTGRES_DB_PASSWORD | radius | Пароль для подключения к БД. |
| RADIUS_POSTGRES_DB_NAME | ursus | Наименование БД для подключения. |
| Переменные для настройки авторизации по протоколу EAP-PEAP |
| RADIUS_CERTS_CA_CERT_FILE | trusted_server.crt | Наименование файла внешнего сертификата CA. |
| RADIUS_CERTS_PRIVATE_KEY_FILE | trusted_server.k | Наименование внешнего приватного ключа сертификата. |
| RADIUS_CERTS_PRIVATE_KEY_PASSWORD | не задано | Пароль к файлу приватного ключа сертификата сервера; оставьте пустым, если файл приватного ключа не запаролен. |
| RADIUS_CERTS_CERTIFICATE_FILE | trusted_server_chain.crt | Наименование файла внешнего сертификата, который будет использовать FreeRADIUS. |
| Переменные для настройки авторизации по протоколу EAP-TLS |
| RADIUS_EAP_TLS_CERTS_CA_CERT_FILE | trusted_server.crt | Наименование файла внешнего сертификата CA. |
| RADIUS_EAP_TLS_CERTS_PRIVATE_KEY_FILE | trusted_server.k | Имя файла приватного ключа сертификата сервера. |
| RADIUS_EAP_TLS_CERTS_PRIVATE_KEY_PASSWORD | не задано | Пароль к файлу приватного ключа сертификата сервера; оставьте пустым, если файл приватного ключа не запаролен. |
| RADIUS_EAP_TLS_CERTS_CERTIFICATE_FILE | trusted_server_chain.crt | Наименование файла внешнего сертификата, который будет использовать FreeRADIUS. |
| Переменные для работы с сервисом проверки статуса отозванных сертификатов (OCSP) |
| RADIUS_EAP_TLS_OCSP_ENABLE | false | Включение проверки статуса отзыва сертификата по протоколу OCSP. |
| RADIUS_EAP_TLS_OCSP_OVERRIDE_URL | false | Использование URL сервиса OCSP из сертификата. |
| RADIUS_EAP_TLS_OCSP_URL | http://127.0.0.1/ocsp | URL для обращения к сервису OCSP. |
| RADIUS_EAP_TLS_OCSP_SOFTFAIL | false | "Мягкая" проверка доступа к серверу проверки OSCP - если сервер недоступен, процесс не завершится, а продолжится. |
| RADIUS_EAP_TLS_OCSP_TIMEOUT | 0 | Таймаут обращения к серверу OSCP. |
| RADIUS_EAP_TLS_OCSP_USE_NONCE | true | Включение одноразового кода в запрос - nonce, который может быть включен в соответствующий ответ. |
Переменные уровня логирования сервисов |
| ROOT_LOGGING_LEVEL | DEBUG | Корневой уровень логирования. Логи сервисов выше данного уровня не отображаются. |
| URSUS_LOGGING_LEVEL | DEBUG | Уровень логирования сервиса NAICE-Ursus. |
| GAVIA_LOGGING_LEVEL | DEBUG | Уровень логирования сервиса NAICE-Gavia. |
| LEMMUS_LOGGING_LEVEL | DEBUG | Уровень логирования сервиса NAICE-Lemmus. |
| OVIS_LOGGING_LEVEL | DEBUG | Уровень логирования сервиса NAICE-Ovis. |
| LEPUS_LOGGING_LEVEL | DEBUG | Уровень логирования сервиса NAICE-Lepus. |
| VULPUS_LOGGING_LEVEL | DEBUG | Уровень логирования сервиса NAICE-Vulpus. |
| GULO_LOGGING_LEVEL | DEBUG | Уровень логирования сервиса NAICE-Gulo. |
| AQUILA_LOGGING_LEVEL | DEBUG | Уровень логирования сервиса NAICE-Aquila. |