İçeriğe geç
AggregaAggrega
Dil seçin: Türkçe
Bu sayfa makine çevirisiyle çevrilmiştir. İngilizce orijinalini okuyun.

CI'da derleme çıktısı üzerinde politika

Bir Aggrega derlemesinin çıktı dizinini okuyan ve bir kuralı çiğnediğinde onu reddeden, kullanıma hazır iki kural betiği. Bir işlem hattında, aggrega build komutundan sonra, o işlem hattının yapılandırma üzerinde zaten çalıştırdığı diğer her şeyle birlikte çalışırlar.

Bu dizin bir Aggrega çalışma alanı değildir — hiçbir Aggregate, hiçbir Release ve hiçbir katalog varlığı tanımlamaz. Kendi deponuza kopyaladığınız bir çift betik ve her birini çağıran işlem hattı adımından oluşur.

Bu betiklerin ait olduğu yol ve bunun yerine derleme içi yönetişim soketinin ne zaman doğru yol olduğu yönetişim soketi sayfasında açıklanır.

İki kural

BetikReddettiği
require-pinned-image.shetiketi olmayan ya da latest etiketli bir konteyner imajı
deny-inline-credential-material.shkimlik bilgisi materyalini düz değer olarak taşıyan, işlenmiş bir Secret

Her biri tek argüman olarak çıktı dizinini alır ve orada ne varsa dolaşır. Hiçbiri derlemenin nerede çalıştığını, hangi hedef olduğunu ya da çalışma alanının nasıl düzenlendiğini bilmez:

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

İkisi de PATH üzerinde yq dışında hiçbir şeye ihtiyaç duymaz. yq, bir JSON belgesini bir YAML belgesini okuduğu ifadeyle okur, çünkü JSON, YAML’ın bir alt kümesidir; bu yüzden tek bir betik çıktının her iki biçimini de kapsar.

yq dışında bu dizin hiçbir şeye ihtiyaç duymaz: katalog çekme, aggrega ikili dosyası ya da ağ gerekmez. ./check.sh, iki kuralı kendi yazdığı, bir derlemenin ürettiği biçimlerdeki küçük çıktı dizinleri üzerinde çalıştırır ve her çıkış kodunu ve raporu o dizin için beklenenle karşılaştırır; herhangi bir uyuşmazlıkta 1 ile çıkar. Kuralları üzerinde çalıştırmak için gerçek bir derleme üretmek, derlediğiniz örneğin gerektirdiklerini gerektirir.

İki değil, üç çıkış kodu

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

Üçüncüsü ikincisinden bilerek ayrıdır. “Yapıtlar okunamadı” durumu hiçbir zaman “yapıtlar geçti” durumundan ayırt edilemez olmamalıdır; yönetişim soketinde değerlendirilemeyen bir politikanın izin olarak değil hata olarak raporlanmasının nedeni de aynıdır. Sıfır dışındaki her çıkışı başarısızlık sayan bir işlem hattı her ikisinden de doğru davranışı alır; bunları ayırt etmek isteyen bir işlem hattı ise ayırt edebilir.

Hiçbir şey bulmayan bir çalıştırma ne kadarına baktığını söyler; böylece hiçbir şeyle eşleşmeyen bir kural, eşleşip karşılanan bir kuraldan ayırt edilemez olmak yerine görünür olur:

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

Bir kuralı uyarlamak

Her betik yq ile kararı birbirinden ayrı tutar ve bunu ikisinin buluştuğu noktadaki bir yorumda belirtir: bir yq ifadesi her belgeyi sekmeyle ayrılmış satırlara okur, bir kabuk işlevi de her satır hakkında karar verir. Farklı bir kural ifade etmek için bu ikisini değiştirin ve dolaşmaya dokunmayın.

