Skip to content

Latest commit

 

History

History
325 lines (238 loc) · 27.8 KB

README.md

File metadata and controls

325 lines (238 loc) · 27.8 KB
Raw

dcape - Docker composed application environment

GitHub Release GitHub code size in bytes GitHub license

Dcape - это среда оркестрации docker-контейнеров для программистов. Она позволяет упростить разворачивание собственного или стороннего ПО на локальном компьютере, промышленном или облачном сервере. Среду dcape формируют сервисы встроенных приложений, которые автоматизируют задачи по запуску, обновлению, удалению, анализу и мониторингу разворачиваемых приложений. Состав встроенных приложений конфигурируется по необходимости при инициализации dcape.

Для развертывания приложения в среде dcape достаточно составить два файла - Makefile и docker-compose.yml. Приложения, для которых эти файлы составлены, являются адаптированными для развертывания в среде dcape. Примеры можно посмотреть в списке адаптированных приложений.

Как это работает

Приложения (собственные исходные тексты или файлы конфигурации стороннего ПО) размещаются в репозитории на github.com или аналогичном сервисе (может использоваться встроенное приложение gitea, или собственный аналогичный сервис).

Для поддержки среды dcape репозиторий должен содержать файлы:

  • docker-compose.yml - конфигурация сервисов docker, используемых для сборки и запуска приложений
  • Makefile с командами создания файла конфигурации запуска .env, подготовки окружения приложения (БД и прочее), запуском сервисов через docker-compose

Разворачивание приложения производится командой make start-hook, которая путем исполнения целей из Makefile, подготавливает запуск приложения, финальной целью является запуск docker-compose с использованием переменных конфигурации запуска из файла .env. Инициирование запуска make start-hook производится вебхуком сервиса git, при использовании промышленного или облачного сервера с dcape. Если dcape используется локально - разворачивание приложения осуществляется командой make start, запускаемой в терминале.

Файл .env c переменными для docker-compose.yml и другими переменными для запуска приложения не размещается в репозитории, при первом деплое он создается командой make .env и сохраняется вебхуком в Хранилище конфигураций (enfist). После этого, доступ к конфигурации запуска приложения осуществляется через это хранилище. Для каждой ветки репозитория создается своя конфигурация запуска.

Настройка dcape, для разворачивания приложения, состоит из двух шагов:

  1. Настроить автоматическое обновление (webhook) в репозитории проекта
  2. Поместить в хранилище конфигураций запуска приложения файл .env с разрешением на деплой (_CI_HOOK_ENABLED=yes)

После этого push в репозиторий проекта будет приводить к разворачиванию/обновлению приложения в среде dcape. См. также: DEPLOY.md. Для локального использования dcape такая настройка не требуется.

Стек приложений

Текущая версия dcape имеет в составе следующие встроенные приложения:

  • cis (в составе dcape) - статический сайт (на базе nginx), на котором публикуется информация, необходимая для работы с dcape: список разврнутых приложений, ключи доступа, и т.п. Для доступа к информации необходимо наличие учетной записи в gitea и участие в задаваемой в настройках команды (организации) gitea.
  • gitea (docker) - git совместимый сервис для работы с репозиториями
  • traefik (docker) - агрегация и проксирование www-сервисов развернутых приложений по заданному имени с поддержкой сертификатов Let's Encrypt
  • portainer (docker) - управление приложениями (контейнерами и образами)
  • webhook (docker) - деплой (запуск, обновление, удаление) приложений по событию из gitea
  • webtail (docker) - агрегация и www доступ к логам событий приложений (запуск, удаление, обновление)
  • enfist (docker) - хранилище файлов .env в postgresql
  • narra (docker) - сервис авторизации для nginx через API gitea
  • postgresql (docker) - хранение конфигураций приложений и баз данных, если приложению требуется СУБД. Детали в инструкции по работе с Postgres

Служебные приложения dcape:

  • nginx (docker) - доступ к статическому контенту
  • dcape-config-cli - утилита для работы (загрузки,выгрузки, изменения) с конфигурациями запуска в среде dcape

Приложения, адаптированные для среды dcape:

  • drone (docker) - сборка и тест приложения в отдельном контейнере
  • mattermost (docker) - сервис группового общения
  • powerdns - (docker) DNS-сервер, который хранит описания зон в БД postgresql

