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

Політики в CI над результатом збирання

Два готові до використання скрипти правил, які читають вихідний каталог збирання Aggrega і відхиляють його, коли він порушує правило. Вони запускаються в конвеєрі після aggrega build, поряд з усім іншим, що цей конвеєр уже запускає над конфігурацією.

Цей каталог не є робочим простором Aggrega — він не описує ні Aggregate, ні Release, ні жодної сутності каталогу. Це пара скриптів, які ви копіюєте у власний репозиторій, плюс крок конвеєра, що викликає кожен із них.

Маршрут, до якого вони належать, і випадки, коли натомість правильним є сокет керування всередині збирання, описано на сторінці сокета керування.

Два правила

СкриптВідхиляє
require-pinned-image.shобраз контейнера без тегу або з тегом latest
deny-inline-credential-material.shвідрендерений Secret, що містить облікові дані як літерал

Кожен приймає вихідний каталог як єдиний аргумент і обходить усе, що в ньому є. Жоден не знає нічого про те, де виконувалося збирання, яка це була ціль чи як організовано робочий простір:

Terminal window
./require-pinned-image.sh <output-directory>
./deny-inline-credential-material.sh <output-directory>

Обом потрібен лише yq у PATH і більше нічого. yq читає документ JSON тим самим виразом, що й документ YAML, оскільки JSON є підмножиною YAML, тож один скрипт охоплює обидві форми результату.

Окрім yq, цій теці нічого не потрібно: ні отриманого каталогу, ні бінарного файлу aggrega, ні мережі. ./check.sh запускає обидва правила над невеликими вихідними теками, які записує сам, у тих формах, які видає збірка, і порівнює кожен код завершення та звіт з очікуваними для цієї теки; за будь-якої розбіжності він завершується з кодом 1. Щоб отримати справжню збірку для перевірки правилами, потрібне те саме, що потрібне прикладу, який ви збираєте.

Три коди виходу, а не два

0 no finding — the output satisfies the rule
1 finding — the output breaks it, and every offending artifact is named
2 cannot evaluate — bad usage, yq absent, or an artifact that does not parse

Третій навмисно відрізняється від другого. «Артефакти не вдалося прочитати» ніколи не повинно бути невідрізненним від «артефакти пройшли перевірку» — з тієї ж причини політика, яку неможливо обчислити, у сокеті керування повідомляється як збій, а не як дозвіл. Конвеєр, який вважає будь-який ненульовий код виходу збоєм, отримує правильну поведінку від обох; конвеєр, що хоче їх розрізняти, може це зробити.

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

OK: every image pinned across 3 container(s) in 43 document(s)
OK: no inline credential material across 43 document(s), 1 of them credential-carrying

Адаптація правила

Кожен скрипт тримає yq і рішення окремо та зазначає це в коментарі в точці, де вони зустрічаються: вираз yq читає кожен документ у рядки, розділені табуляцією, а функція оболонки вирішує щодо кожного рядка. Щоб виразити інше правило, змініть ці дві частини, а обхід залиште без змін.

Це розділення не є прикрасою. Двом схожим на вигляд правилам воно потрібне з протилежних причин:

  • Одного ключа недостатньо. ConfigMap містить блок data: точно так само, як і Secret, а data: у ConfigMap не є обліковими даними. Тому вид є частиною правила щодо облікових даних, а не лише ключ.
  • Рекурсивний пошук — це забагато. CustomResourceDefinition оголошує власну схему, і ця схема може оголосити властивість з іменем image. Правило, яке шукало б ключ image у кожному документі, повідомило б схему CRD як незакріплене робоче навантаження. Тому require-pinned-image.sh явно читає шість шляхів специфікації пода, і додавання виду робочого навантаження означає додавання шляху.

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

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

Terminal window
aggrega scaffold --example policy-in-ci

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

Terminal window
cd policy-in-ci

Збирання

Ця тека не містить робочого простору, тож тут нічого збирати. ./check.sh запускає обидва правила на невеликих вихідних каталогах, які сам записує, у формах, що їх видає збірка, і перевіряє кожен вердикт:

Terminal window
./check.sh

Щоб запустити правило на справжній збірці, передайте йому вихідний каталог цієї збірки, як це робить наступний розділ.

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

Підійде будь-який зібраний приклад у цьому дереві. Наведені нижче команди — саме ті, що дали коди виходу, записані далі.

