Синхронизация локальных изменений с docker/kubernetes контейнером
Думаю это знакомая ситуация, когда вы решили создать какой-то сервис, написали первичный код, завернули это в контейнер, запустили в docker или в kubernetes и все заработало…но вам понадобилось поменять код, ведь вы собираетесь вести активную разработку — изменять файлы, добавлять новые зависимости и так далее, не хотелось бы каждый раз вручную собирать или синхронизировать файлы, т.к. это занимает много времени. К счастью мир не стоит на месте и уже есть несколько инструментов, которые позволят вам решить эту задачу и ниже я вам расскажу о некоторых из них, с примерами и кодом.
skaffold/tile конфигурации настроены для kubernetes, самый простой способ развернуть у себя локальный кластер — это docker desktop, заходим в настройки и отмечаем галочкой Enable Kubernetes или же можете воспользоваться minikube
Docker compose watch
Пожалуй, стоит начать с самого простого, как инструмента, так и конфигурации — это Docker compose watch, которая стала доступна начиная с версии 2.22.
Watch можно использовать, чтобы отслеживать изменения в файлах и выполнить одну из трех действий:
Sync — синхронизирует изменения в файле с файлом в контейнере.
Rebuild — запускает процесс сборки образа и заменяет уже запущенный контейнер новым
Sync + Restart — синхроинизурет изменения и перезапускает контейнер
Пример:
На примере выше можно увидеть простой конфиг для docker compose, но нам интересен ключ watch, где указано, что если поменялся файл web/package.json, нужно запустить пересборку, т.к. нужно обновить зависимости и перезапустить процесс, но если изменилось что-то другое в папке web, то запускаем процесс синхронизации, а npm start внутри контейнера увидит эти изменения и обновит сервис.
Запускать в режиме watch очень легко, нужно запустить следующую команду:
docker compose watch
Пример работы docker compose watch
Это простой пример показывает как легко можно запустить контейнер и синхронизировать изменения на лету, более подробную информацию про эту возможность читайте на официальном сайте https://docs.docker.com/compose/file-watch/
Skaffold
Следующий на очереди Skaffold, прекрасный инструмент, которым пользуюсь в течение последних двух лет, работает стабильно, имеет довольно обширный функционал, но в рамках данной статьи рассмотрим только команду skaffold dev, которая автоматические отслеживает изменения и синхронизирует их в kubernetes pod.
Пример:
На примере выше можно увидеть простую конфигурацию, где указан путь до Dockerfile и путь до k8s manifest-а, в конфиге sync выбран тип manual, который говорит о том, что путь до директории, который нужно синхронизировать, мы укажем сами, что и сделано (синхронизируем изменения в локальной папке web в /app папку контейнера).
Для запуска в режиме разработки (в этом режиме отслеживаются и синхронизируются изменения) нужно запустить команду:
skaffold run -f deploy/skaffold.yaml --port-forward=pods
Пример работы skaffold dev
Это не все возможности Skaffold, это очень мощный инструмент, который можно использовать как для локальной разработки, так и на продакшне, более подробную информацию можете прочитать на официальном сайте https://skaffold.dev/docs/
Tilt
Последний, но не по важности, инструмент Tilt, с которым у меня практически нет опыта, но на github более 7k звездочек и они присоединилсь к Docker, что звучит многообещающе.
Пример:
У этого инструмента свой формат файла и для подсветки синтаксикса в intellij idea можно воспользоваться этим https://github.com/tilt-dev/tiltfile.tmbundle, на скрине можно увидеть 3 функции:
1. k8s_yaml — указываем путь до k8s manifest
2. docker_build — указываем данные для сборки и интересная часть live_update, где указываем, что нужно синхронизировать и какую команду нужно запустить, если изменился какой-то файл
3. k8s_resource — тут указаны название ресурса и порт, который хотим прокинуть
Запуск довольно простой:
tilt up -f deploy/Tiltfile
Пример работы title up
Как и с другими инструментами, это лишь простой пример применения этого инструмента, который способен на большее, подробности можете прочесть на официальном сайте https://docs.tilt.dev/
Если вы знаете другие инструменты, которыми вы пользуетесь или пользовались, просьба отписаться в комментариях, по возможности буду обновлять пост с примерами других инструментов.
Все исходники можно найти тут https://github.com/idsulik/local-dev
p.s. если вам нужна отдельная утилита, которая отслеживает изменения и синхронизирует в контейнер пода, то рекомендую skasync(https://github.com/konrin/skasync), можно использовать вкупе с skaffold и не только
