Çalıştırılabilir örnekler
Başlamak için Başlarken Aggrega’yı kurar ve bu örneklerden ikisini adım adım izler.
aggrega CLI ile derleyebileceğiniz, eksiksiz ve çatallanabilir çalışma alanları. Her biri kendi kendine yeten bir dizindir — bir geliştiricinin yazdığı bir Aggregate ve bir veya daha fazla Release/Manifest çifti — ve sayfasının belirttiği dışında hiçbir kurulum gerektirmeden derlenir. Birini dağıttığı ürüne veya gösterdiği şeye göre bulmak için buradaki tüm örnekleri listeleyen Ürüne ve yeteneğe göre örnekler sayfasını kullanın.
Örnekler iki kipte gelir — tek bir müfredatın iki ucu:
-
Tüketim — çalışma alanı standart kütüphane katalog varlıklarına başvurur ve yerel olarak yalnızca kendi öğretime özgü içeriğini yazar. Hiçbir
--catalogbayrağı olmadan derlenir:Terminal window aggrega build --release release.yamlBaşvurulan bu varlıkların nereden okunduğu çalışma alanına bağlıdır. Çalışma alanı kökündeki bir
catalog/dizini, onu bir şeyin adlandırıp adlandırmadığına bakılmaksızın okunur; bu nedenle kendi öğretim içeriğini yazan bir çalışma alanı onu doğrudan orada tutabilir. Bir.aggrega-config.yamltaşıyan çalışma alanı ayrıcacatalog_dirsaltında listelenen her dizini okur; bunların her biri varlık tuttuğu bir dizindir. Listelenen dizinler önce,catalog/ise en son aranır ve yığın ilk bulunanın kazandığı biçimde çalışır; dolayısıyla daha önce aranan bir dizindeki varlık, sonrakindeki aynı kimlikli varlığı gölgeler. Hiçbir yerel dizinin bildirmediği şey — standart kütüphane varlıkları — yapılandırmanındefault_registryolarak adlandırdığı kayıt defterinden,hub.aggrega.ai’den çözümlenir. Yerel olarak hiçbir şey yazmayan bir çalışma alanı yerel bir girdiye ihtiyaç duymaz; necatalog/dizini ne de.aggrega-config.yamltaşıyan bir çalışma alanı ise tamamen yapılandırılmış kayıt defteri üzerinden çözümlenir.catalog_dirsdeğerini boş bir liste olarak yazmak, çalışma alanının hiç yerel kataloğu olmadığını belirtir.catalog_dirsiçindeki her yol çalışma alanının içindeki bir dizini adlandırır; bu nedenle tüm çalışma alanının başka bir yere alınan bir kopyası olduğu gibi derlenir.Her hedef için ayrı bir katalog tutan çok hedefli bir çalışma alanı, her hedefin dizinlerini Release dosyasıyla anahtarlanmış olarak
workspace.releasesaltında adlandırır; böylece her Release kendi kataloğuna karşı derlenir. -
Yazım — çalışma alanı katalog varlıklarını (Components, Features, Recipes) yerel
catalog-*/dizinlerinde sıfırdan oluşturur.mariadb-adminerişlenmiş yazım örneğidir; oluşturduğu varlıklar, tüketim örneklerinin tükettikleriyle aynı türdendir.
Her çalıştırmada aggrega build --release <release file> ile bir release derleyin; her örneğin sayfası kendi komutlarını verir. Çalışma alanı kataloğunu yukarıda açıklandığı gibi sağlar; çalışma alanının adlandırmadığı bir katalog dizini için --catalog’u kendiniz geçirin, buna gerek duyan sayfalar bunu gösterir.
Kilit dosyaları birlikte gönderilmez, üretilir; bu nedenle yeni bir klonda hiç kilit dosyası yoktur ve ilk derlemenin bir taneye ihtiyacı vardır. aggrega build varsayılan olarak salt okunurdur: kilit dosyası yoksa durur ve ilerlemenin iki yolunu belirtir. O ilk derleme için --auto-pull geçirin — aggrega build --release release.yaml --auto-pull — böylece kilit dosyası derleme sırasında çözümlenir; önceden bir kez aggrega pull --release <release file> çalıştırmak da aynı işi yapar ve sonraki her derlemenin bayraksız çalışmasını sağlar.
Belgelendirme deposunun bir çalışma kopyasında çoğu çalışma alanı ayrıca, deponun kendi denetimlerinin derlerken kullandığı bir build-release.sh yardımcı betiği taşır. Bu betik bir release için aggrega build’i çalıştırır, önce komutu yazdırır ve hangi aggrega ikili dosyasını kullandığını ve bu dosyanın nereden geldiğini bildirir; ikili dosyayı seçmek için AGGREGA_BIN’i ayarlayın. aggrega scaffold --example tarafından yazılan bir kopya yardımcı betiği taşır ama onun çağırdığı ortak betiği içermez; bu nedenle böyle bir kopyayı doğrudan aggrega build ile derleyin.
Buradaki bir örnek standart kütüphane kataloğunun bir çalışma kopyasından söz ettiğinde, İçe aktarma bunun nereden edinileceğini anlatır.
Bunlar, Örneklere genel bakış içinde açıklanan kavram sayfalarını tamamlar: bir kavram sayfası tek bir fikri açıklar ve onu gösteren çalışma alanına bağlantı verir; buradaki çalışma alanları ise derleyebileceğiniz, okuyabileceğiniz ve uyarlayabileceğiniz bütün yığınlardır.
Bir sayfa bir derlemenin ne ürettiğini gösterdiğinde, o blok gerçek bir çalıştırmadan kopyalanmıştır; böylece kendi çıktınızı onunla karşılaştırabilirsiniz — ve çıkarılan satırlar işaretlenir. Bu sayfalardaki çıktıyı okumak bu uzlaşımı ve kullandığı işareti açıklar.
Buradaki her dizin tek bir çalışma alanı değildir. Hızlı başlangıç örnekleri her adım için bir çalışma alanı, içe aktarma örnekleri ise bir içe aktarmanın her aşaması için bir çalışma alanı içerir; bir sonraki paragraf bunu açıklar. Bir dizin hiç çalışma alanı içermez: policy-in-ci, bir derlemenin çıktı dizinini okuyan ve bir kuralı ihlal ettiğinde onu reddeden iki kural betiğini, her biri için işlem hattı adımıyla birlikte içerir. Bu betikler buradaki çalışma alanlarının çıktıları üzerinde ve sizinkiler üzerinde çalışır.
Her import-* örneği — Ürüne ve yeteneğe göre örnekler sayfasında import yeteneği altında listelenir — başka bir biçimde yazılmış bir projeyi, aggrega import onunla karşılaştığı hâliyle iki klasörde tutar: source/, proje, onu bir çalışma alanı yapan .aggrega-config.yaml ve içe aktarmanın hiçbir kaynağın tutamayacağı değerleri okuduğu yanıt dosyası; ve draft/, içe aktarmanın yazdığı dosyalar, değiştirilmeden, yazıldığı gibi derlenebilen bir çalışma alanı, standart çıktıya (stdout.txt) ve standart hataya (import.txt) yazdırdıklarıyla birlikte. İçe aktarma altındaki adım adım kılavuzu her aşamayı öğretir. check.sh dosyası bu deponun ortak scripts/check-import-example.sh betiğini çalıştırır; bu betik yeniden içe aktarır, yazdığını ve yazdırdığını draft/ ile, kılavuzun alıntıladığı blokları da örneğin dosyalarıyla karşılaştırır, ardından taslak olarak yazılan Release’i doğrular ve derler.
Öğretim sırası
Buradaki her örneğin, başlığındaki tier ve position ile belirlenen tek bir öğretim sırasında bir yeri vardır: katman listesinin verdiği sırayla katman katman ve her katman içinde en basitten başlayarak. Öğretim sırasına göre her örneği bu şekilde listeler ve kenar çubuğunun Örnekler bölümü de aynı sırayı izler. Katmanları yukarıdan aşağıya okuyun ya da yaptığınız işe uyan katmana geçin; bir örneği bunun yerine neyi dağıttığına ya da neyi gösterdiğine göre bulmak için aynı sayfa örnekleri ürüne ve yeteneğe göre listeler.
Bir derleme, işlediği şey üzerinde eklentiler de çalıştırabilir — bkz. Bir işlem hattı adımına ne zaman başvurulmalı.
Her örneğin üst bilgisi
Her örneğin README dosyası, YAML ön bilgisi olarak yazılmış kısa bir üst bilgiyle açılır ve örneğin ne olduğunu söyler: düzeyi, öğretim sırasındaki yeri, dağıttığı ürünler ve gösterdikleri. Ürüne ve yeteneğe göre örnekler bu üst bilgilerden üretilir.
---example: level: start tier: catalog-only position: 1 products: [core/datastore/mariadb, core/devtool/adminer] shows: [connections, credentials]---level, bu düzeylerden biridir:
start— “Yalnızca katalog” düzeyi: katalog varlıklarından bir araya getirilir; Aggregate, Manifest ve Release dışında hiçbir şey yazılmaz.authoring— “Yazım” düzeyi: bir Component, bir Feature ya da bir Recipe yazar veya birinin nasıl şekillendiğini gösterir.advanced— “İleri” düzey: sınırlar, yönetişim politikası, ek açıklama güdümlü Features ve bir araya getirilmiş bulut yığınları.
tier, örneğin ait olduğu öğretim sırası bölümüdür; bu sırayla öğretilen şu kademelerden biridir:
start-here— Buradan başlayın: “Başlarken” kılavuzunun adım adım büyüttüğü iki örnek, ardından bulut için iki başlangıç örneği.catalog-only— Yalnızca katalog: katalog varlıklarından bir araya getirilir; Aggregate, Manifest ve Release dışında hiçbir şey yazılmaz.authoring— Yazma: kendine ait bir Component, Feature ya da Recipe yazar veya bunların nasıl biçimlendiğini gösterir.advanced— İleri düzey: sınırlar, yönetişim politikası, ek açıklama güdümlü Features ve bir araya getirilmiş bulut yığınları; bunların birkaçı tek bir derlemede birleştirilir.importers— İçe aktarıcılar: başka bir biçimde yazılmış bir proje,aggrega importile Aggrega dosyalarına taslak olarak aktarılır, ardından incelenir ve derlenir.
position, örneğin kademesi içindeki yeridir; o kademedeki başka hiçbir örneğin almadığı pozitif bir tam sayıdır. Bir kademe örneklerini en düşük konumdan yukarıya doğru, en basitten başlayarak listeler.
products, örneğin dağıttığı her katalog Component’ini, katalog girdisinin taşıdığı adla listeler. Genel bir işlem bileşeni (örneğin core/compute/server) ve örneğin kendisi için bildirdiği bir varlık listelenmez; bu yüzden bir örnek hiçbirini listelemeyebilir.
shows, örneğin gösterdiklerini listeler; her girdi bu listeden alınır:
multi-target— iki veya daha fazla hedef için derlenen ya da iki veya daha fazla şekilde gerçekleştirilen tek bir Aggregate.recipe-selection— bir bileşeni hangi Recipe’in ya da bir eki hangi FeatureRecipe’in gerçekleştireceğini Manifest’in seçmesi: tür başına, örnek başına veya hedef başına.modules— modül olarak içe aktarılan bir katalog Aggregate’i.connections—usessoketleri aracılığıyla bağlanan ve değerleri her kenar boyunca aktarılan bileşenler.credentials— kimlik bilgisi ekleri ve her hedefin bunları nasıl teslim ettiği.parameters— bir Release’in karşıladığı parametrelere yukarı taşınan değerler.features— yönlendirme, izleme, bütçe, önbellek veya maskeleme gibi, kimlik bilgisi dışında bir amaçla eklenen Features.boundaries— sınırlara yerleştirilen bileşenler veya modüller ve bunlar arasında geçenler.policy— derleme sırasında ya da çıktısı üzerinde bir derlemeyi kabul eden veya reddeden yönetişim politikası.guardrails— durması amaçlanan bir Release ve durduğunda verdiği ileti.catalog-authoring— örnek için yazılmış, yanında tutulan ya da kataloğa yayımlanan bir Component, Feature veya Recipe.cloud-infrastructure— yönetilen bulut hizmetleri için Terraform veya CloudFormation çıktısı.external-sources— işlediği şeyi getiren bir Recipe: bir yukarı akış chart’ı, bir git deposu veya bir modül.import— başka bir biçimde yazılmış,aggrega importile Aggrega dosyalarına taslak olarak aktarılmış, ardından incelenip derlenmiş bir proje.
Bir örnek, dizinin onu yerleştirebilmesi için en az bir ürün veya bir yetenek listeler. README dosyası ayrıca ilk komut bloğunda aggrega scaffold --example <name>, ikincisinde cd <name> bulunan bir ## Scaffold the example bölümü taşır; bu bölümü doğrudan, ilk komut bloğu aggrega scaffold --example komutunun o cd’den sonra çalıştırılmak üzere yazdırdığı şey olan bir ## Build bölümü izler. Bu deponun kökünden çalıştırılan scripts/gen-examples-index.sh --check, her üst bilgiyi bu listelere göre denetler, iki bölümden herhangi biri eksik olan bir örneği ve ne yürütülebilir bir check.sh ne de bir build-release.sh içeren bir örneği reddeder ve dizinin güncel olduğunu doğrular; dizini yeniden yazmak için onu --check olmadan çalıştırın.