Terminal window
cd ../external-secrets-operator
aggrega build --release release.yaml
Terminal window
cd ../ai-agent-and-model-router
aggrega build --release release.yaml

Lock-файли генеруються, а не постачаються, тож у свіжому клоні їх немає, і першому збиранню потрібен такий файл; в огляді прикладів описано два способи це розв’язати.

Крок конвеєра

Наведені нижче фрагменти — це GitHub Actions; ця форма переноситься на будь-який конвеєр, що може виконати команду оболонки й прочитати її код виходу. Кожен рядок run: — це команда, від якої отримано ці коди виходу.

# every image a rendered workload runs is pinned
jobs:
policy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- name: Compile the Release
run: aggrega build --release release.yaml --auto-pull
working-directory: ai-agent-and-model-router
- name: Images are pinned
run: ./require-pinned-image.sh ../ai-agent-and-model-router/dist
working-directory: policy-in-ci
# no credential material reaches the artifacts as a literal
jobs:
policy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- name: Compile the Release
run: aggrega build --release release.yaml --auto-pull
working-directory: external-secrets-operator
- name: No inline credential material
run: ./deny-inline-credential-material.sh ../external-secrets-operator/dist
working-directory: policy-in-ci

У вашому власному репозиторії один робочий простір, а не дерево прикладів, тож аргументом є місце, куди пише ваше збирання — зазвичай dist поруч із робочим простором, — а скрипти лежать там, де ви зберігаєте інструменти конвеєра. Змінюються лише ці два шляхи.

Що повідомляє кожне правило

Запущено з цього каталогу над збираннями трьох сусідніх прикладів. Відмова називає кожен артефакт, проти якого вона заперечує, тож журнал конвеєра і є списком знахідок.

Образи закріплено — над сутністю Release, чиї Recipes закріплюють кожен образ:

Terminal window
$ ./require-pinned-image.sh ../ai-agent-and-model-router/dist
OK: every image pinned across 4 container(s) in 12 document(s)
$ echo $?
0

Над сутністю Release, чий Recipe бере за джерело висхідний чарт Helm і не перевизначає власне посилання чарту на образ:

Terminal window
$ ./require-pinned-image.sh ../advanced-platform/dist
REFUSED: data/helm/db-statefulset-default-db-mariadb.yaml: StatefulSet/db-mariadb container mariadb runs unpinned image registry-1.docker.io/bitnami/mariadb:latest
REFUSED: data/helm/db-statefulset-default-db-mariadb.yaml: StatefulSet/db-mariadb container preserve-logs-symlinks runs unpinned image registry-1.docker.io/bitnami/mariadb:latest
REFUSED: 2 finding(s) across 3 container(s) in 12 document(s)
$ echo $?
1

Жодних вбудованих облікових даних — над сутністю Release, чий єдиний Secret заповнює його оператор під час виконання, а не рендериться зі значенням у ньому:

Terminal window
$ ./deny-inline-credential-material.sh ../external-secrets-operator/dist
OK: no inline credential material across 43 document(s), 1 of them credential-carrying
$ echo $?
0

Над сутністю Release, яка заповнює три слоти облікових даних за значенням:

Terminal window
$ ./deny-inline-credential-material.sh ../ai-agent-and-model-router/dist
REFUSED: helm/agent--router-zumodel-zdcredential--agent-secret-agent-router-model-credential.yaml (document 1): Secret/agent-router-model.credential carries inline material under api-key
REFUSED: helm/router--api-zukey--router-secret-router-api-key.yaml (document 1): Secret/router-api-key carries inline material under master-key
REFUSED: helm/router--provider-zukey--router-secret-router-provider-key.yaml (document 1): Secret/router-provider-key carries inline material under provider-key
REFUSED: 3 finding(s) across 12 document(s), 3 of them credential-carrying
$ echo $?
1

Ця остання відмова — правило, яке обирає середовище, а не дефект сутності Release. Заповнення слота облікових даних за значенням — підтримувана форма: автор надає дані, а ціль рендерить їх там, де робоче навантаження може їх прочитати, і компілятор не має щодо цього жодної думки. Поруч і окремо він таки попереджає, коли значення, яке автор оголосив чутливим, потрапляє до ключа доставки як літерал, — і це попередження лише радить, а не зупиняє, бо сімейство облікових даних за значенням є навмисним. У будь-якому разі середовище, яке забороняє цю форму, саме про це заявляє: тут або в сокеті керування. Обидва маршрути та вибір між ними описано на сторінці сокета керування.