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

Стек Harbor — реєстр контейнерів, розгорнутий як один реліз

Цей приклад компілює реальний реєстр контейнерів у маніфести Kubernetes з одного Aggregate, написаного розробником.

Реєстр контейнерів — це багато взаємодійних сервісів: площина керування з API та сервісом токенів, сховище блобів OCI та його контролер, вебконсоль, рівень асинхронних обробників, сканер вразливостей, реляційний бекенд, кеш «ключ — значення» і зворотний проксі перед ними. Каталог описує все це як одну сутність Component, бо супровідники самого реєстру публікують Helm-чарт, який розгортає його цілком як один реліз, у порядку, потрібному його сервісам. Сутність Component оголошує реєстр; сутність Recipe обгортає цей чарт.

Реєстр імпортується як модуль: багаторазово використовуваний субагрегат, що компонує сутність Component і експортує її опубліковану адресу. Сутність Aggregate верхнього рівня імпортує модуль за назвою і передає йому три ключі реєстру; оператор задає розміри компонента модуля в сутності Release.

Файли

ФайлРоль
aggregate.yamlНамір розробника: імпортує модуль реєстру контейнерів (core/harbor) і передає йому три ключі реєстру з власних параметрів.
manifest-helm-synth.yamlЗіставляє тип компонента реєстру з Recipe, що обгортає його Helm-чарт, а Feature облікових даних — з реалізацією, яка читає Secret, що вже існує в просторі імен, — за винятком пароля адміністратора, який вона за назвою прив’язує до реалізації, що створює Secret із параметра модуля.
release-helm-synth.yamlЗапис оператора для цільового середовища Kubernetes. Називає сутності Secret, що містять три ключі, які Aggregate передає вниз, задає розміри компонента модуля за його ідентифікатором в області видимості модуля і приєднує до нього ключ підпису токенів, спільний секрет сервісів і ключ, яким шифруються збережені облікові дані, називаючи сутності Secret, що їх містять; усе інше залишено на значення за замовчуванням зі схеми.

