Chính sách trong CI, trên đầu ra của bản build
Hai script quy tắc dùng ngay được, đọc thư mục đầu ra của một bản build Aggrega và
từ chối nó khi nó vi phạm một quy tắc. Chúng chạy trong một pipeline, sau aggrega build,
cùng với bất cứ thứ gì khác mà pipeline đó vốn đã chạy trên cấu hình.
Thư mục này không phải là một workspace Aggrega — nó không định nghĩa Aggregate nào,
Release nào hay thực thể catalog nào. Nó là một cặp script mà bạn sao chép vào
repository của mình, cùng với bước pipeline gọi từng script.
Hướng tiếp cận mà chúng thuộc về, và khi nào socket quản trị bên trong bản build mới là lựa chọn đúng, được mô tả trong trang socket quản trị.
Hai quy tắc
| Script | Từ chối |
|---|---|
require-pinned-image.sh | một container image không có tag, hoặc có tag latest |
deny-inline-credential-material.sh | một Secret đã render chứa dữ liệu thông tin xác thực dưới dạng literal |
Mỗi script nhận thư mục đầu ra làm đối số duy nhất và duyệt qua mọi thứ có trong đó. Không script nào biết gì về nơi bản build đã chạy, target là gì, hay workspace được bố trí ra sao:
./require-pinned-image.sh <output-directory>./deny-inline-credential-material.sh <output-directory>Cả hai chỉ cần yq trên PATH và không gì khác.
yq đọc một tài liệu JSON bằng cùng biểu thức mà nó dùng để đọc một tài liệu YAML, vì
JSON là một tập con của YAML, nên một script bao quát được cả hai dạng đầu ra.
Ngoài yq, thư mục này không cần gì cả: không cần check out catalog, không cần binary aggrega và không cần mạng. ./check.sh chạy cả hai quy tắc trên các thư mục đầu ra nhỏ do chính nó ghi ra, theo các dạng mà một bản build tạo ra, và so sánh từng mã thoát và báo cáo với kết quả mong đợi cho thư mục đó; nó thoát với 1 khi có bất kỳ sai khác nào. Để tạo một bản build thật nhằm chạy các quy tắc, cần những gì ví dụ bạn build cần.
Ba mã thoát, không phải hai
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 parseMã thứ ba được cố ý tách biệt với mã thứ hai. “Không thể đọc được các artifact” không bao giờ được lẫn với “các artifact đã đạt”, cũng là lý do mà một chính sách không thể đánh giá tại socket quản trị được báo là một lỗi chứ không phải là cho phép. Một pipeline coi mọi mã thoát khác 0 là thất bại sẽ có hành vi đúng với cả hai; pipeline nào muốn phân biệt chúng thì có thể làm vậy.
Một lần chạy không tìm thấy gì sẽ cho biết nó đã xem xét bao nhiêu, để một quy tắc không khớp với bất cứ thứ gì được thấy rõ, thay vì lẫn với một quy tắc đã khớp và được thỏa mãn:
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Điều chỉnh một quy tắc
Mỗi script tách riêng yq và phần quyết định, và nói rõ điều đó trong một chú thích tại
chỗ chúng gặp nhau: một biểu thức yq đọc từng tài liệu thành
các hàng phân tách bằng tab, và một hàm shell quyết định trên từng hàng. Để biểu đạt một
quy tắc khác, hãy thay đổi hai phần đó và giữ nguyên phần duyệt.
Sự tách biệt này không phải để trang trí. Hai quy tắc trông giống nhau cần nó vì những lý do trái ngược nhau:
- Chỉ một khóa thôi là không đủ. Một
ConfigMapmang một khốidata:giống hệt mộtSecret, vàdata:của một ConfigMap không phải là dữ liệu thông tin xác thực. Vì vậy kind là một phần của quy tắc về thông tin xác thực, chứ không chỉ khóa. - Tìm kiếm đệ quy là quá mức. Một
CustomResourceDefinitionkhai báo schema riêng của nó, và schema đó có thể khai báo một thuộc tính tên làimage. Một quy tắc tìm khóaimagetrong mọi tài liệu sẽ báo schema của một CRD là một workload chưa được ghim. Vì vậyrequire-pinned-image.shđọc tường minh sáu đường dẫn pod-spec, và thêm một kind workload nghĩa là thêm một đường dẫn.
Tạo ví dụ
Ghi ví dụ vào một thư mục mới đặt theo tên của nó:
aggrega scaffold --example policy-in-ciSau đó nó in ra các lệnh cần chạy tiếp theo. Lệnh đầu tiên chuyển vào thư mục mới:
cd policy-in-ciBuild
Thư mục này không chứa workspace nào, nên không có gì để build ở đây. ./check.sh chạy cả hai quy tắc trên các thư mục đầu ra nhỏ do chính nó ghi, theo các dạng mà một bản build xuất ra, và kiểm tra từng phán quyết:
./check.shĐể chạy một quy tắc trên một bản build thật, hãy truyền cho nó thư mục đầu ra của bản build đó, như mục tiếp theo làm.
Tạo một bản build để chạy chúng
Bất kỳ ví dụ đã build nào trong cây này đều dùng được. Các lệnh dưới đây là những lệnh đã tạo ra các mã thoát được ghi lại ở phần sau.
cd ../external-secrets-operatoraggrega build --release release.yamlcd ../ai-agent-and-model-routeraggrega build --release release.yamlLockfile được tạo ra chứ không được phân phối kèm, nên một bản clone mới không có lockfile nào và bản build đầu tiên cần một lockfile; phần tổng quan về các ví dụ nêu hai cách để giải quyết.
Bước pipeline
Các đoạn mã dưới đây là GitHub Actions; cấu trúc này áp dụng được cho mọi pipeline
có thể chạy một lệnh shell và đọc mã thoát của nó. Mỗi dòng run: là lệnh
đã tạo ra các mã thoát này.
# 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-ciTrong repository của bạn chỉ có một workspace chứ không phải một cây ví dụ, nên đối số là nơi bản build của bạn ghi ra — dist cạnh workspace, trong trường hợp thông thường — và các script nằm ở bất cứ đâu bạn đặt công cụ pipeline. Chỉ hai đường dẫn đó thay đổi.
Mỗi quy tắc báo cáo gì
Chạy từ thư mục này, trên các bản build của ba ví dụ cùng cấp. Một lần từ chối nêu tên mọi artifact mà nó phản đối, nên log của pipeline chính là danh sách phát hiện.
Các image đã được ghim — trên một Release mà các Recipes ghim mọi image:
$ ./require-pinned-image.sh ../ai-agent-and-model-router/distOK: every image pinned across 4 container(s) in 12 document(s)$ echo $?0Trên một Release có Recipe lấy nguồn từ một Helm chart upstream và không ghi đè tham chiếu image của chính chart đó:
$ ./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 $?1Không có dữ liệu thông tin xác thực nội tuyến — trên một Release có một Secret duy nhất được operator của nó điền vào lúc chạy, thay vì được render kèm một giá trị bên trong:
$ ./deny-inline-credential-material.sh ../external-secrets-operator/distOK: no inline credential material across 43 document(s), 1 of them credential-carrying$ echo $?0Trên một Release điền ba vị trí thông tin xác thực bằng giá trị:
$ ./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 $?1Lần từ chối cuối cùng đó là một quy tắc mà một hệ thống tự chọn, không phải một khiếm khuyết của Release. Điền một vị trí thông tin xác thực bằng giá trị là một dạng được hỗ trợ: tác giả cung cấp dữ liệu và target render nó ở nơi workload có thể đọc, và trình biên dịch không có quan điểm nào về điều đó. Gần đó, và tách biệt, trình biên dịch có cảnh báo khi một giá trị mà tác giả đã khai báo là nhạy cảm đi tới một khóa phân phối dưới dạng literal — và cảnh báo đó chỉ khuyến nghị chứ không dừng lại, vì họ thông tin xác thực theo giá trị là có chủ đích. Dù thế nào, chính hệ thống cấm dạng này là bên nói ra điều đó: ở đây, hoặc tại socket quản trị. Hai hướng tiếp cận và cách lựa chọn giữa chúng có trên trang socket quản trị.