Bu ayrım süs değildir. Benzer görünen iki kural buna zıt nedenlerle ihtiyaç duyar:

  • Tek başına bir anahtar yeterli değildir. Bir ConfigMap, tıpkı bir Secret gibi bir data: bloğu taşır ve bir ConfigMap’in data: bloğu kimlik bilgisi materyali değildir. Bu yüzden kimlik bilgisi kuralına yalnızca anahtar değil, tür de dahildir.
  • Özyinelemeli bir arama fazladır. Bir CustomResourceDefinition kendi şemasını bildirir ve bu şema image adlı bir özellik bildirebilir. Her belgede bir image anahtarı arayan bir kural, bir CRD’nin şemasını sabitlenmemiş bir iş yükü olarak raporlardı. Bu yüzden require-pinned-image.sh altı pod-spec yolunu açıkça okur ve bir iş yükü türü eklemek bir yol eklemek demektir.

Örneği oluşturun

Örneği, adını taşıyan yeni bir klasöre yazın:

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

Ardından sırada çalıştırılacak komutları yazdırır. İlki yeni klasöre geçer:

Terminal window
cd policy-in-ci

Derleme

Bu klasör bir çalışma alanı içermez, bu yüzden burada derlenecek bir şey yoktur. ./check.sh, her iki kuralı da kendi yazdığı, bir derlemenin ürettiği biçimlerdeki küçük çıktı dizinleri üzerinde çalıştırır ve her kararı denetler:

Terminal window
./check.sh

Bir kuralı gerçek bir derleme üzerinde çalıştırmak için, sonraki bölümün yaptığı gibi ona o derlemenin çıktı dizinini verin.

Üzerinde çalıştırılacak bir derleme üretmek

Bu ağaçtaki derlenmiş herhangi bir örnek işe yarar. Aşağıdaki komutlar, ileride kaydedilen çıkış kodlarını üreten komutlardır.

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

Kilit dosyaları dağıtılmaz, üretilir; bu yüzden yeni bir klonda hiç yoktur ve ilk derlemenin bir taneye ihtiyacı vardır; örneklere genel bakış bunu çözmenin iki yolunu belirtir.

İşlem hattı adımı

Aşağıdaki parçacıklar GitHub Actions içindir; yapı, bir kabuk komutu çalıştırıp çıkış kodunu okuyabilen her işlem hattına taşınır. Her run: satırı, bu çıkış kodlarının geldiği komuttur.

# 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

Kendi deponuzda bir örnekler ağacı yerine tek bir çalışma alanı vardır; bu yüzden argüman, derlemenizin yazdığı yerdir — olağan durumda çalışma alanının yanındaki dist — ve betikler işlem hattı araçlarını nerede tutuyorsanız orada durur. Yalnızca bu iki yol değişir.

Her kuralın raporladıkları

Bu dizinden, kardeş örneklerden üçünün derlemeleri üzerinde çalıştırılmıştır. Bir ret, itiraz ettiği her yapıtı adlandırır; böylece işlem hattı günlüğü bulgu listesinin kendisidir.

İmajlar sabitlenmiş — Recipes’i her imajı sabitleyen bir Release üzerinde:

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

Recipe’i bir üst kaynak Helm chart’ını kullanan ve chart’ın kendi imaj başvurusunu geçersiz kılmayan bir Release üzerinde:

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

Satır içi kimlik bilgisi materyali yok — tek Secret’i içinde bir değerle işlenmek yerine çalışma zamanında operatörü tarafından doldurulan bir Release üzerinde:

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

Üç kimlik bilgisi yuvasını değerle dolduran bir Release üzerinde:

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

Bu son ret, Release’teki bir kusur değil, bir kurumun seçtiği bir kuraldır. Bir kimlik bilgisi yuvasını değerle doldurmak desteklenen bir yapıdır: bir yazar materyali sağlar ve hedef onu iş yükünün okuyabileceği yerde işler; derleyicinin bu konuda bir görüşü yoktur. Bunun yakınında ve ayrı olarak, bir yazarın hassas olarak bildirdiği bir değer bir teslim anahtarına düz değer olarak gittiğinde derleyici uyarır — ve bu uyarı durdurmaz, yalnızca öneride bulunur, çünkü değerle kimlik bilgisi ailesi bilinçlidir. Her iki durumda da bu yapıyı yasaklayan, bunu söyleyen kurumun kendisidir: burada ya da yönetişim soketinde. İki yol ve aralarındaki seçim yönetişim soketi sayfasında yer alır.