Що демонструє приклад

  • Багатосервісний продукт як один Component. Реєстр є одним Component, а не кількома, не через свій розмір, а через те, де підтримується його зв’язування: маршрутизація зворотного проксі, ключ служби токенів, за яким площина керування перевіряє кожен pull і push, параметри підключення, які кожна служба читає для бекенда й кешу, розподіл логічних баз даних, що розділяє простори ключів кешу служб, і порядок запуску — усе це узгоджують із продуктом ті, хто його випускає, усередині чарту. Споживач оголошує реєстр і отримує все це узгодженим.
  • Обгорнутий чарт. Recipe називає чарт у source: і накладає на нього valuesMapping: — шаблон значень є всією реалізацією, а провайдер Helm рендерить власні шаблони чарту з ним. Жодне робоче навантаження тут не синтезується.
  • Закріплений зовнішній вхід. Чарт — це вхід, який завантажує збірка, тому його закріплено, як будь-яку залежність: файл блокування записує версію чарту, його розв’язану URL-адресу та дайджест архіву в source_artifacts. Збірка із заповненим файлом блокування бере чарт зі сховища вмісту й перевіряє його за цим дайджестом.
  • Одна опублікована адреса для всієї платформи. Зворотний проксі чарту спрямовує шлях браузера / до консолі, а шляхи реєстру й API (/v2/, /api/, /service/, /c/) — до площини керування, тож контейнерний клієнт входить, виконує push і pull на тому самому хості, на якому браузер відкриває консоль. Саме цей Service публікує provides.host, і споживачеві не потрібна друга адреса, щоб дістатися будь-якого з наборів шляхів.
  • Дві публічні назви для неї. Модуль експортує цю одну адресу як registry, кінцеву точку, з якою працюють клієнти образів та API, і як ui, вебкінцеву точку. Обидві вказують на адресу, що обслуговує обидва набори шляхів, тож споживач підключається до тієї назви, яка описує його намір.
  • Задання розмірів компонента модуля оператором. Release звертається до компонента модуля за його ідентифікатором в області модуля (harbor.registry), щоб задати обчислювальні ресурси, і сутності Aggregate розробника не потрібно повторювати фізичні розміри.
  • Правила повноти для згрупованого значення. infra.compute містить ключ CPU і ключ пам’яті, і Recipe зупиняється на групі, що залишає порожнім будь-який із них. Площина керування, відрендерена з лімітом CPU і без ліміту пам’яті, суттєво відрізняється від тієї, яку описують оголошені значення за замовчуванням сутності Component, і ніщо у відрендереному виводі про це не скаже — тому збірка зупиняється й називає відсутній ключ. Ключ, пропущений у групі, набуває значення за замовчуванням сутності Component.
  • Шість ключів без значення за замовчуванням. Ключ, яким служба токенів підписує токени реєстру, разом із його сертифікатом; три секрети, якими власні служби реєстру автентифікуються одна перед одною та підписують стан завантаження; ключ захисту від підробки запитів; і ключ, яким площина керування шифрує збережені облікові дані, не мають значення за замовчуванням: ключ, який мав би кожен читач каталогу, дозволив би будь-кому випускати токени, яким довіряє реєстр, або читати те, що він зберігає. Component оголошує ці слоти обов’язковими, тож збірка, яка залишає один порожнім, зупиняється й називає слот. Збірка не читає жодного з шести значень і не рендерить жодного з них: кожне робоче навантаження читає кожне з Secret, який воно називає.
  • Три ключі, які приєднує Release. Модуль не приєднує ні ключ підписування токенів, ні спільний секрет площини керування, ні ключ, яким шифруються збережені облікові дані, тож Release приєднує всі три до компонента модуля, token_key, core_secret і secret_key, кожен через core/referenced-secret з infra.origin, що називає Secret, а Manifest прив’язує Feature до k8s-existing-secret. Площина керування монтує ключ підписування токенів і ключ шифрування із Secrets, які вони називають, а служби читають спільний секрет зі своїх.
  • Облікові дані, які заповнює модуль. Пароль облікового запису адміністратора, ключ захисту від міжсайтової підробки запитів, спільний секрет рівня обробників і секрет стану завантаження сховища blob-об’єктів — це теж слоти облікових даних у Component, і модуль заповнює кожен із власного параметра (admin_password, csrf_key, jobservice_secret, registry_http_secret) через Feature облікових даних core/referenced-secret, тож кожне робоче навантаження читає їх із Secret за назвою. Оскільки модуль приєднує цю Feature, Manifest зіставляє її. Три ключі не мають значення за замовчуванням і в модулі, тож Aggregate оголошує власні параметри й передає їх далі через aggregates.harbor.parameters, Release їх заповнює, а k8s-existing-secret читає кожен як назву Secret, що вже існує в просторі імен; Release, що не надає значення, зупиняє збірку, називаючи параметр. Цей приклад залишає пароль адміністратора на значенні модуля за замовчуванням для розробки, і Manifest прив’язує це одне приєднання за назвою до k8s-secret-from-parameter, що створює Secret із ним. Решта паролів записується в конфігурацію, яку рендерить Release, тож їх замінюють заданням infra; якщо не задано, кожен набуває значення для розробки, яке вказує Recipe.
  • Детермінований вивід над чартом, який інакше генерував би матеріал. Сам по собі цей чарт створює власні секрети, коли їх не надано, — спільний секрет і секрет підписування токенів площини керування, секрети рівня обробників і сховища blob-об’єктів, ключ захисту від підробки запитів і хешований пароль сховища blob-об’єктів, який він повторно хешує зі свіжою сіллю при кожному рендерингу. Натомість кожен із них надається: шість ключів — завжди із Secrets, які називає Release, а паролі — з приєднаних облікових даних за назвою, де слот заповнено, і з фіксованого значення для розробки, де ні, тож два рендеринги ідентичного входу дають побайтово ідентичний вивід.
  • Відтворювані образи. Кожен образ, який запускає реєстр, закріплено за явним тегом. Продукт постачає їх усі з одним тегом, тож infra.engine_version вибирає їх усі одразу; infra.overrides.image замінює закріплення однієї служби, а infra.overrides.image_prefix переміщує їх разом для Release, що завантажує образи з дзеркала.

