Aller au contenu
AggregaAggrega
Selectionner la langue: Français
Cette page a été traduite automatiquement. Lire l’original en anglais.

Politique en CI, sur la sortie du build

Deux scripts de règles prêts à l’emploi qui lisent le répertoire de sortie d’un build Aggrega et le refusent lorsqu’il enfreint une règle. Ils s’exécutent dans un pipeline, après aggrega build, à côté de tout ce que ce pipeline exécute déjà sur la configuration.

Ce répertoire n’est pas un espace de travail Aggrega — il ne définit aucun Aggregate, aucune Release et aucune entité de catalogue. C’est une paire de scripts que vous copiez dans votre propre dépôt, plus l’étape de pipeline qui invoque chacun d’eux.

La voie à laquelle ils appartiennent, et le moment où le socket de gouvernance intégré au build est au contraire le bon choix, sont décrits sur la page du socket de gouvernance.

Les deux règles

ScriptRefuse
require-pinned-image.shune image de conteneur sans tag, ou avec le tag latest
deny-inline-credential-material.shun Secret rendu contenant des éléments d’identification sous forme littérale

Chacun prend le répertoire de sortie comme seul argument et parcourt tout ce qui s’y trouve. Aucun ne sait quoi que ce soit de l’endroit où le build s’est exécuté, de la cible dont il s’agissait ou de l’organisation de l’espace de travail :

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

Les deux ont besoin de yq dans le PATH et de rien d’autre. yq lit un document JSON avec la même expression qu’un document YAML, car JSON est un sous-ensemble de YAML, si bien qu’un seul script couvre les deux formes de sortie.

Au-delà de yq, ce répertoire n’a besoin de rien : ni checkout du catalogue, ni binaire aggrega, ni réseau. ./check.sh exécute les deux règles sur de petits répertoires de sortie qu’il écrit lui-même, dans les formes qu’un build produit, et compare chaque code de sortie et chaque rapport à ceux attendus pour ce répertoire ; il se termine avec 1 à la moindre divergence. Produire un vrai build sur lequel exécuter les règles nécessite ce que nécessite l’exemple que vous construisez.

Trois codes de sortie, et non deux

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

Le troisième est délibérément distinct du deuxième. « Les artefacts n’ont pas pu être lus » ne doit jamais être indiscernable de « les artefacts ont réussi », pour la même raison qu’une politique non évaluable au socket de gouvernance est signalée comme une défaillance plutôt que comme une autorisation. Un pipeline qui traite toute sortie non nulle comme un échec obtient le bon comportement des deux ; un pipeline qui veut les distinguer le peut.

Une exécution qui ne trouve rien indique combien elle a examiné, si bien qu’une règle qui n’a rien trouvé du tout est visible au lieu d’être indiscernable d’une règle qui a trouvé des correspondances et a été satisfaite :

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

Adapter une règle

Chaque script sépare yq et la décision, et le dit dans un commentaire à l’endroit où ils se rencontrent : une expression yq lit chaque document en lignes séparées par des tabulations, et une fonction shell décide sur chaque ligne. Pour exprimer une règle différente, modifiez ces deux éléments et laissez le parcours tel quel.

La séparation n’est pas décorative. Deux règles qui se ressemblent en ont besoin pour des raisons opposées :

  • Une clé seule ne suffit pas. Un ConfigMap porte un bloc data: exactement comme un Secret, et le data: d’un ConfigMap n’est pas un élément d’identification. Le type de ressource fait donc partie de la règle sur les identifiants, pas seulement la clé.
  • Une recherche récursive va trop loin. Une CustomResourceDefinition déclare son propre schéma, et ce schéma peut déclarer une propriété nommée image. Une règle qui chercherait une clé image dans chaque document signalerait le schéma d’une CRD comme une charge de travail non épinglée. C’est pourquoi require-pinned-image.sh lit explicitement les six chemins de pod-spec, et ajouter un type de charge de travail signifie ajouter un chemin.

Générer l’exemple

Écrivez l’exemple dans un nouveau dossier qui porte son nom :

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

Elle affiche ensuite les prochaines commandes à exécuter. La première vous place dans le nouveau dossier :

Terminal window
cd policy-in-ci

Build

Ce dossier ne contient aucun espace de travail, il n’y a donc rien à compiler ici. ./check.sh exécute les deux règles sur de petits répertoires de sortie qu’il écrit lui-même, sous les formes qu’émet un build, et vérifie chaque verdict :

Terminal window
./check.sh

Pour exécuter une règle sur un vrai build, donnez-lui le répertoire de sortie de ce build, comme le fait la section suivante.

Produire un build sur lequel les exécuter

N’importe quel exemple construit dans cette arborescence convient. Les commandes ci-dessous sont celles qui ont produit les codes de sortie consignés plus bas.

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

Les fichiers de verrouillage sont générés plutôt que livrés, si bien qu’un clone récent n’en a aucun et que le premier build en a besoin d’un ; la vue d’ensemble des exemples indique les deux façons de le résoudre.

L’étape de pipeline

Les extraits ci-dessous sont des GitHub Actions ; la forme se transpose à tout pipeline capable d’exécuter une commande shell et de lire son code de sortie. Chaque ligne run: est la commande dont proviennent ces codes de sortie.

# 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

Dans votre propre dépôt, il y a un seul espace de travail plutôt qu’une arborescence d’exemples, si bien que l’argument est l’endroit où votre build écrit — dist à côté de l’espace de travail, dans le cas habituel — et les scripts se trouvent là où vous gardez l’outillage de pipeline. Seuls ces deux chemins changent.

Ce que signale chaque règle

Exécutées depuis ce répertoire, sur les builds de trois des exemples voisins. Un refus nomme chaque artefact auquel il s’oppose, si bien que le journal du pipeline est la liste des constats.

Les images sont épinglées — sur une Release dont les Recipes épinglent chaque image :

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

Sur une Release dont la Recipe s’appuie sur un chart Helm amont et ne surcharge pas la référence d’image propre au chart :

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

Aucun élément d’identification en ligne — sur une Release dont l’unique Secret est rempli par son opérateur à l’exécution plutôt que rendu avec une valeur à l’intérieur :

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

Sur une Release qui remplit trois emplacements d’identifiants par valeur :

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

Ce dernier refus est une règle qu’un parc informatique choisit, et non un défaut de la Release. Remplir un emplacement d’identifiant par valeur est une forme prise en charge : un auteur fournit l’élément et la cible le rend là où la charge de travail peut le lire, et le compilateur n’a aucune opinion à ce sujet. À proximité, et séparément, il avertit bien lorsqu’une valeur qu’un auteur a déclarée sensible parvient à une clé de livraison sous forme littérale — et cet avertissement conseille plutôt qu’il n’arrête, car la famille des identifiants par valeur est délibérée. Dans un cas comme dans l’autre, c’est le parc informatique qui interdit la forme qui le dit : ici, ou au socket de gouvernance. Les deux voies et le choix entre elles se trouvent sur la page du socket de gouvernance.