CLI · Winter Console

Команда service

service работает с сервисами, которые объявляет components(): показывает их, записывает то, что им нужно, в Dockerfile и подсказывает, что добавить в compose.

Субкоманды list · dockerПишет DockerfileНе трогает compose

Что такое service и зачем

service — команда для сервисов приложения: базы, кеша, очереди, которые работают в одном контейнере с приложением.

Проблема. Каждому сервису нужно что-то в образе — пакеты, каталоги, тома, — и всё это вписывают в Dockerfile и compose руками, а потом не забывают поправить при каждой смене версии или пути.

Решение. Сервис сам описывает, что ему нужно. call service docker пишет Dockerfile — без этого программы в образе нет. А compose — ваш: команда только показывает, что в него добавить, а решаете вы.

Субкоманды

Субкоманда Назначение
list Объявленные сервисы: класс, пакет, приоритет, пакеты apk, тома, переменные
docker Пишет блок в Dockerfile, показывает, что нужно в compose

list

bash
php call service list

Для каждого сервиса — что он и что ему нужно:

text
[ redis ]
class       Main\Services\Redis
package     the project
priority    High
packages    redis
volume      redis-data → /var/lib/redis
[ redis ]

package — Composer-пакет, из которого пришёл класс сервиса, с версией; the project — класс из самого проекта.

docker

bash
php call service docker

Синтаксис

text
call service docker [--dry] [--service=имя]

Параметры

--dry — показать, что будет записано, и ничего не менять.

--service=имя — сервис compose, которым работает приложение, для подсказки. По умолчанию — первый в docker-compose.yml, а если его нет — server.

Что делает

  • Dockerfile — один блок между метками # winter:services и # winter:services end: пакеты apk, каталоги с владельцем winter, команды run, переменные ENV. В первый раз блок встаёт перед первым COPY последней стадии, потом заменяется на месте. Сервисов не осталось — блок удаляется.
  • compose — не меняется. Команда печатает, что в него добавить:
    • stop_grace_period — срок остановки приложения плюс 5 секунд. Без него Docker убивает контейнер через 10 секунд;
    • тома для данных сервисов — если данные должны пережить пересоздание контейнера. Не нужны — не добавляйте. Путь уже лежит в вашем томе — этот пропустите.

Результат

text
  Dockerfile .................................................... [UPDATED]
[i] Compose is yours: add to docker-compose.yml, service "server", what fits:
[ docker-compose.yml ]
  services:
    server:
      stop_grace_period: 70s
      volumes:
        - postgres-data:/var/lib/postgresql/data
  volumes:
    postgres-data:
[ docker-compose.yml ]
[i] stop_grace_period: a stop needs 70s; without it Docker kills the container after 10s.
[i] volumes: keep the data when the container is recreated. Leave them out if it need not survive; skip one whose path is already inside a volume of yours.
[i] Rebuild the image to take it in:  docker compose up -d --build

На повторном запуске без изменений — Dockerfile … [UNCHANGED], подсказка та же.

Ошибки

  • Нет Dockerfile — No Dockerfile in the project: create one with `call cfg docker` first.
  • Метка начала блока есть, а конца нет (блок правили руками) — команда ничего не угадывает и просит вернуть метку # winter:services end или удалить блок.
  • Два сервиса просят одно и то же по-разному (каталог с разными правами, одна переменная с разными значениями) — ошибка с тем, что именно расходится; ничего не пишется.
  • Есть компонент с $grace = 0 (ждать сколько угодно) — stop_grace_period в подсказке нет, об этом предупреждение.

Дальше