Перейти до вмісту
AggregaAggrega
Обрати мову: Українська
Цю сторінку перекладено машинним способом. Читати оригінал англійською.

Файли збирання

Ця сторінка пояснює одну ідею, а саме який файл збирання що визначає, і не є робочим простором, який можна запустити. Вебзастосунок із PostgreSQL, побудований крок за кроком показує її в робочому просторі, який ви збираєте; запишіть його у власну теку командою:

Terminal window
aggrega scaffold --example quickstart-web

Потім вона виводить команди, які слід виконати далі:

Terminal window
cd quickstart-web
cd 1
aggrega build --release release.yaml --auto-pull
export QUICKSTART_DB_PASSWORD=choose-a-password
docker compose -p quickstart-web -f dist/compose/docker-compose.yaml up -d --wait
# then open http://127.0.0.1:8080/ in your browser

П’ять видів файлів, у кожного один автор

Збирання читає п’ять видів файлів. Кожен визначає одне, і в типовій команді кожен має власного автора:

  • сутність Component визначає, що таке певний вид компонента: значення, які може задати розробник, налаштування інфраструктури, які може задати оператор, що вона публікує для компонентів, які до неї під’єднуються, і сокети, через які вона під’єднується. Каталог стандартної бібліотеки містить сутності Components, потрібні більшості застосунків, як-от core/datastore/postgres і core/compute/server, тож робочий простір зазвичай не пише жодної;
  • сутність Aggregate належить розробникові: які компоненти має застосунок і до чого під’єднується кожен із них;
  • сутність Recipe перетворює один вид компонента на файли для одного інструмента — сервіс Compose, чарт Helm, модуль Terraform;
  • сутність Manifest вибирає, яка сутність Recipe реалізує кожен вид компонента для однієї цілі;
  • сутність Release називає сутності Aggregate і Manifest та задає налаштування одного середовища. Саме її ви збираєте: aggrega build --release release.yaml.

Цей поділ є орієнтиром: одна людина може написати всі п’ять, і збирання приймає будь-який із них, якщо кожен коректний.

Aggregate: компоненти та їхні з’єднання

Перший крок прикладу — вебзастосунок і його база даних. Його сутність Aggregate з 1/aggregate.yaml без коментарів:

spec:
components:
web:
type: core/compute/server
features:
db_password:
type: core/secret-value
values:
key: PGPASSWORD
origin: "${QUICKSTART_DB_PASSWORD}"
uses:
database:
db:
target: db
inject:
env:
- in: PGHOST
from: host
- in: PGPORT
from: port
- in: PGUSER
from: user
- in: PGDATABASE
from: database
db:
type: core/datastore/postgres
features:
password:
type: core/secret-value
values:
key: POSTGRES_PASSWORD
origin: "${QUICKSTART_DB_PASSWORD}"

Тут ніщо не називає порт, хост, простір імен чи інструмент. web під’єднується до db через свій сокет database, а список inject визначає, яка змінна застосунку отримує кожен запис, що його публікує база даних: from: називає запис, in: — змінну.

З’єднання — це рядок, переданий конвеєром

Сутність Recipe бази даних публікує host, port, user і database, щоб з’єднання їх прочитало. Яку адресу містить host, залежить від сутності Recipe, яку вибрала сутність Manifest: ім’я сервісу, коли база даних працює поруч із застосунком, рядок-вказівник, який інструмент розгортання ресурсів розв’язує для керованої бази даних, або адреса сервера, що вже існує. Збирання копіює кожен опублікований рядок у змінну, яку назвала сутність Aggregate, і не інтерпретує його: воно ніколи не розв’язує адресу й не перевіряє, чи вона досяжна.

Сутності Manifest і Release

Сутність Manifest з 1/manifest.yaml прив’язує кожен вид компонента, а також вкладення паролів, до сутності Recipe, яка реалізує його в Docker Compose:

spec:
mappings:
components:
type:
core/compute/server:1.1.0: compose/server:2.0.0
core/datastore/postgres:1.0.0: compose/postgres:1.0.0
features:
type:
core/secret-value:1.0.0: compose/dotenv-secret:1.0.0

Сутність Release з 1/release.yaml називає сутності Aggregate і Manifest та задає те, що знає лише середовище, тут — образ, який запускає застосунок, порт, який він слухає, і порт, на якому Docker Compose публікує його на loopback-адресі вашої машини (дайджест образу скорочено):

spec:
aggregate: quickstart-web
manifest: quickstart-web-compose
components:
web:
infra:
image: hub.aggrega.ai/tools/quickstart-web:1.1.0@sha256:…
port: 8080
published_port: 8080
db: {}

Подальші кроки прикладу розширюють його: кеш Redis поруч із базою даних, потім ті самі компоненти в AWS через Terraform, потім резервні копії бази даних.

Параметри: одна сутність Aggregate, багато середовищ

Значення, яке відрізняється між середовищами, оголошують у сутності Aggregate як типізований параметр, на нього посилаються там, де його використовують, а задає його кожна сутність Release. У прикладі Завдання, що запускається на вимогу сутність Aggregate оголошує розклад свого звіту:

spec:
parameters:
report_schedule:
type: string
default: ""
components:
report:
type: core/compute/task
values:
schedule: "{{ .parameters.report_schedule }}"

а сутність Release його заповнює:

spec:
parameters:
report_schedule: "30 2 * * 1-5"

Збирання перевіряє кожне значення, яке задає сутність Release, на відповідність типу параметра, перш ніж заповнити шаблон. Сутність Release ніколи сама не пише values компонента: вона заповнює параметри, які надає сутність Aggregate, тож сутність Aggregate залишається єдиним місцем, що визначає, які значення змінюються залежно від середовища. Сутність Release також може читати свої параметри з окремого файлу, parameters: { $import: ./env/prod-values.yaml }.