Подготовка к установке
Для установки SoftWLC в минимальной конфигурации понадобится сервер со следующими параметрами:
- Оперативная память не менее 10Gb
- CPU >= 2200MHz
- Память жесткого диска >= 35Gb
- Выход в Интернет
- Операционная система Ubuntu Server 20.04 LTS / Ubuntu Server 22.04 LTS / Astra Linux Special Edition 1.7.4 (Воронеж) / РЕД ОС Муром (7.3.1-7.3.3) / Astra Linux Special Edition 1.7.5 (Воронеж)
Подробнее о требованиях к серверу смотрите здесь.
Рекомендуется устанавливать контроллер на чистую ОС.
Перед установкой необходимо выполнить обновление пакетов на сервере с помощью команд sudo apt update && sudo apt upgrade
В комплекте с контроллером идет демо-лицензия.
Использование плейбуков позволяет установить SoftWLC в двух вариантах:
Загрузка скрипта
В операционной системе необходимо создать отдельную директорию, где будет находиться сам скрипт, конфигурационные файлы, данные и плейбуки для Ansible. В качестве примера будет создана директория ansible в домашней директории пользователя.
mkdir /home/<имя пользователя>/ansible
Переходим в созданную директорию
cd /home/<имя пользователя>/ansible
Далее, необходимо загрузить скрипт установщик по ссылке из репозитория и разместить его в созданной ранее директории.
Данную операцию также можно выполнить из терминала:
wget http://archive.eltex.org/wireless/help/softwlc-latest/eltex-softwlc-helper-ansible-latest.sh
Следующим шагом необходимо выдать права на исполнение файла eltex-softwlc-helper-ansible-latest.sh:
sudo chmod +x eltex-softwlc-helper-ansible-latest.sh
Все действия со скриптом необходимо проводить с использованием sudo
Не обязательно скачивать скрипт на тот же хост, куда будет устанавливаться SoftWLC. Адрес его установки будет запрошен самим скриптом далее.
Скачивание плейбуков
Установка скриптом предусматривает автоматичекое скачивание плейбуков Ansible. Однако данную операцию можно выполнить и вручную командой:
wget http://archive.eltex.org/wireless/help/softwlc-latest/softwlc-ansible-1.37.tar.gz
Установка SoftWLC
Чтобы произвести дефолтную установку SoftWLC необходимо запустить скрипт с правами суперпользователя с флагом --default-install:
sudo ./eltex-softwlc-helper-ansible-latest.sh --default-install
В процессе установки будут запрошены адрес удалённого (локального) хоста и данные для входа по SSH для Ansible:
Setup HOSTS for default installation List of prepared hosts: softwlc_main Information note Ansible uses SSH with existing OS credentials to access machines. Next, you will be asked to provide details for connecting via SSH to the hosts you specified. In the future, it is recommended to add the generated ssh key and use it (via "private_key_file" in ansible.cfg for example) to increase the security of the connection. More information (Official Ansible Web site): https://docs.ansible.com/ansible/latest/reference_appendices/config.html Setup credentials for HOST: softwlc_main Enter address for HOST: softwlc_main (blank for last used): 192.168.1.1 softwlc_main will be configured at the: 192.168.1.1 Enter SSH user login for HOST: softwlc_main (blank for last used): tester Enter SSH user password for HOST: softwlc_main (blank for last used): ****** Enter sudo password for HOST: softwlc_main (blank for last used): ******
Сами сервисы будут установлены на указанный хост по пути /opt/eltex-softwlc/. Данный путь можно изменить.
По завершении работы скрипта в терминале появятся данные для подключения:
Installation of Eltex SoftWLC finished successfully.
URLs of SoftWLC components:
Eltex.EMS Server management (internal) IP: {{ems_ip}}
Eltex.EMS Server external IP: {{ server_ip }}
Eltex.EMS GUI: http://<адрес SoftWLC>:8080/ems/jws
login: admin
password: <empty>
Portal constructor: http://<адрес SoftWLC>:8080/epadmin
login: admin
password: password
Wi-Fi customer cabinet (B2B): http://<адрес SoftWLC>:8080/wifi-cab
login: admin
password: password
Систему необходимо конфигурировать только при первой установке. Для запуска уже установленной системы необходимо использовать тег run, для остановки stop:
sudo ./eltex-softwlc-helper-ansible-latest.sh --run sudo ./eltex-softwlc-helper-ansible-latest.sh --stop
При повторном запуске в различных ситуациях могут потребоваться дополнительные действия от пользователя
1) Запрос на создание бэкапа конфигурации. При выборе Y, нажатии на Enter, создастся архив с файлами конфигурации Ansible. Выбор по умолчанию - Y.
Do you want to backup your configuration files ? [Y/n] (default="Y"):
2) Запрос на замену параметров в файлах директории softwlc-ansible/*. При выборе Y все файлы в директории softwlc-ansible (за исключением my_softwlc/*) будут заменены на дефолтные из архива. Выбор по умолчанию - N.
You already have a softwlc-ansible configuration directory. Do you want to replace this configuration with default parameters from the archive? [y/N] (default="N"):
3) Запрос на замену параметров в файлах директории my_softwlc/*. При выборе Y все файлы в директории my_softwlc будут заменены на дефолтные из sample/*, удаляя все настройки пользователя, если таковые были. Выбор по умолчанию - N.
You already have my_softwlс configurations. Do you want to replace this configuration with default parameters from inventory/sample ? [y/N] (default="N"):
На данном этапе установка SoftWLC в Docker через Ansible завершена. Доступ к параметрам сервисов можно получить по пути /opt/eltex-softwlc/ . Остальные возможности скрипта рассмотрены ниже.
Обновление лицензий
Плейбуки Ansible позволяют обновить лицензии для сервисов eltex-ems-core, eltex-airtune, eltex-wifi-cab. Более подробно о лицензировании проекта SoftWLC здесь.
Обновление лицензий eltex-wifi-cab
1) Поместить файл лицензии в директорию:
/home/<имя пользователя>/ansible/softwlc-ansible-1.37/licences/wifi-cab/
2) Запустить скрипт с флагом --update-wifi-cab-licence
sudo ./eltex-softwlc-helper-ansible-latest.sh --update-wifi-cab-licence
Обновление лицензий eltex-ems-core, eltex-airtune
1) Поместить файл лицензии в директорию:
/home/<имя пользователя>/ansible/softwlc-ansible-1.37/licences/ems-airtune/
2) Запустить скрипт с флагом --update-ems-licence
sudo ./eltex-softwlc-helper-ansible-latest.sh --update-ems-licence
Контроль установки через флаги
Скрипт позволяет контролировать процесс установки с помощью флагов. Информацию по ним вы можете посмотреть используя флаг --help
sudo ./eltex-softwlc-helper-ansible-latest.sh --help
В дефолтной установке не требуется использование флагов. Однако при необходимости углублённой настройки комплекса можно использовать флаги, описанные ниже.
Доступные флаги
| Флаг | Значение |
|---|---|
Установка | |
--default-install | Установка системы SoftWLC в дефолтном состоянии (standalone/1 хост). |
| --reservation-install | Многохостовая установка системы SoftWLC в схеме резервирования 1+1 (reservation/ 2 хоста). Подробнее. |
| --replication-galera-install | Многохостовая установка системы SoftWLC в схеме репликации 1+1+3 Galera Cluster Nodes (replication/ 5 хостов). Подробнее. |
Миграция из Deb в Docker | |
--migrate-from-debs | Миграция параметров из Deb установки в Docker. Подробнее. |
--migrate-db-backup | Миграция базы данных из Deb установки в Docker (создание бэкапа). Подробнее. |
--migrate-db-restore | Миграция базы данных из Deb установки в Docker (восстановление бэкапа). Подробнее. |
Дополнительные параметры (Хост Ansible) | |
-d | --download | Скачивание, распаковка архива с плейбуками и подготовка параметров Ansible. |
--install-docker | Установка Docker на хост со скриптом для запуска Ansible. |
--start-ansible | Запуск контейнера Ansible. |
Дополнительные параметры (Инструменты) | |
--test-ports | Тестирование доступности портов. |
--backup | Создание резервной копии всех данных и конфигурационных файлов сервисов SoftWLC. |
--restore | Распаковка архива с резервной копией данных сервисов SoftWLC. |
--run | Запуск контейнеров. |
--stop | Остановка контейнеров. |
--delete | Удаление контейнеров. |
--recreate-service <service_name> | Пересборка сервиса, после примененных к нему изменений. |
--restore-galera | Восстановление кластера Galera. |
--generate-keys | Генерация новых ключей для сервисов eltex-doors и eltex-wifi-cab. |
--update-ems-licence | Обновление/добавление лицензии eltex-ems-core/eltex-airtune. |
--update-wifi-cab-licence | Обновление/добавление лицензии eltex-wifi-cab и инкрементальной лицензии. |
--change-password | Смена паролей от системных пользователей. Подробнее. |
--reconfigure | Реконфигурация сервисов SoftWLC. |
--configure-radius-proxy | Конфигурация проксирования Radius. Подробнее. |
-h | --help | Вывод подсказки по флагам. |
--version | Информация по текущей версии SoftWLC, EMS, Airtune, Ansible Script, Ansible Playbooks. Подробнее. |
Настройка параметров установки
В дефолтной установке используются параметры, которые можно настроить на этапе распаковки архива с плейбуками.
Настраиваемые параметры можно найти по пути:
/home/<имя пользователя>/ansible/softwlc-ansible-1.37/inventory/my_softwlc/group_vars/all.yml
При необходимости настройки параметров до установки SoftWLC можно запустить скрипт с флагом -d для получения соответствующей директории:
sudo ./eltex-softwlc-helper-ansible-latest.sh -d
Обратите внимание, что пароли изменяются не только путём редактирования данного файла. Подробнее о смене паролей можно прочитать здесь:
v1.37_Смена паролей сервисных пользователей SoftWLC с использовнаием Ansible
Параметры из /home/<имя пользователя>/ansible/softwlc-ansible-1.37/inventory/sample/group_vars/all.yml не применяются при установки и служат как дефолтные параметры, используемые при обновлении.
Изменять их не нужно.
Создание резервной копии системы
При необходимости, резервную копию всех данных сервисов SoftWLC можно выполнить, используя флаг backup. Все данные, содержащиеся в папке, где установлен SoftWLC, помещаются в архив в директорию backup. Запуск происходит следующим образом:
sudo ./eltex-softwlc-helper-ansible-latest.sh --backup
Для распаковки архива, содержащего резервную копию используется флаг restore:
sudo ./eltex-softwlc-helper-ansible-latest.sh --restore
Запуск апплета EMS
Перед запуском апплета EMS через приложение Java Web Start убедитесь, что на ПК установлен Oracle Java.
В строке браузера введите следующий адрес:
http://<ip address SoftWLC>:8080/ems/jws
При этом в браузере появится предложение открыть или скачать файл с расширением jnlp. Откройте этот файл с помощью приложения Java Web Start:
javaws ems_gui.jnlp
Рекомендуем использовать Oracle Java 17. Инструкция по запуску апплета - v1.37_Запуск аплета EMS на Java 17
Для создания ярлыка на рабочем столе для запуска апплета EMS в Java Control Panel должно быть включено хранение временных файлов.