Створення прикладу

Цей приклад можна зібрати командами нижче або доручити збирання вашому ШІ-асистенту.

Запишіть приклад у нову теку, названу за ним:

Terminal window
aggrega scaffold --example harbor-stack

Потім вона виводить команди, які слід виконати далі. Перша переходить у нову теку:

Terminal window
cd harbor-stack

Збирання

Цей робочий простір не містить .aggrega-config.yaml, тож сутності стандартної бібліотеки розв’язуються з реєстру hub, hub.aggrega.ai, і прапорець каталогу не потрібен. Recipe завантажує chart, тож спершу розв’яжіть залежності у lockfile:

Terminal window
aggrega pull --release release-helm-synth.yaml
aggrega build --release release-helm-synth.yaml

Відрендерені артефакти потрапляють у dist/.

Перш ніж застосовувати їх, створіть шість Secrets, які називає Release, у просторі імен, у який розгортається реєстр: harbor-token-key, що містить закритий ключ RSA під ключем даних tls.key і сертифікат для цього ключа під tls.crt; harbor-core-secret, що містить 16-символьний секрет під ключем даних secret; harbor-secret-key, що містить 16-символьний ключ під secretKey; harbor-csrf-key, що містить 32-символьний ключ під CSRF_KEY; а також harbor-jobservice-secret і harbor-registry-http-secret, що містять 16-символьний секрет під JOBSERVICE_SECRET і REGISTRY_HTTP_SECRET відповідно. Наприклад:

Terminal window
openssl req -x509 -newkey rsa:4096 -nodes -days 3650 -subj "/CN=harbor-token-ca" \
-keyout tls.key -out tls.crt
kubectl create secret tls harbor-token-key --key tls.key --cert tls.crt
kubectl create secret generic harbor-core-secret --from-literal=secret="$(openssl rand -hex 8)"
kubectl create secret generic harbor-secret-key --from-literal=secretKey="$(openssl rand -hex 8)"
kubectl create secret generic harbor-csrf-key --from-literal=CSRF_KEY="$(openssl rand -hex 16)"
kubectl create secret generic harbor-jobservice-secret --from-literal=JOBSERVICE_SECRET="$(openssl rand -hex 8)"
kubectl create secret generic harbor-registry-http-secret --from-literal=REGISTRY_HTTP_SECRET="$(openssl rand -hex 8)"

Реєстр, служби якого не можуть знайти ці Secrets, не запускається.

З ШІ-асистентом

ШІ-асистент, налаштований з інструментами Aggrega, може зробити те саме: вставте йому цей промпт.

Використовуйте лише інструменти Aggrega і не створюйте жодної папки самостійно. Якщо в папці робочої області ще немає папки `harbor-stack`, один раз викличте інструмент `scaffold` зі значенням `example`, встановленим у `harbor-stack`, і без `dir`: він записує приклад у нову папку `harbor-stack`. Потім викличте інструмент `build` із `workspace_root`, встановленим у `harbor-stack`, `release`, встановленим у `release-helm-synth.yaml`, `auto_pull`, встановленим у true, і `write`, встановленим у true. Скажіть мені, які файли записала збірка; вони розташовані в `harbor-stack/dist/`.

Як виглядає скомпонований реєстр

