Fix inline configs and secrets in registry Compose deployment
This commit is contained in:
31
REGISTRY.md
31
REGISTRY.md
@@ -7,8 +7,21 @@ Homegate 0.4 поддерживает два способа установки:
|
|||||||
| `compose.registry.yaml` | Готовый образ из Gitea; именованные volumes, автоматическая первичная настройка |
|
| `compose.registry.yaml` | Готовый образ из Gitea; именованные volumes, автоматическая первичная настройка |
|
||||||
| `compose.yaml` | Прежний запуск из исходников с `build`, `setup.sh` и каталогами на хосте |
|
| `compose.yaml` | Прежний запуск из исходников с `build`, `setup.sh` и каталогами на хосте |
|
||||||
|
|
||||||
Gitea здесь ещё не подключена, образ не опубликован. Workflow готов к запуску в вашем
|
Для установки дождитесь успешной публикации образа в Gitea Actions.
|
||||||
репозитории. Имена `git.example.home` и `your-user` ниже — примеры.
|
Имена `git.example.home` и `your-user` ниже — примеры.
|
||||||
|
|
||||||
|
В варианте с одним файлом Compose записывает `configs.content` и `secrets.environment`
|
||||||
|
в файловую систему контейнера до его запуска. Поэтому у `initialize`, `homegate` и `ui`
|
||||||
|
задано `read_only: false`; у `ssh-export` остаётся `read_only: true`. Иначе создание
|
||||||
|
контейнера завершается ошибкой `cannot create config/secret ... in read-only service`.
|
||||||
|
Это ограничение проверяется в `ci/check_compose.py` без запуска контейнеров.
|
||||||
|
Ограничения UID, capabilities и `no-new-privileges` сохраняются. В варианте установки
|
||||||
|
из исходников configs/secrets берутся из файлов на хосте и не требуют этого исключения.
|
||||||
|
|
||||||
|
Если скачали ранний `compose.registry.yaml` для `0.4.0`, добавьте `read_only: false`
|
||||||
|
в каждый из сервисов `initialize`, `homegate`, `ui` после `<<: *runtime`, затем выполните
|
||||||
|
`docker compose up -d`. Исправление совместимо с образом `0.4.0`; новый образ не нужен.
|
||||||
|
Сохраняйте прежнее имя Compose-проекта и volumes с настройками и CA.
|
||||||
|
|
||||||
## 1. Настройте репозиторий и runner один раз
|
## 1. Настройте репозиторий и runner один раз
|
||||||
|
|
||||||
@@ -252,12 +265,16 @@ docker compose start homegate ui ssh-export
|
|||||||
|
|
||||||
Локально проходят 55 тестов, включая первый запуск, сохранение пользовательских изменений
|
Локально проходят 55 тестов, включая первый запуск, сохранение пользовательских изменений
|
||||||
и CA, отказ от повреждённого конфига и проверку адреса/версии публикуемого образа.
|
и CA, отказ от повреждённого конфига и проверку адреса/версии публикуемого образа.
|
||||||
Оба Compose-файла проверяются установленным Docker Compose. Синтаксис shell, JavaScript
|
Оба Compose-файла проверяются установленным Docker Compose, включая совместимость
|
||||||
и YAML workflow проверен. Docker daemon при подготовке выключен, поэтому сборка образа
|
`read_only` с источниками configs/secrets. Синтаксис shell, JavaScript и YAML workflow проверен.
|
||||||
и исполнение самого workflow локально не проверены. Контейнерный smoke-test остаётся
|
После исправления `read_only` локально проверены сборка образа для ARM64 и контейнерный
|
||||||
ручной проверкой и исключён из Gitea Actions.
|
smoke-test на Docker Compose 5.3.1: инициализация volumes, вход в панель, изоляция secrets,
|
||||||
|
SSH-export и сохранение настроек/CA при повторной инициализации. Проверка использует
|
||||||
|
временные volumes без портов хоста и без доступа к NPM/Pi-hole; их реальные API этим тестом
|
||||||
|
не проверяются. Контейнерный smoke-test остаётся ручной проверкой и исключён из Gitea Actions.
|
||||||
|
|
||||||
Официальные контракты: [Gitea Container Registry](https://docs.gitea.com/usage/packages/container/),
|
Официальные контракты: [Gitea Container Registry](https://docs.gitea.com/usage/packages/container/),
|
||||||
[Gitea Actions](https://docs.gitea.com/usage/actions/quickstart/),
|
[Gitea Actions](https://docs.gitea.com/usage/actions/quickstart/),
|
||||||
[Compose secrets из environment](https://docs.docker.com/reference/compose-file/secrets/),
|
[Compose secrets из environment](https://docs.docker.com/reference/compose-file/secrets/),
|
||||||
[Compose configs с content](https://docs.docker.com/reference/compose-file/configs/).
|
[Compose configs с content](https://docs.docker.com/reference/compose-file/configs/),
|
||||||
|
[ограничение read_only в реализации Compose](https://github.com/docker/compose/blob/v2.40.0/pkg/compose/secrets.go).
|
||||||
|
|||||||
@@ -7,6 +7,21 @@ import yaml
|
|||||||
import homegate as h
|
import homegate as h
|
||||||
|
|
||||||
|
|
||||||
|
def check_read_only_resources(model):
|
||||||
|
# compose config accepts this combination, but container creation rejects it.
|
||||||
|
for name, service in model['services'].items():
|
||||||
|
if not service.get('read_only'):
|
||||||
|
continue
|
||||||
|
for kind in ('configs', 'secrets'):
|
||||||
|
for resource in service.get(kind, []):
|
||||||
|
source = resource['source']
|
||||||
|
definition = model[kind][source]
|
||||||
|
assert 'file' in definition, (
|
||||||
|
f'{name}: read_only requires a file source for {kind}.{source}; '
|
||||||
|
'Compose cannot inject content/environment into a read-only container'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
env = dict(os.environ, HOMEGATE_IMAGE='registry.example/homegate/homegate:0.4.0',
|
env = dict(os.environ, HOMEGATE_IMAGE='registry.example/homegate/homegate:0.4.0',
|
||||||
HOMEGATE_LAN_IP='192.168.0.10', HOMEGATE_PROXY_IP='192.168.0.10',
|
HOMEGATE_LAN_IP='192.168.0.10', HOMEGATE_PROXY_IP='192.168.0.10',
|
||||||
@@ -18,6 +33,7 @@ def main():
|
|||||||
model = json.loads(subprocess.check_output(
|
model = json.loads(subprocess.check_output(
|
||||||
['docker', 'compose', '--env-file', os.devnull, '-f', 'compose.registry.yaml',
|
['docker', 'compose', '--env-file', os.devnull, '-f', 'compose.registry.yaml',
|
||||||
'config', '--format', 'json'], env=env))
|
'config', '--format', 'json'], env=env))
|
||||||
|
check_read_only_resources(model)
|
||||||
assert set(model['services']) == {'initialize', 'homegate', 'ssh-export', 'ui'}
|
assert set(model['services']) == {'initialize', 'homegate', 'ssh-export', 'ui'}
|
||||||
for name, service in model['services'].items():
|
for name, service in model['services'].items():
|
||||||
assert 'build' not in service, name
|
assert 'build' not in service, name
|
||||||
@@ -31,6 +47,7 @@ def main():
|
|||||||
assert model['services']['initialize']['network_mode'] == 'none'
|
assert model['services']['initialize']['network_mode'] == 'none'
|
||||||
assert not model['services']['initialize'].get('secrets')
|
assert not model['services']['initialize'].get('secrets')
|
||||||
assert not model['services']['ssh-export'].get('secrets')
|
assert not model['services']['ssh-export'].get('secrets')
|
||||||
|
assert model['services']['ssh-export']['read_only']
|
||||||
assert [v['source'] for v in model['services']['ui']['secrets']] == ['ui_password']
|
assert [v['source'] for v in model['services']['ui']['secrets']] == ['ui_password']
|
||||||
for name in ('ui', 'ssh-export'):
|
for name in ('ui', 'ssh-export'):
|
||||||
assert all(v['target'] != '/data' for v in model['services'][name]['volumes'])
|
assert all(v['target'] != '/data' for v in model['services'][name]['volumes'])
|
||||||
@@ -38,8 +55,10 @@ def main():
|
|||||||
assert all('environment' in s and 'file' not in s for s in model['secrets'].values())
|
assert all('environment' in s and 'file' not in s for s in model['secrets'].values())
|
||||||
seed = h.validate_config(yaml.safe_load(model['configs']['initial-config']['content']))
|
seed = h.validate_config(yaml.safe_load(model['configs']['initial-config']['content']))
|
||||||
assert seed['services'] == [] and seed['ssh_hosts'] == []
|
assert seed['services'] == [] and seed['ssh_hosts'] == []
|
||||||
subprocess.run(['docker', 'compose', '--env-file', '.env.example', '-f', 'compose.yaml',
|
source_model = json.loads(subprocess.check_output(
|
||||||
'config', '--quiet'], check=True, env=env)
|
['docker', 'compose', '--env-file', '.env.example', '-f', 'compose.yaml',
|
||||||
|
'config', '--format', 'json'], env=env))
|
||||||
|
check_read_only_resources(source_model)
|
||||||
# The one-file deployment cannot accidentally fall back to all host interfaces.
|
# The one-file deployment cannot accidentally fall back to all host interfaces.
|
||||||
del env['HOMEGATE_LAN_IP']
|
del env['HOMEGATE_LAN_IP']
|
||||||
missing = subprocess.run(['docker', 'compose', '--env-file', os.devnull,
|
missing = subprocess.run(['docker', 'compose', '--env-file', os.devnull,
|
||||||
|
|||||||
@@ -31,6 +31,8 @@ x-environment: &environment
|
|||||||
services:
|
services:
|
||||||
initialize:
|
initialize:
|
||||||
<<: *runtime
|
<<: *runtime
|
||||||
|
# Compose copies configs.content into the container before starting it.
|
||||||
|
read_only: false
|
||||||
entrypoint: [python, /app/bootstrap.py]
|
entrypoint: [python, /app/bootstrap.py]
|
||||||
command: []
|
command: []
|
||||||
user: "0:0"
|
user: "0:0"
|
||||||
@@ -52,6 +54,8 @@ services:
|
|||||||
|
|
||||||
homegate:
|
homegate:
|
||||||
<<: *runtime
|
<<: *runtime
|
||||||
|
# Compose requires a writable root filesystem for secrets.environment.
|
||||||
|
read_only: false
|
||||||
depends_on:
|
depends_on:
|
||||||
initialize:
|
initialize:
|
||||||
condition: service_completed_successfully
|
condition: service_completed_successfully
|
||||||
@@ -98,6 +102,8 @@ services:
|
|||||||
|
|
||||||
ui:
|
ui:
|
||||||
<<: *runtime
|
<<: *runtime
|
||||||
|
# Compose requires a writable root filesystem for secrets.environment.
|
||||||
|
read_only: false
|
||||||
entrypoint: [python, /app/homegate_ui.py]
|
entrypoint: [python, /app/homegate_ui.py]
|
||||||
command: []
|
command: []
|
||||||
depends_on:
|
depends_on:
|
||||||
|
|||||||
Reference in New Issue
Block a user