Политики в CI поверх результата сборки
Два готовых к использованию скрипта с правилами, которые читают выходной каталог сборки Aggrega и
отклоняют его, если он нарушает правило. Они запускаются в конвейере после aggrega build,
наряду со всем, что этот конвейер уже выполняет над конфигурацией.
Этот каталог не является рабочим пространством Aggrega — в нём не определяется ни Aggregate, ни
Release, ни какая-либо сущность каталога. Это пара скриптов, которые вы копируете в свой
репозиторий, и шаг конвейера, вызывающий каждый из них.
Путь, к которому они относятся, и случаи, когда вместо него следует использовать встроенный в сборку сокет управления, описаны на странице о сокете управления.
Два правила
| Скрипт | Отклоняет |
|---|---|
require-pinned-image.sh | образ контейнера без тега или с тегом latest |
deny-inline-credential-material.sh | отрисованный Secret, содержащий учётные данные в виде литерала |
Каждый принимает выходной каталог как единственный аргумент и обходит всё, что в нём есть. Ни один из них ничего не знает о том, где выполнялась сборка, для какой цели, или как устроено рабочее пространство:
./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 rule1 finding — the output breaks it, and every offending artifact is named2 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явно читает шесть путей спецификации пода, и добавление вида рабочей нагрузки означает добавление пути.
Создание примера
Запишите пример в новую папку, названную по его имени:
aggrega scaffold --example policy-in-ciЗатем она выводит команды, которые нужно выполнить дальше. Первая переходит в новую папку:
cd policy-in-ciСборка
В этой папке нет рабочего пространства, поэтому здесь нечего собирать. ./check.sh запускает оба правила на небольших выходных каталогах, которые записывает сам, в тех формах, которые выдаёт сборка, и проверяет каждый вердикт:
./check.shЧтобы запустить правило на настоящей сборке, передайте ему выходной каталог этой сборки, как это делает следующий раздел.
Получение сборки для их запуска
Подойдёт любой собранный пример из этого дерева. Приведённые ниже команды — те, что дали коды выхода, записанные далее.
cd ../external-secrets-operatoraggrega build --release release.yamlcd ../ai-agent-and-model-routeraggrega build --release release.yamlLock-файлы генерируются, а не поставляются, поэтому в свежем клоне их нет, и первой сборке он нужен; обзор примеров описывает два способа это решить.
Шаг конвейера
Фрагменты ниже написаны для GitHub Actions; та же схема переносится на любой конвейер, который
может выполнить команду оболочки и прочитать её код выхода. Каждая строка run: — это команда,
которая дала эти коды выхода.
# every image a rendered workload runs is pinnedjobs: 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 literaljobs: 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 закрепляют каждый образ:
$ ./require-pinned-image.sh ../ai-agent-and-model-router/distOK: every image pinned across 4 container(s) in 12 document(s)$ echo $?0Над сущностью Release, чей Recipe берёт вышестоящий чарт Helm и не переопределяет собственную ссылку чарта на образ:
$ ./require-pinned-image.sh ../advanced-platform/distREFUSED: data/helm/db-statefulset-default-db-mariadb.yaml: StatefulSet/db-mariadb container mariadb runs unpinned image registry-1.docker.io/bitnami/mariadb:latestREFUSED: data/helm/db-statefulset-default-db-mariadb.yaml: StatefulSet/db-mariadb container preserve-logs-symlinks runs unpinned image registry-1.docker.io/bitnami/mariadb:latestREFUSED: 2 finding(s) across 3 container(s) in 12 document(s)$ echo $?1Нет встроенных учётных данных — над сущностью Release, чей единственный Secret заполняется оператором во время выполнения, а не отрисовывается со значением:
$ ./deny-inline-credential-material.sh ../external-secrets-operator/distOK: no inline credential material across 43 document(s), 1 of them credential-carrying$ echo $?0Над сущностью Release, которая заполняет три слота учётных данных по значению:
$ ./deny-inline-credential-material.sh ../ai-agent-and-model-router/distREFUSED: helm/agent--router-zumodel-zdcredential--agent-secret-agent-router-model-credential.yaml (document 1): Secret/agent-router-model.credential carries inline material under api-keyREFUSED: helm/router--api-zukey--router-secret-router-api-key.yaml (document 1): Secret/router-api-key carries inline material under master-keyREFUSED: helm/router--provider-zukey--router-secret-router-provider-key.yaml (document 1): Secret/router-provider-key carries inline material under provider-keyREFUSED: 3 finding(s) across 12 document(s), 3 of them credential-carrying$ echo $?1Последний отказ — это правило, которое выбирает инфраструктура, а не дефект сущности Release. Заполнение слота учётных данных по значению — поддерживаемая форма: автор предоставляет данные, а цель отрисовывает их там, где рабочая нагрузка может их прочитать, и компилятор не имеет на этот счёт мнения. Рядом, и отдельно, он выдаёт предупреждение, когда значение, объявленное автором как чувствительное, попадает в ключ доставки в виде литерала, — и это лишь совет, а не остановка, поскольку семейство учётных данных по значению предусмотрено намеренно. В любом случае запрет такой формы высказывает сама инфраструктура: здесь или на сокете управления. Оба пути и выбор между ними описаны на странице о сокете управления.