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

Сутності за ролями

Кожен вид сутності має роль, яка зазвичай його створює. Ця сторінка — повна карта: звертайтеся до неї, коли ви знаєте своє завдання, але ще не знаєте, до якого файлу воно належить. Розподіл ролей — це орієнтир, а не вимога компілятора (див. Персони); він називає, хто зазвичай володіє видом у добре структурованому налаштуванні.

Карта коротко

РольВиди сутностейЗавдання
РозробникAggregateНамір застосунку: що таке застосунок і що йому потрібно
Архітектор платформиComponent, FeatureБагаторазовий версіонований контракт каталогу
Експлуатація платформиRecipe, FeatureRecipe, Plugin для рендерингу провайдераProvider-специфічне перетворення на відрендерену інфраструктуру
Оператор платформиManifest, ReleaseМаршрутизація та зв’язування розгортання
Наскрізна підтримкаSchemaLibrary, MappingLibrary, WorkloadLibrary, ArtifactLibrary, Plugin, WorkloadСпільні структури, код розширень і вид компілятора, яким володіє платформа

Розробник

Aggregate — єдина поверхня, яку створює розробник, і єдине джерело істини для топології застосунку. Вона оголошує компоненти, з яких складається застосунок, values, які приймає кожен із них, сутності Features, поведінка яких є наміром застосунку (з їхніми values), parameters, відкриті для варіювання між середовищами, і ребра uses, що з’єднують компоненти. Вона навмисно агностична щодо фізичної інфраструктури: ніщо в сутності Aggregate не називає хмару, кластер чи провайдера. Саме ця агностичність щодо можливостей дозволяє одній сутності Aggregate розгортатися будь-де.

Архітектор платформи

Component — багаторазовий версіонований контракт для одного виду будівельного блока. Він оголошує через JSON Schema values, які може надати розробник; виходи provides, які він передає споживачам; і сокети usesSchema, які він відкриває для зв’язування. Сутності Components несуть семантичні мітки, що керують політиками та рендерингом. Архітектор підтримує контракт сутності Component стабільним, щоб розробники могли на нього покладатися.

Feature — підключувана можливість, яку розробник або оператор може додати до компонента: експортер метрик, маскування чутливого тексту на AI-шлюзі, прив’язка облікових даних. Сутність Feature оголошує, що їй потрібно і з чим вона несумісна; те, як її реалізовано — ресурси, які вона генерує, або налаштування, які вона записує в те, що її компонент уже рендерить, — міститься в її FeatureRecipe.

Експлуатація платформи

Recipe — специфічна для провайдера реалізація сутності Component. Вона відображає оголошені значення сутності Component на вихід конкретного провайдера — реліз Helm, сервіс Compose, модуль Terraform — за допомогою шаблонів і передає значення provides споживачам. Сутність Recipe ніколи не змінює значень для розробника, які оголошує Component; вона лише вирішує, як їх буде відрендерено.

FeatureRecipe — специфічна для провайдера реалізація сутності Feature, що застосовується під час прив’язування. Вона генерує ресурси, які передбачає підключення Feature для певного провайдера, або записує передбачені ним налаштування в те, що підключений компонент уже рендерить.

Provider-рендеринговий Plugin — провайдер — це гостьовий модуль Wasm, який перетворює вхідні дані сутності Recipe на нативні маніфести провайдера. Він постачається як сутність Plugin із pluginType: provider, що оголошує назву (або назви) провайдера, який вона рендерить, і свій контракт сокета провайдера. Операційна команда (або автор плагіна) надає провайдери, щоб сутностям Recipes було з чим рендеритися. Див. Огляд сутностей Providers, щоб дізнатися про постачувані провайдери та їхні контракти.

Безпечне читання облікових даних у сутності Recipe

Облікові дані надходять до сутності Recipe каналом inject, .context.inject.env, у вигляді будь-якого тексту, який обрав їхній автор, тож вони можуть містити символи, які шаблон не може записати в YAML як є. Усередині скаляра в подвійних лапках подвійна лапка передчасно завершує значення, а зворотна скісна риска починає екранування: збирання зупиняється або зворотна скісна риска мовчки губиться. Екрануйте обидва символи там, де записується значення:

