Przejdź do głównej zawartości
AggregaAggrega
Wybierz język: Polski
Ta strona została przetłumaczona maszynowo. Przeczytaj oryginał w języku angielskim.

Polityki w CI, na wyniku kompilacji

Dwa gotowe do użycia skrypty reguł, które odczytują katalog wyjściowy kompilacji Aggrega i odrzucają go, gdy narusza regułę. Działają w potoku, po aggrega build, obok wszystkiego, co ten potok już uruchamia na konfiguracji.

Ten katalog nie jest przestrzenią roboczą Aggrega — nie definiuje żadnego Aggregate, żadnego Release ani żadnej encji katalogu. To para skryptów, które należy skopiować do własnego repozytorium, wraz z krokiem potoku, który wywołuje każdy z nich.

Ścieżka, do której należą, oraz sytuacje, w których właściwszym wyborem jest gniazdo zarządzania w kompilacji, opisano na stronie gniazda zarządzania.

Dwie reguły

SkryptOdrzuca
require-pinned-image.shobraz kontenera bez tagu lub z tagiem latest
deny-inline-credential-material.shwyrenderowany Secret zawierający dane uwierzytelniające jako literał

Każdy przyjmuje katalog wyjściowy jako jedyny argument i przechodzi przez wszystko, co się w nim znajduje. Żaden nie wie nic o tym, gdzie przebiegała kompilacja, jaki był cel ani jak zorganizowana jest przestrzeń robocza:

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

Oba wymagają yq w PATH i niczego więcej. yq odczytuje dokument JSON tym samym wyrażeniem co dokument YAML, ponieważ JSON jest podzbiorem YAML, więc jeden skrypt obsługuje obie postacie wyniku.

Poza yq ten katalog nie potrzebuje niczego: ani sklonowanego katalogu encji, ani pliku binarnego aggrega, ani sieci. ./check.sh uruchamia obie reguły na małych katalogach wyjściowych, które sam zapisuje, w kształtach emitowanych przez kompilację, i porównuje każdy kod wyjścia i raport z oczekiwanym dla danego katalogu; przy jakiejkolwiek niezgodności kończy z kodem 1. Utworzenie prawdziwej kompilacji, na której można uruchomić reguły, wymaga tego, czego wymaga kompilowany przykład.

Trzy kody wyjścia, nie dwa

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

Trzeci celowo różni się od drugiego. „Nie udało się odczytać artefaktów” nigdy nie może być nieodróżnialne od „artefakty przeszły kontrolę” — z tego samego powodu polityka, której nie da się ocenić, jest w gnieździe zarządzania zgłaszana jako błąd, a nie jako zezwolenie. Potok traktujący każdy niezerowy kod wyjścia jako niepowodzenie uzyskuje właściwe zachowanie w obu przypadkach; potok, który chce je rozróżniać, może to zrobić.

Przebieg, który niczego nie znajduje, podaje, ile sprawdził, dzięki czemu reguła, która nie dopasowała niczego, jest widoczna, a nie nieodróżnialna od reguły, która dopasowała i została spełniona:

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

Dostosowywanie reguły

Każdy skrypt oddziela yq od decyzji i zaznacza to w komentarzu w miejscu, w którym się spotykają: wyrażenie yq odczytuje każdy dokument do wierszy rozdzielonych tabulatorami, a funkcja powłoki decyduje o każdym wierszu. Aby wyrazić inną regułę, należy zmienić te dwa elementy, a przechodzenie pozostawić bez zmian.