Збірка генерує ресурси, які чарт визначає для цієї конфігурації: Deployments для зворотного проксі, консолі, площини керування, рівня обробників і сховища блобів; StatefulSets для бекенду, кешу та сканера; persistent volume claims для сховища блобів і для журналів рівня обробників; ConfigMaps і Secrets, які читає кожен сервіс; а також Services перед ними. Поряд із ними сутність Feature облікових даних генерує один Secret, harbor-zdregistry-admin-password, що містить типове для розробки значення модуля для пароля адміністратора, яке площина керування читає з нього, а не з власного Secret чарту. Для жодного з шести ключів Secret не генерується: площина керування монтує ключ підпису токенів із harbor-token-key, а ключ шифрування — з harbor-secret-key, а сервіси читають решту з harbor-core-secret, harbor-csrf-key, harbor-jobservice-secret і harbor-registry-http-secret — Secrets, які називає сутність Release.

Рівно один із цих Services є адресою, до якої підключаються споживачі, — dist/app/helm/harbor.registry-service-default-harbor-zdregistry.yaml:

apiVersion: v1
kind: Service
metadata:
name: harbor-zdregistry
[… omitted: the namespace, the chart's labels, and the labels and annotations every rendered document carries]
spec:
type: ClusterIP
ports:
- name: http
port: 80
targetPort: 8080
selector:
release: harbor-zdregistry
app: "harbor"
component: nginx

Його селектор указує на зворотний проксі, і саме це дає реєстру одну адресу. port відповідає infra.port; проксі за ним слухає на порту, який фіксує чарт, і Service перенаправляє трафік на нього, тож зміна infra.port змінює опубліковану адресу, а не порт, на якому слухає проксі.

Іменування: параметр, що публікує адресу, — не той параметр, що іменує ресурси

Цей чарт виводить більшість імен своїх ресурсів із параметра імені верхнього рівня, а потім додає до них суфікси: Service площини керування — це <instance>-core, консолі — <instance>-portal, сховища блобів — <instance>-registry, і так само для рівня обробників, сканера, бекенду та кешу. Жоден ресурс не названо просто цим іменем.

Опублікований Service іменується окремим параметром, що стосується лише публікації, власне значення за замовчуванням якого — фіксований літерал, незалежний від імені верхнього рівня. Recipe, що задає лише параметр верхнього рівня, опублікував би адресу, на яку не відповідає жоден Service, а два екземпляри в одному просторі імен обидва створили б Service під тим самим фіксованим літералом і конфліктували б. Тому Recipe задає обидва параметри з ідентифікатора екземпляра — саме тому створений вище Service названо за екземпляром і саме тому provides.host називає адресу, яка існує.

На це варто звернути увагу, коли ви обгортаєте будь-який платформний чарт: provides.host має називати Service, який чарт справді створює, а те, який параметр це визначає, є властивістю чарту, а не домовленістю, спільною для всіх чартів.

Чого ця конфігурація не містить

Ingress чарту залишено вимкненим, а зворотний проксі натомість опубліковано як Service, внутрішній для кластера, оскільки Component публікує адресу всередині кластера, а не зовнішнє ім’я хоста. Єдину зовнішню точку доступу збирають на рівні ingress, і вона маршрутизує на адресу, яку експортує цей модуль. Захист транспортного рівня вимкнено, оскільки власне джерело сертифікатів чарту генерує центр сертифікації та підписаний сертифікат під час рендерингу, і два рендеринги ідентичних вхідних даних не відтворили б їх однаково. Монітор Prometheus-operator вимкнено.

Метрики реєстру також вимкнено. Параметр values.metrics_enabled сутності Component вмикає їх для площини керування, рівня обробників, сховища блобів і доданого експортера та публікує чотири Service, щоб їх міг виявити збирач метрик; той самий параметр чарту також відкриває налагоджувальний слухач сховища блобів — профілювання, траси виконання та змінні середовища виконання без перевірки того, хто звертається, — для кожного абонента всередині кластера. Модуль залишає це значення за замовчуванням false, тож цей приклад не рендерить жодних метрик; Aggregate, що сам оголошує Component, може його задати. Образ експортера все одно зафіксовано разом з рештою.