Docker окружение
| ВНИМАНИЕ!
Если вы уже используете Docker-окружение для USERSIDE 3.12, установленное до 10 мая 2019 г., то Вам обязательно необходимо ознакомиться с разделом обновления с устаревшей версии 3.12! Если Вы разворачивали Docker-окружение до 10 мая 2019 г., если оно содержит отдельно каталог с окружением userside-docker и отдельно каталог с системой /opt/userside и резервными копиями /opt/backup, то ваше окружение считается устаревшим! |
Описание
Docker-окружение является удобной альтернативой самостоятельной сборке и настройке всех необходимых компонентов сервера.
Данная статья описывает создание и запуск набора файлов - бандла Docker-окружения для USERSIDE, начиная с версии 3.12 и новее. Docker-окружение состоит только из сервисов, необходимых для функционирования системы ERP USERSIDE и не содержит саму систему USERSIDE - она устанавливается отдельно, используя заготовленные макросы.
Требования
Необходимо, чтобы на вашем сервере был установлен Docker CE, а также Docker-compose. Для этого у Вас должен быть сервер под управлением 64-разрядной ОС Linux. Инструкции по установке Docker CE и Docker-compose, в зависимости от дистрибутива и версии Linux, Вы найдете на официальном сайте: Docker CE, Docker-compose.
Мы рекомендуем использовать GIT-репозиторий для получения новых версий бандлов. Для этого необходимо установить систему управлениями версиями GIT. Однако, если Вы по каким-то причинам предпочитаете не использовать репозиторий, Вы можете просто загружать архивы с наборами файлов (бандл) вручную, как будет сказано ниче.
Версионирование бандла
С 8 мая 2019 г. структура бандла целиком изменена для удобного версионирования и простой миграции на новые версии. Если вы разворачивали бандл до 8 мая 2019 то обязательно изучите раздел Обновление - Обновление со старой версии 3.12.
После 8 мая 2019 г. для версии USERSIDE 3.12 был создан новый бандл с новыми образами, а также был создан бандл для версии USERSIDE 3.13, релиз которого запланирован на середину мая 2019 г.
Под каждую версию USERSIDE существует своя специальная версия бандла. Каждая такая версия расположена в отдельной ветке в git-репозитории. Ветки имеют одноименное с версией USERSIDE наименование. Например, v3.12, v3.13 и т.д.
Самая новая версия бандла, соответствующая последней версии стабильного релиза USERSIDE, всегда отображается в основную ветку master.
Вы можете использовать ветку master всегда, если желаете обновляться на новые релизы USERSIDE с их выходом. В противном случае вы можете использовать ветку с конкретной версией бандла, соответствующей необходимой вам версии USERSIDE.
Установка
В данном разделе рассматривается установка и запуск бандла с нуля. Если Вы обновляетесь с 3.12, то вам также придется установить бандл для 3.13 с нуля, предварительно сделав все резервные копии. Это описано в разделе Обновление.
Мы несколько изменили рекомендации по установке, тем самым упростив процесс установки, сделав его понятней и избавив вас от неоднозначного понимания некоторых действий.
Далее будут описаны шаги с указанием в качестве примера установку в каталог /docker/userside. Вы можете использовать любой удобный Вам путь расположения файлов, однако учитывайте то, что все примеры использования будут показаны именно для этого каталога.
Клонирование репозитория
Создайте каталог, в котором будет размещаться ваш бандл, а тажке в нем будет размещаться и всё окружение, включая файлы системы USERSIDE, резервные копии и файлы базы данных. И перейдите в него.
mkdir /docker && cd $_
Выполните команду клонирования репозитория в подкаталог с именем userside.
git clone https://github.com/userside/userside-docker.git userside cd userside
Если вы желаете ограничиться конкретной веткой, чтобы все обновления файлов шаблонов не выходили за пределы этой ветки, вы можете перейти в нее, например, для версии 3.13 используйте ветку v3.13. Этот шаг является необязательным. Мы рекомендуем оставаться на ветке master.
git checkout v3.13
Для последующих обновлений файлов шаблонов вам достаточно выполнить команду:
git pull
Без использования репозитория
Если по какой-то причине использование репозитория Вам не подходит, Вы можете загрузить файлы заготовок бандла вручную в виде архивов
Обратите также внимание на то, что для обновления бандла, вместо выполнения команды git pull из инструкций по обновлению ниже, вам каждый раз нужно будет загружать архив с новой версией бандла самостоятельно!
Создайте каталог, где будет размещаться бандл USERSIDE
mkdir /docker && cd $_ && mkdir -p userside
Затем загрузите в него архив с бандлом, разархивируйте его и скопируйте файлы в подкаталог userside, затем перейдите в него
wget https://github.com/userside/userside-docker/archive/v3.13.0.tar.gz tar xzf v3.13.0.tar.gz rm v3.13.0.tar.gz cp -fr userside-docker-3.13.0/* userside/ rm -rf userside-docker-3.13.0 cd userside
Конфигурирвание бандла
Выполните команду инициализации - она скопирует все необходимые файлы из шаблонов, если те еще не существуют.
./init.sh
В результате у вас появятся файлы Makefile (содержит макросы для простого управления бандлом) и docker-compose.yml (содержит всю конфигурацию бандла).
docker-compose.yml
Вы должны отредактировать файл docker-compose.yml в соответствии с вашими требованиями.
servces
В разделе services находятся настройки всех сервисов, образующих бандл - окружение для работы USERSIDE. Далее описаны рекомендации по настройке сервисов.
postgres
Раздел environment:
- LANG - настройки языка, расположения и кодировки в формате LOCALE.
- TZ - часовой пояс.
- POSTGRES_DB - наименование базы данных (желательно оставить как есть).
- POSTGRES_USER - имя пользователя для доступа к БД.
- POSTGRES_PASSWORD - пароль для доступа к БД.
fpm
Раздел environment:
- TZ - часовой пояс
Раздел volumes:
- Также, если вам необходимо внести какие-либо настройки в php-ini, вы можете раскомментировать строку с подключением файла php.ini в качестве volume, затем вручную скопировать файл php.ini-example, находящийся в подкаталоге config, в файл с именем php.ini и внести в него необходимые правки.
nginx
Раздел ports:
- Укажите номер порта хоста (слева), который бы вы хотели транслировать на порт 80 контейнера nginx. Если на хосте у вас установлен сервер nginx и вы желаете проксировать http-запросы внутрь контейнера, то в этом случае желательно ограничить доступ к контейнеру по http, а также изменить порт хоста. Например, чтобы транслировать порт 8080 локального хоста на порт 80 контейнера, укажите "8080:80". Если необходимо ограничить доступ только с локального хоста (если используете проксирование), укажите "127.0.0.1:8080:80".
Раздел logging:
- Здесь вы можете настроить логгирование стандартными средствами docker. По умолчанию в шаблоне настроена ротация логов с максимальным размером файлов 20 Мб и их количеством 10 шт.
volumes
Здесь настраиваются пути к отображаемым внутрь контейнеров volumes. Желательно не изменять эти настройки без необходимости. Если же все таки есть необходимость их изменить, то также измените соответствующие пути и в Makefile
networks
Если указанная по умолчанию подсеть для бандла пересекается с какой либо вашей подсетью, измените ее здесь в значении параметра subnet. Также это может быть полезно, если вы поднимаете несколько бандлов для разных копий USERSIDE.
Makefile
Этот файл содержит макрокоманды, упрощающие управление бандлом. По сути, это всего лишь сокращения длинных команд, которые Вы также можете использовать для конкретизации параметров.
Главные макрокоманды вынесены в самый верх файла. Это те команды, которые могут пригодиться вам для работы с бандлом чаще остальных. Чаще всего, это просто более короткие псевдонимы других команд. Чтобы выполнить любую из команд, достаточно указать ее после make в командной строке. При этом текущий каталог должен быть /docker/userside. Например, чтобы запустить бандл, выполните:
make up
Список команд
- up - запускает бандл
- down (или stop) - останавливает бандл
- install - составная команда, которая выполняет все действия, необходимые для развёртывания и запуска бандла, а также установки USERSIDE
- userside-install - команда, которая только запускает скрипт-установщик внутри контейнера (возможно пригодится, если установка предыдущей командой закончилась неудачно и нужно повторить запуск установщика)
- update - составная команда, которая выполняет все действия, необходимые для обновления как docker-образов окружения, так и самой системы USERSIDE
- uninstall - составная команда, которая выполняет удаление бандла. При этом файлы userside, резервные копии и файлы базы данных остаются
- log - команда, отображающая все логи бандла в реальном времени (выход ctrl+c)
Также Вы можете использовать и остальные команды в отдельности, указанные в этом файле. Кроме того, Вы можете использовать команду docker-compose напрямую, чтобы выполнять команды бандла, не предусмотренные этим файлом.
Если вам необходимо изменить или дополнить список макросов, вы можете изменять этот файл так, как вам необходимо. При обновлении бандла обновится лишь шаблон этого файла, а не сам файл.
Инсталляция
При первом запуске необходимо выполнить макрос install:
make install
Этот макрос создаст необходимые каталоги, затем запустит бандл (при первоначальном запуске будут загружены все необходимые образы), затем запустит установщик userside, установит crontab для периодических операций и выполнит первоначальный запуск crontab для userside.
При установке обратите внимание на имена хостов для postgresql и redis. Именами хостов этих служб являются имена сервисов: postgres и redis соответственно.
После успешной инсталляции никаких дополнительных действий не требуется. Откройте в браузере адрес с установленным userside.
Эксплуатация
При необходимости бандл можно остановить командой
make stop
И запустить командой
make up
Следить за логами в реальном времени командой
make log
Запустить консоль PostgreSQL psql
make postgres-psql
Запустить консоль Redis redis-cli
make redis-cli
Запустить планировщик userside вручную
make cron-run
Также можно использовать команду docker-compose для случаев, не предусмотренных набором макросов (можете дополнить список макросов самостоятельно).
docker-compose -p userside ps
Приведенная выше команда отобразит все контейнеры бандла и их состояние.
Резервное копирование и восстановление
Во время инсталляции создается crontab в /etc/cron.d/userside, в котором прописаны три действия: периодический запуск планировщика userside и два действия для резервного копирования базы данных и файлов.
Если Вам необходимо вручную создать резервные копии базы данных и файлов, Вы можете запустить макрос:
make backup
В результате в каталоге /docker/data/backup будут созданы резервные копии базы данных и файлов.
Чтобы восстановить базу данных из резервной копии, выполните:
make DUMP="userside_2019-05-08_09-23-19.dump" dbrestore
Также вы можете использовать другие удобные вам приемы, используемые при резервном копировании и восстановлении базы данных при работе с Docker-контейнерами.
Чтобы восстановить файлы из резервной копии, выполните:
cd /docker/data/backup tar -xjf userside_2019-05-08_09-23-19.tar.bz2 -C /docker/data/
Дополнительное конфигурирование
Вам может понадобиться более тонко настроить бандл. Например, изменить значения переменных php.ini или же провести настройку postgresql.
PHP
Случай с php.ini уже был показан выше. Строка, которую необходимо раскомментировать, а также файл шаблона php.ini-example уже содержатся в бандле в качестве примера. Просто скопируйте файл php.ini-example, расположенный в каталоге config бандла, с именем php.ini, внесите необходимые правки, раскомментируйте строку, подключающую этот файл в качестве volume в сервисе fpm файла docker-compose.yml и перезапустите бандл
cd config cp php.ini-example php.ini nano php.ini nano docker-compose.yml make stop make up
PostgreSQL
Для более производительной работы сервера PostgreSQL требуется произвести его настройку в соответствии с техническими параметрами сервера - тюнинг. С методиками тюнинга можно ознакомиться по ссылкам [1] и [2]. Также есть специальные инструменты, помогающие сформировать конфигурацию сервера PostgreSQL в удобном интерактивном виде [3] и [4].
Конфигурационные файлы PostgreSql транслируются из докер-контейнера вместе с базой данных в каталог /docker/data/db. В нем вы найдете все необходимые конфигурационные файлы, включая файл pg_hba.conf для настройки разрешений. После внесения правок просто перезапустите бандл макросами stop и up:
make stop make up
Обновление
Мы рекомендуем производить обновление в то время, когда приостановка работы системы не влияет на работу компании. Во время обновления могут произойти нештатные ситуации, от которых никто не застрахован. И, хотя у нас этот процесс отлажен достаточно четко, все равно, пожалуйста, не полагайтесь на волю случая.
В пределах минорной версии
Если вы обновляетесь в пределах минорной версии. Например, в пределах 3.13 (с 3.13.2 на 3.13.8), то вам достаточно воспользоваться макросом update:
git pull make update
В этом случае автоматически будет выполнено резервное копирование базы данных и файлов, обновление docker-образов и запуск инсталлятора для произведения обновления самого приложения. Как правило, в пределах минорной версии никаких изменений в окружении не происходит (если того не требуют исправления, о чем всегда будет указано в changelog к версии, на которую вы планируете обновиться), поэтому больше никаких действий не требуется.
На новую минорную версию
Если вы обновляетесь на новую минорную версию. Например, с версии 3.13.87 на версию 3.14.2, то обновление в полностью автоматическом режиме не подойдет. Эта инструкция также справедлива и для обновления с версии 3.12 на новую минорную версию (например, 3.13), при условии, что бандл для 3.12 вы разворачивали по инструкции после 10 мая 2019 г. Для этого необходимо сначала обязательно ознакомиться с информацией по обновлению на новую минорную версию, затем проделать следующие шаги:
make backup make stop git pull
Затем внимательно просмотреть файлы docker-compose.yml-example и Makefile-example на предмет новых сервисов, томов, зависимостей, наименований образов, макросов. Затем дополнить свои файлы docker-compose.yml и Makefile недостающими или измененными строками. Затем выполнить:
make bundle-pull make up make postgres-postgis-update make userside-install
После установки убедиться, что все работает корректно.
Обновление с устаревшей версии 3.12 на новую
Если Вы разворачивали Docker-окружение для версии 3.12 по инструкции до 10 мая 2019 года, то вам необходимо проделать последовательность действий, описанную в этом разделе.
Как убедиться в том, что вы разворачивали Docker-окружение, которое является устаревшим? Если у вас каталог с бандлом (по инструкции это был каталог ~/userside-docker) и каталог с устанавливаемым приложением и резервными копиями (по инструкции это были каталоги /opt/userside /opt/backup), то ваша версия устарела. В новой версии бандла v3.12 организация каталогов точно такая же, как и в v3.13 и во всех будущих версиях.
Итак, если у вас именно устаревший бандл, то проделайте следующее:
Резервное копирование
Перейдите в каталог с бандлом (~/userside-docker если вы следовали инструкции и не меняли его месторасположение) и выполните резервное копирование, запустив команду
make backup
Далее создайте где-то в надежном месте каталог, в котором будут размещены промежуточные резервные копии. Например, пусть это будет /backup и скопируйте в него все файлы резервных копий, а также файл docker-compose.yml
mkdir /backup sudo cp /opt/backup/* /backup cp docker-compose.yml /backup
Убедитесь в том, что файлы резервных копий скопированы!
Удаление старых файлов
Остановите работу бандла и удалите его
docker-compose -p userside down -v
Теперь удалите каталог с бандлом, каталог с приложением и бекапами
make uninstall cd / sudo rm -rf ~/userside-docker sudo rm -rf /opt/userside /opt/backup
На данный момент у вас должны остаться только резервные копии.
Установка нового бандла
Теперь произведите установку бандла с самого начала. Вы можете использовать ветку master (она содержит актуальную версию 3.13 или ту версию, которая будет актуальна на момент чтения этих строк) или же выбрать другую ветку, как показано выше в разделе установки. Мы рекомендуем использовать ветку master. Выполните следующие команды:
mkdir -p /docker && cd $_ git clone https://github.com/userside/userside-docker.git userside cd userside
Теперь выполните инициализацию - в результате в каталоге появятся файлы docker-compose.yml и Makefile. Отредактируйте файл docker-compose.yml, указав в нем настройки для сервисов postgres и nginx точно такие же, как были в старом файле docker-compose.yml (который Вы сохранили в /backup)
./init.sh nano docker-compose.yml
Создайте необходимые каталоги, запустите бандл и проверьте его работу. Статус всех контейнеров должен быть Up
make create-env-dir make up docker-compose -p userside ps
Восстановление из резервной копии
Восстановите базу данных и файлы из резервной копии. Для этого скопируйте файлы последней резервной копией, которая была сделана непосредственно перед обновлением, из каталога /backup в каталог /docker/userside/data/backup (имена файлов у вас будут другие!), выполните команды восстановления и команду обновления postgis для базы данных. (В процессе восстановления могут быть ошибки записи для расширения postgis - это нормально, так как у пользователя базы данных userside недостаточно для этого прав)
cp /backup/userside_2019_05-07* data/backup/ make DUMP="userside_2019-05-07_00-00-00.dump" dbrestore tar -xjf data/backup/userside_2019-05-07_16-49-41.tar.bz2 -C /docker/userside/data/ make postgres-postgis-update
Запуск обновления
Теперь необходимо запустить скрипт-инсталлятор для обновления версии
make userside-install
Во время обновления вам понадобится ввести параметры подключения к сервисам, которых еще не существовало в версии 3.12. Для подключения к сервису Redis используйте имя хоста redis, остальные параметры оставьте по умолчанию.
После обновления выполните команду установки crontab
make cron-setup
Убедитесь, что USERSIDE работает нормально. На этом обновление с версии 3.12 можно считать завершенным.
Предложения по доработке бандла
Мы принимаем предложения по доработке бандла окружения в issue или в виде нормально оформленных pull-request'ов на Github или в виде предложений и замечаний через тикет-систему в личном кабинете.