Актуальный список адаптированных приложений dcape

Зависимости

  • linux 64bit (git, make, wget, gawk, openssh-client)
  • docker

Для работы с контейнерами в dcape используется образ docker c docker-compose, поэтому отдельной установки docker-compose не требуется.

Быстрый старт

На удаленном (облачном) сервере, где после установки ОС ubuntu/debian не производилось настроек, можно установить dcape и провести тюнинг сервера одной командой:

curl -sSL https://raw.githubusercontent.com/dopos/dcape/master/install.sh | sh -s \
 192.168.0.1 -a op -p 32 -s 1Gb -delntu \
 -c 'APPS="traefik-acme gitea portainer enfist cis" DOMAIN=your.domain TRAEFIK_ACME_EMAIL=admin@your.domain'

В DNS зоне для домена your.domain должна быть создана wildcard запись для ip сервера (.your.domain A ip)

См. также: install.sh

Управление конфигурациями запуска приложений

Конфигурация запуска любого приложения dcape - текстовый файл .env, который создается командой make .env. Этот файл используется make start-hook для разворачивания приложения и docker-compose для управления контейнерами приложения. В части переменных, используемых в docker-compose.yml, формат файла должен соответствовать docker-compose env_file.

Конфигурации запуска приложений хранятся в БД в виде Key-value хранилища, где ключ формируется из адреса git репозитория organization--name_of_repo--branch (организация--проект--ветка), а значение - содержимое .env файла. Доступ к хранилищу закрыт паролем и осуществляется через фронтенд cis.

Кроме веб-интерфейса, работа с конфигурациями запуска может осуществляться через dcape-config-cli. Примеры команд, доступных после клонирования (git clone) и настройки (make .env) dcape-config-cli:

  • make get TAG=name - получить из хранилища конфигурацию для тега name и сохранить в файл name.env
  • make set TAG=name - загрузить файл name.env в хранилище с тегом name

Тег содержит значение равное ключу БД Key-value хранилища organization--name_of_repo--branch (организация--проект--ветка)

Структура проекта

dcape
├── apps
│   ├── cis
│   │   ├── docker-compose.inc.yml
│   │   ├── html/
│   │   ├── Makefile
│   │   └── nginx.conf
│   ├── enfist
│   │   ├── docker-compose.inc.yml
│   │   └── Makefile
│   ├── gitea
│   │   ├── docker-compose.inc.yml
│   │   └── Makefile
│   ├── portainer
│   │   ├── docker-compose.inc.yml
│   │   └── Makefile
│   ├── traefik
│   │   ├── docker-compose.inc.yml
│   │   └── Makefile
│   └── traefik-acme
│       ├── docker-compose.inc.yml
│       └── Makefile
├── DEPLOY.md
├── docker-compose.inc.yml
├── install.sh
├── LICENSE
├── Makefile
└── README.md

Установка

Установка производится на хост с 64bit linux

Настройка DNS

При установке на локальный компьютер, для доступа к сервисам dcape (cis.dev.lan, port.dev.lan) необходимо настроить wildcard domain *.dev.lan:

sudo bash -c 'echo "address=/dev.lan/127.0.0.1" > /etc/NetworkManager/dnsmasq.d/dev.lan.conf'
sudo service network-manager reload

или можно прописать эти имена в /etc/hosts:

sudo bash -c 'echo "127.0.0.1 cis.dev.lan" >> /etc/hosts'
sudo bash -c 'echo "127.0.0.1 port.dev.lan" >> /etc/hosts'

но в этом случае придется отдельно прописывать имя для каждого нового сервиса dcape.

Установка приложения

# make
which make || sudo apt-get install make

# dcape
cd /opt
sudo mkdir dcape && sudo chown $USER dcape
git clone https://github.com/dopos/dcape.git
cd dcape

# gawk wget curl apache2-utils openssh-client
make deps

Использование TLS

