Kebijakan di CI, atas keluaran build
Dua skrip aturan siap pakai yang membaca direktori keluaran build Aggrega dan
menolaknya bila melanggar suatu aturan. Skrip ini berjalan dalam pipeline, setelah aggrega build,
bersama apa pun yang sudah dijalankan pipeline tersebut atas konfigurasi.
Direktori ini bukan workspace Aggrega — direktori ini tidak menulis Aggregate,
Release, maupun entitas katalog apa pun. Isinya sepasang skrip yang Anda salin ke
repositori Anda sendiri, ditambah langkah pipeline yang memanggil masing-masing skrip.
Rute tempat skrip ini berada, dan kapan soket tata kelola di dalam build justru menjadi rute yang tepat, dijelaskan di halaman soket tata kelola.
Kedua aturan
| Skrip | Menolak |
|---|---|
require-pinned-image.sh | image kontainer tanpa tag, atau dengan tag latest |
deny-inline-credential-material.sh | Secret hasil render yang membawa materi kredensial sebagai literal |
Masing-masing menerima direktori keluaran sebagai satu-satunya argumen dan menelusuri apa pun yang ada di sana. Keduanya tidak tahu apa pun tentang di mana build dijalankan, target mana, atau bagaimana workspace disusun:
./require-pinned-image.sh <output-directory>./deny-inline-credential-material.sh <output-directory>Keduanya hanya memerlukan yq di PATH.
yq membaca dokumen JSON dengan ekspresi yang sama seperti saat membaca dokumen YAML, karena
JSON adalah subset YAML, sehingga satu skrip mencakup kedua bentuk keluaran.
Selain yq, direktori ini tidak membutuhkan apa pun: tidak perlu checkout katalog, tidak perlu biner aggrega, dan tidak perlu jaringan. ./check.sh menjalankan kedua aturan pada direktori output kecil yang ditulisnya sendiri, dalam bentuk yang dihasilkan build, dan membandingkan setiap kode keluar dan laporan dengan yang diharapkan untuk direktori tersebut; skrip ini keluar dengan 1 pada setiap ketidakcocokan. Menghasilkan build sungguhan untuk dijalankan aturan memerlukan apa yang diperlukan contoh yang Anda build.
Tiga kode keluar, bukan dua
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 parseKode ketiga sengaja dibedakan dari kode kedua. “Artefak tidak dapat dibaca” tidak boleh sampai tak terbedakan dari “artefak lolos”, dengan alasan yang sama seperti kebijakan yang tidak dapat dievaluasi di soket tata kelola dilaporkan sebagai kesalahan, bukan sebagai izin. Pipeline yang menganggap setiap kode keluar bukan nol sebagai kegagalan mendapatkan perilaku yang benar dari keduanya; pipeline yang ingin membedakannya pun bisa.
Proses yang tidak menemukan apa pun menyebutkan seberapa banyak yang diperiksanya, sehingga aturan yang tidak cocok dengan apa pun terlihat, alih-alih tak terbedakan dari aturan yang cocok dan terpenuhi:
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-carryingMenyesuaikan aturan
Setiap skrip memisahkan yq dari keputusan, dan menyatakannya dalam komentar di
titik pertemuan keduanya: ekspresi yq membaca setiap dokumen menjadi
baris yang dipisahkan tab, dan fungsi shell memutuskan setiap baris. Untuk menyatakan
aturan lain, ubah keduanya dan biarkan penelusurannya.
Pemisahan ini bukan hiasan. Dua aturan yang tampak serupa memerlukannya karena alasan yang berlawanan:
- Kunci saja tidak cukup.
ConfigMapmembawa blokdata:persis sepertiSecret, dandata:milik ConfigMap bukan materi kredensial. Jadi kind merupakan bagian dari aturan kredensial, bukan hanya kuncinya. - Pencarian rekursif terlalu berlebihan.
CustomResourceDefinitionmendeklarasikan skemanya sendiri, dan skema itu dapat mendeklarasikan properti bernamaimage. Aturan yang mencari kunciimagedi setiap dokumen akan melaporkan skema CRD sebagai workload yang tidak dipin. Karena iturequire-pinned-image.shmembaca keenam jalur pod-spec secara eksplisit, dan menambahkan kind workload berarti menambahkan jalur.
Membuat contoh
Tulis contoh ke folder baru yang dinamai sesuai contoh itu:
aggrega scaffold --example policy-in-ciKemudian ia mencetak perintah yang dijalankan berikutnya. Perintah pertama berpindah ke folder baru:
cd policy-in-ciBuild
Folder ini tidak memuat workspace, jadi tidak ada yang perlu di-build di sini. ./check.sh menjalankan kedua aturan pada direktori output kecil yang ditulisnya sendiri, dalam bentuk yang dikeluarkan sebuah build, dan memeriksa setiap putusan:
./check.shUntuk menjalankan aturan pada build nyata, berikan direktori output build itu kepadanya, seperti yang dilakukan bagian berikutnya.
Menghasilkan build untuk diperiksa
Contoh mana pun yang sudah di-build di pohon ini dapat digunakan. Perintah di bawah adalah perintah yang menghasilkan kode keluar yang dicatat lebih lanjut di bawah.
cd ../external-secrets-operatoraggrega build --release release.yamlcd ../ai-agent-and-model-routeraggrega build --release release.yamlLockfile dibuat, bukan disertakan, sehingga hasil clone baru tidak memilikinya dan build pertama memerlukannya; ikhtisar contoh menyebutkan dua cara untuk mengatasinya.
Langkah pipeline
Cuplikan di bawah menggunakan GitHub Actions; bentuknya berlaku untuk pipeline apa pun yang
dapat menjalankan perintah shell dan membaca kode keluarnya. Setiap baris run: adalah perintah
yang menghasilkan kode keluar ini.
# 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-ciDi repositori Anda sendiri terdapat satu workspace, bukan pohon contoh, sehingga argumennya adalah lokasi mana pun tempat build Anda menulis — dist di samping workspace, dalam kasus umum — dan skripnya berada di mana pun Anda menyimpan perkakas pipeline. Hanya kedua jalur itu yang berubah.
Apa yang dilaporkan setiap aturan
Dijalankan dari direktori ini, atas build dari tiga contoh yang bersebelahan. Penolakan menyebutkan setiap artefak yang dipersoalkannya, sehingga log pipeline menjadi daftar temuan.
Image dipin — atas Release yang Recipes-nya mempin setiap image:
$ ./require-pinned-image.sh ../ai-agent-and-model-router/distOK: every image pinned across 4 container(s) in 12 document(s)$ echo $?0Atas Release yang Recipe-nya mengambil chart Helm upstream dan tidak menimpa referensi image milik chart itu sendiri:
$ ./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 $?1Tanpa materi kredensial inline — atas Release yang satu-satunya Secret-nya diisi oleh operatornya saat runtime, bukan dirender dengan nilai di dalamnya:
$ ./deny-inline-credential-material.sh ../external-secrets-operator/distOK: no inline credential material across 43 document(s), 1 of them credential-carrying$ echo $?0Atas Release yang mengisi tiga slot kredensial berdasarkan nilai:
$ ./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 $?1Penolakan terakhir itu adalah aturan yang dipilih suatu estate, bukan cacat pada Release. Mengisi slot kredensial berdasarkan nilai adalah bentuk yang didukung: penulis menyediakan materinya dan target merendernya di tempat yang dapat dibaca workload, dan compiler tidak memiliki opini tentang hal itu. Di dekatnya, dan secara terpisah, compiler memang memberi peringatan bila nilai yang dideklarasikan penulis sebagai sensitif berpindah ke kunci pengiriman sebagai literal — dan peringatan itu hanya bersifat anjuran, bukan penghentian, karena keluarga kredensial berdasarkan nilai memang disengaja. Bagaimanapun, estate yang melarang bentuk itulah yang menyatakannya: di sini, atau di soket tata kelola. Kedua rute dan pilihan di antara keduanya ada di halaman soket tata kelola.