Зачем
Три сервиса, и у каждого одни и те же restart, security_opt и ротация логов:
services:
app:
image: ghcr.io/example-user/app:latest
restart: unless-stopped
security_opt: ["no-new-privileges:true"]
logging:
driver: json-file
options:
max-size: 10m
max-file: "3"
cache:
image: redis:7.4-alpine
restart: unless-stopped
security_opt: ["no-new-privileges:true"]
logging:
driver: json-file
options:
max-size: 10m
max-file: "3"
db:
image: mariadb:11.8
restart: always
security_opt: ["no-new-privileges:true"]
logging:
driver: json-file
options:
max-size: 10m
max-file: "3"
Блок из семи строк повторён трижды, у db отличается только restart. Чтобы поменять max-size, правку
делаем в трёх местах и ни одно не пропускаем. Если четвёртый сервис добавить без блока logging, его лог
ничем не ограничен: Docker по умолчанию не ротирует логи, и файл растёт, пока не займёт диск.
Как пишем
Общее описываем один раз вверху файла и подключаем в каждый сервис одной строкой:
x-defaults: &defaults
restart: unless-stopped
security_opt: ["no-new-privileges:true"]
logging:
driver: json-file
options:
max-size: 10m
max-file: "3"
services:
app:
<<: *defaults
image: ghcr.io/example-user/app:latest
cache:
<<: *defaults
image: redis:7.4-alpine
db:
<<: *defaults
image: mariadb:11.8
restart: always
&defaults даёт блоку имя, *defaults ссылается на него по имени, а <<: добавляет все его ключи в сервис,
как если бы их написали там руками. Если тот же ключ есть у самого сервиса, побеждает он: у db останется
restart: always.
Блоки верхнего уровня, имя которых начинается с x-, compose не разбирает — в них и держим такие заготовки.
Без x- он ругается на незнакомый ключ (первый случай ниже).
Свой environment заменяет общий целиком
<<: добавляет ключи якоря как есть и вложенные блоки не объединяет. Если у сервиса свой environment:,
он заменяет environment: из якоря полностью, а не дописывается к нему. Чтобы добавить переменные к общим,
подключаем якорь внутри самого environment::
x-env: &env
TZ: Etc/UTC
services:
worker:
<<: *defaults
environment:
<<: *env
QUEUE: mail
У worker будут обе: TZ и QUEUE. Со списками (security_opt, ports) так нельзя: список сервиса
заменяет список из якоря целиком.
Если не работает
validating …/compose.yaml: additional properties 'defaults' not allowed
- Причина
- Общий блок назван без
x-. Compose знает только свои ключи верхнего уровня, а всё, что начинается сx-, пропускает. - Делаем
- Переименовываем в
x-defaults.
unknown anchor 'defaults' referenced при запуске с compose.override.yaml
- Причина
- Якорь виден только в своём файле. В override и в файлах из
include:якорей основного файла нет. - Делаем
- Повторяем блок в override или заводим там свой якорь.
У сервиса пропала переменная из общего блока
- Причина
- У сервиса свой
environment:— он заменил весьenvironment:из якоря.<<:добавляет ключи якоря целиком и вложенные блоки не объединяет. - Делаем
- Подключаем общий блок внутри:
environment:с первой строкой<<: *envи своими переменными ниже.
Как проверить
docker compose config печатает файл с раскрытыми якорями: у каждого сервиса должен быть полный блок.
docker compose config | grep -A4 'logging:'