Dcape поддерживает протокол TLS с использованием ключей Let's Encrypt. При инициализации Dcape, поддержку TLS можно сконфигурировать четырьмя способами:

  • local mode - локальная установка, использование DCAPE на локальном компьютере без поддержки TLS.
  • dev mode - установка с использованием TLS с отдельным сертификатом для каждого приложения, использование которых настраивается конкретно для приложения при его развертывании. По умолчанию включено для встроенных приложений dcape (cis, portainer, gitea). В этом режиме используется переменная REDIR_ENTRY, которой устанавливается редирект на https отдельно для каждого приложения. В других режимах значение этой переменной не определено и не используется.
  • wild mode - установка для деплоя приложений с возможностью использования TLS c wilcards сертификатом от Let's Encrypt для всех веб сервисов dcape и приложений (позволяет не опасаться ограничения по лимиту количества сертификатов на один домен).
  • production mode - установка с использованием индивидуальных сертификатов Let's Encrypt для каждого веб сервиса.

Dcape поддерживает автоматическую генерацию сертификатов и валидацию домена для индивидуальных сертификатов. Для wildcards сертификатов, автоматическая генерация сертификатов и валидация доменов поддерживается для DNS провайдеров с поддержкой API. По умолчанию, при инициализации, конфигурируется автоматизированная генерация (перегенерация) сертификатов, при которой автоматически запускается генерация сертификата, в лог файл выдается хеш, который необходимо внести в поле домена, тип TXT, имя _acme-challenge.$DOMAIN, значение хеш из лога . Wildcards генерируется для домена: *.$DOMAIN, где DOMAIN="домен для которого разворачивается DCAPE"

Для перехода на автоматический wild-mode необходимо:

  • изменить в директиве APPS сервис traefik-acme на treafik-acme-wild
  • в .env добавить директивы DNS_CHALLENGE_PROVIDER и DNS_CHALLENGE_RESOLVER
  • в apps/traefik-acme-wild/docker-compose.inc.yml в секции environment указать соответствующие вашему провайдеру наименования API_KEY/API_URL по примеру PDNS
  • выполнить make reup для DCAPE.

В случае не запуска traefik-acme-wild смотреть логи контейнера. Контейнер не будет запускаться, если упущены обязательные настройки.

В период настройки во избежание бана со стороны Letsencrypt рекомендуется использовать директиву ACME_CASERVER=https://acme-staging-v02.api.letsencrypt.org/directory для работы через тестовый канал (выписывается Fake сертификат), а после полной отладки механизма, выкл ACME_CASERVER.

Инициализация

На этом этапе задается список приложений, формируется файл настроек dcape (файл .env) и вспомогательные файлы. Выбор варианта команды make init зависит от требуемой конфигурации среды (состава встроенных приложений).

При инициализации определяется состав сервисов, который будет запущен при старте dcape. Полный перечень сервисов: db, traefik, portainer, enfist, cis. В зависимости от поддержки TLS, сервис traefik используется с разными именами (конфигурациями): traefik, traefik-acme, traefik-acme-wild.

Примеры команды:

# конфигурация локального сайта в комплекте с gitea
make init-local

# сайт, доступный извне, с сертификатами от Let's Encrypt
make init-master-prod DOMAIN=your.host TRAEFIK_ACME_EMAIL=admin@your.host

# сайт, доступный извне, с сертификатами от Let's Encrypt, без gitea.
make init-slave-prod DOMAIN=your.host TRAEFIK_ACME_EMAIL=admin@your.host

# сайт, доступный извне, с сертификатами от Let's Encrypt для встроенных приложений
make init-master-dev DOMAIN=your.host TRAEFIK_ACME_EMAIL=admin@your.host

# сайт, доступный извне, с сертификатами от Let's Encrypt для встроенных приложений, без gitea.
make init-slave-dev DOMAIN=your.host TRAEFIK_ACME_EMAIL=admin@your.host

# сайт, доступный извне, с сертификатом wildcards от Let's Encrypt
make init-master-wild DOMAIN=your.host TRAEFIK_ACME_EMAIL=admin@your.host

# сайт, доступный извне, с сертификатом wildcards от Let's Encrypt, без gitea.
make init-slave-wild DOMAIN=your.host TRAEFIK_ACME_EMAIL=admin@your.host

# свой список приложений
make init APPS="gitea portainer" DOMAIN=example.com

# использование контейнера postgresql для разработки SQL:
make init PG_IMAGE=dopos/postgresql

# изменение локального порта, по которому будет доступен postgresql (по умолчанию: 5433):
make init PG_PORT_LOCAL=5434

