Инструкция по инсталляции
1. Введение
В данном документе описаны пошаговые процедуры инсталляции программной платформы решений для устройств и технологий дополненной и виртуальной реальности «ИКСАР» (далее ПО ИКСАР).
Документ предназначен для системных администраторов, обладающих базовыми навыками работы с операционными системах семейства Linux. Данная инструкция применяется после получения Заказчиком установочного носителя (дистрибутива ПО).
Дистрибутив ПО для Заказчика обычно содержит:
• все необходимые для установки ИКСАР компоненты (контейнеры) системных и прикладных программных продуктов, кроме ПО Docker;
• примеры/заготовки конфигурационных файлов.
Для определенности предполагается, что перед установкой с установочного носителя скопирован каталог install в каталог /install на сервер (в корень). Некоторые из шагов можно выполнить с загрузкой необходимых контейнеров из облачных репозиториев по сети, вместо использования дистрибутива.
2. Установка серверной части Системы на Linux
2.1. Установка и настройка Docker
Установить ПО Docker для используемой версии и редакции ОС в соответствии с инструкциями данного ПО. Версия Docker должна быть не ниже 24. Для повышения безопасности рекомендуется настроить его в режиме запуска с правами непривилегированного пользователя (Rootless mode).
Данная инструкция предполагает, что Docker установлен в режиме Rootless mode под пользователем xrd. Установка и настройка ПО Docker для различных ОС Linux описана в дополнительных документах.
2.2. Подготовка места для размещения данных и настроечных файлов
Для определенности предположим, что все настроечные файлы и данные будут размещены в каталоге /xr/docker
1. Создание каталога:
➢ sudo mkdir -p /xr
➢ sudo chown -R xrd:xrd /xr
2. Обновление владельца каталога /install:
➢ sudo chown -R xrd:xrd /install
Все дальнейшие действия выполняются под пользователем xrd.
2.3. Создание сети для взаимодействия контейнеров
➢ docker network create -d bridge backend
2.4. Установка Postgre SQL
1. Загрузить образ контейнера:
➢ docker load < /install/images/postgres-16.6.tar.gz
2. Скопировать настроечные файлы:
➢ mkdir /xr/docker
➢ cp -r /install/docker/postgres /xr/docker/
3. Проверить и настроить параметры запуска в файле/xr/docker/postgres/compose.yaml
➢ >"
4. Запустить сервис PostgreSQL:
➢ cd /xr/docker/postgres
➢ docker compose up –d
2.5. Установка сервера приложений ИКСАР
1. Загрузить образ контейнера:
➢ docker load < /install/images/xr-NN-NNNN.tar.gz
где NN-NNNN – номер устанавливаемой версии.
2. Скопировать настроечные файлы:
➢ cp -r /install/docker/xr-prod /xr/docker/
3. Проверить и настроить параметры запуска в файле /xr/docker/xr-prod/data/xr.properties
4. Заменить файл keystore.jks файлом с актуальным серверным SSLсертификатом.
5. Под администратором сменить владельца каталога /xr/docker/xr-prod/data
6. Запустить сервис ИКСАР (под пользователем xrd).
Через несколько минут (должны отработать скрипты создания структур БД) проверить успешность запуска в журнале /xr/docker/xr-prod/data/log/spring.log.
7. Настроить первоначальные данные, необходимые для последующей регистрации лицензионного ключа.
8. Перезапустить контейнер ИКСАР:
➢ cd /xr/docker/xr-prod
➢ docker restart xr-prod
2.6. Проверка доступности приложения
Проверить доступность приложения, зайдя в браузере на локальном ПК по адресу, заданному в параметре xr.main-server-url файла параметров /xr/docker/xr-prod/data/xr.properties – должна открыться страница логина. Если серверный сертификат не настроен должным образом, то перед страницей логина браузер отобразит сообщение о небезопасном соединении.
В данном документе описаны пошаговые процедуры инсталляции программной платформы решений для устройств и технологий дополненной и виртуальной реальности «ИКСАР» (далее ПО ИКСАР).
Документ предназначен для системных администраторов, обладающих базовыми навыками работы с операционными системах семейства Linux. Данная инструкция применяется после получения Заказчиком установочного носителя (дистрибутива ПО).
Дистрибутив ПО для Заказчика обычно содержит:
• все необходимые для установки ИКСАР компоненты (контейнеры) системных и прикладных программных продуктов, кроме ПО Docker;
• примеры/заготовки конфигурационных файлов.
Для определенности предполагается, что перед установкой с установочного носителя скопирован каталог install в каталог /install на сервер (в корень). Некоторые из шагов можно выполнить с загрузкой необходимых контейнеров из облачных репозиториев по сети, вместо использования дистрибутива.
2. Установка серверной части Системы на Linux
2.1. Установка и настройка Docker
Установить ПО Docker для используемой версии и редакции ОС в соответствии с инструкциями данного ПО. Версия Docker должна быть не ниже 24. Для повышения безопасности рекомендуется настроить его в режиме запуска с правами непривилегированного пользователя (Rootless mode).
Данная инструкция предполагает, что Docker установлен в режиме Rootless mode под пользователем xrd. Установка и настройка ПО Docker для различных ОС Linux описана в дополнительных документах.
2.2. Подготовка места для размещения данных и настроечных файлов
Для определенности предположим, что все настроечные файлы и данные будут размещены в каталоге /xr/docker
1. Создание каталога:
➢ sudo mkdir -p /xr
➢ sudo chown -R xrd:xrd /xr
2. Обновление владельца каталога /install:
➢ sudo chown -R xrd:xrd /install
Все дальнейшие действия выполняются под пользователем xrd.
2.3. Создание сети для взаимодействия контейнеров
➢ docker network create -d bridge backend
2.4. Установка Postgre SQL
1. Загрузить образ контейнера:
➢ docker load < /install/images/postgres-16.6.tar.gz
2. Скопировать настроечные файлы:
➢ mkdir /xr/docker
➢ cp -r /install/docker/postgres /xr/docker/
3. Проверить и настроить параметры запуска в файле/xr/docker/postgres/compose.yaml
➢ >"
4. Запустить сервис PostgreSQL:
➢ cd /xr/docker/postgres
➢ docker compose up –d
2.5. Установка сервера приложений ИКСАР
1. Загрузить образ контейнера:
➢ docker load < /install/images/xr-NN-NNNN.tar.gz
где NN-NNNN – номер устанавливаемой версии.
2. Скопировать настроечные файлы:
➢ cp -r /install/docker/xr-prod /xr/docker/
3. Проверить и настроить параметры запуска в файле /xr/docker/xr-prod/data/xr.properties
4. Заменить файл keystore.jks файлом с актуальным серверным SSLсертификатом.
5. Под администратором сменить владельца каталога /xr/docker/xr-prod/data
6. Запустить сервис ИКСАР (под пользователем xrd).
Через несколько минут (должны отработать скрипты создания структур БД) проверить успешность запуска в журнале /xr/docker/xr-prod/data/log/spring.log.
7. Настроить первоначальные данные, необходимые для последующей регистрации лицензионного ключа.
8. Перезапустить контейнер ИКСАР:
➢ cd /xr/docker/xr-prod
➢ docker restart xr-prod
2.6. Проверка доступности приложения
Проверить доступность приложения, зайдя в браузере на локальном ПК по адресу, заданному в параметре xr.main-server-url файла параметров /xr/docker/xr-prod/data/xr.properties – должна открыться страница логина. Если серверный сертификат не настроен должным образом, то перед страницей логина браузер отобразит сообщение о небезопасном соединении.