Схема Aggrega Workload
Сгенерированный справочник. Не редактируйте вручную — сгенерируйте заново из опубликованной JSON Schema.
Идентификатор схемы: https://aggrega.ai/schemas/workload-v1beta1.schema.json
Абстрактная спецификация рабочей нагрузки, принадлежащая платформе. Recipe в синтезированном режиме объявляет ровно один Workload с помощью ключевого слова workload: (встроенный блочный скаляр или workload: { $import:
Руководство по написанию сущностей Workload в прозе см. в справочнике по написанию Workload; на этой странице документирована структурная схема, которую описывает этот справочник.
Тип верхнего уровня: object
Свойства
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
apiVersion | const “aggrega.ai/v1beta1” | да | Константа: "aggrega.ai/v1beta1" |
kind | const “Workload” | да | Константа: "Workload" |
form | string (enum) | нет | Абстрактное намерение относительно формы контроллера для рабочей нагрузки. Выбирает тип жизненного цикла рабочей нагрузки во время выполнения независимо от целевой платформы: stateless (взаимозаменяемые долгоживущие реплики), stateful (реплики со стабильной идентичностью и хранилищем для каждой реплики), daemon (один экземпляр на каждый подходящий хост), scheduled (повторяющиеся запуски по времени), task (однократный запуск до завершения), reference (внешняя конечная точка без вычислений — без контроллера; helm создаёт ExternalName Service, compose передаёт конечную точку через контракт внедрения). Пустое значение трактуется как stateless. Каждый целевой провайдер отображает форму на собственную нативную форму; сама форма не содержит нативных для платформы типов ресурсов. Том persistentTemplate сопутствует stateful и допустим только для рабочей нагрузки stateful. Рабочая нагрузка reference объявляет endpoint (и, при необходимости, port) и не объявляет контейнеров, а также не имеет собственного поля учётных данных, поскольку имя переменной окружения принадлежит потребителю, а не конечной точке. Потребитель, которому нужны учётные данные для конечной точки, объявляет слот в featuresSchema своей сущности Component и заполняет его из блока attachments своего контейнера, если список inject этого слота допускает такую доставку. Допустимые значения: "stateless", "stateful", "daemon", "scheduled", "task", "reference" По умолчанию: "stateless" |
endpoint | string | нет | Внешняя конечная точка для form: reference — хост или URL. Компилятор передаёт её как детерминированную строку-указатель; она никогда не разрешается во время компиляции (AOT). Обязательна, если form равно reference, и имеет смысл только в этом случае. helm выводит её как externalName сервиса ExternalName Service (часть с хостом); compose передаёт её потребителям через provides рецепта. |
port | integer | нет | Необязательный порт для конечной точки reference (form: reference). helm выводит его как порт в ExternalName Service. Минимум: 1. Максимум: 65535. |
schedule | string | нет | Расписание cron для form: scheduled — стандартное выражение crontab из 5 полей (например, ‘0 0 * * *’) или один из макросов @hourly, @daily, @weekly, @monthly, @yearly. Обязательно, если form равно scheduled, и имеет смысл только в этом случае; целевой провайдер передаёт его без изменений в поле schedule запланированного ресурса. |
suspend | логическая | нет | Приостанавливает повторяющееся расписание рабочей нагрузки с form: scheduled. При значении true ресурс по расписанию рендерится с расписанием на месте, но ни один запуск по этому расписанию не начинается, пока оно не будет возобновлено; запуск по-прежнему можно создать из ресурса вручную — в Kubernetes это kubectl create job false |
replicas | integer | нет | Количество реплик. По умолчанию 1. Для цели compose значение не попадает ни в какую часть вывода, и всякий раз, когда оно задано, выдаётся предупреждение — в том числе при явном 1. Минимум: 0. По умолчанию: 1 |
initContainers | container[] | нет | Упорядоченный список контейнеров, которые выполняются до завершения перед запуском основных контейнеров. |
containers | map из container | нет | Упорядоченное отображение имени контейнера → спецификация контейнера. Требуется хотя бы одна запись. Авторский порядок сохраняется. Не менее 1 записи. |
volumes | map из volume | нет | Упорядоченное отображение имени тома → спецификация тома. Каждая спецификация тома объявляет ровно одно из: ephemeral, configmap, secret, persistent, persistentTemplate. |
services | map из service | нет | Упорядоченное отображение имени сервиса → спецификация сервиса. В helm каждая запись становится отдельным K8s Service, а запись с типом Loopback останавливает сборку. В compose нет отдельного примитива сервиса, поэтому записи не отображаются один к одному: запись с типом NodePort или LoadBalancer публикует свои порты на всех интерфейсах хоста в собственном сервисе compose рабочей нагрузки, запись с типом Loopback публикует там свои порты только на loopback-адресе хоста, запись с типом ClusterIP или Headless ничего не публикует, и все опубликованные порты собираются в список портов этого единственного сервиса, причём порт хоста совпадает с портом контейнера. В helm каждый Service получает имя <name>-<key>: имя собственного Deployment рабочей нагрузки (или другого контроллера), затем дефис и ключ записи, поэтому Workload, объявляющий services.http, чей Deployment называется api-server, рендерит Service с именем api-server-http. В compose ключ ничего не называет в выводе. |
scheduling | object | нет | Нативные для K8s ограничения планирования. Для helm передаются напрямую. Для цели compose эти ограничения не попадают ни в какую часть вывода, и если блок задан, выдаётся предупреждение. |
podSecurityContext | object | нет | |
serviceAccount | string | нет | Имя ServiceAccount, от имени которого выполняется эта рабочая нагрузка. Собственно RBAC (ресурсы ServiceAccount/Role/RoleBinding) следует выводить через Features или артефакты, а не через это поле. |
imagePullSecrets | string[] | нет | Имена секретов для загрузки образов из частных реестров. helm выводит pod.imagePullSecrets. В compose нет аналога внутри файла — аутентификация в реестре настраивается отдельно через docker login, — и поле опускается. |
priorityClassName | string | нет | Имя PriorityClass, определяющего приоритет планирования этой рабочей нагрузки. helm выводит pod.priorityClassName. В compose нет аналога приоритета планирования для одного хоста, и поле опускается. |
runtimeClassName | string | нет | Имя RuntimeClass, выбирающего среду выполнения контейнеров для этой рабочей нагрузки (например, среду с поддержкой GPU, такую как ‘nvidia’). Компилятор передаёт имя без изменений; кластер сопоставляет его с настроенным RuntimeClass во время планирования. helm выводит pod.runtimeClassName. В compose нет аналога runtime class, и поле опускается. Только для вычислительных нагрузок: не допускается для рабочей нагрузки reference. |
terminationGracePeriodSeconds | integer | нет | Число секунд между SIGTERM и SIGKILL при завершении. helm выводит pod.terminationGracePeriodSeconds; compose выводит stop_grace_period. Минимум: 0. |
dnsPolicy | string (enum) | нет | Политика DNS пода. helm выводит pod.dnsPolicy. В compose нет аналога политики DNS, и поле опускается (вместо этого compose напрямую отображает nameservers/searches из dnsConfig). Допустимые значения: "Default", "ClusterFirst", "ClusterFirstWithHostNet", "None" |
dnsConfig | object | нет | Пользовательская конфигурация DNS пода. helm выводит pod.dnsConfig. compose отображает nameservers в dns, а searches в dns_search; у options нет аналога в compose, и там они опускаются. |
hostAliases | object[] | нет | Статические сопоставления имён хостов с IP, добавляемые в файл hosts пода. helm выводит pod.hostAliases; compose выводит extra_hosts (по одной записи hostname:ip на каждое имя хоста). |
hostNetwork | логическая | нет | Запускает рабочую нагрузку в собственном сетевом пространстве имён узла хоста вместо изолированного. Порты, которые открывает рабочая нагрузка, тогда доступны по собственным адресам узла, а рабочая нагрузка видит сетевые интерфейсы узла. Это поле выбирает только сетевое пространство имён и ничего больше: оно не объявляет портов, и каждый порт, который открывает рабочая нагрузка, по-прежнему объявляется в containers. |
Дополнительные свойства не допускаются.
workload.scheduling
Нативные для K8s ограничения планирования. Для helm передаются напрямую. Для цели compose эти ограничения не попадают ни в какую часть вывода, и если блок задан, выдаётся предупреждение.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
nodeSelector | map of string | нет | |
affinity | object | нет | |
tolerations | object[] | нет | |
topologySpreadConstraints | object[] | нет |
Дополнительные свойства не допускаются.
workload.podSecurityContext
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
runAsUser | integer | нет | |
runAsGroup | integer | нет | |
fsGroup | integer | нет | |
supplementalGroups | integer[] | нет |
Дополнительные свойства не допускаются.
workload.dnsConfig
Пользовательская конфигурация DNS пода. helm выводит pod.dnsConfig. compose отображает nameservers в dns, а searches в dns_search; у options нет аналога в compose, и там они опускаются.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
nameservers | string[] | нет | |
searches | string[] | нет | |
options | object[] | нет |
Дополнительные свойства не допускаются.
workload.hostAliases[]
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
ip | string | да | |
hostnames | string[] | да |
Дополнительные свойства не допускаются.
Определения
container
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
name | string | нет | Необязательное имя контейнера. Для позиционной записи initContainers задаёт имя создаваемого контейнера; если оно опущено, используется сгенерированное имя init- |
image | string | да | Ссылка на образ контейнера (например, ‘nginx:1.27-alpine’, ‘ghcr.io/example/app:v1.2.3’). |
imagePullPolicy | string (enum) | нет | Политика загрузки образа. helm выводит её как container.imagePullPolicy. compose отображает её в pull_policy сервиса (Always в always, Never в never, IfNotPresent в if_not_present). Допустимые значения: "Always", "Never", "IfNotPresent" |
command | string[] | нет | Переопределяет точку входа образа. K8s: .command. Compose: entrypoint. |
args | string[] | нет | Аргументы, передаваемые command (или точке входа образа, если command отсутствует). K8s: .args. Compose: command. |
variables | map of string | нет | Переменные окружения в виде строковых пар «ключ — значение». K8s: spec.template.spec.containers[].env[]. Compose: services. |
attachments | map of containerAttachment | нет | Упорядоченная карта «имя переменной окружения или файла → { from, as, key?, path?, connection? }». Каждая запись ссылается на слот, объявленный в featuresSchema сущности Component, — или, если запись называет connection, на слот, который объявляет сокет этого соединения, — и доставляет то, что опубликовало вложение, заполняющее этот слот. Поле ‘as’ выбирает механизм доставки, который должен быть разрешён в массиве inject: слота. Слоты-«чёрные ящики» (inject: []) НЕ МОГУТ здесь указываться. |
envFrom | object[] | нет | Массовый импорт окружения из источника ConfigMap или Secret. helm выводит container.envFrom (configMapRef/secretRef). В compose нет примитива импорта окружения из объекта — ссылка на источник не является файлом хоста, поэтому переосмысление через env_file незаметно изменило бы смысл; рабочая нагрузка, объявляющая envFrom, явно останавливает сборку на целевой платформе compose. |
ports | map of integer or object | нет | Именованные порты контейнера. Порт задаётся либо просто номером (web: 8080), либо объектом, содержащим номер вместе с транспортным протоколом порта (dns: { port: 53, protocol: UDP }); если протокол не объявлен, обе формы означают одно и то же. Допустимые значения протокола: TCP, UDP и SCTP; если ключ опущен, действует значение по умолчанию целевой платформы. На имена портов ссылаются services.*.ports и разрешение порта http-пробы, а порт сервиса берёт транспорт у порта контейнера, в который разрешается его имя, поэтому транспорт объявляется один раз. K8s: containerPort, протокол указывается только там, где он объявлен. Compose: порт контейнера попадает в вывод, только если его публикует спецификация сервиса; у самого порта контейнера нет отдельного поля compose, а опубликованный порт несёт объявленный транспорт как суффикс /protocol в опубликованной записи — транспорт, который compose не может выразить, останавливает сборку, а не публикует порт с другим транспортом. |
resources | object | нет | |
health | object | нет | Пробы работоспособности контейнера — ready, live и startup, — каждая объявляется как http, tcp или exec. Для helm преобразуются в K8s httpGet/tcpSocket/exec. Для compose у сервиса одна проверка healthcheck: http и tcp становятся тестами CMD-SHELL, exec — тестом CMD, а если объявлено несколько проб, сохраняется только одна — предупреждение называет преобразованную пробу и отброшенные. |
volumeMounts | object[] | нет | |
restartPolicy | string (enum) | нет | Допустимые значения: "Always", "OnFailure", "Never" |
lifecycle | object | нет | Хуки жизненного цикла контейнера. Для helm преобразуются в K8s container.lifecycle (postStart/preStop). В compose нет примитива хуков жизненного цикла; рабочая нагрузка, объявляющая lifecycle, явно останавливает сборку на целевой платформе compose, а не отбрасывает хук незаметно. |
securityContext | object | нет |
Дополнительные свойства не допускаются.
container.envFrom[]
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
configMap | string | нет | Имя источника ConfigMap, создаваемого входом artifacts этой сущности Recipe или подключённой сущностью Feature. |
secret | string | нет | Имя слота featuresSchema — собственного слота сущности Component или, если задан connection, слота, который объявляет сокет этого соединения; имя импортируемого Secret определяется из provides слота. |
connection | string | нет | Псевдоним соединения, которое использует компонент, — имя, под которым оно записано в блоке uses компонента в сущности Aggregate или Release. Если задан, secret называет слот, объявленный сокетом, через который подключено это соединение, а импортируемый Secret — тот, который опубликовало вложение, переносимое этим соединением в этом слоте, поэтому компонент, обращающийся к нескольким целям, импортирует для каждой собственный Secret. Имеет смысл только вместе с secret. Соединение, которое компонент не использует, или слот, который не объявляет его сокет, отклоняется с указанием обоих. |
prefix | string | нет | Необязательный префикс, добавляемый к имени каждой импортируемой переменной окружения. |
Дополнительные свойства не допускаются.
container.resources
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
requests | resourceList | нет | |
limits | resourceList | нет |
Дополнительные свойства не допускаются.
container.health
Пробы работоспособности контейнера — ready, live и startup, — каждая объявляется как http, tcp или exec. Для helm преобразуются в K8s httpGet/tcpSocket/exec. Для compose у сервиса одна проверка healthcheck: http и tcp становятся тестами CMD-SHELL, exec — тестом CMD, а если объявлено несколько проб, сохраняется только одна — предупреждение называет преобразованную пробу и отброшенные.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
ready | probe | нет | |
live | probe | нет | |
startup | probe | нет |
Дополнительные свойства не допускаются.
container.volumeMounts[]
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
name | string | да | Должно совпадать с ключом в карте volumes: верхнего уровня. |
path | string | да | Точка монтирования внутри контейнера. |
subPath | string | нет | Монтирует отдельный файл или подкаталог из тома по пути path, не скрывая другие файлы в целевом каталоге. |
readonly | логическая | нет | По умолчанию: false |
Дополнительные свойства не допускаются.
container.lifecycle
Хуки жизненного цикла контейнера. Для helm преобразуются в K8s container.lifecycle (postStart/preStop). В compose нет примитива хуков жизненного цикла; рабочая нагрузка, объявляющая lifecycle, явно останавливает сборку на целевой платформе compose, а не отбрасывает хук незаметно.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
postStart | lifecycleHook | нет | |
preStop | lifecycleHook | нет |
Дополнительные свойства не допускаются.
container.securityContext
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
runAsUser | integer | нет | |
runAsGroup | integer | нет | |
runAsNonRoot | логическая | нет | |
readOnlyRootFilesystem | логическая | нет | |
allowPrivilegeEscalation | логическая | нет | |
capabilities | object | нет |
Дополнительные свойства не допускаются.
container.securityContext.capabilities
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
add | string[] | нет | |
drop | string[] | нет |
Дополнительные свойства не допускаются.
containerAttachment
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
from | string | да | Имя слота, объявленного в featuresSchema сущности Component, — или, если задан connection, слота, который объявляет сокет, через который подключено это соединение. |
connection | string | нет | Псевдоним соединения, которое использует компонент, — имя, под которым оно записано в блоке uses компонента в сущности Aggregate или Release. Если задан, from называет слот, объявленный сокетом, через который подключено это соединение (usesSchema. |
as | string (enum) | да | Механизм доставки. Должен быть разрешён в массиве inject: слота. Допустимые значения: "env", "file" |
key | string | нет | Для as: env — конкретный ключ данных секрета указанного слота, который читает эта запись. Задайте его, если секрет слота содержит несколько ключей данных, чтобы запись выбрала один из них по имени; две записи могут ссылаться на один слот с разными ключами, чтобы прочитать несколько ключей из одного секрета. Если опущен, запись читает единственный опубликованный ключ слота. Игнорируется для as: file, при котором монтируется весь секрет. |
path | string | нет | Путь к файлу внутри контейнера (обязателен при as: file). |
Дополнительные свойства не допускаются.
resourceList
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
cpu | string | нет | Количество CPU (например, ‘100m’, ‘0.5’, ‘2’). helm выводит его без изменений в resources.{requests,limits}.cpu. compose отображает его в deploy.resources.{reservations,limits}.cpus как дробное число ядер: количество в милли-CPU преобразуется (500m становится 0.5), количество в целых ядрах передаётся как есть. Количество, которое compose не может преобразовать, явно останавливает сборку, а не выводит неверное значение. |
memory | string | нет | Объём памяти (например, ‘128Mi’, ‘1Gi’). helm выводит его без изменений в resources.{requests,limits}.memory. compose отображает его в deploy.resources.{reservations,limits}.memory как точное число байтов. Количество, дающее целое число байтов, преобразуется точно (1.5Gi становится 1610612736); количество, которое его не даёт или не является количеством, явно останавливает сборку, а не округляется. |
Дополнительные ключи: расширенное (с областью поставщика/домена) количество ресурса, ключом которого служит полностью квалифицированное имя ’^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)+/[A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?$.
Любые другие свойства не допускаются.
probe
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
http | string | нет | Проба HTTP GET: путь проверяется на том порту контейнера, имя которого идёт первым в алфавитном порядке. |
tcp | integer | нет | Проба TCP-сокета на заданном номере порта контейнера. Минимум: 1. Максимум: 65535. |
exec | string[] | нет | Проба exec — команда, выполняемая внутри контейнера. Не менее 1 записи. |
timeoutSeconds | integer | нет | Минимум: 1. |
initialDelaySeconds | integer | нет | Минимум: 0. |
periodSeconds | integer | нет | Минимум: 1. |
failureThreshold | integer | нет | Минимум: 1. |
successThreshold | integer | нет | Минимум: 1. |
Дополнительные свойства не допускаются.
lifecycleHook
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
exec | string[] | нет | Не менее 1 записи. |
httpGet | object | нет | Нативная для K8s форма httpGet (path, port, scheme, host, httpHeaders). Передаётся в helm как есть. На цели compose рабочая нагрузка, объявляющая хук жизненного цикла, останавливает сборку, поскольку в compose нет примитива хука жизненного цикла — хук никогда не отбрасывается молча. |
Дополнительные свойства не допускаются.
volume
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
ephemeral | object | нет | |
configmap | object | нет | |
secret | object | нет | |
persistent | object | нет | |
persistentTemplate | object | нет | Шаблон заявки для каждой реплики. Требует form: stateful, поскольку только форма stateful даёт каждой реплике стабильную идентичность, необходимую заявке для каждой реплики. В Kubernetes становится StatefulSet.volumeClaimTemplates. На цели compose деградирует до одного именованного тома, общего для всех реплик, и об этой деградации сообщает предупреждение. |
Дополнительные свойства не допускаются.
volume.ephemeral
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
sizeLimit | string | нет | Количество K8s (например, ‘1Gi’). K8s: emptyDir.sizeLimit. Compose: том становится записью tmpfs без размера, поэтому это значение не попадает в вывод — если оно задано, об этом сообщает предупреждение. |
Дополнительные свойства не допускаются.
volume.configmap
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
source | string | да | Имя ConfigMap, выводимого этим Recipe через artifacts: или подключённой Feature; на ConfigMap, который выводит другой Recipe, здесь не ссылаются. |
items | object[] | нет | Необязательный выбор соответствия ключей путям. |
Дополнительные свойства не допускаются.
volume.secret
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
source | string | да | |
items | object[] | нет |
Дополнительные свойства не допускаются.
volume.persistent
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
size | string | да | Количество K8s (например, ‘10Gi’). |
class | string | нет | StorageClassName. Необязательно. |
accessModes | string (enum)[] | нет | Режимы доступа PVC. helm выводит spec.accessModes, по умолчанию [ReadWriteOnce], если не указано. В томах compose нет понятия режима доступа, и он опускается. Допустимые значения для каждой записи: "ReadWriteOnce", "ReadOnlyMany", "ReadWriteMany", "ReadWriteOncePod". |
Дополнительные свойства не допускаются.
volume.persistentTemplate
Шаблон заявки для каждой реплики. Требует form: stateful, поскольку только форма stateful даёт каждой реплике стабильную идентичность, необходимую заявке для каждой реплики. В Kubernetes становится StatefulSet.volumeClaimTemplates. На цели compose деградирует до одного именованного тома, общего для всех реплик, и об этой деградации сообщает предупреждение.
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
size | string | да | |
class | string | нет | |
accessModes | string (enum)[] | нет | Режимы доступа PVC для шаблона заявки каждой реплики. helm выводит spec.accessModes, по умолчанию [ReadWriteOnce], если не указано. В compose нет понятия режима доступа, и он опускается. Допустимые значения для каждой записи: "ReadWriteOnce", "ReadOnlyMany", "ReadWriteMany", "ReadWriteOncePod". |
Дополнительные свойства не допускаются.
service
| Свойство | Тип | Обязательно | Описание |
|---|---|---|---|
type | string (enum) | да | Тип сервиса: насколько далеко доступны порты записи. ClusterIP оставляет их в собственной сети цели, доступными для соседей рабочей нагрузки; Headless тоже, а в helm выводит Service K8s с clusterIP: None; NodePort и LoadBalancer публикуют их за пределами этой сети; Loopback публикует их только на loopback-адресе самого хоста, доступными с машины, на которой работает рабочая нагрузка, и ниоткуда больше. helm выводит ClusterIP, NodePort и LoadBalancer как одноимённый тип Service K8s и отклоняет запись Loopback с указанием имени, поскольку у Service K8s нет типа, привязывающегося к loopback-адресу хоста. compose ничего не публикует для ClusterIP и Headless, публикует порты NodePort и LoadBalancer на всех интерфейсах хоста как host:container и публикует порты Loopback на loopback-адресе IPv4 как 127.0.0.1:host:container; порт, который также публикует запись NodePort или LoadBalancer, публикуется на всех интерфейсах. Допустимые значения: "ClusterIP", "NodePort", "LoadBalancer", "Headless", "Loopback" |
ports | словарь integer | да | Словарь «имя порта сервиса → номер порта контейнера». Имена портов должны совпадать с ключами в containers. |
Дополнительные свойства не допускаются.