После выполнения init, надо отредактировать файл .env, изменив дефолтные настройки на необходимые. Также будет создан каталог var/ для файлов, необходимых для запуска приложений. Персистентные данные приложений размещаются в var/data/, журналы - в var/log/.

По готовности файла .env, необходимо обработать его командой

make apply

При этом будут стартованы контейнеры enfist и db (postgresql), созданы БД приложений, загружены необходимые для работы данные.

Настройка git (cis)

Доступ к cis.host осуществляется через систему git. Для доступа, необходимо в файле .env (CIS_GITEA_ORG) указать наименование команды (организации), участникам которой будет предоставлен доступ. Создать в git команду (организацию) и включить в нее участников.

Использование

  • make up - старт приложений

После выполнения этой команды все последующее администрирование среды и запущеных сервисов производится в www интерфейсе portainer. Вместе с тем, в консоли доступны следующие команды:

  • make - список доступных команд
  • make down - остановка и удаление всех контейнеров
  • make dc CMD="up -d cis" - стартовать контейнер заданного приложения (если не запущен)
  • make dc CMD="rm -f -s cis"- остановить и удалить контейнер
  • make dc CMD="up -d --force-recreate cis" - пересоздать и стартовать контейнер и его зависимости
  • make db-create NAME=ENFIST - создать в postgresql пользователя и БД из настроек enfist
  • make db-drop NAME=ENFIST - удалить пользователя и БД
  • make apply PG_SOURCE_SUFFIX=-171014 - развернуть проект, используя резервные копии БД, созданные pg-backup

Обновление файла .env

При обновлении проекта возможно появление новых переменных в .env файле. Алгоритм обновления .env с сохранением старых настроек:

mv .env .env.bak
make init

Другой вариант:

mv .env .env.1019
make init CFG_BAK=.env.1019

Все совпадающие значения будут взяты из .env.bak (т.е. из старого конфига). Если изменятся номера версий используемых образов docker, будут выведены предупреждения.

Для того, чтобы обновить номера версий образов docker, сохранив остальные настройки, надо подготовить .env.bak, убрав из него номера версий:

grep -v "_VER=" .env > .env.bak
mv .env .env.all
make init

Особенности реализации

  • для запуска контейнеров достаточно docker и make (docker-compose запускается в контейнере)
  • для настройки приложения достаточно двух файлов - Makefile и docker-compose.yml
  • настройки встроенных приложений размещены в apps/*/docker-compose.inc.yml, все эти файлы средствами make копируются в docker-compose.yml перед запуском docker-compose
  • файлы var/apps/*/Makefile содержат две цели (для адаптированных приложений):
    • init - добавление настроек приложения в файл .env
    • apply - подготовка БД и данных приложения в var/data/*/

Две и более среды dcape на одном сервере

  • в текущей версии - для второй копии изменить порт в параметре TRAEFIK_PORT и использовать в настройке APPS traefik (не traefik-acme).
  • в планах - для 2й и следующих копий реализовать конфигурацию без своего traefik (с подключением основного traefik к сети копии).

TODO

  • nginx в cis кэширует ip внутренних хостов (enfist, traefik etc) и после их рестарта может их потерять (или обратиться к чему-то другому по старому ip)
  • mmost bot: /cget <name>, /cset <name>, /cls <mask> (channel linked to server)
  • flow: PR -> Drone -> post to mmost chat with link to PR
  • webhook: обработка pull request

Предыдущее решение

Dcape (Дикейп) - это реинкарнация consup (консап). В dcape тот же функционал реализован на основе docker-compose, более продвинутой чем fidm версии fig. В dcape не требуется для каждого приложения создавать специальный docker-образ. В большинстве случаев подходит официальный образ приложения с https://hub.docker.com (или https://cloud.docker.com). В остальных случаях используются альтернативные сборки, доступные в этом же реестре.

Благодарности

  • Проекту docker-compose, который научился читать конфиг из файла (что позволило отказаться от fidm)
  • Проекту traefik за возможность на лету подключать контейнеры как виртуальный HTTP-хост (что избавило от необходимости собирать индивидуальные контейнеры consup)
  • Проекту portainer, который позволил управлять инфраструктурой docker через веб-интерфейс, без логина на сервер по ssh

Лицензия

The MIT License (MIT), see LICENSE.

Copyright (c) 2017 Alexey Kovrizhkin lekovr+dopos@gmail.com