АВТОМАТИЧЕСКОЕ РАЗВЁРТЫВАНИЕ PLAN-R
С помощью скрипта update.sh входящего в комплект поставки, можно произвести автоматическую установку или обновление Plan-R.
Справка по флагам
Скрипт, update.sh поддерживает следующие флаги:
- -f : директория, которая содержит архив с дистрибутивом Plan-R в zip формате или директория с распакованным дистрибутивом
- -w : директория развёртывания. По умолчанию, /opt. Для правильной работы скрипта не рекомендуется менять значение по умолчанию
- -i : принудительный запуск скрипта в режиме чистой установки(INSTALL_MODE). По умолчанию, false.
- -b : создание бэкапа БД, перед обновлением(флаг поддерживается, только в режиме обновления). Если, флаг передан в значении true, то создаётся бэкап базы данных на текущий момент в директории /dppm/postgres_dump. По умолчанию, false.
- -l : перенос конфигураций системы логирования (/logging) из предыдущей версии. Если, флаг -l передан в значении true, то текущая конфигурация fluent-bit и loki сохраняется(флаг поддерживается, только в режиме обновления). По умолчанию, false.
- -с : создание записи в планировщикке crontab для автоматического бэкапа базы данных. Если, флаг передан в значении true, то входящий в комплект поставки скрипт dump.sh, добавляется в таблицу исполнения скриптов по расписанию crontab. В данном случае скрипт выполняется каждую ночь в 3:00, делает бэкап в директорию /dppm/postgres_dump/ с периодом ротации 14 (Это означает что в папке всегда будет хранится 14 актуальных бэкапов) и количеством файлов, которые не удалятся в любом случае – 5. По умолчанию, false.
- -h : вызов справки по флагам
Установка Plan-R с помощью скрипта update.sh(Linux)
Подготовка к установке Plan-R
Перед установкой Plan-R, нужно убедится, что в системе установлены совместимые версии Docker и Docker Compose, а также ахрхиватор unzip. Минимально, совместимыми версиями, являются Docker 19.03.0 и Docker Compose 1.27.1. Проверить наличие в системе Docker и Docker Compose и unzip, можно следующими командами:
docker -v
docker-compose -v
#Docker Compose version v2
docker compose version
#unzip
unzip -v
Если, в системе не установлено ПО Docker и Docker Compose, то рекомендуется выполнить установку в соответсвии с инструкцией на официальном сайте: https://docs.docker.com/engine/install/
Внимание! После, установки Docker и Docker Compose в соответсвии с инструкцией на официальном сайте, в систему установится Docker Compose version v2. Для того, чтобы Docker Compose version v2 был совместим и мог выполнять команды Docker Compose version v1, нужно ввести в терминале от имени администратора, следующую команду:
sudo ln -s /usr/libexec/docker/cli-plugins/docker-compose /usr/bin/docker-compose
Установка unzip:
- Для Ubuntu/Debian:
sudo apt install unzip
- Для RHEL/CentOS/Fedora:
sudo yum install unzip
Установка Plan-R
Внимание! Перед началом установки Plan-R убедитесь в наличии минимум 20Гб свободного места
Для того, чтобы произвести чистую установку Plan-R, необходимо запустить c правами администратора скрипт update.sh с флагом -i true. Так же, с помощью флага -f нужно обязательно передать директорию, в которой находится скачаный архив с дистрибутивом в zip формате.
Скрипт update.sh запущенный в режиме чистой установки(с флагом -i true), по умолчанию создаёт в директории развёртывания /opt, следующую структуру каталогов:
- /opt/dppm/ – каталог текущей развернутой системы
- /opt/dppm/dist/ – каталог для хранения скачанных дистрибутивов
- /opt/dppm/postgres_dump – каталог для бэкапов базы данных
Директория развёртывания по умолчанию /opt. Если, необходимо задать другую директорию развёртывания, то необходимо передать в скрипт update.sh флаг -w с указанием директории, в которой будет создаваться структура каталогов.
Внимание! В режиме чистой установки не рекомендуется изменять директорию развёртывания по умолчанию.
По окончании установки, перейдите в директорию /opt/dppm/planr, проверьте настройки файла .env и выполните запуск Plan-R, выполнив скрипт ./start.sh
Обновление Plan-R с помощью скрипта update.sh(Linux)
Внимание! Перед началом обновления Plan-R убедитесь в наличии минимум 20Гб свободного места
Внимание! Перед началом обновления Plan-R убедитесь, что созданная при установке Plan-R структура каталогов,имеет вид:
- /opt/dppm/ – каталог текущей развернутой системы
- /opt/dppm/distr/ - каталог для хранения скачанных дистрибутивов
- /opt/dppm/planr/ - содержит набор файлов конфигурации PLAN-R и всех необходимых сервисов
- /opt/dppm/images/ - каталог images, содержит заархивированные docker-образы системы PLAN-R(наличие, необязательно)
Перед проведением обновления, необходимо перейти в папку разворота системы по умолчанию /opt/dppm/planr и остановить систему, выполнив скрипт ./stop.sh.
Входящий в комплект поставки скрипт update.sh по умолчанию, запускается в режиме обновления. При запуске скрипта, с помощью флага -f, нужно обязательно указать директорию, в которой находится архив со скачанным дистрибутивом в zip формате. В режиме обновления, скрипт update.sh поддерживает все флаги, перечисленные в пункте Справка по флагам(см.выше). Так же, справку по флагам можно вызвать, запустив скрипт update.sh в терминале с флагом -h:
./update.sh -h
Перейдите в папку со скриптом и выполните обновление системы, запустив с правами администратора скрипт update.sh с необходимыми флагами:
После выполнения обновления, перейдите в директорию /opt/dppm/planr, проверьте настройки файла .env и выполните запуск Plan-R, выполнив скрипт ./start.sh