Skip to content

cli continuous delivery (CD) utility for docker-compose apps

License

Notifications You must be signed in to change notification settings

PavelMilanov/opencd

Repository files navigation

opencd - cli-утилита для CD (continuous delivery) кода из вашего удаленного репозитория


требования и зависимости

  • ОС на базе дистрибутивов Linux (Debian, Ubuntu);
  • установленные git, docker;
  • наличие файла docker-compose.* в вашем проекте;
  • доступ к удаленному репозиторию. (если репозиторий приватный - предварительно установить ssh-ключи для авторизации в репозитории).

для чего нужен

  • осуществляет непрерывную достаку кода из вашего удаленного репозитория с помощью файла конфигурации opencd.yaml;
  • собирает и перезапускает docker-контейнеры;
  • следит за состоянием образов и контейнеров, удаляя ненеужные.

как работает

  • анализирует изменения удаленного и локального репозитория с помощью git;
  • анализирует файл конфигурации docker-compose;
  • автоматизирует сборку и обновление ваших компонентов docker-compose на основе изменений git;
  • удаляет неиспользуемые контейнеры и образы docker.

установка

  • выполнить последовательно следующие команды:
wget https://github.com/PavelMilanov/opencd/releases/download/v0.2.5.1/install.sh
sudo bash ./install.sh
  • проверка установленной версии opencd:
opencd version

opencd version 0.2.5.1
git version 2.45.0
Docker Compose version v2.27.0-desktop.2
  • добавить в корень проекта файл opencd.yaml

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

  • обновить проект:
opencd deploy -e [environment] -s [stage]
  • помощь при обновлении проекта:
opencd deploy -h
  • посмотреть версию:
opencd version
  • посмотреть структуру команд:
opencd help

справочная информация

  • краткое описание структуры opencd.yaml