Перейти к содержимому
AggregaAggrega
Выберите язык: Русский
Эта страница переведена машинным способом. Читать оригинал на английском.

Скрипты начальной загрузки PostgreSQL и пользовательская конфигурация — синтезированный helm

core/datastore/postgres предоставляет два необязательных значения разработчика, которые определяют первый запуск базы данных: init_scripts (SQL или shell, выполняемые один раз при инициализации) и custom_config (фрагмент postgresql.conf). На целевой платформе синтезированного helm сущность Recipe передаёт их в контейнер как смонтированные ConfigMap. Этот пример показывает, что возможность является аддитивной: сущность Aggregate, в которой ни одно из значений не задано, отрисовывается точно так же, как минимальная база данных, а сущность Aggregate, в которой они заданы, получает ConfigMap, тома и точки монтирования, и больше ничего не затрагивается.

Две сущности Releases одного и того же Component с одним и тем же Manifest, различающиеся только значениями разработчика:

  • release-bare.yaml (aggregate-bare.yaml) — init_scripts и custom_config не заданы.
  • release-config.yaml (aggregate-config.yaml) — оба заданы.

Создание примера

Этот пример можно собрать командами ниже или поручить сборку вашему ИИ-ассистенту.

Запишите пример в новую папку, названную по его имени:

Terminal window
aggrega scaffold --example postgres-init-config

Затем она выводит команды, которые нужно выполнить дальше. Первая переходит в новую папку:

Terminal window
cd postgres-init-config

Сборка

Terminal window
aggrega build --release release-bare.yaml --auto-pull
aggrega build --release release-config.yaml --auto-pull

Каталог разрешается из реестра hub, указанного в .aggrega-config.yaml, поэтому флаг --catalog не нужен, а --auto-pull во время сборки записывает lock-файл, которого нет в свежем клоне. Базовый релиз записывает три файла в dist/helm/helm/; сконфигурированный релиз записывает эти три файла и ещё два в dist/helm/helm/db/.

С ИИ-ассистентом

ИИ-ассистент, настроенный с инструментами Aggrega, может сделать то же самое: вставьте в него этот промпт.

Используйте только инструменты Aggrega и не создавайте папки самостоятельно. Если в папке Workspace ещё нет папки `postgres-init-config`, вызовите один раз инструмент `scaffold`, задав для `example` значение `postgres-init-config` и не задавая `dir`: он запишет пример в новую папку `postgres-init-config`. Затем вызовите инструмент `build` по одному разу для каждой сущности Release в таком порядке — `release-bare.yaml` и `release-config.yaml` — каждый раз задавая для `workspace_root` значение `postgres-init-config`, для `release` — этот файл, для `auto_pull` — true и для `write` — true. Сообщите мне, какие файлы записала каждая сборка; они находятся в `postgres-init-config/dist/`.

Базовый вариант — аддитивная отправная точка

aggregate-bare.yaml оставляет оба значения незаданными. Результат отрисовки — StatefulSet, Service типа ClusterIP и Headless Service: ни ConfigMap, ни тома configmap, ни монтирования тома в каталог инициализации, ни аргумента с файлом конфигурации у контейнера. Это обычный вид минимальной базы данных PostgreSQL:

dist/helm/helm/db-statefulset.yaml
dist/helm/helm/db-default-service.yaml
dist/helm/helm/db-headless-service.yaml

Поскольку оба значения в Recipe защищены проверкой наличия, незаданное значение ничего не порождает: тело ConfigMap отрисовывается пустым и пропускается, а строки тома, монтирования и аргумента сервера исключаются проверкой. Сущность Aggregate, которая никогда не касается этих значений, не меняется от их существования.

Сконфигурированный вариант — скрипты и конфигурация смонтированы

aggregate-config.yaml задаёт оба значения:

values:
init_scripts:
01-schema.sql: |
CREATE TABLE app_users ( ... );
02-seed.sql: |
INSERT INTO app_users (email) VALUES ('founder@example.com');
custom_config: |
max_connections = 200
shared_buffers = 256MB

Теперь сборка записывает два дополнительных ConfigMap и подключает их к StatefulSet:

