Yönetişim soketi
Soketin tek bir rolü değil, tamamı: dört rol (ikisi bir derlemeyi değerlendirir, ikisi onu biçimlendirir), derleyiciyle birlikte gelen her iki politika motoru ve bir operatörün bir eklentiyi nasıl bağladığı.
Bir operatör, bir derlemeyi incelemek ve bulduklarına göre işlem yapmak için bir Wasm yönetişim eklentisi bağlar. Derleyici ana bilgisayarı içeriğe karşı tarafsız ve kendi görüşü olmayan biçimde kalır: derleme yükünü konuğa iletir ve konuğun döndürdüğüne göre işlem yapar; politikanın kendisini ise hiçbir zaman yorumlamaz. Alana özgü politika zekâsının tamamı (politika dili, onun motoru ve kurallar) konuğun içinde bulunur.
Bu, her soketin tabi olduğu aynı derleme öncesi saflık sözleşmesidir: konuk kendisine verilen yükü değerlendirir ve ana bilgisayarın olduğu gibi tükettiği bir sonuç döndürür (bkz. sanal alan sözleşmesi). Ana bilgisayar, konuğun konuştuğu politika dili hakkında hiçbir şey öğrenmez ve kendine ait hiçbir politika motoru kodu taşımaz.
Bir yönetişim eklentisi tam olarak bir role bağlanır ve hangi yükün geldiğini de bağlamanın onunla ne yapabileceğini de eklenti değil rol belirler. İkisi karar rolüdür: bağlama derlemeyi değerlendirir ve ana bilgisayar döndürülen her karar için üç işlemden tam olarak birini uygular. İkisi dönüştürme rolüdür: bağlama, derlemenin etiketlerinde veya ek açıklamalarında bir değişiklik bildirir ve ana bilgisayar bunu uygular. Birden fazla role hizmet eden bir eklenti her rol için bir kez bağlanır ve kendine ait bir rol bildirmez; rolü bağlama taşır.
Bu sayfa yönetişim soketini kapsamlı olarak ele alır: dört rol
ve her birinin taşıdığı yük, ana bilgisayarın göre işlem yaptığı karar önem düzeyleri,
bir operatörün sağladığı motordan bağımsız girdi kanalı, derleyiciyle birlikte gelen iki politika motorundan
biri (biri Rego’yu, biri CEL’i değerlendirir) için nasıl politika yazılacağı,
bir konuğun yabancı bir politika motorunu nasıl sarmaladığı, birlikte gelen başvuru konukları
ve bir operatörün bir eklentiyi bir çalışma alanına nasıl bağladığı. Soketin işlem hattındaki yeri ve türlendirilmiş iletim biçimleri için bkz.
plugin-contract.md; bir eklentiyi katalog varlığı olarak yazmak ve yayımlamak için bkz.
Wasm eklenti geliştirici kılavuzu.
Zihinsel model: host yönlendirir, guest karar verir
Bir derlemede host, eklemenin rolüne ait yükü bir araya getirir, bunu ABI sınırının öbür yanına iletir ve guest’in döndürdüğünü geri okur. Bir verdict rolünde bu, her biri bir önem derecesi ve insanların okuyabileceği bir ileti taşıyan verdict’lerden oluşan bir listedir: host her önem derecesini bir derleme eylemine eşler; iletiyi anlamı için okumaz, politikanın neyi denetlediğini bilmez ve kararı hangi motorun ürettiğini de bilmez. Bir transform rolünde ise bu, yapılacak değişikliktir; değişiklik o rolün yönettiği etiketlere ya da açıklamalara yöneliktir, başka hiçbir şeye değil.
Host politika içeriğini yorumlamadığından politika yüzeyinin tamamı guest’e aittir: kuralların hangi dilde yazıldığı, onları hangi motorun değerlendirdiği ve tetiklenen bir kuralın nasıl bir verdict’e ya da değişikliğe dönüştüğü. Soket sözleşmesi tasarım gereği dardır — bir rol, bir girdi kümesi ve bir sonuç — böylece Wasm’a derlenen her politika teknolojisi ona hizmet edebilir.
Bir verdict rolü kabul eder ya da reddeder, başka hiçbir şey yapmaz: host onun çıktısını yalnızca bir karar olarak okur ve hiçbir zaman bir değişiklik olarak uygulamaz; bu yüzden bir politika uyumsuz bir derlemeyi sessizce uyumlu hâle getiremez. Bir transform rolü bilinçli bir istisnadır ve onu istisna yapan, operatörün onu eklemiş olmasıdır — etiketleri biçimlendirmek için bir plugin eklemek, etiketlerin biçimlendirileceğinin bildirilmesidir. Böyle bir eklemenin neyi değiştirebileceği kendi rolünün yüzeyiyle sınırlıdır ve bunun dışındaki herhangi bir şeyde derleme açıkça durdurulur.
Dört rol
Bir plugin tam olarak bir role bağlanır ve rol, host’un onu işlem hattının neresinde değerlendireceğini, hangi yükü alacağını ve neyi döndürebileceğini belirler. İki role hizmet etmesi gereken bir plugin iki kez bağlanır: her rol için bir kez.
Karar rolleri: ir-verdict ve render-verdict
ir-verdict— konuk, işleme öncesinde ara gösterim grafiği üzerinde akıl yürütür. Yük, yetenekten bağımsız IR grafiğinin tamamını (derleyicinin tuttuğu her düğüm, kenar ve ekleme) ve buna ek olarak çözümleyicinin sıraladığı yönlendirme yollarını taşır; böylece bir politika grafiği yeniden dolaşmadan topoloji ve erişilebilirlik hakkında akıl yürütebilir. Bu yol listesi başlangıç düğümü başına sınırlıdır: yoğun bağlantılı veya döngüsel bir topoloji, sıralamanın ürettiğinden daha fazla farklı rota barındırabilir ve sınıra ulaşıldığında o başlangıç düğümünden kalan rotalar listelenmez. Bu nedenle listede bulunan bir yol gerçektir; ancak bir yolun bulunmaması hiç yol olmadığının kanıtı değildir: kararı bir şeyin erişilemez olmasına dayanan bir politika bunu yalnızca yol listesinden değil, yükün eksiksiz taşıdığı düğümlerden ve kenarlardan saptamalıdır. Grafikteki bir şey yazıldığı gibi değildir: bir yazarın hassas olarak bildirdiği her değer (bir eklemeninvaluesveyainfraalanında, bir sınır eklemesinininfraalanında, bir düğümün kendivaluesveyainfraalanında ya da bir bağlantının kendivaluesveyainfraalanında){"aggrega_withheld": "declared"}gizleme işaretçisi olarak gelir; anahtarı, hassasiyet işareti ve yanındaki bildirilmemiş her değer ise yazıldığı gibi gelir. Bir politika, hassas olarak bildirilmiş malzemenin nereye gittiğini değerlendirir ve malzemenin kendisini hiçbir zaman almaz; bkz. bir yönetişim politikasının okuduğu ekleme bilgileri. Birir-verdictpolitikası, herhangi bir yapıt üretilmeden önce, statik analiz geçidinde çalışır. Bunu, bir derlemeyi herhangi bir şey işlemeden önce durdurması gereken mimari ve kablolamayla ilgili politikalar için kullanın: topoloji değişmezleri, sınır ötesi kimlik doğrulama, kimlik bilgisi akışının biçimi.render-verdict— konuk, işleme sonrasında işlenmiş çıktı üzerinde akıl yürütür. Yük, üretilen yapıtları yola göre sıralanmış olarak taşır; böylece aktarılan veri aynı girdiyle yapılan çalıştırmalarda bayt bayt aynıdır. Her yapıt, çıktı yolunu ve işlenmiş metnini taşır; ek olarak, üreten provider bir biçim bildirmişse işlendiği biçimi, içerik politikadan önce ayrıştırılan bir biçimdeyse de içeriğinin ayrıştırılmış yapılandırılmış görünümünü taşır. Birrender-verdictpolitikası derlemenin ürettiğini tam olarak görür ve içindeki hiçbir şey gizlenmez: bir Recipe’in bir yapıta işlediği değer işlendiği gibi gelir, çünkü politikanın değerlendirdiği şey yapıtın kendisidir. Bunu somut çıktıyla ilgili politikalar için kullanın; örneğin işlenmiş Docker Compose hizmetlerini veya Kubernetes nesnelerini inceleyen bir kural.
Dönüşüm rolleri: annotation-transform ve label-transform
-
annotation-transform— konuk, çözümleme sırasında ve ek açıklama genişletmesinden önce eklenecek ek açıklamaları bildirir. Yük, bağlantının ek açıklama ekleyebileceği her bileşeni, her birinin halihazırda sahip olduğu ek açıklamalarla birlikte, ayrıca Manifest’in bağlama kaydettiği ek açıklama anahtarlarını taşır. Kayıtlı bir anahtar altına eklenen bir ek açıklama, ardından bir Feature bağlantısına genişler; bu rol, geliştiricinin yazmadığı bir yeteneği derlemeye bu yolla ekler.Ek açıklama ekleyebileceği bileşenler, bir sınırın
components:altında adlandırdığı her bileşen ve bir sınırınaggregates:yönlendirme girdisinin içeri yönlendirdiği her bileşendir. Bir yönlendirme girdisi, kendicomponents:alanı bunların hepsini, bazılarını ya da hiçbirini adlandırsın —documents: {}hiçbirini adlandırmaz — modülünün her bileşenini, içine iç içe yerleştirilmiş modüllerin bileşenleri dahil, yerleştirir; yük her birini taşır. Yönlendirilmiş bir bileşen, derleme grafiğinde taşıdığı kimlikle adreslenir — modülün adı, bir nokta ve bileşenin modül içindeki adı,documents.backendörneğinde olduğu gibi; her iç içe modül için bir modül adı ve nokta daha eklenir —; derleme grafiği ve tanılamaları onu böyle yazar, bu yüzden bir karar da onu bu şekilde adlandırır. Yönlendirme girdisinin adlandırmadan yerleştirdiği bir bileşen, yük üzerinde kendine ait hiçbir ek açıklama taşımaz ve ona eklenen bir ek açıklama, yönlendirme girdisi altında onun üzerine yazılmış bir ek açıklama olarak uygulanır. -
label-transform— konuk, topoloji oluşturma sırasında, yani grafik kurulduktan sonra ve grafik değerlendirilmeden önce uygulanacak etiket değişikliklerini bildirir. Yük, derlemenin düğümlerinin bir izdüşümünü (her biri örneklediği Component, onun için çözümlenen sürüm, şu anda taşıdığı etiketler ve örneğinin bildirdiği değerlerle birlikte; değerler salt okunurdur ve Component’inin hassas olarak bildirdiği her değer, grafik kararının alıkoyduğu gibi alıkonur) ve buna ek olarak Release’in adını ve ortamını taşır. Bunu, bir geliştiricinin hiçbir zaman yazmak zorunda kalmaması gereken türetilmiş meta veriler (uyumluluk kapsamı, sahiplik, maliyet ilişkilendirmesi) ve bir geliştiricinin bildirdiği yapılandırmanın hak ettiği bir yetenek etiketi için kullanın.
Roller farklı yükler taşır, çünkü farklı anlarda devreye girer ve farklı sorulara yanıt verirler. Dördü de aşağıda açıklanan, operatörün sağladığı aynı girdi kanalını taşır. Bir yükü okumak yerine görmek için aggrega build --release <release> --policy-input <dir>, her rolün oraya bağlanan bir plugin’e verdiği yükü — hiçbir şey bağlanmamış bir rol de dahil — rol başına bir JSON dosyası olarak ya da bir rolün bağlantıları farklı yükler aldığında bağlantı başına bir dosya olarak yazar; --dry-run ile birlikte kullanıldığında bu dosyaları yazar ve başka hiçbir şey yapmaz. annotation-transform, label-transform ve ir-verdict rollerinde dosya, bir politikanın okuduğu input belgesidir. render-verdict rolünde politika motoru, yükü bir politika okumadan önce yeniden biçimlendirir — her yapıtın documents öğeleri ondan ayrıştırılır — bu nedenle derleyicinin içindeki bir motor üzerindeki bir render-verdict politikası, Bir politikayı bir derlemeyi denetlemeden önce test etme bölümünün gösterdiği gibi, warn ya da info ile bağlanarak bir derleme içinde test edilir. .wasm dosyasını kendiniz derlediğiniz bir plugin için aggrega plugin run-local --plugin <plugin.wasm> --export verdict_render --with @<dir>/render-verdict.json onu bu dosya üzerinde çalıştırır.
Kararlar ve önem düzeyleri
Aşağıdaki önem düzeyleri, karar rollerinin söz dağarcığıdır. Bir dönüştürme rolü bir karar yerine bir değişiklik bildirir, bu nedenle önem düzeyi taşımaz.
Bir konuk, bir karar listesi döndürür. Her karar, derleme eylemini belirleyen bir önem düzeyi taşır:
halt— derlemeyi durdurur; ana makine, kararın iletisini gerekçe olarak gösterir. Derleme hiçbir yapıt üretmez.warn— kararı işaretler; derleme devam eder.info— kararı kaydeder; derlemenin sonucu değişmez.
Bu üçü kümenin tamamıdır ve diğer her soketin tanılamalarının kullandığı üçlüyle aynıdır; bu nedenle bir önem düzeyi, nerede okursanız okuyun aynı anlama gelir.
Başka herhangi bir değer taşıyan bir karar, dördüncü bir yol değil, bir sözleşme ihlalidir. Derleme durur ve ileti; plugin’i, kararın taşıdığı değeri ve sözleşmenin bildirdiği üç değeri adlandırır. Böylece yanlış yazılmış bir önem düzeyi, hiçbir şeyin üzerine işlem yapmadığı bir karar olarak geçip gitmek yerine bir derleme hatası olarak bildirilir. Bu üç değerden biriyle bildirim yapan bir konuk bundan etkilenmez.
İzin veren bir değerlendirme hiçbir şey döndürmez. Bir konuk yalnızca bir kural tetiklendiğinde karar üretir; bu nedenle boş bir karar listesi, politikanın derlemeye izin verdiği anlamına gelir. Üretilecek bir “geçti” kararı yoktur — sessizlik izin demektir.
Bir konuk tek bir değerlendirmede, önem düzeylerini karıştırarak birçok karar döndürebilir. Ana makine bunların tümünü dolaşır: herhangi bir halt derlemeyi durdurur (ve her halt iletisi gösterilir), warn ve info kararları ise engelleme yapmadan bildirilir. Bu, derlemeyi durduran bir politikayı tavsiye niteliğindeki bir lint denetiminden ayıran durdurma-tavsiye ayrımını yansıtır.
with kanalı: kaynaklar ve ayarlar
Bir politika konuğu genellikle uyguladığı belirli kurallardan bağımsız, genel amaçlıdır — motor konuğun içine gömülüdür, ancak kurallar her bağlamada ayrı ayrı sağlanır. with kanalı bu bağlamaya özgü girdiyi taşır. Motordan bağımsız iki alanı vardır:
sources— guest’in yüklediği politika tanımı dosyaları. Host, adı verilen her dosyayı derleme zamanında okur ve baytlarını guest’e opak biçimde iletir: bir kaynağı asla ayrıştırmaz ve guest’e verdiği yol, dosyanın temel adıdır, asla host üzerindeki mutlak bir yol değildir. Baytların ne anlama geldiği tamamen guest’in işidir — bir guest için bir.regodosyası, başka bir guest için başka bir politika biçimi, böyle bir arşivi okuyan bir guest için ise bütün bir politika kümesinin base64 ile kodlanmış arşivi.settings— konuğun kendi motoruna eşlediği bir yapılandırma eşlemi. Bir konuk ayarlanabilir değerlerini (bir kopya sayısı üst sınırı, zorunlu bir etiket anahtarı) bu eşlemden okur. Varsayılan olarak ana makine bunu, üzerinde işlem yapmadan olduğu gibi iletir; bir konuk ayrıca bunun için bir şema bildirebilir (aşağıya bakın), bu durumda ana makine konuğu çalıştırmadan önce eşlemi bu şemaya göre doğrular.
Tamamen gömülü bir konuk — kuralları bağlama sırasında sağlanmak yerine içine derlenmiş olan — with alanını hiç kullanmaz. Kanal her rolde isteğe bağlıdır.
Türlendirilmiş ayarlar
Bir konuk, beklediği settings için bir JSON Schema bildirebilir. Bildirdiğinde ana makine, bağlamanın settings değerini konuğu çalıştırmadan önce bu şemaya göre doğrular. Uymayan ayarlar, sorunlu anahtarı ve şemanın ne beklediğini adlandıran bir iletiyle derlemeyi durdurur — eksik bir zorunlu anahtar, yanlış türde bir değer, bilinmeyen bir anahtar ya da aralık dışındaki bir değer, anlaşılması güç bir konuk hatası veya daha kötüsü yanlış ama başarılı bir derleme olarak ortaya çıkmak yerine en baştan yakalanır.
Türlendirilmiş ayarlar isteğe bağlıdır ve ana makine tarafından değil, konuk tarafından bildirilir. Ayar şeması bildirmeyen bir konuk serbest biçimli davranışı korur: ana makine settings değerini denetlemeden iletir. Ana makine, konuğun bildirdiği şema hangisiyse ona karşı sıradan JSON Schema doğrulaması yürütür; ayarların ne anlama geldiğini yorumlamaz. Bu, denetimi motordan bağımsız tutar — her konuk okuduğu ayarların biçimini tanımlar, ana makine de tam olarak bu biçimi uygular, fazlasını değil.
Hiç ayar bildirmeyen bir bağlama, JSON null olarak doğrulanır. Bir konuğun ayarlarını zorunlu kılabilmesini sağlayan budur: yalnızca bir nesneyi kabul eden bir şema, hiç ayar sağlamayan bir bağlamayı reddeder ve derleme durur. Sonuç ters yönde de geçerlidir ve bilinçli olarak göz önünde bulundurulması gereken de budur: ayarları gerçekten isteğe bağlı olan bir konuk, bir nesnenin yanı sıra null değerini de kabul eden bir şema bildirmelidir, aksi hâlde ayarsız hiç bağlanamaz. Derleyicinin içinde gelen iki politika motoru tam da bu nedenle "type": ["object", "null"] bildirir — birini with: bloğu olmadan bağlayın, varsayılanlarıyla çalışır. Yalnızca "type": "object" bildiren bir konuk, amaçlansın ya da amaçlanmasın, ayarlarını zorunlu kılmış olur.
ABI, Aggrega’nın kendisine aittir
Soket sözleşmesi herhangi bir politika motorunun değil, Aggrega’nın kendi ABI’sidir. Wasm’a derlenmiş herhangi bir politika teknolojisinin doğrudan takılabilir bir konuk olarak hizmet verebilmesini sağlayan budur: konuk dışarıya doğru Aggrega yüzeyini konuşur — describe() ile birlikte hizmet verdiği rolün çağırdığı dışa aktarım — ve kullandığı motor ne olursa olsun, bu yüzeyin arkasındaki bir uygulama ayrıntısıdır.
Yabancı bir politika motorunu saran bir konuk, o motorun ABI’sini kendi içinde soğurur. Motorun kendi Wasm ABI’si, kendi giriş noktaları ya da kendi host geri çağırma protokolü varsa, saran konuk onu dahili olarak örnekler ve çalıştırır, motorun kararını da soketin karar biçimine geri eşler. Derleyici host’u yalnızca standart yönetişim karar yüzeyini görür; hangi motorun söz konusu olduğunu asla öğrenmez ve motora özgü hiçbir kod taşımaz. Bir politikayı bir motordan diğerine geçirmek bir host değişikliği değil, bir bağlama değişikliğidir.
Derleyicinin içinde iki politika motoru gelir
CLI ikili dosyasına iki politika motoru derlenmiştir ve bir operatör bunlardan birini ya da ikisini birden, herhangi bir yönetişim eklentisini bağladığı şekilde bağlar:
| Koordinat | Politika dili | Bağlanan kaynak |
|---|---|---|
governance/rego | Rego | .rego dosyaları ya da bütün bir politika kümesinin base64 ile kodlanmış arşivi |
governance/cel | Common Expression Language (CEL) | .cel ifade dosyaları ya da .yaml / .yml kural belgeleri |
Dilin etrafındaki her şey ortaktır. İkisi de dört rolün tümüne hizmet eder, ikisi de
rol başına aynı yükü aynı alan adlarıyla okur, ikisi de kararlarını aynı translation
ayarı aracılığıyla aynı üç karar önem düzeyine eşler ve ikisi de değerlendiremedikleri bir
derlemeye izin vermek yerine açıkça başarısız olur. Her biri, kendisini sunan derleyici
sürümünü kendi sürümü olarak taşır; hiçbiri harici bir araç zincirine ihtiyaç duymaz ya da
derleme sırasında bir şey indirmez. Her dilin neyi ifade edebildiği ise ortak değildir:
Rego’da birkaç yardımcı kuraldan oluşan bir kural, CEL’de ayarlar ve tekrar gerektirebilir;
bir rotayı dolaşan bir kural yazmadan önce Bir ifadenin neyi söyleyebileceği bölümüne bakın.
Farklı olan, kuralların yazıldığı dildir ve seçimin tek dayanağı da budur. Halihazırda bir Rego külliyatı tutan bir yapı ya da başka bir yerde kabul denetimi için Rego yazan bir ekip, Rego motorunu bağlar ve politikaları olduğu gibi çalışır. Kurallarını, bir Kubernetes doğrulayıcı kabul politikasında olduğu gibi bir belge üzerinde tekil ifadeler olarak dile getiren bir ekip ise CEL motorunu bağlar. İkisi rol başına bağlanır; bu nedenle bir çalışma alanı bir rolde Rego’yu, başka bir rolde CEL’i ya da aynı rolde ikisini iki ayrı bağlantı olarak çalıştırabilir.
Ana makine, bir kararın hangisinden geldiğinden bağımsızdır: yükü yönlendirir, bir karar ya da bir değişiklik okur ve buna göre davranır. Bir politikayı bir dilden diğerine geçirmek bir bağlantı değişikliği ve kuralların yeniden yazılmasıdır; asla bir ana makine değişikliği değildir.
Rego politikaları: iki yol
Rego yaygın bir politika dilidir ve onu çalıştırmanın iki yolu vardır: derleyicinin içinde gelen, zahmetsiz bir motor ve tam doğruluklu bir kaçış yolu.
Derleyicideki Rego motoru zahmetsiz yoldur. Wasm’a özgü bir Rego değerlendiricisi taşır; böylece bir operatör bir .rego dosyasını sources içine bırakır ve
plugin’i bağlar: harici bir araç zinciri gerekmez ve derleme zamanında hiçbir şey indirilmez.
Dört rolün tümüne hizmet eder: aynı plugin, bağlandığı role göre derleme grafiğini yargılar, işlenmiş çıktıyı yargılar, etiketleri biçimlendirir veya ek açıklamalar enjekte eder.
Katalog kimliği pluginType: governance altındaki yalın rego adıdır,
yani governance/rego koordinatı; sürümü ise onu getiren derleyici sürümüdür. Bunun için politika yazma bir
sonraki bölümdür.
Değerlendirici, başvuru uygulamasını gömmek yerine Rego’yu bağımsız olarak yeniden uygular ve her Rego yerleşik işlevini uygulamaz. Bir politika, değerlendiricinin uygulamadığı bir
yerleşik işlevi çağırdığında bağlantı yüksek sesle başarısız olur: izin değil, bir hata döndürür. Derleme ardından plugin’i adlandıran bir hatayla durur;
bu, “motor bu politikayı değerlendiremiyor” durumunun hiçbir zaman “politika derlemeye izin veriyor” ile karıştırılmaması için bilerek bir halt kararından ayrıdır.
Değerlendirilemeyen bir politika derlemeyi durdurur; asla sessizce geçmez.
opa build -t wasm kaçış yolu tam doğruluklu yoldur. Bir
politika yerleşik işlevlerin tamamına veya başvuru motorunun tam anlamsallığına ihtiyaç duyduğunda,
onu OPA’nın kendi araç zinciriyle bir Wasm modülüne derleyin ve bu modülü ince bir adaptör konuk arkasında çalıştırın.
Adaptör, OPA’nın Wasm ABI’sini tamamen kendi içinde soğurur
(yukarıdaki ABI, Aggrega’nın kendisine aittir bölümüne göre):
OPA ile derlenmiş modülü örnekler, girdiyi ayarlar, değerlendirmeyi çağırır ve
kararı karar biçimine geri eşler. Ana makine yalnızca standart
yönetişim kararı yüzeyini görür.
Çalışılmış bir örnek olarak bir başvuru adaptör konuğu sunulur. Rego’da yazılmış ve opa build -t wasm ile bir WebAssembly modülüne önceden derlenmiş bir politikayı gömer; bu sabitlenmiş, depoya eklenmiş bir yapıttır, böylece değerlendirme hiçbir OPA süreci olmadan ve hiçbir şey indirilmeden tamamen konuk içinde çalışır. Her derlemede adaptör, bu hazır modülü gömülü bir Wasm yorumlayıcısıyla kendi içinde örnekler, modülün kendi içe aktarımlarını (doğrusal belleğini ve yerleşik geri çağrılarını) karşılar, yükü OPA input belgesi olarak ve bağlantının settings nesnesini OPA data belgesi olarak okur, derlenmiş her giriş noktasını değerlendirir ve her giriş noktasının deny / warn / audit giriş noktası adını sırasıyla halt, warn ve info karar önem derecesine eşler. Hazır bir politika, adaptörün uygulamadığı ana makine tarafından sağlanan bir yerleşik işleve ihtiyaç duyarsa adaptör yüksek sesle başarısız olur: izin döndürmek yerine modülü reddeder; böylece değerlendirilemeyen bir politika sessizce geçmek yerine derlemeyi durdurur. Hazır modülü Rego kaynağından yeniden üretmek, OPA CLI ile çalıştırılan bir yazım adımıdır; derleme zamanı bağımlılığı değildir. ../examples/policy-data-class-route/ o adaptörü kendine ait bir modül etrafında derler ve her ikisini yeniden üreten komutları verir.
İki yol aynı ana makine sözleşmesini paylaşır; bu nedenle bir politikayı derleyicideki motordan tam motora taşımak bir bağlantı değişikliğidir.
Rego motoru için politika yazma
Motor, operatörün yazdığı Rego’yu tamamen konuk içinde, dört rolden hangisine bağlanmışsa orada değerlendirir. Motoru iki kez, iki rolde, iki farklı politika dosyasıyla bağlamak, tek bir motorun aynı derlemenin iki anını kapsamasını sağlar.
Bağlamanın rolüne ait yük, politikanın input belgesidir ve bağlamanın settings nesnesi politikanın data belgesidir; bu nedenle bir politika, operatörün sağladığı bir eşik değerini data.max_replicas olarak okur. Bağlamanın sources altında bildirdiği her dosya bir politika modülü olur ve bu dosyaların bildirdiği her paket değerlendirilir.
Bir politikanın hangi kural sözdizimiyle yazıldığı
Rego iki kural sözdizimiyle yazılır ve motor, modül modül her ikisini de kabul eder. Bu nedenle güncel sözdizimi ortaya çıkmadan önce oluşturulmuş bir politika kümesi, bugün yazılmış bir kümeyle aynı bağlamada yan yana değerlendirilir.
Güncel sözdiziminde kural gövdesi if ile başlar, bir kümeye toplayan kural bunu contains ile belirtir ve modül, paket bildiriminin altında kendi satırında import rego.v1 bildirerek hangi sözdizimiyle yazıldığını belirtir:
package example
import rego.v1
deny contains msg if { count(input.graph.spec.nodes) > 20 msg := "this build declares more than twenty nodes"}Eski köşeli başlıklı sözdiziminde kuralın topladığı değer, kural başlığında köşeli parantez içinde yer alır ve gövde doğrudan onu izler. Bu sözdizimindeki bir modül hiçbir şey bildirmez, çünkü güncel sözdizimi olarak ayrıştırılamamasından tanınır:
package example
deny[msg] { count(input.graph.spec.nodes) > 20 msg := "this build declares more than twenty nodes"}Hiçbir şey bildirmediği hâlde güncel sözdizimi olarak ayrıştırılan bir modül, adıyla reddedilir. Okumayı sabitleyen bildirimdir ve bildirim olmadan aynı kural metni ters bir karara varabilir: hiçbir zaman sağlanmayan bir kural gövdesi güncel sözdiziminde hiçbir karar üretmez, eski sözdiziminde ise bir karar üretir; böylece sessiz kalması gereken bir politika derlemeyi durdurur, tersi durumda da bir kuralın durdurmak için yazıldığı bir derleme geçer. Motor, böyle bir modül için bir okuma seçmek yerine modülü reddeder ve neyin ekleneceğini söyler:
policy source "policy.rego" must declare `import rego.v1`. Both Rego rule syntaxes are accepted, and this module parses as either one — so without the import its rules could be read in the older syntax, where the same text can reach the opposite decision. Add `import rego.v1` on its own line below the package declaration.Ret bir karar değil, Plugin’i adlandıran bir derleme hatasıdır; bu nedenle derlemeyi değerlendirilemeyen bir politikanın durdurduğu gibi durdurur ve hiçbir zaman derlemeye izin vermiş bir politika olarak okunmaz.
Sizi şaşırtmadan önce bilinmeye değer iki uç durum vardır. Hiç kural gövdesi olmayan, yalnızca veri bildiren bir modül güncel sözdizimi olarak ayrıştırılır; bu nedenle, iki okuma onun için farklı olamayacak olsa da ondan da bildirim istenir. Ve eski sözdiziminde yazılmış bir modül hiçbir zaman reddedilmez, çünkü güncel sözdizimi olarak ayrıştırılmaz: ikisini birbirinden ayıran motorun kendisidir, bu yüzden bilinçli olarak köşeli başlıkla yazılmış bir politika, bunu belirtmeyi unutmuş güncel sözdizimli bir politikayla hiçbir zaman karıştırılmaz.
Bir politika kararlarını bir karar anahtarı altında toplar
Her rol, bir politikanın kararlarını bir karar anahtarından, yani politikanın içine topladığı adlandırılmış bir kuraldan okur. Hangi anahtarların okunduğunu ve bir anahtar altındaki kararın ne anlama geldiğini rol belirler.
Bir karar rolünde karar bir iletidir ve toplandığı anahtar, iletinin hangi önem derecesiyle raporlanacağını belirler. Varsayılan olarak anahtarlar, uzlaşıma dayalı Rego toplama adlarıdır:
| Toplandığı anahtar | Raporlandığı derece | Derlemeye etkisi |
|---|---|---|
deny | halt | derlemeyi durdurur |
warn | warn | tamamlanan bir derlemeyle birlikte gösterilir |
audit | info | kaydedilir; derlemenin sonucu değişmez |
İki sözcük dağarcığını birbirinden ayrı tutun, çünkü bunlar iki ayrı dağarcıktır: deny, warn ve audit sizin politikanızdaki adlardır; halt, warn ve info ise soketin raporladığı önem dereceleridir. Sol sütunu yeniden adlandırmak size kalmıştır; sağ sütun her soketin paylaştığı kapalı kümedir.
Kararlarını farklı adlandıran bir politika, eşlemeyi bağlamanın ayarlarında bildirir:
with: settings: translation: - key: blocked severity: halt - key: advisory severity: warnBildirilen bir eşleme varsayılanı genişletmez, onun yerini alır: eşlemenin adlandırdığı anahtarlar tam olarak okunan anahtarlardır; bu nedenle yukarıdaki eşleme bildirildikten sonra hâlâ deny içine toplayan bir politika hiçbir karara ulaşmaz. Kuralların bildirildiği sıra, kararların raporlandığı sıradır. Politikanın bildirmediği bir anahtar bir hata değil, eksik bir karardır; bu sayede tek bir politika dosyası birden çok bağlamaya hizmet edebilir.
Üç derecenin dışındaki bir önem derecesi ve boş bildirilmiş bir eşleme, Plugin’in bildirdiği ayar şeması tarafından reddedilir; ana makine, bir bağlamanın ayarlarını gönderimden önce bu şemaya göre doğrular. Aynı anahtarın iki kez eşlenmesi eşleme okunurken reddedilir; bu da herhangi bir politika çalışmadan öncedir. Her iki durumda da derleme bir karara varılmadan önce durur, hiçbir zaman yarısı uygulanmış bir eşlemeyle durmaz.
Bunun dışında ayarlar politikanın kendi verisidir: eşleme nesneden okunur ve nesne politikanın data belgesine değişmeden ulaşır; bu nedenle varsayılan anahtarlar için yazılmış bir politika, hiç eşleme yapılandırılmamış olsaydı göreceği veri belgesinin aynısını görür.
Bir dönüştürme rolünde karar bir ileti değil, yapılacak değişikliktir; bu nedenle belirlenecek bir önem derecesi yoktur ve bunun yerine anahtar sabittir: etiket şekillendirme rolünde labels, ek açıklama ekleme rolünde annotations. Bir translation ayarı yalnızca kararların raporlandığı yerde okunur; bu nedenle böyle bir ayar bildiren bir dönüştürme bağlaması, rolünün kullanmadığı bir ayar taşımaktadır.
Karar anahtarı, bağlamanın yüklediği her paketten okunur; bu nedenle bir politika kümesi kurallarını paketlere yayabilir ve her paket topladığını katar. Bunun öbür yüzü, başınıza gelmeden önce bilinmeye değerdir: tek bir bağlama içinde karar anahtarı her pakette ayrılmış bir kural adıdır; bu yüzden kendi amaçları için labels içine toplayan bir yardımcı paketin girdileri etiket kararları olarak okunur. Bu durum sessizce değil, açıkça başarısız olur — bağlama, anahtar altında toplanan bir şeyin o biçimde bir karar olmadığını raporlar — ancak böyle bir iletiyi okumanın en hızlı yolu onu bir ad çakışması olarak görmektir; bu nedenle anahtarı karar için ayırın ve yardımcı kurala farklı bir ad verin.
Her rolün yükü neleri sunar
Yük, politikanın input belgesidir; bu nedenle bir politika onu, iletimin verdiği adlarla okur.
Derleme grafiği, onu taşıyan iki rolde farklı bir yoldadır. Grafik üzerindeki bir hüküm tüm grafik belgesini alır, bu yüzden düğümleri input.graph.spec.nodes konumundadır; etiket şekillendirme rolü düğümlerin bir izdüşümünü alır, bu yüzden düğümleri input.graph.nodes konumundadır. Bu iki rol arasında taşınan bir kural bu nedenle kopyalanmaz, düzenlenir; bunu unutmanın belirtisi bir hata değil, hiç tetiklenmeyen bir kuraldır, çünkü var olmayan bir yol yalnızca tanımsızdır.
| Rol | Bir politikanın okudukları |
|---|---|
ir-verdict | input.graph — derleme grafiği belgesinin tamamı: düğümler düğüm kimliğine göre anahtarlanmış olarak input.graph.spec.nodes konumunda, kenarlar input.graph.spec.edges konumunda. Bir yazarın hassas olarak bildirdiği bir değer {"aggrega_withheld": "declared"} olarak okunur. input.precalculated_paths — numaralandırılmış yönlendirme yolları; her biri sıralı nodes listesini ve attached_features öğesini, yani üzerinde herhangi bir yere eklenmiş Feature türlerini taşır (aşağıya bakın). Liste her zaman bulunur: bileşenler arasında hiç rota olmayan bir derleme boş bir liste taşır. |
render-verdict | input.artifacts — üretilen her dosya için bir girdi; her biri path, content, format ve dosyanın ayrıştırılmış belgeleri olan documents ile. format, dosyayı render eden sağlayıcının o dosya için bildirdiği biçimdir — Terraform sağlayıcısı ürettiği her .tf dosyası için hcl, her .tf.json dosyası için json bildirir, vendor edilmiş bir modülün dosyaları da buna dahildir — ve hiçbir sağlayıcı bir biçim bildirmediğinde boş dizedir; örneğin bir Recipe’nin bir sınırın paylaşılan çıktısına kattığı bir dosyada olduğu gibi. Böyle bir dosya yine de uzantısına göre ayrıştırılır, bu yüzden documents her iki durumda da bulunur. Yapısal olarak okunamayan bir yapıt parse_error taşır ve hiç belge taşımaz; böylece bir politika, okunamayan bir dosyanın incelenmeden geçmesine izin vermek yerine doğrudan bu hata üzerine reddedebilir. |
label-transform | input.graph.nodes — derlemenin düğüm kimliğine göre anahtarlanmış düğümleri; her biri component, resolved_version, labels ve values ile: düğümün örneğinin Aggregate içinde bildirdiği değerler, şablonları parametrelerine göre değerlendirilmiş olarak; örnek hiçbir değer bildirmediğinde bulunmaz. Düğümün Component’inin hassas olarak bildirdiği bir değer, ir-verdict aşamasında olduğu gibi {"aggrega_withheld": "declared"} olarak okunur; bildirilmemiş kardeş değerleri ise yazıldığı gibi okunur. Bir kural bir etiketi belirlemek için input.graph.nodes[id].values okur; bir değeri değiştiremez. input.compilation_context — Release’in release_name ve environment değerleri; böylece bir politika ortama göre farklı karar verebilir. |
annotation-transform | input.targets — eklentinin açıklama ekleyebileceği her bileşen; her biri boundary_path, component_name — bir yönlendirme girdisinin yerleştirdiği bir bileşen için derleme grafiğindeki kimliği, örneğin metrics.query — ve Release’in bileşenin kendisine yazdığı annotations ile; her değer yazıldığı gibidir: bir dize, alt anahtarlardan oluşan bir nesne ya da bileşenin miras alacağı bir açıklamadan vazgeçtiği yerde null. Bileşenin taşıdığı her anahtar, değeri ne olursa olsun bulunur; böylece bir kural, birinin zaten yazdığı bir anahtara dokunmadan bırakabilir. input.binding_keys — Manifest’in bağlama kaydettiği açıklama anahtarları. |
Bir Terraform kaynağı, Terraform’un iki biçiminin her birinde farklı bir yolda okunur. Yerel bir .tf dosyasının documents içeriğinde bir blok önce türünün, sonra etiketlerinin her birinin altına yerleşir ve son etiket bir blok listesi tutar, çünkü aynı türü ve etiketleri paylaşan bloklar kaynak sırasıyla tek bir listede toplanır. Bu nedenle bir kaynak özniteliği input.artifacts[_].documents[_].resource.<type>.<name>[_].<attr> konumunda okunur — herhangi bir adla bir RDS örneği için input.artifacts[_].documents[_].resource.aws_db_instance[_][_].allocated_storage. Bir .tf.json dosyası Recipe’nin yazdığı gibi okunur; bu yüzden adın bloğun kendisini tuttuğu alışılmış nesne biçimi resource.<type>.<name>.<attr> konumunda okunur ve her iki biçim için tasarlanmış bir politika her iki yolu da okur. Bu, derleyicinin içindeki her iki politika motoru için de geçerlidir. Diğer biçim için yazılmış bir Rego kuralı, adlandırdığı yolu tanımsız bulur: orada bir değeri sınayan bir kural hiç tetiklenmez, not ile eksik bir değer üzerine reddeden bir kural ise her kaynakta tetiklenir; diğer biçime dizinleme ya da seçim yapan bir CEL ifadesi, politika dosyasını adlandıran bir değerlendirme hatasıyla derlemeyi durdurur. Aşağıda Render aşaması politika adaptörleri altında açıklanan başvuru Rego render adaptörü, yerel bir .tf dosyasını kendisi ayrıştırır ve tek bir bloğu nesne olarak okur; bu yüzden bir politika bu adaptör ile derleyicinin içindeki bir motor arasında taşındığında Terraform yolu kopyalanmaz, düzenlenir.
Her rol ayrıca input.sources öğesini — eklentinin kendi dosyaları; her biri temel ad path ve content ile — taşır. Bir politika yalnızca bu dosyalardan biri olarak çalışır; bu yüzden bir kuralın listeyi okuduğu her yerde liste en az o dosyayı içerir.
input.settings, eklentinin ayar nesnesidir; politikanın data belgesiyle aynı nesnedir ve eklenti ayar bildirdiğinde bulunur. Eklenti hiçbirini bildirmediğinde kuralın ne bulacağı role bağlıdır: ir-verdict, label-transform ve annotation-transform rollerinde alan yoktur, bu yüzden input.settings, yükün taşımadığı her yol gibi tanımsızdır; render-verdict rolünde ise boş nesnedir. Bu nedenle bir ayarın yapılandırılıp yapılandırılmadığına bağlı olan bir kural nesneyi değil, okuduğu ayarı sınar; bu her rolde aynı biçimde davranır — yapılandırılmış bir max_nodes okunur, yapılandırılmamış olanı ise input.settings.max_nodes öğesini tanımsız ve kuralı sessiz bırakır:
package example
import rego.v1
deny contains msg if { limit := input.settings.max_nodes count(input.graph.spec.nodes) > limit msg := sprintf("this build declares more than %v nodes", [limit])}CEL motoru bildirilmemiş bir ayar nesnesini farklı biçimde ele alır ve bunu aşağıda kendi bölümünde belirtir.
attached_features ve binding_keys nesne değil listedir; bu nedenle bir politika üyeliği in ile sınar:
package security
import rego.v1
deny contains msg if { some path in input.precalculated_paths some gateway in path.nodes input.graph.spec.nodes[gateway].labels["dataplane.aggrega.ai/content-masking"] not "core/data-masking" in path.attached_features msg := sprintf("path %v passes through %v with no masking Feature attached.", [concat(" -> ", path.nodes), gateway])}attached_features, yol üzerindeki herhangi bir düğümün tuttuğu her eklentinin Feature türlerinin birleşimidir — o düğümün bağlantılarından birine yazılmış bir eklenti de, hangi bağlantıya yazılmış olursa olsun, buna dahildir; bu yüzden kural, ağ geçidinin kendisindeki bir core/data-masking eklentisiyle sağlanır; o Feature zaten oraya eklenir: ağ geçidinin bildirdiği içerik maskeleme yeteneğine göre seçim yapar. Eklentinin maskelediği şey, o ağ geçidinden geçen sohbet ve tamamlama metnidir; kural eklentinin listelediklerini değil, var olduğunu denetler.
Tüm yol üzerinde bir birleşim olduğu için liste, bir Feature’ın bir rota üzerinde bir yere eklendiğini söyler, ama asla nereye eklendiğini söylemez. Bir Feature’ın bir rotanın iki belirli bileşeninin — kısıtlı veriyi tutan ile onun ulaştığı — arasında bulunup bulunmadığını bilmesi gereken bir kural, rotanın nodes listesini sırayla ve her düğümün kendi eklentilerini input.graph.spec.feature_values_mapping[<node>] konumunda okur; aynı soru attached_features üzerinden sorulursa, Feature’ın ikinci bileşenin ötesinde bulunduğu bir rota geçer. ../examples/policy-data-class-route/ Rego motoru, CEL motoru ve OPA için bu şekilde yazılmıştır.
Bir düğüm nesnesi kendine ait bir kimlik taşımaz: kimlik, input.graph.spec.nodes içinde altında bulunduğu anahtardır; yukarıdaki kuralın bir id alanını okumak yerine path.nodes üzerinden okuduğu kimlikleri iletisine taşımasının nedeni budur.
Bir politikanın bir eşlemin anahtarlarıyla karşılaştığı sıra
Grafik, yazarının yazdığı sırayı korur: düğümler bileşenlerin bildirildiği sırada, her düğümün etiketleri de düğümün onları taşıdığı sırada. Bu sıra konuğa bozulmadan geçer — yük ikisini de sıralı girdiler olarak taşır (sırasını koruyan eşlemler bölümüne bakın). Bir politikanın bu sırayla karşılaşıp karşılaşmayacağına yük değil, politikayı değerlendiren motorun bir nesneyi nasıl tuttuğu karar verir:
- Rego motoru bir nesnenin anahtarlarını sıralı tutar.
input.graph.spec.nodes, bir düğümünlabelsöğesi ya da başka herhangi bir nesne — politikanın kendisinde yazılmış olanlar dahil — üzerinde dolaşan bir kural anahtarlarla sıralı düzende karşılaşır:web,api,metricsolarak bildirilen bileşenlerleapi,metrics,webolarak karşılaşılır. - CEL motoru bir eşlem için hiçbir sıra sabitlemez.
input.graph.spec.nodesya da bir düğümünlabelsöğesi üzerindeki bir kavrama, özdeş girdili iki derlemede anahtarlarla farklı sıralarda karşılaşabilir ve aynı eşlemin tek bir ifade içindeki iki dolaşımı birbirinden farklı olabilir. Tek bir karar anahtarı altındaki iletilerin sıralanmasının nedeni budur: kararı bir anahtarın bulunduğu konuma bağlı olmayan bir kural yazın. - Bir eklenti kitine karşı yazılmış bir konuk, yazarın sırasıyla karşılaşır. Kiti aracılığıyla çözüldüğünde düğümler ve her düğümün etiketleri, kitin sırayı koruyan kapsayıcısına yükün onları taşıdığı sırayla ulaşır ve her kitin sunduğu yönetişim bağdaştırıcısı iskeleti, motoruna aynı sırayla yazılmış bir JSON belgesi verir. Bu belgeyi kendine ait bir değer türüne dönüştüren bir motor ise, sırasını koruyan eşlemler bölümünün anlattığı gibi, bunun yerine o türün sırasıyla karşılaşır.
Etiketleri şekillendirme: politika etiketi adlandırır, motor onu adresler
Etiket şekillendirme rolünde bir politika, labels altında etiket başına bir karar toplar; düğümü, etiket anahtarını ve etiketin alacağı değeri adlandırır:
package tagging
import rego.v1
labels contains {"node": id, "key": "compliance.example.com/tier", "value": "gold"} if { some id, node in input.graph.nodes node.labels["component.aggrega.ai/type"] == "stateful-server"}Zaten var olan bir anahtarı ayarlamak değerini değiştirir. Bir karar bunun yerine bir anahtarın kaldırılmasını isteyebilir:
labels contains {"node": id, "key": "draft.example.com/scratch", "op": "remove"} if { some id, node in input.graph.nodes node.labels["draft.example.com/scratch"]}Bir politika, derlemenin uyguladığı düzenleme talimatını yazmak yerine etiketi adlandırır ve bunun nedenini bilmekte yarar var: talimat bir etiketi yol ile adresler ve bir Aggrega etiket anahtarı çoğu zaman yol ayırıcısı olan bir / içerir — bu yüzden elle yazılmış bir yol tek bir etiket yerine iç içe bir konumu adresler. Motor, kararın adlandırdığı etiketi adresler; böylece kaçış işlemi her politikada değil bir kez yazılır ve politika, yollar hakkında değil etiketler hakkında bir ifade olarak okunabilir kalır.
Bir karar yalnızca bir etiketi değiştirebilir. Motorun ürettiği her talimat tek bir düğümdeki tek bir etiketi adresler; bu yüzden bir politikanın bir düğümün Component’inde, çözümlenmiş sürümünde, düğüm kümesinde ya da dize olmayan bir etiket değerinde değişiklik ifade etmesinin hiçbir yolu yoktur. Derlemede bulunmayan bir düğümü adlandıran ya da düğümün taşımadığı bir etiketi kaldıran bir karar, derleme tarafından talimatı adlandıran bir iletiyle reddedilir — asla sessizce yok sayılmaz.
../examples/policy-label-transform/, böyle bir politikayı iki yerleşik etiketleme plugin’inin yanına ekler ve ayrıca onların yazdığı etiketleri okuyan, grafik üzerinde bir hüküm de ekler. Bu plugin’lerin her birinin ne okuyup ne yazdığı Yerleşik etiketleme plugin’leri sayfasındadır.
Açıklama ekleme
Açıklama ekleme rolünde bir politika, annotations altında açıklama başına bir karar toplar; hedefi hedefin kendi taşıdığı koordinatla, ayrıca anahtarı ve değerini adlandırır:
package tagging
import rego.v1
annotations contains { "boundary_path": target.boundary_path, "component_name": target.component_name, "annotation_key": "backup.example.com/schedule", "annotation_value": "nightly",} if { some target in input.targets not target.annotations["backup.example.com/schedule"]}Bir kararın yazdığı alan adları, hedeflerini okuduğu alan adlarıdır; bu yüzden uzlaşım yalnızca yükten öğrenilebilir. input.binding_keys okunması, bir politikanın yalnızca Manifest’in anlam kaydettiği anahtarları eklemesini sağlar — bunlar bir Feature eklentisine genişleyenlerdir.
Bir kararın değeri, o açıklamaya sizin de yazabileceğiniz bir değerdir: bir dize ya da alt anahtarlardan oluşan bir nesne. Tek bir alt anahtarı yönlendiren bir bağlama bir dize alır; birden çok alt anahtarı yönlendiren bir bağlama ise, tam olarak bir operatörün Release içinde yazdığı gibi, her birini adlandıran bir nesne alır:
annotations contains { "boundary_path": target.boundary_path, "component_name": target.component_name, "annotation_key": "feature.aggrega.ai/monitoring", "annotation_value": {"interval": "30s", "port": "metrics", "path": "/metrics"},} if { some target in input.targets not target.annotations["feature.aggrega.ai/monitoring"]}Derleme, enjekte edilen bir değeri Release içinde yazılmış aynı değeri okuduğu gibi okur; bu yüzden değer aynı biçimde genişler ve bağlı Feature’a karşı aynı biçimde denetlenir. Motor bir nesnenin anahtarlarını sıralı tutar, bu yüzden alt anahtarlar derlemeye sıralı olarak ulaşır. Başka herhangi bir biçimdeki değer — null, bir liste, bir sayı, bir boolean ya da alt anahtarı olmayan bir nesne — derleme tarafından enjeksiyon adlandırılarak reddedilir: rol açıklama ekler ve null ya da boş bir nesne, bir yazarın bir açıklamayı kaldırmak için yazdığı vazgeçme olarak okunur. Yükün taşımadığı bir bileşeni adlandıran bir karar da aynı biçimde, koordinat ve açıklama adlandırılarak reddedilir.
Derleme, enjekte edilen bir açıklamayı nasıl yönlendirildiği ya da ne taşıdığı nedeniyle reddettiğinde — birden çok alt anahtarı yönlendiren bir bağlamaya verilen bir dize, bağlı Feature’ın şemasının kabul etmediği bir alt anahtar değeri ya da Release tarafındaki bir açıklamanın kullanamayacağı values sütunu üzerinden yönlendirilen bir alt anahtar — ret, onu enjekte eden plugin’i ve plugin’in eklendiği yönetişim rolünü adlandırır; böylece değer, Release’te kimsenin yazmadığı bir satıra değil, ona karar veren politikaya kadar izlenir.
../examples/policy-annotation-transform/, böyle bir politikayı ekler; bir bağlama altında bir dize, bir diğerinin altında alt anahtarlardan oluşan bir nesne enjekte eder ve bu açıklamaları elle yazan bir Release ile aynı dosyaları derler.
Bütün bir politika kümesini tek bir arşiv olarak eklemek
Bir politika kümesi dosya dosya ya da politika dosyalarını ve veri belgelerini birlikte taşıyan tek bir arşiv olarak eklenir; bu, bir Rego araç zincirinin oluşturduğu biçimdir. Eklenen bir dosyanın içeriği konuğa metin olarak aktarılır ve sıkıştırılmış bir arşiv metin değil rastgele baytlardır; bu nedenle bir arşiv base64 ile kodlanmış olarak ve adı .base64 ile bitecek şekilde adlandırılarak eklenir:
tar czf bundle.tar.gz policy.rego data.jsonbase64 -w0 bundle.tar.gz > bundle.tar.gz.base64with: sources: - ./policies/bundle.tar.gz.base64Bir dosyayı politika metni olarak değil de arşiv olarak işaretleyen şey adıdır; bu da seçimi operatörün kendi beyanı olarak tutar: böylece hasarlı bir arşiv, ayrıştırılamayan bir politika dosyası olarak okunmak yerine, dosyayı ve başarısız olan adımı belirten hasarlı bir arşiv olarak bildirilir. Arşivi kodlamak, operatörün araç zinciri arşivi oluşturduktan sonra eklediği bir adımdır.
Arşivin içinde her .rego üyesi bir politika modülüdür ve her data.json ya da data.yaml üyesi, bulunduğu dizinin altına yerleştirilmiş bir veri belgesidir; {"max": 3} içeren bir limits/data.json, bir politika tarafından data.limits.max olarak okunur. Başka türdeki üyeler arşiv tarafından kendi araç zinciri için taşınır ve politika girdisi değildir.
Açılamayan bir arşiv, eklenen dosyayı belirten bir hatadır: çözülemeyen bir kodlama, açılamayan sıkıştırılmış bir akış, kesilmiş bir arşiv, okunamayan bir veri dosyası ya da hiç politika içermeyen bir arşiv. Bunların hiçbiri boş bir politika kümesi üretmez, çünkü boş bir politika kümesi hiçbir karara ulaşmaz ve “arşiv okunamadı” durumu hiçbir zaman “politika derlemeye izin verdi” durumundan ayırt edilemez olmamalıdır.
CEL motoru için politika yazmak
Motor, operatörün yazdığı CEL’i, dört rolden hangisine bağlandıysa orada, tamamen konuk içinde değerlendirir. Katalog kimliği pluginType: governance altındaki yalın cel adıdır (governance/cel koordinatı) ve sürümü, onu sunan derleyici sürümüdür. Motoru iki farklı politika dosyasıyla iki role, iki kez bağlamak, tek bir motorun aynı derlemenin iki anını kapsamasını sağlar.
plugins: governance: - uri: governance/cel:<version> role: ir-verdict with: sources: - ./policies/topology.cel settings: max_nodes: 20Bir politika tüm yüke tek bir adla, input ile erişir; bu nedenle okuduğu adlar, iletimin onlara verdiği adlardır: derleme grafiği input.graph altında, numaralandırılmış yönlendirme yolları input.precalculated_paths altında, işlenmiş dosyalar
input.artifacts altında, açıklama hedefleri input.targets altındadır. Bu role özgü yollar, yukarıdaki Her rolün yükünün sundukları
bölümünde tablolanan yollardır ve her iki motor için aynıdır: tek bir iletim, tek bir kök ad altında okunur.
Bağlamanın kendi dosyaları input.sources altında, ayarları ise input.settings altındadır; böylece operatörün sağladığı bir eşik değeri input.settings.max_nodes olarak okunur. Öğrenilecek ikinci bir belge yoktur: ayarlar da her şey gibi input’un parçasıdır. İkisi de her zaman bir değer olarak bulunur (bağlama hiçbirini bildirmediğinde ayarlar her rolde boş nesnedir), bu yüzden onlara erişen bir ifadenin yokluklarına karşı önlem alması gerekmez ve tek bir ayarın yapılandırılıp yapılandırılmadığı, anahtarı üzerinde bir sınamadır: has(input.settings.max_nodes).
İki yazım biçimi ve aralarında seçim yapan dosya adı
Bir politika iki biçimden biriyle bağlanır ve hangisi olduğunu dosyanın adı söyler:
| Dosya adının sonu | Okunduğu biçim |
|---|---|
.cel | olduğu gibi değerlendirilen tek bir ifade |
.yaml veya .yml | bir kurallar belgesi: kurallardan oluşan bir liste |
| başka herhangi bir şey | tek bir ifade |
Kuralın tamamı addır. Hiçbir ayar biçim seçmez ve biçimi tahmin etmek için dosyanın metni incelenmez; metin bu soruyu zaten yanıtlayamazdı, çünkü bir ifadenin en dıştaki değeri bir eşlemedir, bir kurallar belgesininki de öyledir; bu da iki biçimi şekil bakımından ayırt edilemez kılar.
Dolayısıyla kural iki yönde de işler ve her iki hata da yanlış okunmak yerine reddedilir. policy.cel adlı bir kurallar belgesi reddedilir, çünkü YAML kurallarından oluşan bir liste bir ifade değildir; policy.yaml adlı bir ifade reddedilir, çünkü bir ifade kurallardan oluşan bir liste değildir. Her ret dosyayı adıyla belirtir. Her iki yönde de çözüm dosyayı yeniden adlandırmaktır.
Bir politika kümesi gerektiği kadar dosyadan oluşur ve iki biçim tek bir bağlama içinde serbestçe karışabilir.
.cel adlı bir dosyada bir ifade
Bir ifade dilinde kararların altında toplanacağı kural adları yoktur; bu yüzden kararlar, ifadenin ürettiği değerin ta kendisidir: karar anahtarından o anahtarın topladıklarına giden bir eşleme. Bir hüküm rolünde anahtar, altında ulaşılan iletileri toplar; derlemeyi biçimlendiren bir rolde ise uygulanacak kararları toplar.
{ "deny": input.graph.spec.nodes .filter(n, input.graph.spec.nodes[n].resolved_version == "latest") .map(n, "component " + n + " tracks the latest version; pin it"), "warn": size(input.graph.spec.nodes) > input.settings.max_nodes ? ["this build declares a lot of components"] : [],}Dosyanın atladığı bir anahtar orada hiçbir karara ulaşmamıştır, bu nedenle bir dosyanın her anahtarı adlandırması gerekmez; ayrıca her rol yalnızca ilgili olduğu anahtarı okur, böylece tek bir politika kümesi aynı dosyalardan hem bir hüküm rolüne hem de derlemeyi biçimlendiren bir role hizmet edebilir. Bir anahtar, topladıklarının bir listesini, bunlardan tek birini ya da hiçbiri için null değerini taşır.
Eşleme dışında herhangi bir şeye değerlendirilen bir ifade, yazılması gereken şekli belirtilerek reddedilir. Beklenmeye değer hata yalın bir size(input.graph.spec.nodes) <= 5 ifadesidir: bu bir boolean’dır ve false değerini bir durdurma olarak okumak, yazarın hiç yazmadığı bir ileti uydurmak anlamına gelirdi.
.yaml veya .yml adlı bir dosyada bir kurallar belgesi
Bir kurallar belgesi, her biri ulaştığı karar anahtarını, ulaşılıp ulaşılmadığına karar veren ifadeyi ve ulaşıldığında neyin raporlandığını belirten kurallardan oluşan bir listedir:
- key: deny expression: size(input.graph.spec.nodes) > 20 message: this build declares a lot of components- key: warn expression: has(input.settings.max_nodes) message: a component ceiling is configured for this environmentBir kuralın raporladığı şey, tıpkı bir ifadede olduğu gibi, ulaştığı karar anahtarına göre belirlenir. Metin, bir hükmün taşıdığı iletidir. Bir eşleme, derlemeyi biçimlendiren bir rolün okuduğu tek kararın alanlarıdır:
- key: labels expression: input.compilation_context.environment == "production" message: node: app key: compliance.example.com/tier value: goldBir kuralın ikisinden hangisini yazdığına yalnızca kural karar verir (bunu seçen bir ayar yoktur) ve anahtarı için yanlış olanı yazan bir kural, adıyla belirtilerek reddedilir.
Başınıza gelmeden önce bilinmeye değer bir YAML ayrıntısı: çift tırnakla başlayan bir ifadenin belge okuyucusu için tırnak içine alınması gerekir, çünkü " ile açılan bir değer, tırnakla başlayan bir metin olarak değil, tırnaklı bir skaler olarak okunur.
- key: annotations expression: '"backup.example.com/schedule" in input.binding_keys' message: boundary_path: main component_name: app annotation_key: backup.example.com/schedule annotation_value: nightlyBir kurallar belgesi, herhangi bir şey değerlendirilmeden önce temsil ettiği ifade olarak okunur. Her kural, ifade sağlandığında raporunu, sağlanmadığında hiçbir şey taşımayan karar anahtarına dönüşür ve aynı anahtarı paylaşan kurallar birleştirilir. Böylece her iki biçimi tek bir değerlendirici çalıştırır ve bir kurallar belgesi, temsil ettiği ifadenin karar verdiği şeye tam olarak karar verir; her rolde, hükümler ve derlemeyi biçimlendiren kararlar için aynı şekilde. Bundan iki sonuç çıkar. Bir belge ile temsil ettiği elle yazılmış ifade aynı kararlara ulaşır, çünkü ikisi aynı değerlendirmedir. Ve aşağıdaki sıralama kuralları belgeye değil, değerlendirilen biçime aittir: bir belgenin kuralları yazıldıkları sırayla raporlanmaz.
Hangi biçim uygun: birbirlerinin yerine geçmezler
Her iki biçim de tek bir değerlendiriciden geçer, bu nedenle hiçbiri diğerinden daha hızlı ya da daha güvenilir değildir. Farklı olan, her birinin neyi söyleyebildiğidir; iki biçim öğrenilecek iki şey olduğundan, ayrımı zevke bırakmak yerine açıkça belirtmek yerinde olur. Kuralın raporladığı şeye göre seçin.
- Rapor sabit olduğunda bir kurallar belgesi. İleti ya da karar, ona ulaşan ifadenin yanına bir kez yazılır ve dosya bir denetimler listesi gibi okunur. “Bu doğruysa, tam olarak şunu söyle” için daha kısa biçim budur.
- Rapor bulduğu şeyi adlandırdığında bir ifade. Tek bir ifade bir derlemenin bileşenlerini süzer ve bileşen başına bir ileti ya da bir karar üretir; böylece okuyucu bir sayı hakkında tek bir cümle yerine her ihlal eden için
component payments tracks the latest version; pin itiletisini alır.
Bir kurallar belgesinin yapamadığı iş bu ikincisidir: kurallarının her biri önceden yazılmış tek bir rapor taşır, bu yüzden onu hangi bileşenin tetiklediği hakkında söyleyecek bir şeyi yoktur. Belge biçimine yönelip ardından iletide ihlal edenin adını istemek, kuralı bir ifade olarak yeniden yazmakla biten bir yoldur; bu yüzden seçimi baştan bu soruya göre yapmak yerinde olur.
Bir ifadenin söyleyebilecekleri
Bu motorun değerlendirdiği ifadeler filter, map ve exists
kavramalarını, dizeler ve listeler üzerinde +, size, in, startsWith, string(),
koşul işlecini ve hesaplanmış bir tamsayıyla dizinlenen bir listeyi kullanır. Bazı CEL ortamlarının eklediği uzantı işlevlerini sunmazlar: join, split,
substring, indexOf, flatten, cel.bind ve lists.range her biri bildirilmemiş bir başvuru olarak reddedilir; ayrıca bir kavrama tek bir değişken alır, bu yüzden exists(i, v, …) gibi iki değişkenli bir biçim de aynı şekilde reddedilir. Bir ret, dosyayı ve başvuruyu belirten bir derleme hatasıdır:
policy source "routes.cel" could not be evaluated: Undeclared reference to 'join'Bir rotada ilerleyen bir kuralı üç sonuç biçimlendirir:
- Ara bir değeri adlandırmanın yolu yoktur. İki kez kullanılan bir alt ifade
iki kez yazılır ya da tek öğeli bir liste eşlenerek bağlanır:
[value].map(name, …)[0]gövdesininame,valuedeğerine bağlı olarak bir kez değerlendirir. - Bir listenin konumlarında ilerlemenin yolu yoktur. Bir rotanın bileşenlerini
konuma göre karşılaştıran bir kural, konumları ayarlarından alır (
[0, 1, 2, …]gibi birpositionslistesi) ve rotayı her birinde dizinler; bu yüzden listenin kendisinden uzun bir rotaya karşı, onu kısmen okumak yerine böyle bir rotada durdurarak önlem alması gerekir. - Bir karar anahtarı iletileri toplar, ileti listelerini değil. Rota başına bir ileti listesi üreten bir ifade bir karar anahtarı altında reddedilir (hata, bir ileti yerine liste türünde bir değer topladığını söyler); bu yüzden bir kural rota başına bir kayıt üretir ve iletiyi ondan oluşturur. Ayrıca ifadenin iki kez ürettiği bir ileti iki kez raporlanır: aşağıda açıklanan sıralama bir anahtarın topladıklarını sıralar ve tekrarı kaldırmaz.
../examples/policy-data-class-route/, üçünün altında yazılmış bir CEL kuralını, Rego motoru için aynı kuralın yanında içerir.
Karar anahtarları ve önem dereceleri
Karar anahtarları, bunların önem derecelerine varsayılan eşlemesi ve onları yeniden adlandıran translation ayarı Rego motorundakiyle aynıdır; yukarıdaki
Bir politika kararlarını bir karar anahtarı altında toplar
bölümüne bakın. Varsayılan olarak deny halt düzeyinde, warn warn düzeyinde ve audit info düzeyinde raporlanır; bildirilen bir translation bu varsayılanı genişletmek yerine onun yerini alır ve bildirdiği sıra, hükümlerin raporlanma sırasıdır.
Her iki motor da bunun için aynı ayar şemasını bildirir; bu nedenle bir translation bloğu, kararları hangi dil ifade ederse etsin aynı anlama gelir ve hatalı biçimlendirilmiş bir blok, herhangi bir politika çalışmadan önce reddedilir.
Derlemeyi biçimlendiren bir rolde anahtar eşlenmez, sabittir: etiket biçimlendirme rolünde labels, açıklama ekleme rolünde annotations.
Sıralama: bir anahtar içinde sıralı ve kararlar üzerinde tam sıra
Bir karar anahtarı altındaki mesajlar sıralı olarak raporlanır. Bu, bir sunum tercihi değil sözleşmenin bir parçasıdır ve nedeni akılda tutulmaya değer: bir eşlem üzerindeki bir kavrama ifadesi (input.graph.spec.nodes üzerinde .filter(...) ve .map(...); bileşen başına bir kural yazmanın en doğal yolu budur) o eşlemi, değerlendiricinin sabitlemediği bir sırayla dolaşır. Kendi hâline bırakılırsa aynı girdi, her derlemede aynı mesajları farklı bir sırayla raporlardı. Sıralama bunu ortadan kaldırır.
Bundan, hata gibi okunması kolay ama hata olmayan iki sonuç çıkar:
- Bir kurallar belgesinin kuralları da sıralı raporlanır, yazıldıkları sırayla değil; çünkü belge, karşılık geldiği ifade olarak değerlendirilir ve sıralama, bir anahtarın topladıklarına uygulanır.
- Elle yazılmış bir liste de sıralanır.
["second", "first"]taşıyan bir anahtar,firstöğesinisecondöğesinden önce raporlar. Değerlendirilmiş bir sonuçta, yazarın elle yazdığı bir listeyi bir kavrama ifadesinin ürettiğinden ayıran hiçbir şey yoktur; dolayısıyla korunacak bir yazım sırası yoktur.
Anahtarlar arasında sıra, translation ayarının bildirdiği sıradır. Dosyalar arasında ise dosya adlarının sırasıdır, çünkü bir eklemenin kaynakları, eklemenin listelediği sırayla değil ada göre sıralı olarak gelir.
Derlemeyi biçimlendiren bir rolde aynı gerekçe kararların kendilerine de uygulanır ve sıra daha güçlüdür: kararlar, adlandırdıkları her şeye göre artan sırada raporlanır; bu, bir kararın ifade edebileceği şeyler üzerinde tam bir sıradır: önce düğüm, sonra etiket anahtarı, sonra etiketin eklenip eklenmediği ya da kaldırılıp kaldırılmadığı, sonra değer; bir ekleme içinse önce sınır, sonra bileşen, sonra açıklama anahtarı, sonra değeri. Etiketlerde ya da açıklamalarda yapılan bir değişiklik oluşturulan çıktıya ulaşır; bu nedenle keyfi bir sıra, aynı girdinin bir derlemeden diğerine farklı oluşturulması anlamına gelirdi.
Etiketleri biçimlendirme
Etiket şekillendirme rolünde bir politika, labels altında etiket başına bir karar toplar; düğümü, etiket anahtarını ve etiketin alacağı değeri adlandırır:
{ "labels": input.graph.nodes .filter(n, input.graph.nodes[n].labels["component.aggrega.ai/type"] == "stateful-server") .map(n, { "node": n, "key": "compliance.example.com/tier", "value": input.compilation_context.environment == "production" ? "gold" : "bronze", }),}Zaten var olan bir anahtarı ayarlamak, değerini değiştirir. Bir karar bunun yerine, op değerini remove olarak adlandırarak bir anahtarın kaldırılmasını isteyebilir:
{ "labels": input.graph.nodes .filter(n, "draft.example.com/scratch" in input.graph.nodes[n].labels) .map(n, {"node": n, "key": "draft.example.com/scratch", "op": "remove"}),}Tek bir kararın etrafında liste gerekmez ve labels anahtarı adlandırmayan bir dosya hiçbir etiket hakkında karar vermez.
Bir politika, derlemenin uyguladığı düzenleme talimatını yazmak yerine etiketi adlandırır; nedeni Rego motorunun
etiket biçimlendirme bölümünde
verilmiştir: bir Aggrega etiket anahtarı sıklıkla / içerir ve elle yazılmış bir yol, tek bir etiket yerine iç içe bir konumu adresler. Motor, kararın adlandırdığı etiketi adresler.
Bir düğümün taşımayabileceği bir etiketi okumak boş bir değer değil, bir hatadır; ikinci örneğin anahtarı okumadan önce var olup olmadığını sormasının nedeni budur. Bu, ifade dilinin eksik bir anahtarı okumaya ilişkin kendi kuralıdır ve belirgindir: hiçbir düğümün taşımadığı bir etikete uzanan bir politika, sessizce hiçbir şeye karar vermek yerine değerlendirilemediğini raporlar.
Bir karar yalnızca bir etiketi değiştirebilir. Derlemede olmayan bir düğümü adlandıran ya da düğümün taşımadığı bir etiketi kaldıran bir karar, derleme tarafından talimatı adlandıran bir mesajla reddedilir; asla sessizce yok sayılmaz.
Her düğüm ve etiket anahtarı için tek bir karara ulaşın. Aynı düğümdeki aynı etiket için iki farklı değer üretebilen bir kural yetersiz belirtilmiştir: her iki kararı da üretmek yerine değeri ifadenin içinde, bir koşul ifadesiyle ya da tek bir dalı kabul eden bir filtreyle çözün.
../examples/policy-label-transform/, etiket şekillendirme rolünü baştan sona gösterir; politikası Rego motoru için yazılmıştır.
Kayıtlı bir anahtar altında açıklama ekleme
Açıklama ekleme rolünde bir politika, annotations altında açıklama başına bir karar toplar; hedefi, hedefin kendi taşıdığı koordinatla, ayrıca anahtarı ve değerini adlandırır:
{ "annotations": input.targets .filter(t, "backup.example.com/schedule" in input.binding_keys) .map(t, { "boundary_path": t.boundary_path, "component_name": t.component_name, "annotation_key": "backup.example.com/schedule", "annotation_value": "nightly", }),}Bir kararın yazdığı alan adları, hedeflerini okuduğu alan adlarıdır; bu nedenle uzlaşım yalnızca yükten öğrenilebilir. input.binding_keys okumak, bir politikanın yalnızca Manifest’in anlam kaydettiği anahtarları eklemesini sağlar; bunlar bir Feature eklemesine genişleyen anahtarlardır. Her alan zorunludur: boş anahtarlı ya da boş bileşen adlı bir açıklama, bir politikanın istemeyi amaçladığı bir şey değildir. Bir bileşenin altında bulunduğu sınır meşru olarak boş dizeyle adlandırılabilir; bu nedenle bu alan bulunmalıdır ama boş olabilir.
Değer, o açıklamaya sizin de yazabileceğiniz bir değerdir: bir dize ya da alt anahtarlardan oluşan bir eşlem; ikincisi, birden çok alt anahtarı aynı anda yönlendiren bir bağlamayı besleyendir — "annotation_value": {"interval": "30s", "port": "metrics", "path": "/metrics"}. İfade dili bir eşlem için hiçbir sıra belirlemediğinden motor bir eşlemin alt anahtarlarını sıralı yazar ve değeri ifadenin ürettiği gibi iletir; JSON modelinin tutamayacağı bir değer — bayt, zaman damgası, süre — metne dönüştürülmek yerine reddedilir. Ardından derleme değeri, Release içinde yazılmış aynı değeri okuduğu gibi okur ve null, bir liste, bir sayı, bir boolean ya da boş bir eşlemi enjeksiyonu adlandırarak reddeder. Bir bileşen ve anahtar için farklı değerlere sahip iki karar, değerin JSON’una göre sıralanır. Bir hedefin annotations öğesi her mevcut değeri yazıldığı gibi taşır — bir dize, bir eşlem ya da vazgeçme için null — bu yüzden "feature.aggrega.ai/monitoring" in t.annotations sınaması, değeri ne olursa olsun bir anahtarı bulur.
Yükün taşımadığı bir bileşeni adlandıran bir karar, derleme tarafından koordinat ve açıklama adlandırılarak reddedilir. Derleme, enjekte edilen bir açıklamayı yönlendirmesi, alt anahtar değerleri ya da sütunu nedeniyle reddettiğinde, ret onu enjekte eden plugin’i ve plugin’in eklendiği rolü adlandırır. Etiketlerde olduğu gibi, bir anahtar için iki karar üretmek yerine değeri ifadenin içinde çözerek her bileşen ve açıklama anahtarı için tek bir karara ulaşın.
../examples/policy-annotation-transform/, açıklama ekleme rolünü baştan sona gösterir; politikası her iki motor için yazılmıştır.
Bir politika ya da karar okunamadığında
Motorun okuyamadığı, değerlendiremediği ya da belgelenen biçimdeki kararlardan başka bir şey üreten bir politika, bir hüküm ya da değişiklik döndürmek yerine derlemenin başarısız olmasına yol açar. Başarısızlık, dosyayı ve hata dosyanın bir bölümüne aitse dosya içindeki konumu adlandıran bir derleme hatası olarak raporlanır; bu, bilinçli olarak bir halt hükmünden ayrıdır, böylece “bu politika değerlendirilemedi” durumu asla “bu politika derlemeye izin veriyor” ile karıştırılmaz.
Bir ifade için bu, ayrıştırılamayan bir kaynağı (ayrıştırıcının kendi satır ve sütunuyla ve hatalı konumun altında bir şapka işaretiyle raporlanır) ve karar anahtarından o anahtarın topladıklarına bir eşlemden başka bir şeye değerlendirilen bir kaynağı kapsar.
Bir kurallar belgesi için bu, kural listesi olmayan metni, içinde hiç kural olmayan bir listeyi, bir alanı eksik ya da boş olan bir kuralı, biçimin tanımlamadığı bir alanı, ne metin ne de metinden metne bir eşleme olan bir raporu ve okunamayan bir ifadeyi kapsar. Tek bir kurala ait bir hata, o kuralın konumunu (bir yazarın kendi dosyasını saydığı gibi birden başlayarak) ve karar anahtarını adlandırır. İfadesi ayrıştırılamayan bir kural değerlendirmeden önce reddedilir; böylece şapka işareti, yazarın hiç görmediği çevrilmiş metindeki bir konuma değil, yazarın yazdığı ifadenin içine düşer.
Derlemeyi biçimlendiren bir roldeki bir karar için bu, kararın olması gereken yerdeki bir mesajı, eksik bir koordinatı ve bu motorun karar biçiminin tanımlamadığı bir alanı kapsar. Sonuncusu ayrıca belirtilmeye değer: yanlış yazılmış bir annotation_valu yok sayılmaz, reddedilir; böylece hata, sessizce boş bir değer eklenip değişiklik olmadan tamamlanan bir derleme bırakılması yerine raporlanır. Bu tür her ret dosyayı adlandırır ve o türden bir kararın neyi adlandırması gerektiğini belirterek sona erer.
Render aşaması politika adaptörleri
Render aşaması adaptörü, derlemenin IR grafiği yerine render edilmiş çıktısı üzerinde akıl yürütür. Render yükü, üretilen yapıtları — her biri çıktı yolu ve render edilmiş içeriğiyle ve geçerli olduğu yerde render edildiği biçim ve ayrıştırılmış yapılandırılmış bir görünümüyle birlikte — ve ayrıca eklemenin kendi kaynaklarını ve ayarlarını, her birini eklemenin onu bildirdiği yerde, taşır. Bir adaptör bu içeriği hedeflediği çıktı biçimine göre okur, yapılandırılmış sonuç üzerinde bir politikayı değerlendirir ve sonucu halt / warn / info kararlarına eşler. Yük kendine ait hiçbir çıktı biçimi adlandırmadığından, tek bir adaptör kalıbı her render hedefine hizmet eder; yeni bir çıktı biçimi yeni bir adaptördür, ana makinede bir değişiklik değil.
Her render aşaması adaptörü yukarıdaki anlamda bir adaptördür: dışa doğru Aggrega ABI’sini konuşur ve içe doğru hedefe özgü bir biçimi ya da yabancı bir politika motorunun sözleşmesini soğurur; böylece derleyici her türlü çıktı biçimi veya politika mantığından arınmış kalır. Derleyicideki Rego ve CEL motorları render-verdict rolüne doğrudan hizmet eder; bunların ötesinde, iki başvuru render aşaması adaptörü, her yaygın çıktı biçimi için bir tane olmak üzere, plugin geliştirme kitinin Rust örnekleri arasında çalışılmış örnekler olarak gelir.
../examples/policy-render-verdict/, dört hedefin çıktısı — Kubernetes nesneleri, bir Docker Compose dosyası, bir Terraform kök yapılandırması ve bir CloudFormation şablonu — üzerinde render-verdict rolünde tek bir kural ekler; kural derleyicideki her motor için birer kez yazılmıştır ve her hedefe yerleştirilen ihlalin derlemeyi durdurduğunu, kontrol örneğinin ise geçtiğini denetler.
Bu rolde ya da başka bir rolde kendi adaptörünüzü yazmak için her plugin geliştirme kitinin sunduğu yönetişim adaptörü iskeletinden başlayın: Kendi yönetişim plugin’inizi yazmak, iskeletten adaptörün reddettiği bir derlemeye kadar adım adım ilerler.
YAML, JSON ve Terraform HCL çıktısı — başvuru Rego render adaptörü
Başvuru Rego render adaptörü, operatörün sağladığı Rego’yu herhangi bir YAML veya JSON render çıktısı üzerinde ve Terraform’un yerel HCL çıktısı üzerinde çalıştırır. Render aşaması biçiminin çalışılmış bir örneğidir: derleyicideki motorla aynı Wasm-yerel Rego değerlendiricisi ve aynı üç karar önem derecesine eşlenen aynı deny / warn / audit toplama uzlaşımı; derleme grafiği yerine render edilmiş dosyalar üzerinde akıl yürütür.
YAML/JSON hedefleri arasında çıktı biçiminden bağımsızdır. Adaptör her yapıtın içeriğini bir veya daha fazla YAML veya JSON belgesi olarak ayrıştırır — YAML, JSON’un bir üst kümesidir, dolayısıyla CloudFormation yığını gibi bir JSON şablonu aynı ayrıştırıcıdan geçer — ve ayrıştırılmış belgeleri ham içerikle birlikte politikaya sunar. Bir politika, bu tür herhangi bir hedefin yapılandırılmış render çıktısı üzerinde sıradan Rego ile akıl yürütür: input.artifacts[_].documents[_] ayrıştırılmış belgeleri verir (bir Docker Compose dosyasının services alanı, bir CloudFormation şablonunun Resources alanı), input.artifacts[_].content ham metni verir ve eklemenin settings nesnesi Rego data belgesidir. Örneğin Docker Compose çıktısı üzerinde onaylı kayıt defteri gerektiren bir politika, imajı kayıt defteri öneki taşımayan her hizmeti reddeder.
Adaptör ayrıca Terraform’un yerel HCL render çıktısı üzerinde de akıl yürütür. Yerel bir .tf dosyası ne YAML ne de JSON’dur; bu yüzden adaptör onu, bir Terraform-JSON (.tf.json) dosyasının zaten ayrıştırıldığı aynı kanonik nesneye yansıtır: bir politika bir kaynak özniteliğini
input.artifacts[_].documents[_].resource.<type>.<name>.<attr> konumunda okur — bir RDS örneği için input.artifacts[_].documents[_].resource.aws_db_instance[_].allocated_storage
— derleyici hangi Terraform biçimini üretmiş olursa olsun aynı şekilde. Öznitelik türleri korunur (sayı sayı, boolean boolean kalır) ve çözümlenmemiş bir Terraform ifadesi ${ ... } biçiminde bir dize olarak kalır. Terraform-JSON gövdeleri
(.tf.json, .auto.tfvars.json) YAML/JSON yolundan değişmeden geçer; bir Terraform şablon dosyası (.tftpl) ise — bağımsız yapılandırma değil, şablon metni olduğundan — yansıtılmaz ve yapılandırılmamış her içerik gibi parse_error döndürür.
Bu liste, derleyicinin ne ürettiğini değil, adaptörün ayrıştırıcısının neyi kabul ettiğini söyler. İkisi aynı küme değildir ve otomatik yüklenen değişken dosyası farklı oldukları durumdur: derleyici hiçbir yolda böyle bir katman üretmez — kaynaklı bir modülün girdileri, sınırın kök yapılandırmasındaki o bileşenin modül bloğunun argümanlarıdır — dolayısıyla bu biçim bir politikanın görünümüne yalnızca satıcıya dahil edilmiş bir modül kendine ait bir tane getirdiğinde ulaşır; kaynaklı yol bunu çıktıya olduğu gibi kopyalar. Derleyicinin böyle bir dosya üretmesini bekleyecek şekilde yazılmış bir politika hiçbir zaman tetiklenmez.
Bir yapıtın içeriği ayrıştırılamadığında adaptör ona sessizce izin vermez: ham içeriği tutar, o yapıt için hiçbir ayrıştırılmış belge sunmaz ve ayrıştırıcının mesajını input.artifacts[_].parse_error altına kaydeder; böylece bir politika, bozuk bir yapıtta derlemeyi açıkça durdurabilir. Derleyicideki Rego motorunda olduğu gibi, gömülü değerlendiricinin uygulamadığı bir yerleşik işlevi çağıran politika gürültülü biçimde başarısız olur — eklentiyi adlandıran bir hata; asla sessiz bir izin değil.
Kubernetes çıktısı — Kubewarden render adaptörü
Kubewarden render adaptörü, render edilmiş Kubernetes manifestleri üzerinde Kubewarden tarzı kabul politikalarını çalıştırır. Kubernetes admission-review sözleşmesini içe doğru soğurur: bir Kubewarden politikası tek bir nesneyi saran bir istek alır ve kabul-ya-da-ret yanıtı döndürür. Render aşamasında derlemenin çıktısı zaten bir Kubernetes kaynakları kümesi olduğundan, bu aşama kabul biçimli bir politikayı çalıştırmanın doğal yeridir. Render edilen her nesne için adaptör kabul alanlarını ayrıştırılmış nesnenin kendisinden türetir, nesneyi konuğun içinde admission-review biçimli bir isteğe sarar, politikayı çalıştırır ve yanıtı bir karara eşler: ret bir karar olur; kabul hiçbir şey üretmez. Birlikte gelen başvuru politikası bir etiket gerektirme kuralıdır — her nesne settings tarafından adlandırılan bir etiket anahtarı taşımalıdır — yaygın bir Kubewarden kalıbı.
Render aşaması adaptörlerinin ortak kapsamı
- Render aşaması, adaptör başına bir çıktı biçimi. Render aşaması adaptörü IR grafiği üzerinde değil, render edilmiş yapıtlar üzerinde akıl yürütür ve ayrıştırdığı çıktı biçimini hedefler — başvuru Rego render adaptörü için YAML/JSON ve Terraform yerel HCL, Kubewarden adaptörü için Kubernetes nesneleri. Grafik aşaması politikası ya da birlikte gelen hiçbir adaptörün ayrıştırmadığı bir çıktı biçimi üzerindeki politika, farklı bir konuktur.
- Yalnızca doğrulama. Render aşaması adaptörü kabul eder ya da reddeder; asla değiştirilmiş bir nesne döndürmez. Değiştiren bir politikanın değiştirilmiş nesnesi yok sayılır — derleyici render edilmiş çıktıyı bir politika kararından yola çıkarak asla yeniden yazmaz. Politika karar verir; düzenleme yapmaz.
Bir politikayı bağlamak
Bir operatör, bir yönetişim eklentisini çalışma alanı yapılandırmasındaki (.aggrega-config.yaml) plugins.governance listesi aracılığıyla bağlar. Her girdi bir eklentiyi, bağlandığı role değerini ve isteğe bağlı olarak kurallarını ve ayarlanabilir değerlerini sağlayan with kanalını belirtir:
plugins: governance: - uri: <resolvable-plugin-reference> role: ir-verdict with: sources: - ./policies/replicas.rego settings: max_replicas: 3uri, eklenti olarak çözümlenir. Ana makine her sources dosyasını derleme zamanında okur ve baytlarını misafire iletir; settings ise olduğu gibi aktarılır. Hiçbir yönetişim eklentisi bağlanmamış bir derleme, soketi işlem yapmadan çalıştırır; dolayısıyla bağlama, bir çalışma alanına yalnızca ekleme yapar.
Birden çok role hizmet eden bir eklenti, her rol için bir kez bağlanır ve her bağlamanın kendi kuralları ve kendi ayarları olur:
plugins: governance: - uri: governance/rego:<version> role: label-transform with: sources: - ./policies/tagging.rego - uri: governance/rego:<version> role: ir-verdict with: sources: - ./policies/topology.rego settings: translation: - key: blocked severity: haltBir eklemenin hangi sürümü adlandırdığı. Bir uri bir Plugin varlığını adlandırır — <pluginType>/<name> koordinatı ve iki noktadan sonra bir sürüm — ve sürüm çözümlemede rol oynar. CLI’a derlenmiş iki motor için varlık iki yerden birinden gelir. Her derleyici yayını, governance/rego ve governance/cel için Plugin varlıklarını kendi sürümüyle yayımlar ve standart kitaplık kataloğu bunları, her birini onu yayımlayan yayının sürümüyle taşır; bir çalışma alanı bunları listelediği katalog dizinlerinden okur. aggrega ikili dosyası her birinden bir varlığı, yalnızca kendi yayınının sürümüyle taşır. Hiçbirinin taşımadığı ve hiçbir pull işleminin içerik önbelleğine getirmediği bir sürümü adlandıran bir ekleme, başvuruyu adlandırarak derlemeyi E0137 ile durdurur.
Dolayısıyla bir ekleme, çalışma alanının okuduğu kataloğun taşıdığı bir sürümü adlandırır. Bu sürüm, kendi yayını dışındaki bir aggrega yayını altında da katalogdan çözümlenir; yalnızca ikili dosyanın taşıdığı bir sürüm — kendi yayınının sürümü — ise yalnızca o yayınla çözümlenir; bu, hüküm rolünde de dönüştürme rolünde de aynıdır. Bir dönüştürme rolünde pull, çözümlediği sürümü kilit dosyasına sabitler ve ne çalışma alanının okuduğu bir kataloğun ne de ikili dosyanın taşıdığı bir sürümü E0103 ile reddeder. Sürüm motoru değil, plugin’in dışa aktarımlarını ve çalışma zamanı sınırlarını kaydeden Plugin varlığını seçer: başvuru çözümlendiğinde çalışan motor, derlemeyi çalıştıran ikili dosyaya derlenmiş olandır, çünkü ikili dosyaya yerleşik plugin’ler bir plugin’in modülünün okunduğu ilk yerdir. Çalışma alanının kendisinin bildirdiği bir yönetişim plugin’i — kendi katalog dizinindeki bir Plugin varlığı ve yanında .wasm dosyası — o varlığın kaydettiği sürümle adlandırılır.
Her rol varsayılan bir giriş işlevi seçer — grafiği değerlendiren rol için verdict_ir, işlenmiş yapıtları değerlendiren rol için verdict_render, etiket biçimlendiren rol için mutate, açıklama ekleyen rol için transform_annotations — ve bir bağlama, function: ile bir rolü farklı bir dışa aktarıma yönlendirebilir. Ana makine, misafirin describe() öz bildiriminde beyan etmediği bir dışa aktarıma yapılan çağrıyı reddeder; böylece misafirinin hizmet vermediği bir rolü belirten bir bağlama, sessizce hiçbir şey yapmak yerine misafir çalışmadan önce adıyla bildirilir.
function:, uri değerinin adlandırdığı eklentideki bir dışa aktarımı adlandırır. Bir karar rolündeki — ir-verdict ya da render-verdict — bir function: adlandıran ama uri: adlandırmayan bir ekleme, hiçbir eklentide olmayan bir işlevi adlandırır; bu nedenle yapılandırma okunurken E0224 altında, dosyayı ve girdinin listesindeki yerini adlandırarak reddedilir: işlevi dışa aktaran eklentinin uri değerini ekleyin.
plugins.governance listesinin ekleme yapan bir eşlikçisi vardır: plugins.governance_append. Eşlikçideki girdiler, her yapılandırma katmanında çözümlenmiş governance listesinin sonuna eklenir; böylece bir çalışma alanı ya da genel bir yapılandırma, temel listeyi gölgelemek yerine politika bağlamalarını birleştirir.
CI’ya ait katman
Elle yazılan .aggrega-config.yaml dosyasının yanında, otomatik bir işlem hattı ayrı bir katman dosyasına, .aggrega-config-append-ci.yaml dosyasına sahip olabilir. Bu dosya, bir işlem hattının denetlediği politikaları (veya liste değerli diğer yapılandırmaları) geliştiricinin elle yazdığı temel yapılandırmayı hiç düzenlemeden bağlayabilmesi için vardır — işlem hattı kendi katman dosyasının tamamının üzerine yazabilir.
Katman yalnızca ekleme yapar. Temel dosyayla aynı yapılandırma şemasına göre doğrulanır ve liste değerli her alan için girdileri çözümlenmiş listenin sonuna eklenir. Yalnızca ekleyebilir: bir temel girdiyi kaldıramaz ve bir temel değeri skaler olarak geçersiz kılamaz — içerdiği bir skaler ya da eşleme anahtarının ekleme anlamı yoktur ve uygulanmak yerine yok sayılır (ve bir çözümleme uyarısında adıyla belirtilir). Ayrıca hiçbir zaman bir çalışma alanı kökü belirlemez: bunu yalnızca workspace: bloğu içeren bir .aggrega-config.yaml yapar; dolayısıyla katmanı bir dizine bırakmak, çalışma alanının nerede başladığını değiştirmeden bağlamalar ekler.
Bu, bir işlem hattına kuruluş genelinde politika uygulamak için temiz bir bağlantı noktası sağlar: işlem hattı, zorunlu politika eklentilerini belirten bir .aggrega-config-append-ci.yaml bırakır ve bu bağlamalar, geliştiricinin yazdıklarının yerine değil, her zaman üzerine birleştirilir.
# .aggrega-config-append-ci.yaml — owned by the pipeline, additive onlyplugins: governance_append: - uri: <organization-policy-plugin-reference> role: render-verdict with: settings: required_label: app.kubernetes.io/nameexamples/policy-org-overlay/, bir ekibin eklemesini, bir genel yapılandırma dosyasının governance_append öğesiyle eklenen bir kuruluşun eklemesini ve bu katman aracılığıyla eklenen bir işlem hattının eklemesini içeren tek bir çalışma alanını derler ve her birleşimin ne yazdırdığını ve tamamlanıp tamamlanmadığını denetler.
Bir politikayı derlemeyi denetlemeden önce test etmek
Rolünün yükünün taşımadığı bir yolu adlandıran bir Rego kuralı bir hata değildir: yol tanımsızdır, kural hiçbir zaman sağlanmaz ve derleme, politika ona izin vermiş gibi tamamlanır. Bu yüzden yeni bir politika halt düzeyini üç adımda hak eder: onu durdurmadan bildiren bir önem düzeyinde ekleyin, adlandırdığı her yolu rolünün aldığı yüke karşı denetleyin ve değerlendireceği derlemelerde ne bildirdiğini okuyun.
Aşağıdaki komutlar, .aggrega-config.yaml dosyası ekibin politikası yerine yeni bir politika ekleyen bir examples/policy-org-overlay/ kopyasında çalışır. Politika, yüksek erişilebilirliği kapalı çalışan bir veri deposunu reddetmek için tasarlanmıştır ve kuralı bir etiket şekillendirme politikasından kopyalanmıştır:
package datastores
import rego.v1
deny contains msg if { some id, node in input.graph.nodes node.labels["component.aggrega.ai/category"] == "datastore" input.graph.spec.infra_mapping[id].ha.enabled == false msg := sprintf("%v is a datastore running with high availability off", [id])}Bildirecek biçimde ekleyin. Politika deny altında toplar; bu varsayılan olarak derlemeyi durdurur. Yalnızca deny öğesini warn düzeyinde adlandıran bir translation, kararlarının her birini uyarı olarak bildirir ve derlemenin tamamlanmasına izin verir; info ise bunun yerine onları kaydeder. Politikanın kendisi uygulanacağı haliyle kalır:
plugins: governance: - uri: governance/rego:0.9.0 role: ir-verdict with: sources: - policies/datastore-ha.rego settings: translation: - key: deny severity: warnYükü yazın ve yolları onun içinde arayın. Bir derleme Release’in kilit dosyasını doldurduktan sonra,
aggrega build --release release.yaml --dry-run --policy-input payloadskomutu, her rolün eklemelerine verdiği yükü payloads/ içine yazar ve başka hiçbir şey yazmaz; <workspace> derlemenin çalıştığı dizini temsil etmek üzere şunu bildirir:
policy input: 4 file(s) written to <workspace>/payloads[… omitted: a lint notice about core/secret-value, the rendered files the run prints in place of writing them, the build's time, and the line saying only the policy inputs were written]Dört dosya annotation-transform.json, ir-verdict.json, label-transform.json ve render-verdict.json dosyalarıdır; hiçbir şey eklenmemiş bir rolün dosyası da yazılır, böylece bir politika herhangi bir yere eklenmeden önce rolüne karşı denetlenebilir. ir-verdict, label-transform ve annotation-transform rollerinde dosya, bir politikanın okuduğu input belgesidir; bu yüzden kurala güvenmeden önce, kuralın adlandırdığı her yol herhangi bir JSON aracıyla dosyadan okunabilir:
jq '.graph.nodes' payloads/ir-verdict.json# nulljq -c '.graph.spec.nodes | keys' payloads/ir-verdict.json# ["db","web"]jq -c '.graph.spec.infra_mapping.db.ha' payloads/ir-verdict.json# {"enabled":false,"read_replicas":0}Kuralın düğümleri orada değildir: input.graph.nodes, etiket şekillendirme rolünün onları taşıdığı yerdir; ir-verdict rolünde ise input.graph.spec.nodes konumundadırlar (bkz. Her rolün yükünün sunduğu şeyler). Dosya ayrıca düzeltilmiş kuralın neye karar vermesi gerektiğini de söyler: db bir veri deposudur, yüksek erişilebilirliği kapalıdır ve bildirilmelidir.
OPA kuruluysa bir Rego politikası aynı dosyaya karşı doğrudan değerlendirilir: opa eval -i payloads/ir-verdict.json -d policies/datastore-ha.rego 'data.datastores.deny'. Derleyicideki Rego motoru bağımsız bir uygulamadır, bu yüzden karar veren değerlendirme yine derlemedir: motorun uygulamadığı bir yerleşik işlev değerlendirilmek yerine derlemeyi durdurur.
render-verdict rolünde dosya, politikanın input belgesi değildir. İçindeki her yapıt path, content ve format taşır; bir kuralın okuduğu documents, politika motoru yükü aldığında içerikten ayrıştırılır, bu yüzden documents üzerindeki bir kural dosyada hiçbir şey bulmaz. O roldeki bir politika, motorun onları ayrıştırdığı yerde test edilir: bir sonraki adımın gösterdiği gibi bir derlemede.
Derleyin ve bildirdiklerini yükün söyledikleriyle karşılaştırın. Kopyalanmış yolla
aggrega build --release release.yaml --auto-pullkomut tamamlanır ve hiçbir şey bildirmez:
Pull complete: release.lock (entities=11, source_artifacts=0, external_inputs=0) notice: LINT: Feature "core/secret-value" at core/secret-value:1.0.0 declares property "origin" in both values: and infra: pillars (path: origin)[… omitted: the build's time and the line naming the dist/ directory it wrote]Yükte yüksek erişilebilirliği kapalı bir veri deposu var ve politika onun hakkında hiçbir şey söylemedi: hata bu sessizliktir ve derlemedeki başka hiçbir şey ona işaret etmez. Kural input.graph.spec.nodes okuduğunda aynı komut db öğesini bildirir ve tamamlanır:
policy plugin "rego" warning: db is a datastore running with high availability offPull complete: release.lock (entities=11, source_artifacts=0, external_inputs=0) notice: LINT: Feature "core/secret-value" at core/secret-value:1.0.0 declares property "origin" in both values: and infra: pillars (path: origin)[… omitted: the build's time and the line naming the dist/ directory it wrote]--dry-run eklemek aynı hükümleri bildirir ve hiçbir dist/ yazmaz; böylece döngü, çıktısını bozmadan bir çalışma alanı üzerinde çalışır.
CEL motoru için yazılmış aynı kural sessizce başarısız olmaz. Orada yükün taşımadığı bir anahtarı okumak bir değerlendirme hatasıdır; bu yüzden kopyalanmış yol, aynı translation ile eklenmiş policies/datastore-ha.cel içinde olduğunda,
{ "deny": input.graph.nodes .filter(n, input.graph.nodes[n].labels["component.aggrega.ai/category"] == "datastore" && input.graph.spec.infra_mapping[n].ha.enabled == false) .map(n, n + " is a datastore running with high availability off"),}komut warn düzeyinde bile derlemeyi durdurur. 1 ile çıkar ve son satırı politika dosyasını ve anahtarı adlandırır:
ir-verdict: plugin "governance/cel:0.9.0": call "verdict_ir": wasm: plugin "cel" call to verdict_ir: policy source "datastore-ha.cel" could not be evaluated: No such key: nodesBir render-verdict politikası da aynı biçimde test edilir. Aynı çalışma alanında, aynı translation ile render-verdict rolüne eklenmiş ve ana makinede bir port yayımlayan bir Compose hizmetini reddeden bir kural,
package published
import rego.v1
deny contains msg if { some artifact in input.artifacts some doc in artifact.documents some name, service in doc.services count(service.ports) > 0 msg := sprintf("%v publishes a port on the host", [name])}bunu yapan tek hizmeti bildirir:
policy plugin "rego" warning: web publishes a port on the host[… omitted: the pull's line, a lint notice about core/secret-value, the build's time and the line naming the dist/ directory it wrote]Ardından uygulayın. translation öğesini kaldırmak deny öğesini halt düzeyine döndürür ve db öğesini bildiren derleme artık onda durur, 1 ile çıkar ve hiçbir dist/ yazmaz:
[… omitted: the lines printed while the lockfile is resolved, which carry the refusal below once more, and a lint notice about core/secret-value][POLICY_ERROR E0005] policy plugin "rego" rejected the build: db is a datastore running with high availability off caused by: policy violationBildiren eklemenin her yerden aynı anda kaldırılması gerekmez. Bir yapılandırma dosyası eklemesinin translation öğesini warn düzeyinde tutarken bir işlem hattının katmanı aynı politikayı halt düzeyindeki deny ile ekleyebilir; examples/policy-org-overlay/ bir kuruluşun kuralını bu şekilde yayar: bir geliştiricinin derlemesinde bir uyarı, bir işlem hattının derlemesinde ise durmanın nedeni.
Politikayı CI’da, derleme çıktısı üzerinde çalıştırmak
Yukarıdaki her şey bir politikayı bir derlemenin içine bağlar. İkinci bir yol daha vardır ve soketten hiçbir şeye ihtiyaç duymaz: kendi aracınızı işlem hattında, derlemenin yazdığı dosyalar üzerinde çalıştırın.
Bu, bir derlemenin ürettiği çıktı sayesinde işler. Kubernetes ve Compose hedefleri
YAML yazar; Terraform hedefi yerel HCL ya da .tf.json biçiminde JSON yazar.
Bunlar, ekosistemin yapılandırma araçlarının zaten okuduğu biçimlerdir ve
aggrega build düz dosyaları bir dizine yazar; sarmalayıcı biçim, dizin
indeksi ya da açılacak bir şey yoktur. Bu nedenle YAML, JSON veya HCL okuyan bir araç,
bir derlemenin çıktısı üzerinde, bir kişinin elle yazdığı yapılandırma üzerinde çalıştığı gibi çalışır
ve Aggrega bunun için ne bir soket, ne bir plugin türü ne de bir yapılandırma anahtarı ekler.
Dolayısıyla mevcut bir kural külliyatının taşınması gerekmez. Kurallarınızı zaten Conftest, Kyverno CLI, kubeconform, Checkov veya OPA’da tutuyorsanız, bu kurallar bir Aggrega derlemesinin çıktısı üzerinde olduğu gibi çalışır ve onları değerlendiren araç, işlem hattınızın zaten kurduğu araçtır.
Her biri kendisini çağıran işlem hattı adımıyla ve gerçek derlemeler üzerinde ürettikleri her iki retle birlikte, kullanıma hazır iki kural betiği examples/policy-in-ci/ konumundadır. Bunlar yalnızca yq kullanır, bu nedenle hiçbir politika araç zinciri kurulu olmadan çalışırlar; gösterdikleri biçim (çıktı dizinini oku, karar ver, sorunlu yapıtları adlandırarak sıfır olmayan kodla çık) bu konumdaki her aracın aldığı biçimdir.
Bir kural hangi yola aittir
Her iki yol da birinci sınıftır ve bir çalışma alanı genellikle ikisini birden kullanır. Belirleyici olan, kuralın neyi görmesi gerektiği ve ne zaman harekete geçmesi gerektiğidir.
Şu durumlarda sokete bağlayın:
- derleme yapıtı hiç üretmemelidir. Bir
ir-verdictpolitikası, herhangi bir şey işlenmeden önce, statik analiz kapısında çalışır; bu nedenle orada bir durdurma hiçbir şey yazılmamış olarak bırakır: incelenecek, karantinaya alınacak veya yanlışlıkla uygulanacak bir çıktı dosyası olmaz. Bir işlem hattı denetimi zorunlu olarak dosyalar var olduktan sonra çalışır. - kural yalnızca derlemenin tuttuğu bilgilere ihtiyaç duyar.
ir-verdictrolü birleştirilmiş grafiği okur: düğümler, kenarlar ve bunların soketleri, doldurduğu yuvayla birlikte her bağlama, bir yazarın hangi değerleri hassas olarak bildirdiği, yönlendirme yolları. Bunların hiçbiri işlenmiş çıktıya taşınmaz (bir Kubernetes manifest’i bir değeri hangi soketin ilettiğini ya da bir kaynağa hangi Feature’ın katkıda bulunduğunu kaydetmez), bu nedenle topoloji veya köken hakkındaki bir kuralın tek bir yeri vardır, o da sokettir. - kural derleme nerede çalışırsa çalışsın geçerli olmalıdır. Bir yönetişim bağlaması çalışma alanı yapılandırmasında bulunur, bu nedenle işlem hattının derlemesine olduğu kadar bir geliştiricinin yerel derlemesine de uygulanır. Bir işlem hattı denetimi ise işlem hattının çalıştığı yerde uygulanır.
- kural derlemeyi yargılamak yerine biçimlendirmelidir. Bunu yalnızca bir dönüştürme rolü yapar ve yalnızca bir operatör onu bağladığı için yapar.
Şu durumlarda CI’da çalıştırın:
- kural zaten mevcuttur, ekibinizin çalıştırdığı ve incelediği bir araçta, o aracın zaten ayrıştırdığı bir biçim üzerinde. Onu soket politikası içeriği olarak yeniden ifade etmek, sonunda yeni bir kapsam getirmeyen bir iştir.
- kural, yapıtlarla hedefin onları alacağı biçimde ilgilidir: her dönüşümden sonraki,
uygulanan biçimdeki nihai dosya kümesi. Bu aynı zamanda
render-verdictrolünün konusudur, dolayısıyla yalnızca bu noktada iki yol aynı şeyi görür ve seçim diğer noktalara bağlıdır. - bulgu derleme için değil, bir inceleyici içindir. Yapıtları ve bulguları yan yana yayımlayan bir işlem hattı inceleyiciye ikisini birden verir; durdurulmuş bir derleme ise yalnızca bir ileti verir.
- denetim tek bir derlemenin ötesine uzanır: bu derlemenin çıktısını bir öncekiyle, bir kümenin canlı durumuyla ya da hiçbir derleme yükünün taşımadığı bir envanterle karşılaştırmak. Her iki karar rolündeki bir politika, bağlı olduğu derlemeyi görür ve gördüğü yalnızca odur.
Yollar birbiriyle yarışmaz, birlikte kullanılır: bir topoloji değişmezi derlemeyi
ir-verdict üzerinden durdurur ve aynı işlem hattı ardından ortamın mevcut yapıt
kurallarını o derlemenin yazdıkları üzerinde çalıştırır.
Çapraz başvurular
plugin-contract.md— soketin işlem hattındaki yeri, taşıdığı tipli kablo biçimleri ve her eklentinin içinde çalıştığı korumalı alan.plugin-developer-guide.md— eklenti yazma,describe()öz bildirimi ve yayımla → çek → derle yaşam döngüsü.../entities/plugin.md— bir eklentiyi kataloğa taşıyanPluginvarlığı.../cli/aggrega-build.md— soketi çalıştıran derleme komutu.../schema/other/aggrega-config.md—plugins.governanceekleme yüzeyi dahil, çalışma alanı yapılandırma şeması.../examples/policy-in-ci/— bir derlemenin çıktısı üzerinde çalıştırılabilen iki kural betiği ve her biri için işlem hattı adımı.../examples/policy-data-class-route/— rotalar üzerinde tek birir-verdictkuralı; Rego motoru, CEL motoru ve başvuru bağdaştırıcı konuğunun arkasındaki OPA için yazılmış, motor başına bir--configdosyasıyla derleme başına eklenmiş ve üçünün de her Release’te aynı sonuca ulaştığını denetleyen bir betikle birlikte.