variables:
{{- $env := optional (default dict .context.inject) "env" dict }}
DB_PASSWORD: "{{ optional $env "DB_PASSWORD" "" | replace "\\" "\\\\" | replace "\"" "\\\"" }}"

optional читає ключ із мапи каналу з порожнім резервним значенням, тож пароль, який нічого не доставило, рендериться як порожній текст. Два виклики replace екранують спершу зворотну скісну риску, а потім лапку — саме в такому порядку, щоб екранування самої лапки не екранувалося повторно, — і залишають кожен інший символ без змін. До значення, прочитаного через index, який зупиняє збирання за відсутності ключа, застосовуються ті самі два виклики replace без змін.

Один символ ця форма не передає — розрив рядка. YAML згортає розрив рядка всередині скаляра в подвійних лапках у пробіл, тож облікові дані, що його містять, доставляються з пробілом на місці розриву. Сутність FeatureRecipe, яка записує облікові дані у свій injectMapping, натомість записує їх через toJson, що однаково передає лапку, зворотну скісну риску й розрив рядка, як показує довідник FeatureRecipe.

Ця сутність FeatureRecipe записує облікові дані під тим механізмом, з якого їх читає сутність Recipe, — env: для .context.inject.env, file:, arg: або власним механізмом компонента під його власною назвою. .context.inject.all будується з цих механізмів і ніколи — з виводу відображення, тож відображення, що записує під all:, нічого б не доставило; натомість збирання на ньому зупиняється, називаючи приєднання, ключ і FeatureRecipe.

Оператор платформи

Manifest — шар маршрутизації. Він вказує компілятору, яка сутність Recipe реалізує кожну сутність Component для певної цілі, тож ту саму сутність Aggregate можна спрямувати на різні реалізації в різних середовищах — хмарну Recipe для продакшену, Recipe для Compose для локального тестування — без жодних змін у файлі розробника.

Release — єдиний вхід компіляції, що фіксує, що збирає одне середовище. Він вказує на сутності Aggregate і Manifest, заповнює parameters, які відкрив розробник, підключає сутності Features, вхідні дані яких є операційними, задає через infra розміри тих, які підключив розробник, і з’єднує власні ребра в межах сокетів, оголошених архітектором. Сутність Release заповнює відкриті точки варіювання; вона не може вводити нові values застосунку чи нові обчислювальні ресурси — вони надходять лише із сутності Aggregate.

Наскрізні допоміжні види

Ці види слугують авторам різних ролей, а не належать одній.

SchemaLibrary — спільна бібліотека структур схем, що повторюються в багатьох сутностях Components і Features. Коли та сама структура (скажімо, блок ресурсів пода) з’являється в багатьох сутностях, архітектор виносить її в запис SchemaLibrary, щоб її було визначено й оновлювано в одному місці.

MappingLibrary — спільна бібліотека багаторазової логіки відображення, яку використовують сутності Recipes і FeatureRecipes, щоб поширені шаблони перетворення мали одне джерело, а не копіювалися.

WorkloadLibrary — спільна бібліотека багаторазового вмісту Workload, щоб структуру розгортання, яка повторюється в багатьох сутностях Recipes, було оголошено один раз та імпортовано в кожен блок workload:.

ArtifactLibrary — спільна бібліотека багаторазових наборів артефактів: іменованих наборів допоміжних вихідних файлів, що належать разом, як-от CRD з його RBAC. Сутність Recipe або FeatureRecipe імпортує набір в одному записі artifacts: і виводить кожен файл із нього.

Plugin — вид розширення. Окрім рендерингу провайдерів, сутності Plugins пакують код WebAssembly, що надає предметну логіку — валідацію політик, мутацію, лінтинг та інші сокети. Створення сутностей Plugin — завдання команди платформи, що підтримує всі інші ролі.

Workload — вид компілятора, яким володіє платформа, а не файл, який розробник або оператор пише вручну як сутність верхнього рівня. Він використовується всередині блока workload: сутності Recipe, де провайдер, за допомогою якого сутність Recipe виконує рендеринг, перетворює нормалізовану структуру робочого навантаження на свою нативну форму. Автори сутностей Recipe взаємодіють із ним через цей блок; довідник Workload документує цю структуру.

Далі