Ten podział nie jest ozdobnikiem. Dwie podobnie wyglądające reguły potrzebują go z przeciwnych powodów:

  • Sam klucz nie wystarczy. ConfigMap zawiera blok data: dokładnie tak jak Secret, a data: obiektu ConfigMap nie jest danymi uwierzytelniającymi. Dlatego rodzaj jest częścią reguły dotyczącej danych uwierzytelniających, a nie tylko klucz.
  • Wyszukiwanie rekurencyjne to za dużo. CustomResourceDefinition deklaruje własny schemat, a ten schemat może deklarować właściwość o nazwie image. Reguła, która szukałaby klucza image w każdym dokumencie, zgłaszałaby schemat CRD jako nieprzypięte obciążenie. Dlatego require-pinned-image.sh jawnie odczytuje sześć ścieżek specyfikacji poda, a dodanie rodzaju obciążenia oznacza dodanie ścieżki.

Generowanie przykładu

Należy zapisać przykład w nowym folderze nazwanym tak jak on:

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

Następnie wypisuje polecenia do uruchomienia w dalszej kolejności. Pierwsze przechodzi do nowego folderu:

Terminal window
cd policy-in-ci

Kompilacja

Ten folder nie zawiera przestrzeni roboczej, więc nie ma tu nic do zbudowania. ./check.sh uruchamia obie reguły na małych katalogach wyjściowych, które sam zapisuje, w kształtach, jakie emituje build, i sprawdza każdy werdykt:

Terminal window
./check.sh

Aby uruchomić regułę na prawdziwym buildzie, należy przekazać jej katalog wyjściowy tego buildu, tak jak robi to następna sekcja.

Przygotowanie kompilacji do sprawdzenia

Nadaje się każdy skompilowany przykład z tego drzewa. Poniższe polecenia to te, które wygenerowały kody wyjścia zapisane niżej.

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

Pliki blokad są generowane, a nie dostarczane, więc świeży klon ich nie ma, a pierwsza kompilacja go wymaga; przegląd przykładów podaje dwa sposoby rozwiązania tego.

Krok potoku

Poniższe fragmenty dotyczą GitHub Actions; ten układ przenosi się na każdy potok, który potrafi uruchomić polecenie powłoki i odczytać jego kod wyjścia. Każdy wiersz run: to polecenie, z którego pochodzą te kody wyjścia.

# 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

We własnym repozytorium jest jeden obszar roboczy, a nie drzewo przykładów, więc argumentem jest miejsce, do którego zapisuje kompilacja — zwykle dist obok obszaru roboczego — a skrypty znajdują się tam, gdzie przechowywane są narzędzia potoku. Zmieniają się tylko te dwie ścieżki.

Co zgłasza każda reguła

Uruchomione z tego katalogu, na kompilacjach trzech sąsiednich przykładów. Odrzucenie wymienia każdy artefakt, który kwestionuje, więc log potoku jest listą ustaleń.

Obrazy są przypięte — na encji Release, której Recipes przypinają każdy obraz:

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

Na encji Release, której Recipe korzysta z zewnętrznego wykresu Helm i nie nadpisuje własnego odwołania wykresu do obrazu:

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

Brak danych uwierzytelniających w treści — na encji Release, której jedyny Secret jest wypełniany przez operatora w czasie działania, a nie renderowany z wartością:

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

Na encji Release, która wypełnia trzy miejsca na dane uwierzytelniające wartościami:

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

To ostatnie odrzucenie wynika z reguły wybranej przez organizację, a nie z wady encji Release. Wypełnianie miejsca na dane uwierzytelniające wartością jest obsługiwanym układem: autor dostarcza dane, a cel renderuje je tam, gdzie obciążenie może je odczytać, a kompilator nie ma na ten temat zdania. Obok, niezależnie, ostrzega on, gdy wartość zadeklarowana przez autora jako wrażliwa trafia do klucza dostarczania jako literał — i to ostrzeżenie jedynie doradza, a nie zatrzymuje, ponieważ rodzina danych uwierzytelniających przekazywanych wartością jest zamierzona. Tak czy inaczej, to organizacja zakazująca tego układu jest tym, kto to wyraża: tutaj lub w gnieździe zarządzania. Obie ścieżki i wybór między nimi opisano na stronie gniazda zarządzania.