Сервисы

Что нужно в образе

php в образе уже есть, а большинства программ — нет. Сервис сам говорит, что ему нужно поставить, в методе image(). Команда call service docker записывает это в Dockerfile.

Описание ServiceImageКоманда call service docker

Что это и зачем

Что это. ServiceImage — список того, что сервису нужно в образе: пакеты, папки.

Проблема. Программу нужно поставить в образ. Если писать apk add в Dockerfile руками, сервис и Dockerfile легко разойдутся: убрали сервис — пакет остался, добавили новый — забыли поставить.

Решение. Сервис сам говорит, что ему нужно. Dockerfile дописывает команда.

Пример: Memcached

Memcached — простой кеш в памяти. В образе его нет, он ставится пакетом memcached:

main/Services/Memcached.php
namespace Main\Services;

use Flytachi\Winter\Kernel\App\Component;
use Flytachi\Winter\Kernel\App\Priority;
use Flytachi\Winter\Kernel\App\Service;
use Flytachi\Winter\Kernel\App\ServiceImage;

final class Memcached implements Service
{
  public function component(): Component
  {
      return Component::command(['memcached', '-l', '127.0.0.1', '-p', '11211'], 'memcached',
          priority: Priority::High,
          ready: 'tcp://127.0.0.1:11211',
          alive: 'tcp://127.0.0.1:11211',
          retries: 3);
  }

  public function image(): ServiceImage
  {
      return new ServiceImage(packages: ['memcached']);
  }
}

Всё отличие от своего сервиса — одна строка в image().

Записать в образ

bash
php call service docker
docker compose up -d --build

В Dockerfile появится блок:

Dockerfile
# winter:services — written by `call service docker`; change the services, not this block
USER root
RUN apk add --no-cache memcached
USER winter
# winter:services end
  • Команда меняет только этот блок, остальной Dockerfile не трогает.
  • Добавили, убрали или поменяли сервис — запустите её снова.
  • Посмотреть, что будет записано, ничего не меняя: php call service docker --dry.

Если программа хранит данные

Кешу хранить нечего. Базе данных нужна папка, которая переживёт пересборку контейнера, — её описывают ещё двумя параметрами:

php
new ServiceImage(
  packages: ['redis'],
  directories: ['/var/lib/redis' => 0755],         // created and given to winter
  volumes: ['redis-data' => '/var/lib/redis'],     // worth keeping in a volume
);

Папку команда создаст в Dockerfile. А том она не записывает, а подсказывает: compose — ваш, и только вы знаете, нужно ли хранить данные и где.

text
[i] Compose is yours: add to docker-compose.yml, service "server", what fits:
[ docker-compose.yml ]
services:
  server:
    stop_grace_period: 70s
    volumes:
      - redis-data:/var/lib/redis
volumes:
  redis-data:
[ docker-compose.yml ]

Там же — stop_grace_period: сколько контейнеру ждать остановки. Его стоит добавить всегда, том — по желанию.

ServiceImage

Параметр Пример Что значит
packages ['memcached'] пакеты apk (образ на Alpine)
directories ['/var/lib/redis' => 0755] папки: создаются, принадлежат пользователю winter
volumes ['redis-data' => '/var/lib/redis'] где лежат данные: имя тома → путь. Для подсказки compose
env ['TZ' => 'UTC'] переменные окружения образа
run ['…'] свои команды RUN, если остального не хватает. Нужны редко

Если сервисов несколько, их пакеты и папки сливаются в один блок, каждый — один раз. Попросят одно и то же по-разному (одна папка с разными правами) — команда скажет об ошибке. Все параметры команды — на странице call service.

Дальше

  • PostgreSQL — готовый сервис с данными, томом и проверками.