dist/helm/helm/db/initdb-configmap.yaml
dist/helm/helm/db/config-configmap.yaml

Оба находятся в db/ — собственном имени компонента. Recipe называет их в своём блоке artifacts:, а файл, названный там, несёт ключ, который написал его автор, а не что-либо, идентифицирующее компонент, — поэтому сборка записывает его под компонентом, который его объявил, и два компонента, использующие один Recipe, не могут оказаться на одном пути. StatefulSet и два Service именуются целевой платформой по компоненту, которому они принадлежат, поэтому остаются в собственном каталоге границы.

Два значения размещаются в отдельных ConfigMap, потому что каждое монтируется целиком в свой путь контейнера:

  • init_scripts → ConfigMap db-initdb, по одному ключу данных на скрипт (01-schema.sql, 02-seed.sql). Том configmap монтирует его в /docker-entrypoint-initdb.d, где PostgreSQL выполняет файлы один раз при первой инициализации в алфавитном порядке ключей.
  • custom_config → ConfigMap db-config, один ключ данных postgresql.conf. Второй том configmap монтирует его в /etc/postgresql, а args: контейнера направляют на него сервер: postgres -c config_file=/etc/postgresql/postgresql.conf. Параметры, которые фрагмент опускает, сохраняют встроенные значения по умолчанию.
# db-statefulset.yaml (container)
containers:
- name: main
image: postgres:16
args:
- postgres
- -c
- config_file=/etc/postgresql/postgresql.conf
[… omitted: the container's port, environment and resources]
volumeMounts:
- name: data
mountPath: /var/lib/postgresql/data
- name: initdb
mountPath: /docker-entrypoint-initdb.d
- name: pgconf
mountPath: /etc/postgresql
[… omitted: the liveness and readiness probes]
volumes:
- name: initdb
configMap:
name: db-initdb
- name: pgconf
configMap:
name: db-config

Эти аргументы сервера передаются как args:, а не как command:, и от этой разницы зависит, будет ли база данных заполнена при запуске: args: передаёт аргументы в точку входа образа, а command: её заменяет. Эта точка входа — скрипт запуска, который создаёт базу данных в пустом каталоге данных, читает окружение POSTGRES_* и выполняет файлы из /docker-entrypoint-initdb.d. Её замена запустила бы сервер со смонтированным postgresql.conf и пропустила бы и инициализацию, и скрипты начальной загрузки: значения, заданные в сущности Aggregate, попали бы в манифест, но так и не выполнились бы.

Задать только одно из двух значений столь же допустимо: ConfigMap, том и монтирование другого просто отсутствуют, а аргумент с файлом конфигурации появляется только тогда, когда задан custom_config.

Compose

Recipe для Compose для core/datastore/postgres читает тот же Component и реализует оба значения через собственный примитив compose: он отрисовывает записи верхнего уровня configs:, а сервис монтирует каждую из них как файл.

  • init_scripts → по одному config на ключ, каждый смонтирован под своим именем файла в /docker-entrypoint-initdb.d. Образ выполняет найденные там файлы один раз в порядке имён файлов и только тогда, когда каталог данных пуст, — база данных, уже содержащая данные, остаётся нетронутой.
  • custom_config → один config, смонтированный как единственный файл /etc/postgresql/postgresql.conf, с теми же аргументами postgres -c config_file=…, направляющими на него сервер. Параметры, которые фрагмент опускает, сохраняют встроенные значения по умолчанию.

Каждая половина и здесь защищена проверкой наличия, поэтому сущность Aggregate, оставляющая одно значение незаданным, отрисовывается так, как будто этого ключа не существует.

При написании блока custom_config для развёртывания compose стоит упомянуть один параметр: listen_addresses по умолчанию принимает только локальные подключения, поэтому блок, в котором он опущен, делает базу данных недоступной для других сервисов в сети compose.

Manifest в этом примере направляет core/datastore/postgres на Recipe для helm. Чтобы собрать тот же Aggregate на compose, нужен Manifest, который вместо этого направляет его на compose/postgres; значения разработчика не меняются.