Kuruluş çapında politika: bir ekibin kuralı, bir kuruluşun kuralı ve bir işlem hattının kuralı
Bir ekibin politikası, onun kuruluşunun politikası ve onun işlem hattının politikası tek bir derlemede birlikte çalışır; her biri kendi yapılandırma dosyasında eklenir. Ekip kuralını kendi çalışma alanında ekler; kuruluş her derlemeye bir kural ekler, işlem hattı da bir tane daha ekler ve hiçbiri ekibin dosyasını düzenlemez. Bir derleme kendisine uygulanan tüm dosyaları okur ve bu dosyaların taşıdığı her eklemeyi çalıştırır.
Kurallar üç karar önem düzeyinin hepsinde raporlanır: info ve warn derlemenin tamamlanmasına izin verir, halt ise onu durdurur. Bunlardan biri, kuruluşun kuralı, iki kez eklenir ve bir translation bloğu aracılığıyla her seferinde farklı bir önem düzeyinde raporlanır.
Ne oluşturur
| örnek | katalog Component’i | burada ne olduğu |
|---|---|---|
db | core/datastore/mariadb | mağazanın veritabanı |
web | core/devtool/adminer | db’ye bağlı bir veritabanı yönetim arayüzü |
Her ikisi de Docker Compose’a, dist/compose/docker-compose.yaml içine derlenir. Bir Aggregate, bir Manifest ve bir Release, release.yaml; hiçbiri bir politika adlandırmaz.
Üç dosya
| kim | dosya | bir derlemenin onu nasıl okuduğu | eklemenin yazıldığı yer |
|---|---|---|---|
| ekip | .aggrega-config.yaml | bu dizini çalışma alanı olarak işaretler, bu nedenle buradaki her derleme onu okur | plugins.governance |
| kuruluş | org/config.yaml | genel yapılandırma dosyası olarak, tek bir derleme için --config org/config.yaml ile adlandırılır | plugins.governance_append |
| işlem hattı | pipeline/.aggrega-config-append-ci.yaml | bu dizine kopyalandıktan sonra, işlem hattının katmanı olarak | plugins.governance_append |
Üç eklemenin hepsi, herhangi bir şey işlenmeden önce derleme grafiğini değerlendiren ir-verdict rolündeki Rego motorudur, governance/rego:0.9.0. 0.9.0, standart kütüphane kataloğundaki Plugin varlığının sürümüdür. Motorun kendisi CLI’ya derlenmiştir — aggrega plugin list, governance/rego’yu gömülü yerleşikler arasında listeler — bu nedenle buradaki hiçbir derleme bir eklenti getirmez.
Kuruluşun dosyası genel bir yapılandırma dosyasıdır. Bir makinede bir tane bulunur ve her derlemede okunur: varsayılan konumundan ya da AGGREGA_CONFIG ortam değişkeninin adlandırdığı dosyadan. --config <path> bunun yerine tek bir çalıştırma için bir dosya adlandırır ve çalışma alanının kendi dosyaları yine de onun üzerine okunur. Bir kuruluşta dosya, her geliştiricinin makinesinde ve her işlem hattında varsayılan konumda dururdu; burada org/ içinde durur ve onu okuması gereken derlemeler onu adlandırır. Genel dosyayı açıkça adlandırma, üç yolun hangi sırayla denendiğini açıklar.
İşlem hattının dosyası bir katmandır. Bir derleme, .aggrega-config.yaml’ı okuduğu dizinlerde, onun yanındaki .aggrega-config-append-ci.yaml’ı okur. Burada, bu dizinde çalıştırılan bir derlemenin onu okumadığı pipeline/ içinde tutulur, çünkü onu okuyan her derlemeyi durdurur; işlem hattının adımı onu içeri kopyalamaktır:
cp pipeline/.aggrega-config-append-ci.yaml .Her dosya ekler ve işlem hattının katmanı yalnızca ekler
Kuruluş da işlem hattı da eklemelerini, plugins.governance listesinin ekleme eşlikçisi olan plugins.governance_append altına yazar. Bir eşlikçi altındaki girdiler, her dosyanın kendi listeleri okunduktan sonra çözümlenmiş listeye eklenir; bu nedenle ekibin plugins.governance’ı ve kuruluşun girdisi birlikte çalışır ve hiçbir dosya diğerini adlandırmaz. Kuruluş plugins.governance’ın kendisini değil eşlikçiyi yazar, çünkü çalışma alanının dosyasındaki bir plugins.governance listesi genel dosyadakinin yerini alır: oraya yazılmış bir kuruluş kuralı ekibin listesi tarafından düşürülür ve derleme bununla ilgili hiçbir şey yazdırmaz. Bir listeyi değiştirmek yerine genişletme, her liste ayarı için eşlikçiyi listeler.
İşlem hattının katmanı yalnızca ekleyebilir. Bir liste ayarı için yazdığı şey diğer dosyaların çözümlediğine eklenir; hiçbir şey kaldırmaz ve auto_pull gibi tek bir değer tutan bir ayarı geçersiz kılmaz. Bu katman auto_pull: true taşır ve onu okuyan bir derleme anahtarı yok sayar ve bunu bir uyarıda belirtir. <workspace> derlemenin çalıştığı dizinin mutlak yolunu temsil ettiğinde, satır şöyledir:
warning: <workspace>/.aggrega-config-append-ci.yaml: ignoring non-additive key "auto_pull" (the CI-owned overlay is additive-only and cannot override the base config)Kurallar ve her birinin raporlandığı önem düzeyi
Bir Rego politikası her kararı bir karar anahtarı altında toplar ve anahtar, kararın raporlandığı önem düzeyini seçer. translation olmadan anahtarlar deny, warn ve audit’tir ve sırasıyla halt, warn ve info olarak raporlanır:
| önem düzeyi | derlemenin yaptığı |
|---|---|
halt | durur, 1 ile çıkar ve dist/ yazmaz |
warn | tamamlanır, mesajı yazdırır ve dist/ yazar |
info | tamamlanır, mesajı yazdırır ve dist/ yazar |
Ekibin kuralı, policies/team.rego, kararları warn altında toplar ve eklemesi hiçbir translation bildirmez, bu nedenle warn olarak raporlanır:
warn contains msg if { some id, node in input.graph.spec.nodes node.labels["component.aggrega.ai/category"] == "datastore" input.graph.spec.infra_mapping[id].ha.enabled == false msg := sprintf("%v runs with high availability off", [id])}Kuruluşun kuralı, org/policies/estate.rego, ayarlarının listelediği bir kategorideki bileşenleri reddeder ve her bileşenin ne çalıştırdığını kaydeder:
deny contains msg if { some id, node in input.graph.spec.nodes category := node.labels["component.aggrega.ai/category"] category in data.refused_categories msg := sprintf("%v runs %v, in the %v category, which the organization does not ship", [id, node.component, category])}
audit contains msg if { some id, node in input.graph.spec.nodes msg := sprintf("%v runs %v %v, upstream licensing %v", [id, node.component, node.resolved_version, node.labels["component.aggrega.ai/upstream-licensing"]])}refused_categories her eklemenin bir ayarıdır ve bir politika, eklemesinin ayarlarını data belgesi olarak okur.
Çeviri: tek kural, iki önem düzeyi
Bir eklemenin ayarlarındaki translation bloğu, hangi karar anahtarlarının okunacağını ve her birinin hangi önem düzeyinde raporlanacağını bildirir. Varsayılan eşlemeyi genişletmek yerine onun yerini alır: adlandırmadığı bir anahtar okunmaz.
Kuruluşun dosyası kuralını bir tavsiye olarak devreye alır. Eklemesi deny’ı warn olarak, audit’i info olarak raporlar:
settings: refused_categories: [devtool] translation: - key: deny severity: warn - key: audit severity: infoİşlem hattı aynı dosyayı ekler ve aynı kuralın derlemeyi durdurmasını sağlar. Çevirisi yalnızca deny’ı adlandırır, bu nedenle eklemesi audit kayıtlarını ikinci kez raporlamaz:
settings: refused_categories: [devtool] translation: - key: deny severity: haltBöylece tek bir kural, aynı web üzerinde, bir geliştiricinin derlemesinde bir uyarıdır ve bir işlem hattının derlemesinin durma nedenidir.
Örneği oluşturun
Bu örneği aşağıdaki komutlarla derleyebilir ya da yapay zekâ asistanınıza sizin için derletebilirsiniz.
Örneği, adını taşıyan yeni bir klasöre yazın:
aggrega scaffold --example policy-org-overlayArdından sırada çalıştırılacak komutları yazdırır. İlki yeni klasöre geçer:
cd policy-org-overlayDerleme
Standart kütüphane kataloğu Components, Recipes, Feature ve onun FeatureRecipe’ini sağlar. Bunlar, .aggrega-config.yaml dosyasının adlandırdığı varsayılan kayıt defteri olan hub.aggrega.ai üzerinden çözümlenir. Kataloğun bir çalışma kopyası (nereden edinilir) --catalog ile belirtildiğinde hiçbir şey bir kayıt defterinden getirilmez, bu nedenle derlemeler çevrimdışı çalışır. --auto-pull derleme sırasında kilit dosyasını doldurur; kilit dosyası ve işlenmiş çıktı üretilir, gönderilmez.
Yalnızca ekibin dosyasıyla:
aggrega build --release release.yaml --auto-pullderleme ekibin uyarısını yazdırır ve tamamlanır. Kuruluşun dosyasıyla birlikte:
aggrega build --release release.yaml --auto-pull --config org/config.yamlekibin uyarısının yanında kuruluşun kayıtlarını info olarak ve kuralını warn olarak yazdırır ve yine de tamamlanır:
info: policy plugin "rego": db runs core/datastore/mariadb 1.0.0, upstream licensing osi-approved info: policy plugin "rego": web runs core/devtool/adminer 1.0.0, upstream licensing osi-approved policy plugin "rego" warning: db runs with high availability off policy plugin "rego" warning: web runs core/devtool/adminer, in the devtool category, which the organization does not shipPull 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]Her karar, onu ekleyen dosyayı değil, onu raporlayan eklentiyi, rego’yu adlandırır; bu nedenle ekibin uyarısı ile kuruluşunki aynı görünür. Kuruluşunki gibi, kuralın kime ait olduğunu söyleyen bir mesaj, onları ayırt etmenin yoludur.
İşlem hattının katmanı içeri kopyalandığında aynı komut durur:
cp pipeline/.aggrega-config-append-ci.yaml .aggrega build --release release.yaml --auto-pull --config org/config.yaml[… omitted: the overlay's warning shown above][… omitted: the lines printed while the lockfile is resolved, which carry the verdicts below once more, the refusal among them] info: policy plugin "rego": db runs core/datastore/mariadb 1.0.0, upstream licensing osi-approved info: policy plugin "rego": web runs core/devtool/adminer 1.0.0, upstream licensing osi-approved policy plugin "rego" warning: db runs with high availability off policy plugin "rego" warning: web runs core/devtool/adminer, in the devtool category, which the organization does not ship notice: LINT: Feature "core/secret-value" at core/secret-value:1.0.0 declares property "origin" in both values: and infra: pillars (path: origin)[POLICY_ERROR E0005] policy plugin "rego" rejected the build: web runs core/devtool/adminer, in the devtool category, which the organization does not ship caused by: policy violationDerleme 1 ile çıkar ve dist/ yazmaz. Kuruluşun kuralı her ekleme tarafından birer kez olmak üzere iki kez raporlanır: kuruluşunki tarafından warn olarak ve işlem hattınınki tarafından halt olarak. audit kayıtları yalnızca kuruluşun eklemesinden olmak üzere bir kez görünür. Onsuz yeniden derlemek için .aggrega-config-append-ci.yaml’ı bu dizinden kaldırın.
Bir yapay zekâ asistanıyla
Aggrega araçlarıyla kurulmuş bir yapay zekâ asistanı da aynısını yapabilir: bu istemi ona yapıştırın.
Yalnızca Aggrega araçlarını kullanın ve kendiniz hiçbir klasör oluşturmayın. Workspace klasöründe henüz `policy-org-overlay` klasörü yoksa, `scaffold` aracını `example` değeri `policy-org-overlay` olacak şekilde ve `dir` olmadan bir kez çağırın: örneği yeni bir `policy-org-overlay` klasörüne yazar. Ardından `build` aracını `workspace_root` değeri `policy-org-overlay`, `release` değeri `release.yaml`, `auto_pull` değeri true ve `write` değeri true olacak şekilde çağırın ve politikanın ne bildirdiğini bana söyleyin. Sonra `aggrega build` komutunu çalıştıran ve onun `--config` bayrağını alan `cli-build` aracını `workspace_root` değeri `policy-org-overlay`, `release` değeri `release.yaml`, `auto_pull` değeri true ve `config` değeri `org/config.yaml` olacak şekilde çağırın ve politikanın bu kez ne bildirdiğini bana söyleyin. Her derlemenin hangi dosyaları yazdığını bana söyleyin; bunlar `policy-org-overlay/dist/` altındadır.Her derlemenin denetlenmesi
Bu öz denetim, kullandığı ortak derleme yardımcı betiğini barındıran belgelendirme deposunun bir çalışma kopyasında çalışır; aggrega scaffold --example tarafından yazılan bir kopya bu yardımcı betiği içermez.
./check.shcheck.sh, build-release yardımcısı aracılığıyla release.yaml’ı beş kez derler, her birini bu çalışma alanının bir kopyasında: yalnızca ekibin dosyasıyla, --config ile adlandırılan kuruluş dosyasıyla, işlem hattının katmanı içeri kopyalanmış olarak, her ikisiyle ve eklemesini eşlikçi yerine plugins.governance altına yazan kuruluş dosyasının bir kopyasıyla — bu durumda ekibin listesi onun yerini alır ve yalnızca ekibin kararı yazdırılır. Her biri için çıkış durumunu, dist/’in yazılıp yazılmadığını ve derlemenin yazdırdığı her kararı — önem düzeyini ve mesajını, eksiksiz ve fazlasız — ve katmanın okunduğu yerde auto_pull’u adlandıran uyarıyı denetler. Her derleme için bir satır, ardından her birinin yazdırdığı kararları yazdırır ve herhangi bir sonuç farklıysa o derlemenin çıktısını yazdırarak 1 ile çıkar:
LAYERS EXIT DIST VERDICT----------------------------------------------------------------------------------------------------team 0 yes OKteam + organization 0 yes OKteam + pipeline 1 no OKall three 1 no OKteam + organization, plugins.governance 0 yes OK
team: warn db runs with high availability off
team + organization: info db runs core/datastore/mariadb 1.0.0, upstream licensing osi-approved info web runs core/devtool/adminer 1.0.0, upstream licensing osi-approved warn db runs with high availability off warn web runs core/devtool/adminer, in the devtool category, which the organization does not ship
team + pipeline: ignored auto_pull warn db runs with high availability off halt web runs core/devtool/adminer, in the devtool category, which the organization does not ship
all three: ignored auto_pull info db runs core/datastore/mariadb 1.0.0, upstream licensing osi-approved info web runs core/devtool/adminer 1.0.0, upstream licensing osi-approved warn db runs with high availability off warn web runs core/devtool/adminer, in the devtool category, which the organization does not ship halt web runs core/devtool/adminer, in the devtool category, which the organization does not ship
team + organization, plugins.governance: warn db runs with high availability off
check: every build ended as expected.Kopyalar geçici bir dizinde oluşturulur ve .aggrega-config.yaml dosyalarındaki katalog yolu oradan da çözümlenebilmesi için mutlak yapılır; bu dizindeki hiçbir dosya düzenlenmez veya yazılmaz. ./build-release.sh’ın çözümlediği ikili dosyayı kullanır, dolayısıyla onu AGGREGA_BIN seçer ve -- sonrasındaki argümanlar her derlemeye ulaşır. Çıkış durumu kararın tamamıdır.
Derleyicinin yorumlamadığı yerler
Derleyici üç dosyayı okur, taşıdıkları eklemeleri art arda ekler, her politikaya derleme grafiğini ve ayarlarını verir ve her kararın raporlandığı önem düzeyine göre hareket eder. Bir devtool’un ne olduğunu, bir kuruluşun neden onu göndermeyeceğini ya da yüksek erişilebilirliğin bir ekip için önemli olduğunu bilmez: bu anlamlar politikaların kuralları ve ayarlarıdır. Roller, yükler ve karar anahtarları için yönetişim soketine bakın.
Dosyalar
aggregate.yaml— veritabanı ve ona bağlanmış yönetim arayüzü.manifest.yaml— her bileşen türünü ve gizli bilgi Feature’ını kendi Docker Compose Recipe’ine bağlar.release.yaml— tek Release..aggrega-config.yaml— ekibin dosyası: varsayılan kayıt defteri ve ekibin eklemesi.policies/team.rego— ekibin kuralı.org/config.yaml— kuruluşun genel yapılandırma dosyası ve eklemesi.org/policies/estate.rego— kuruluşun kuralı.pipeline/.aggrega-config-append-ci.yaml— işlem hattının katmanı; bu dizine kopyalandığında okunur.build-release.sh— Release’i derler ve eşdeğeraggrega buildkomutunu yazdırır.check.sh— beş derlemeyi yapar ve her sonucu denetler.