Schemat grafu Aggrega agnostycznego wobec możliwości (IR)
Dokumentacja wygenerowana automatycznie. Nie należy jej edytować ręcznie — należy ją wygenerować ponownie z opublikowanego JSON Schema.
Identyfikator schematu: https://aggrega.ai/schemas/ir-v1beta1.schema.json
Spłaszczony, w pełni rozwiązany jednowymiarowy graf emitowany przez Topology Builder.
Typ najwyższego poziomu: object
Właściwości
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
apiVersion | const “aggrega.ai/v1beta1” | tak | Stała: "aggrega.ai/v1beta1" |
kind | const “IR” | tak | Stała: "IR" |
metadata | IRMetadata | tak | Tożsamość grafu: encja Aggregate, z której został zbudowany. |
spec | IRSpec | tak | Sam graf: jego węzły, krawędzie i ładunki kluczowane według węzła. |
Dodatkowe właściwości są niedozwolone.
Definicje
Maintainer
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
name | string | tak | Imię i nazwisko opiekuna. |
email | string | nie | Adres e-mail opiekuna. |
url | string | nie | Adres strony internetowej opiekuna. |
FieldProvenance
Pochodzenie jednego liścia w ładunku values lub infra załącznika.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
origin | string | tak | Czy liść został napisany jawnie, czy dodany przez przebieg rozwijania sterowany adnotacjami. |
side | string | nie | Powierzchnia autorska, na której zadeklarowano adnotację; nieobecna dla liści jawnych. |
annotation_key | string | nie | Nazwa adnotacji, która dodała ten liść; nieobecna dla liści jawnych. |
annotation_source | string | nie | Lokalizacja deklaracji adnotacji w źródle w postaci |
overridden_annotation | FieldProvenance | nie | Wkład adnotacji, który przegrał ten liść na rzecz liścia jawnego: gdy jawny liść nadpisał liść dodany przez adnotację, jest to zastąpione pochodzenie, które on wyparł. Liczba pojedyncza — zachowywany jest zawsze dokładnie jeden wyparty wkład. |
Dodatkowe właściwości są niedozwolone.
AttachmentConnection
Połączenie, do którego należy załącznik, w przypadku załącznika zapisanego na połączeniu, które rysuje komponent, a nie we własnym bloku załączników komponentu: gniazdo, przez które połączenie jest podłączone, i alias, pod którym jest zapisane. Ta para wskazuje jedną z krawędzi grafu — krawędź, której źródłem jest węzeł niosący załącznik, a gniazdem i aliasem są te właśnie wartości — dzięki czemu konsument łączy załącznik z tą krawędzią, a przez nią z celem, któremu załącznik jest przedstawiany.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
socket | string | tak | Gniazdo, przez które połączenie jest podłączone: gniazdo krawędzi, do której należy załącznik. |
alias | string | tak | Alias, pod którym połączenie jest zapisane: alias krawędzi, do której należy załącznik. |
Dodatkowe właściwości są niedozwolone.
IRFeatureEntry
Jeden rozwiązany załącznik węzła, przenoszony w feature_values_mapping. Każda rodzina załączników ma ten sam kształt — operacyjny Feature, Feature poświadczeń, Feature tożsamości — więc żadna rodzina nie otrzymuje bardziej stratnej projekcji niż inna. To, co niosą values załącznika poświadczeń, zależy od wyboru autora: poświadczenie przez referencję niesie wskaźnik do magazynu sekretów, poświadczenie przez wartość niesie sam materiał, a kompilator przenosi dosłownie to, co zapisano, nie rozwiązując żadnego z nich.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
type | string | tak | URI encji Feature z katalogu, której żąda ten załącznik. |
resolved_version | string | tak | Dokładna wersja semantyczna rozwiązana podczas kompilacji. |
labels | mapa string | nie | Etykiety katalogowe dołączonej encji Feature, przenoszone dosłownie w kolejności, w jakiej deklaruje je encja katalogu — nigdy niefiltrowane, nienormalizowane ani pozbawiane prefiksów, więc konsument odczytuje dokładnie to, co napisał autor katalogu. Kompilator nie odczytuje żadnej z nich. Nieobecne, gdy Feature nie deklaruje etykiet oraz gdy jego typ nie rozwiązuje się do żadnej encji katalogu. |
catalog_annotations | mapa string | nie | Adnotacje katalogowe dołączonej encji Feature — metadata.annotations encji Feature wskazanej przez ten załącznik — przenoszone dosłownie w kolejności, w jakiej deklaruje je ta encja, nigdy niefiltrowane, nienormalizowane ani pozbawiane prefiksów, więc konsument odczytuje dokładnie to, co napisał autor katalogu, łącznie z kluczami we własnej przestrzeni nazw autora. Kompilator nie odczytuje żadnej z nich. Należy je odróżnić od annotation_key i annotation_source, które nazywają i lokalizują adnotację, z powodu której ten załącznik w ogóle istnieje: tamte dwa pola informują, jak powstał załącznik, to pole podaje metadane encji, którą on wskazuje, a załącznik zapisany w bloku features: niesie te adnotacje, nie niosąc żadnego z tamtych pól. Nieobecne, gdy Feature nie deklaruje adnotacji oraz gdy jego typ nie rozwiązuje się do żadnej encji katalogu. |
binding | string | nie | Nazywa slot załącznika, który wypełnia ten załącznik, albo „free”, gdy nie wypełnia on żadnego zadeklarowanego slotu. Slot deklaruje się w jednym z dwóch miejsc, a o tym, w którym, decyduje miejsce zapisania załącznika: załącznik z własnego bloku załączników węzła wypełnia slot, który encja Component hosta deklaruje w swoim featuresSchema, a załącznik zapisany na połączeniu wypełnia slot, który gniazdo połączenia deklaruje w featuresSchema tego gniazda w encji Component hosta. W obu przypadkach dopasowanie odbywa się po nazwie — załącznik wypełnia slot, gdy Feature jest dołączony pod nazwą slotu, w bloku komponentu lub na połączeniu — więc wartość jest dokładnym kluczem ze zbioru zadeklarowanych slotów, nigdy niczym odczytanym z klucza załącznika. Zbiór slotów gniazda jest zamknięty, ponieważ załącznik zapisany na połączeniu pod nazwą, której gniazdo nie deklaruje, zatrzymuje kompilację, więc załącznik niosący połączenie nigdy nie zgłasza free. Przenoszona jest nazwa slotu, a nie sama wartość logiczna, ponieważ to, który slot został wypełniony, jest bardziej użyteczną połową odpowiedzi. Puste, gdy nie udało się rozwiązać zbioru zadeklarowanych slotów encji Component hosta, co różni się od „free”: free to pozytywne ustalenie, że żaden zadeklarowany slot nie nosi tej nazwy. |
values | object | nie | Ładunek konfiguracji operacyjnej załącznika. W przypadku poświadczenia — ta forma, którą zadeklarował autor: wskaźnik do magazynu sekretów albo sam materiał. |
infra | object | nie | Fizyczne wymiarowanie tego załącznika dla każdej instancji. |
inject | object | nie | Agnostyczne trasowanie wstrzykiwania. Mapuje zmienne lokalne na klucze provides celu. |
origin | string (enum) | nie | Odróżnia załączniki napisane w bloku features: (explicit) od syntetycznych załączników wytworzonych przez przebieg rozwijania sterowany adnotacjami (annotation) lub wskazuje mixed, gdy liście value/infra załącznika niosą mieszankę obu (szczegóły dla poszczególnych liści znajdują się wtedy w mapach pochodzenia). Dozwolone wartości: "explicit", "annotation", "mixed" |
annotation_key | string | nie | Nazwa adnotacji, która wywołała syntetyczny załącznik. Nieobecne, gdy origin ma wartość explicit. |
annotation_source | string | nie | Lokalizacja deklaracji adnotacji w źródle w postaci |
values_provenance | mapa FieldProvenance | nie | Pochodzenie każdego liścia ładunku values, z kluczami w postaci ścieżki liścia rozdzielanej kropkami. |
infra_provenance | mapa FieldProvenance | nie | Pochodzenie każdego liścia ładunku infra, z kluczami w postaci ścieżki liścia rozdzielanej kropkami. |
sensitive | logiczna | nie | Prawda, gdy ten załącznik obsługuje materiał, który autor zadeklarował jako wrażliwy — albo dołączony Feature deklaruje wrażliwy liść w swoim filarze values, infra lub provides, albo slot wypełniany przez załącznik deklaruje niesiony materiał jako wrażliwy: slot załącznika encji Component hosta o tej samej nazwie lub, w przypadku załącznika zapisanego na połączeniu, slot o tej nazwie deklarowany przez gniazdo połączenia. Wyprowadzane z tych deklaracji na scalonym załączniku, nigdy z treści wartości ani z nazwy. Nieustawione, gdy nie ma żadnej z tych deklaracji. |
sensitive_inject | mapa map typu string | nie | Klucze dostarczania inject, których wskazany klucz provides dołączony Feature deklaruje jako wrażliwy, w kształcie samego inject: mechanizm, następnie klucz dostarczania, a jako wartość wskazany klucz provides. Podzbiór inject. Nieobecne, gdy załącznik nie deklaruje mechanizmu dostarczania lub nie wskazuje żadnego wrażliwego klucza provides. |
sensitive_payload_leaves | string[] | nie | Liście, które przenosi ładunek values i infra tego załącznika, a które dołączony Feature deklaruje jako wrażliwe, każdy jako poprzedzona nazwą filaru ścieżka kropkowa zajmowana przez daną: values.db obejmuje db.password i nie sięga sąsiedniego liścia o nazwie dbPassword. Odpowiedź dla całego załącznika nigdy nie jest rozkładana na pojedyncze liście, ponieważ stwierdzałoby to coś fałszywego o liściu pozostawionym jako czytelny. Brak klucza oznacza, że ten załącznik nie wymienia żadnego liścia, który jego Feature deklaruje jako wrażliwy. Nie stwierdza to, że ładunek jest niewrażliwy, i nie odróżnia załącznika, który nie ma takiego liścia do wymienienia, od producenta, który w ogóle nie raportuje tej osi — gość, który odczytuje brak klucza jako pozwolenie na wyświetlenie lub wyemitowanie wartości jawnym tekstem, odczytał go odwrotnie. Liście pojawiają się w kolejności, w jakiej przechowuje je ładunek, liście filaru values przed liśćmi filaru infra — w tej samej kolejności, w jakiej przenoszą je same ładunki values i infra, co sprawia, że ładunek jest identyczny bajt w bajt między uruchomieniami dla identycznych danych wejściowych. Nieobecne, gdy załącznik nie przenosi żadnego liścia, który jego Feature deklaruje jako wrażliwy. |
connection | AttachmentConnection | nie | Połączenie, do którego należy ten załącznik: obecne w każdym załączniku zapisanym w jednym z połączeń węzła i nieobecne w każdym załączniku z własnego bloku załączników węzła. Załącznik zapisany w połączeniu jest pod każdym innym względem jednym z załączników węzła — kluczem jest jego nazwa kwalifikowana, czyli alias połączenia i slot połączone kropką, a powiązanie i wrażliwość przejmuje ze slotu deklarowanego przez gniazdo połączenia — więc to pole odróżnia jedne od drugich i przenosi połączenie jako dane, zamiast pozostawiać je do odczytania z klucza. Konsument łączy je z krawędziami grafu według gniazda i aliasu: krawędź, której źródłem jest węzeł przenoszący ten załącznik i której gniazdo i alias są tymi wartościami, jest połączeniem, w którym załącznik jest prezentowany, a cel tej krawędzi jest tym, czemu jest prezentowany. Załącznik połączenia rysowanego przez załącznik Feature nigdy go nie przenosi, ponieważ takie połączenie nie przenosi żadnych załączników. |
realization | string | nie | FeatureRecipe realizujący ten załącznik, w postaci |
Dodatkowe właściwości są niedozwolone.
IRFeatureEntry.inject
Agnostyczne trasowanie wstrzykiwania. Mapuje zmienne lokalne na klucze provides celu.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
env | mapa string | nie | Dostarczanie przez zmienne środowiskowe: klucze to nazwy lokalnych zmiennych konsumenta, wartości to klucze provides celu. |
file | mapa string | nie | Dostarczanie przez montowanie plików: klucze to lokalne ścieżki plików konsumenta, wartości to klucze provides celu. |
arg | mapa string | nie | Dostarczanie przez argumenty wiersza poleceń: klucze to prefiksy flag konsumenta, wartości to klucze provides celu. |
IRBoundaryFeature
Załącznik Feature na poziomie granicy rzutowany do IR: URI typu Feature oraz infra granicy, względem których FeatureRecipe o zasięgu granicy renderuje i rozwiązuje swoje źródło. Załączniki na poziomie granicy nie przenoszą ładunku values.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
type | string | tak | URI encji Feature katalogu dołączonej na tej granicy. |
infra | object | nie | Fizyczne wymiarowanie załącznika granicy; infra, względem których FeatureRecipe o zasięgu granicy ewaluuje swoje szablony i źródło. |
sensitive_payload_leaves | string[] | nie | Liście, które przenosi ładunek infra tego załącznika granicy, a które dołączony Feature deklaruje jako wrażliwe, każdy jako poprzedzona nazwą filaru ścieżka kropkowa zajmowana przez daną. Pojawiają się tu tylko współrzędne infra.db obejmuje db.password i nie sięga sąsiedniego liścia o nazwie dbPassword. Brak klucza oznacza, że ten załącznik nie wymienia żadnego liścia, który jego Feature deklaruje jako wrażliwy, co obejmuje przypadek, gdy dołączony Feature nie rozwiązuje się do żadnego schematu, który ten czytelnik mógłby odczytać. Nie stwierdza to, że ładunek infra jest niewrażliwy, i nie odróżnia załącznika, który nie ma takiego liścia do wymienienia, od producenta, który w ogóle nie raportuje tej osi. Konsument, który odczytuje brak klucza jako pozwolenie na wyświetlenie lub wyemitowanie wartości jawnym tekstem, odczytał go odwrotnie. Liście pojawiają się w kolejności, w jakiej przechowuje je ładunek, czyli w tej samej kolejności, w jakiej przenosi je sam ładunek infra, co utrzymuje graf identyczny bajt w bajt między uruchomieniami dla identycznych danych wejściowych. Nieobecne, gdy załącznik nie przenosi żadnego liścia, który jego Feature deklaruje jako wrażliwy. |
realization | string | nie | FeatureRecipe realizujący ten załącznik granicy, w postaci |
Dodatkowe właściwości są niedozwolone.
CatalogMetadata
Zestaw metadanych przedsiębiorstwa (Enterprise Metadata Suite) jawnie wyodrębniony z encji katalogu, udostępniający dane o cyklu życia i własności linterom Wasm.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
maintainers | Maintainer[] | nie | Opiekunowie, których encja katalogu wymienia jako swoich właścicieli. |
license | string | nie | Identyfikator licencji SPDX, który encja katalogu deklaruje dla opisywanego przez siebie oprogramowania. |
repository | string | nie | URL repozytorium Git, które encja katalogu wskazuje jako miejsce przechowywania swoich plików źródłowych. |
home | string | nie | URL strony głównej, wiki lub dokumentacji encji katalogu. |
keywords | string[] | nie | Opisowe słowa kluczowe, które deklaruje encja katalogu. |
Dodatkowe właściwości są niedozwolone.
IRNode
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
description | string | nie | Opcjonalna dokumentacja napisana przez programistę, opisująca rolę tej instancji komponentu w aplikacji. Przekazywana z encji Aggregate na potrzeby renderowania i diagnostyki lintowania. |
labels | mapa string | tak | Etykiety duck typingu i ontologii encji. |
component | string | tak | Nazwa bazowej encji Component. |
resolved_version | string | tak | Dokładna wersja semantyczna (Semantic Version) encji Component rozwiązana podczas kompilacji. |
sync_wave | integer | nie | Fala wdrożenia dziedziczona z pola syncWave zawierającej granicy (domyślnie 0; wartości ujemne są dozwolone). W K8s i Helm fala wyznacza kolejność wdrożenia: staje się adnotacją argocd.argoproj.io/sync-wave, a na zasobie, który chart już oznacza jako hook Helm, staje się też wartością helm.sh/hook-weight tego hooka. W compose wartość jest zarówno zapisywana jako etykieta usługi, jak i porządkuje usługi pliku, do którego jest renderowana, poprzez depends_on między nimi. W cloudformation porządkuje provisioning stosu, w który składa się grupa dyspozycji, przy czym każdy zasób w fali jest deklarowany jako zależny od zasobów fali poprzedniej: jest to kolejność ich tworzenia i, odwrotnie, kolejność usuwania, nigdy gotowość, ponieważ szablon stosu nie wyraża pojęcia gotowości zasobu. W terraform porządkuje bloki modułów konfiguracji głównej, w którą składa się granica, przy czym każdy moduł w fali jest deklarowany jako zależny od modułów fali poprzedniej: jest to kolejność, w jakiej silnik wykonuje swoje działania, nigdy gotowość, ponieważ konfiguracja nie wyraża pojęcia gotowości zasobu. Wartość jest też przenoszona wraz z proweniencją budowania węzła. |
boundary_path | string | nie | Ścieżka granicy encji Release, w której umieszczono ten węzeł: nazwy granic od najbardziej zewnętrznej do wewnątrz, połączone znakiem / (np. ‘data/inner’ dla komponentu umieszczonego w granicy inner zadeklarowanej wewnątrz granicy data). Nazwa granicy nie może zawierać /, więc ścieżkę można jednoznacznie rozdzielić z powrotem na granice. Węzeł importowanej encji Aggregate, którą encja Release kieruje do granicy, ma ścieżkę tej granicy. Pozwala pluginom renderującym generować unikatowe identyfikatory uwzględniające granice. |
subsystem_path | string | nie | Ścieżka podsystemu encji Aggregate, w którym zadeklarowano komponent tego węzła: nazwy podsystemów od najbardziej zewnętrznego do wewnątrz, połączone znakiem . (np. ‘backend.storage’ dla komponentu zadeklarowanego w podsystemie storage zagnieżdżonym w podsystemie backend). Nazwa podsystemu nie może zawierać ., więc ścieżkę można jednoznacznie rozdzielić z powrotem na podsystemy. Komponent encji Aggregate, która deklaruje components najwyższego poziomu, ma syntetyzowany podsystem default, oznaczony przez synthesized_subsystem. Ścieżka jest względna wobec encji Aggregate, która deklaruje komponent: węzeł wnoszony przez importowaną encję Aggregate ma swoją ścieżkę w obrębie tej encji Aggregate, bez nazwy, pod którą ją zaimportowano (np. ‘tier’ dla komponentu w podsystemie tier importowanej encji Aggregate), więc węzły z różnych encji Aggregates mogą mieć wspólną ścieżkę. Rozróżniają je identyfikator węzła, który zaczyna się od nazwy importu, oraz source_file. |
synthesized_subsystem | logiczna | nie | Prawda, gdy podsystem tego węzła został syntetyzowany przez kompilator — podsystem default tworzony dla encji Aggregate, która deklaruje components najwyższego poziomu zamiast nazwanych subsystems. Proweniencja wyprowadzona, nigdy nie pisana przez autora: odróżnia syntetyzowany default od podsystemu, który użytkownik jawnie nazwał default. Niezależne od synthesized_boundary (węzeł może być syntetyzowany na jednej z osi lub na obu). Nieobecne (false) dla każdego podsystemu napisanego przez autora. |
synthesized_boundary | logiczna | nie | Prawda, gdy granica tego węzła została syntetyzowana przez kompilator — granica default tworzona dla encji Release, która deklaruje components najwyższego poziomu zamiast nazwanych boundaries. Proweniencja wyprowadzona, nigdy nie pisana przez autora: odróżnia syntetyzowany default od granicy, którą użytkownik jawnie nazwał default, i kieruje artefakty węzła płasko do dist/ zamiast do dist/boundaries/default/. Nieobecne (false) dla każdej granicy napisanej przez autora. |
catalog_metadata | CatalogMetadata | nie | Zestaw metadanych przedsiębiorstwa (Enterprise Metadata Suite) jawnie wyodrębniony z encji katalogu, udostępniający dane o cyklu życia i własności linterom Wasm. |
catalog_annotations | mapa string | nie | Niezmienne, wewnętrzne cechy komponentu tworzone przez architekta platformy w domenie 2. |
release_annotations | mapa string | nie | Ciągi topologii fizycznej i realia operacyjne kaskadowo przekazywane z granic w encji Release. |
aggregate_annotations | mapa string | nie | Metadane poznawcze, intencje dewelopera i FinOps kaskadowo przekazywane z podsystemów w encji Aggregate. |
self_inject | object | nie | Blok self-inject na poziomie encji Component przeniesiony z encji Aggregate; agnostyczne trasowanie wstrzykiwania, które węzeł deklaruje dla samego siebie. Nieprzezroczysty na tej warstwie schematu; plugin polityki, który go odczytuje, sam parsuje bajty. |
source_file | string | nie | Ścieżka pliku encji Aggregate, w którym napisano ten węzeł, względna wobec przestrzeni roboczej. Węzły poziomu głównego mają ścieżkę głównej encji Aggregate; węzły podagregatów mają ścieżkę pliku importowanej encji Aggregate. Ścieżka jest względna wobec katalogu głównego przestrzeni roboczej (katalogu zawierającego .aggrega-config.yaml), więc graf jest identyczny bajt w bajt na maszynach, których przestrzenie robocze leżą pod różnymi ścieżkami bezwzględnymi. Konsumenci filtrujący diagnostykę według pliku rozwiązują to pole względem tego samego katalogu głównego przed porównaniem. Nieobecne, gdy graf zbudowano bez katalogu głównego przestrzeni roboczej. |
uses | object | nie | Blok uses węzła dokładnie w postaci napisanej przez autora: każda nazwa gniazda odwzorowuje się albo na listę nazw instancji docelowych, albo na mapę wpisów połączeń kluczowaną aliasami, w kolejności zadeklarowanej przez autora. Jest to blok w postaci zapisanej, czyli fakt odmienny od rozwiązanych połączeń w edges: gniazdo wypełnione przez autora pojawia się tu nawet wtedy, gdy nie utworzyło żadnego połączenia, więc czytelnik może odróżnić gniazdo wypełnione przez autora od gniazda, które dociera do celu. Nieobecny, gdy węzeł nie ma napisanego bloku uses. Nieprzezroczysty na tej warstwie schematu; plugin polityki, który go odczytuje, parsuje bajty. |
sensitive_payload_leaves | string[] | nie | Liście, które ładunek values i infra tego węzła przenosi, a które jego encja Component deklaruje jako wrażliwe, każdy jako kropkowana ścieżka z prefiksem filaru, którą zajmuje dana: values.db obejmuje db.password i nie sięga do sąsiedniego liścia o nazwie dbPassword. Nieobecny klucz stwierdza, że ten węzeł nie wskazuje żadnego liścia, który jego encja Component deklaruje jako wrażliwy, co obejmuje przypadek, gdy encja Component węzła nie rozwiązuje się do żadnego schematu, który ten czytelnik mógłby odczytać. Nie stwierdza on, że ładunek węzła nie jest wrażliwy, i nie odróżnia węzła, który nie ma takiego liścia do wskazania, od producenta, który w ogóle nie raportuje tej osi. Konsument, który odczytuje nieobecny klucz jako zgodę na wyświetlenie lub emisję wartości jawnym tekstem, odczytał go na odwrót. Liście pojawiają się w kolejności, w jakiej przechowuje je ładunek, liście filaru values przed liśćmi filaru infra, czyli w tej samej kolejności, w jakiej przenoszą je same te ładunki, co utrzymuje graf identyczny bajt w bajt między uruchomieniami dla identycznych danych wejściowych. Nieobecny, gdy węzeł nie przenosi żadnego liścia, który jego encja Component deklaruje jako wrażliwy. |
Dodatkowe właściwości są niedozwolone.
IREdge
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
source | string | tak | ID węzła konsumującego, w którym zaczyna się połączenie. |
target | string | tak | ID węzła, do którego dociera połączenie. |
socket | string | nie | Kategoria usesSchema, do której należy ta krawędź (np. ‘databases’, ‘tools’). |
alias | string | nie | Alias tego połączenia zdefiniowany przez programistę (np. ‘primary_db’). |
socket_declaration | string (enum) | tak | Pochodzenie gniazda: declared, gdy encja katalogu będąca właścicielem gniazda wymienia je w usesSchema (konsumująca encja Component lub, dla krawędzi utworzonej przez encję Feature, źródłowa encja Feature), ad-hoc, gdy autor encji Aggregate nazwał gniazdo, którego katalog nie zadeklarował. Jest to trzecia oś, niezależna od autorstwa krawędzi: mówi, skąd pochodzi gniazdo, a nie kto narysował krawędź, więc krawędź utworzona przez encję Release do zadeklarowanego gniazda i krawędź utworzona przez encję Aggregate do gniazda ad-hoc różnią się na obu osiach niezależnie. Zadeklarowane gniazdo niesie swój wpis usesSchema, w tym selektor ograniczający, do których celów krawędź może prowadzić; gniazdo ad-hoc nie ma wpisu w katalogu, a zatem nie ma selektora, więc to, co krawędź może przenosić, ograniczają wyłącznie zadeklarowane provides celu. Zawsze obecne, więc konsument nigdy nie musi odczytywać braku wartości jako declared, a polityka może wymagać, by każda krawędź była zadeklarowana. Odrębne od znacznika powiązania załącznika, który odpowiada na pytanie o tym samym kształcie, ale dotyczące innego podmiotu. Dozwolone wartości: "declared", "ad-hoc" |
origin_feature | string | nie | Jeśli ta krawędź została autonomicznie zadeklarowana przez encję Feature (w tym przez poświadczeniowe encje Features oznaczone feature.aggrega.ai/kind: secret), pole to identyfikuje URI typu encji Feature. Pozwala wtyczkom Wasm wyodrębnić własną topologię. |
origin_feature_instance | string | nie | Nazwa instancji (dla danego załącznika) encji Feature, która zadeklarowała tę krawędź. Lokalizuje rozwiązane provides encji FeatureRecipe o zasięgu granicy według instancji, rozróżniając dwa załączniki tego samego typu encji Feature na jednej granicy. |
origin_release | logiczna | nie | True, gdy tę krawędź utworzyła encja Release, łącząc zadeklarowane, lecz niepowiązane gniazdo z istniejącym komponentem. Oznacza AUTORSTWO krawędzi, a nie konfigurację: krawędź zadeklarowana przez programistę, dla której encja Release jedynie dostarczyła infra, pozostaje krawędzią pochodzenia Aggregate (origin_release nieustawione; jej infra z encji Release pojawia się w mapie infra krawędzi). origin_feature ustawione => pochodzenie Feature; origin_release true => pochodzenie Release; żadne z nich => pochodzenie Aggregate. |
values | object | nie | Rozwiązane wartości programisty dla tej krawędzi, określane per połączenie (z krawędzi encji Aggregate), walidowane podczas rozwiązywania względem valueSchema zadeklarowanego przez gniazdo źródłowe (gniazdo na konsumującym komponencie, będące źródłem krawędzi) i rzutowane do kontekstu renderowania konsumującego węzła pod .context.uses. |
infra | object | nie | Rozwiązane infra dla tej krawędzi, określane per połączenie, dostarczane przez wpis krawędzi encji Release, walidowane podczas rozwiązywania względem infraSchema zadeklarowanego przez gniazdo źródłowe (gniazdo na konsumującym komponencie, będące źródłem krawędzi) i rzutowane pod .context.uses. |
inject | object | nie | Agnostyczne trasowanie wstrzykiwania. Mapuje zmienne lokalne na klucze provides celu. |
sensitive_payload_leaves | string[] | nie | Liście, które przenoszą values i infra tej krawędzi, a które gniazdo, względem którego są zapisane, deklaruje jako wrażliwe, każdy jako poprzedzona nazwą filaru ścieżka kropkowa zajmowana przez daną: values.db obejmuje db.password i nie sięga sąsiedniego liścia o nazwie db_password. Powierzchnia, która ukrywa w grafie wartości zadeklarowane jako wrażliwe, ukrywa te liście w values i infra tej krawędzi oraz we wpisie uses węzła konsumującego dla tego samego połączenia, który przenosi wartości w postaci zapisanej przez autora. Brak klucza oznacza, że ta krawędź nie wymienia żadnego liścia, który kontrakt jej gniazda deklaruje jako wrażliwy, co obejmuje przypadek, gdy gniazdo nie deklaruje kontraktu, który dałoby się tu odczytać. Nie stwierdza to, że konfiguracja jest niewrażliwa, a konsument, który odczytuje brak klucza jako pozwolenie na wyświetlenie lub wyemitowanie wartości jawnym tekstem, odczytał go odwrotnie. Liście pojawiają się w kolejności, w jakiej przechowują je ładunki, liście filaru values przed liśćmi filaru infra, i to właśnie sprawia, że graf jest identyczny bajt w bajt między uruchomieniami dla identycznych danych wejściowych. Nieobecne, gdy krawędź nie przenosi żadnego liścia, który kontrakt jej gniazda deklaruje jako wrażliwy. |
Dodatkowe właściwości są niedozwolone.
IREdge.inject
Agnostyczne trasowanie wstrzykiwania. Mapuje zmienne lokalne na klucze provides celu.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
env | mapa string | nie | Dostarczanie przez zmienne środowiskowe: klucze to nazwy lokalnych zmiennych konsumenta, wartości to klucze provides celu. |
file | mapa string | nie | Dostarczanie przez montowanie plików: klucze to lokalne ścieżki plików konsumenta, wartości to klucze provides celu. |
arg | mapa string | nie | Dostarczanie przez argumenty wiersza poleceń: klucze to prefiksy flag konsumenta, wartości to klucze provides celu. |
IRMetadata
Tożsamość grafu: encja Aggregate, z której został zbudowany.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
aggregate_name | string | tak | metadata.name encji Aggregate. |
Dodatkowe właściwości są niedozwolone.
IRProvenance
Metadane identyfikowalności na potrzeby diagnostyki i audytu.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
schema_version | string | tak | Wersja schematu IR, z którym zgodny jest graf — aggrega.ai/v1beta1, ta sama wartość, którą niesie apiVersion grafu. |
compiler_version | string | tak | Obowiązkowy znacznik zgodności. Identyfikuje po wersji plik binarny aggrega, który zbudował ten graf. |
aggregate_version | string | tak | Dokładna wersja semantyczna intencji głównej encji Aggregate użytej podczas kompilacji. |
manifest_version | string | tak | Dokładna wersja semantyczna pliku blokady Manifest użytego podczas kompilacji. |
release_version | string | tak | Dokładna wersja semantyczna pliku routingu Release użytego podczas kompilacji. |
Dodatkowe właściwości są dozwolone.
IRSpec
Sam graf: jego węzły, krawędzie i ładunki kluczowane według węzła.
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
nodes | mapa IRNode | tak | Słownik wszystkich węzłów grafu, z kluczami będącymi ich bezwzględnymi ID. Czysto topologiczny. Klucze: co najmniej jedna litera, cyfra, podkreślenie, kropka lub łącznik. Wzorzec: ^[a-zA-Z0-9_.-]+$. |
edges | IREdge[] | tak | Jawne logiczne ścieżki sieciowe i zależności między węzłami. |
values_mapping | object | tak | Jedyne źródło prawdy dla nieprzezroczystych, przekazywanych dalej ładunków kognitywnych, mapowanych według ID węzła. |
infra_mapping | object | tak | Ładunek fizycznego wymiarowania wstrzyknięty z encji Release, mapowany według ID węzła. |
feature_values_mapping | mapa map IRFeatureEntry | tak | Znormalizowana mapa ID węzłów na konfiguracje dołączonych do nich encji Feature. Jeden kubełek zawiera każdy załącznik węzła niezależnie od tego, co produkuje — operacyjne encje Features, poświadczeniowe encje Features, tożsamościowe encje Features — z kluczem będącym nazwą instancji nadaną każdemu załącznikowi przez autora. Załącznik zapisany na jednym z połączeń węzła ma klucz będący jego nazwą kwalifikowaną, czyli aliasem połączenia i slotem połączonymi kropką, i wskazuje swoje połączenie we własnym polu connection. Klucze: co najmniej jedna litera, cyfra, podkreślenie, kropka lub łącznik. Wzorzec: ^[a-zA-Z0-9_.-]+$. |
boundary_features | mapa map IRBoundaryFeature | nie | Załączniki encji Feature każdej granicy, z kluczami według ścieżki granicy, a następnie nazwy instancji. Obecne tylko wtedy, gdy graf ma załączniki encji Feature na poziomie granic. Klucze: co najmniej jedna litera, cyfra, podkreślenie, kropka, ukośnik lub łącznik. Wzorzec: ^[a-zA-Z0-9_./-]+$. |
provenance | IRProvenance | tak | Metadane identyfikowalności na potrzeby diagnostyki i audytu. |
Dodatkowe właściwości są niedozwolone.
IRGraph
| Właściwość | Typ | Wymagana | Opis |
|---|---|---|---|
apiVersion | const “aggrega.ai/v1beta1” | tak | Stała: "aggrega.ai/v1beta1" |
kind | const “IR” | tak | Stała: "IR" |
metadata | IRMetadata | tak | Tożsamość grafu: encja Aggregate, z której został zbudowany. |
spec | IRSpec | tak | Sam graf: jego węzły, krawędzie i ładunki kluczowane według węzła. |
Dodatkowe właściwości są niedozwolone.