Przejdź do głównej zawartości
AggregaAggrega
Wybierz język: Polski
Ta strona została przetłumaczona maszynowo. Przeczytaj oryginał w języku angielskim.

Schemat Aggrega Workspace Config

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/aggrega-config-v1beta1.schema.json

Plik konfiguracyjny obszaru roboczego odczytywany przez CLI aggrega. Znajduje się w .aggrega-config.yaml. Blok workspace jest znacznikiem katalogu głównego: jego obecność oznacza katalog główny obszaru roboczego i zawiera on wyłącznie katalogi katalogów. Każdy inny klucz jest ustawieniem i znajduje się na najwyższym poziomie, w następujących klasach — skąd treść jest pobierana, przypinana i buforowana (wybór rejestru, tryb offline, automatyczne pobieranie i zachowanie przypinania, lokalizacje pamięci podręcznej artefaktów i skompilowanych modułów oraz limity ich rozmiaru), jak treść jest uznawana za zaufaną (podpisywanie i zachowanie weryfikacji podpisów), jak rygorystycznie oceniane jest tworzenie treści (ustawienia poszczególnych reguł lintera, rygor wobec przestarzałych elementów i wskazówka dotycząca wydania autorskiego), które Plugins Wasm są dołączane w całym obszarze roboczym (zarządzanie, linter, importer oraz powiązania renderowania Provider dla poszczególnych celów) oraz jak działa CLI (współbieżność, serwowanie i limity usuwania wpisów z pamięci podręcznej parsowania demona). Poniższe właściwości stanowią pełną i wiążącą listę; to podsumowanie wymienia klasy, a nie klucze, więc dodanie klucza nie może uczynić go nieprawdziwym. Płaska struktura najwyższego poziomu, bez otoczki apiVersion/kind, odrębna od treści katalogu. Dyscyplina ewolucji schematu: dodanie nowego klucza najwyższego poziomu jest podniesieniem wersji SemVer-MINOR (zmiana addytywna); usunięcie lub przeniesienie klucza albo zaostrzenie ograniczenia jest zmianą łamiącą zgodność SemVer-MAJOR.

Typ najwyższego poziomu: object

Właściwości

WłaściwośćTypWymaganaOpis
workspaceobjectnieZnacznik katalogu głównego obszaru roboczego. Sama jego obecność oznacza katalog jako katalog główny obszaru roboczego; zawiera wyłącznie katalogi katalogów definiujące katalog główny — własne katalogi obszaru roboczego oraz te, które encja Release otrzymuje jako własne. Każde ustawienie, które nie definiuje katalogu głównego, znajduje się na najwyższym poziomie, a nie tutaj. Aby oznaczyć katalog główny bez dołączonych katalogów katalogów, należy napisać workspace: {}.
default_registrystringnieDomyślny rejestr OCI, w którym publikowane są encje i z którego rozwiązywane są zależności, gdy encja nie wskazuje rejestru jawnie: aggrega push publikuje tam, a aggrega pull stamtąd pobiera. Domyślnie hub.aggrega.ai. Należy podać name wpisu w registries, który oznacza wtedy host tego wpisu; sam host; albo host, po którym następuje / i ścieżka repozytorium, np. ghcr.io/acme lub harbor.example.com/platform. Najpierw dopasowywana jest nazwa: wartość będąca name jednego wpisu oznacza host tego wpisu, nawet jeśli zapisana jest również jak host, więc publikowanie, pobieranie, weryfikacja podpisów i każde ustawienie zaufania dla rejestru używają tego jednego hosta; wartość, którą nazwane są dwa wpisy, jest odrzucana jako niejednoznaczna, a nazwa, po której następuje ścieżka, jest odrzucana, ponieważ nazwa oznacza host wpisu, a nie lokalizację pod nim. Każda inna wartość musi być hostem zapisanym w pisowni, pod którą przechowywana jest jego polityka zaufania: nazwą hosta małymi literami zawierającą kropkę (registry.example.com), localhost, pojedynczą nazwą z portem (registry:5000), adresem IPv4 lub adresem IPv6 w nawiasach kwadratowych ([::1]), każdą z opcjonalnym :port i bez schematu, danych uwierzytelniających, białych znaków ani wielkich liter — opcjonalnie z następującą ścieżką repozytorium: jednym lub kilkoma segmentami z małych liter i cyfr połączonymi znakiem /, które wewnątrz segmentu mogą być rozdzielone przez ., _, __ lub myślniki, bez tagu, skrótu (digest) ani końcowego /. Ścieżka określa, gdzie rzeczy są publikowane i skąd są pobierane: każda encja publikowana przez domyślny rejestr jest publikowana pod <host>/<path>/, a każda encja rozwiązywana przez niego jest stamtąd pobierana, więc to, co publikuje jedno, znajduje drugie. Ścieżka nigdy nie wpływa na zaufanie do rejestru: wpis registries, którego polityka ma zastosowanie, logowanie, wymóg podpisu i zaufane tożsamości są wyszukiwane wyłącznie po hoście. Port 443 na hoście osiąganym przez HTTPS jest domyślnym portem tego hosta, a jego zapisanie jest odrzucane z podaniem pisowni bez niego; localhost i inne adresy pętli zwrotnej są osiągane przez zwykły HTTP, więc 443 jest tam zwykłym portem i zostaje zachowany. Pusta wartość nie wskazuje domyślnego rejestru. Wartość jest oceniana podczas wczytywania konfiguracji, a nie przez ten schemat, ponieważ wpis, do którego odnosi się nazwa, może być zadeklarowany w innym pliku konfiguracyjnym: jest odczytywana po wszystkich plikach konfiguracyjnych i zmiennej środowiskowej AGGREGA_DEFAULT_REGISTRY i odrzucana tymi samymi słowami niezależnie od tego, które z nich ją ustawiło, ze wskazaniem tego pliku lub zmiennej. Flaga --registry, wskazująca miejsce docelowe publikacji dla jednego wywołania, jest dopasowywana do nazw wpisów w ten sam sposób; każda inna jej wartość może być referencją, a host wskazany przez tę referencję podlega tej samej pisowni i jest miejscem, w którym trafia publikacja, bez ścieżki repozytorium. Host jest oceniany wyłącznie po pisowni: nie jest sprawdzane, czy nazwa się rozwiązuje ani czy pod nią odpowiada rejestr. Domyślnie: "hub.aggrega.ai"
offlinelogicznanieGdy true, kompilacja nie kontaktuje się z żadnym rejestrem; używane są wyłącznie artefakty z pamięci podręcznej i dołączona zawartość katalogów. Domyślnie false. Domyślnie: false
auto_pulllogicznanieGdy false (domyślnie), aggrega build działa tylko do odczytu: nigdy nie zapisuje przypięć źródeł, a brakujący lub niekompletny plik blokady dla wydania wyraźnie zatrzymuje kompilację z diagnostyką nakazującą najpierw uruchomić aggrega pull --release <release>. Gdy true, aggrega build przed kompilacją wykonuje w tym samym procesie krok pobierania — rozwiązując zależności encji Release do pliku blokady i pamięci podręcznej — więc pierwsza kompilacja dla encji Release nie wymaga jawnego kroku pobierania. Ta sama jednorazowa opcja jest dostępna w wierszu poleceń jako aggrega build --auto-pull; pull pozostaje jedynym zapisującym plik blokady. offline: true nie wyłącza kroku pobierania: działa on na tym, co maszyna już posiada — pamięci podręcznej i lokalnych katalogach katalogów — bez łączenia się z rejestrem, a referencja, której żadne z nich nie zawiera, zatrzymuje kompilację własną odmową pobierania wskazującą tę referencję. Domyślnie: false
pin_sources_at_pulllogicznanieGdy false (domyślnie), pobieranie nie zapisuje żadnego przypięcia obok encji: dla encji Recipe lub FeatureRecipe w jednym z katalogów katalogów tego obszaru roboczego, którą buduje encja Release, zatrzymuje się, gdy entity.lock obok encji nie zawiera przypięcia dla każdego wejścia, które encja odczytuje — zdalnego source: z w pełni zapisanymi współrzędnymi, pliku importowanego przez wpis artifacts lub każdego pliku lokalnego source: obok encji — wskazując encję, każde wejście i jego klasę oraz aggrega pin jako krok, który je zapisuje. Przypinanie jest krokiem autora encji, więc encja, której nikt nie przypiął, nie jest jeszcze gotowa do użycia. Gdy true, każde pobieranie w tym obszarze roboczym wykonuje zamiast tego ten krok dla tych samych encji, zapisując te same bajty entity.lock, które zapisuje aggrega pin; w ten sposób obszar roboczy korzystający z encji, których ktoś inny nie przypiął, zapisuje ich przypięcia jednorazowo zamiast się zatrzymywać. Kompilacja wypełniająca własny plik blokady jest pobieraniem i stosuje się do tego ustawienia. aggrega pull --pin-sources przypina dla jednego wywołania, a --pin-sources=false zatrzymuje dla jednego wywołania, niezależnie od tego ustawienia. Encja rozwiązana z pamięci podręcznej, a nie z katalogu katalogów, nie ma gdzie zapisać blokady i nigdy nie jest przez pobieranie przypinana ani zatrzymywana. Domyślnie: false
pin_sources_at_pushlogicznanieGdy true, każde aggrega push w tym obszarze roboczym wykonuje krok przypinania autora encji na publikowanej encji przed jej spakowaniem, więc entity.lock zapisany przez ten krok obok encji jest częścią publikacji; gdy false (domyślnie), wypychanie nie wykonuje kroku przypinania i odrzuca encję Recipe lub FeatureRecipe, której entity.lock nie zawiera każdego przypięcia, które zapisałby ten krok, wskazując aggrega pin. Krok zapisuje obok encji, więc działa tylko tam, gdzie encja ma zapisywalne miejsce, które wypychanie zawsze ma: publikuje encję wskazaną przez jej dokument. aggrega push --pin-sources przypina dla jednego wywołania, a --pin-sources=false nie, niezależnie od tego ustawienia. Jest to ten sam krok, który wykonuje aggrega pin, zapisujący te same bajty. Domyślnie: false
artifact_cache_dirstringnieLokalny katalog pamięci podręcznej artefaktów i zawartości (pobrania z rejestru, manifesty OCI, skompilowane fikstury). Domyślnie .aggrega/cache. Zgodnie z konwencją powinien być wykluczony w gitignore. Ścieżka jest interpretowana względem katalogu głównego obszaru roboczego, niezależnie od miejsca uruchomienia polecenia; wartość bezwzględna jest odrzucana podczas wczytywania konfiguracji, ponieważ każdy odczytujący to ustawienie rozwiązuje je względem tego katalogu głównego, a ścieżka bezwzględna wskazywałaby lokalizację, do której nigdy nie docierają. Pamięć podręczna może znajdować się wewnątrz katalogu katalogów — wartość domyślna tak robi, ponieważ katalog katalogów często jest katalogiem głównym obszaru roboczego — ale nie może NIM BYĆ: skanowanie katalogów pomija pamięć podręczną, więc wartość wskazująca katalog katalogów wyłącza ze skanowania całą zawartość tego katalogu. Wartość wskazująca sam katalog główny obszaru roboczego (. lub dowolny zapis do niego sprowadzalny) jest z tego właśnie powodu odrzucana podczas wczytywania konfiguracji. Wartość wskazująca dowolny inny katalog katalogów nie jest odrzucana: wczytuje się poprawnie, a skanowanie nie znajduje potem niczego w tym katalogu, więc sprawdzenie, czy pamięć podręczna leży poza katalogami wymienionymi w workspace.catalog_dirs, należy do użytkownika. Różni się od parse_cache, który ogranicza pamięć podręczną parsowania demona w pamięci operacyjnej, oraz od compiled_module_cache, który ogranicza ogólnomaszynowy magazyn skompilowanych modułów. Domyślnie: ".aggrega/cache"
skip_signature_verificationlogicznanieGlobalne, jawne wyłączenie weryfikacji podpisów. Gdy ma wartość true, weryfikacja podpisów jest wyłączona dla wszystkich rejestrów, łącznie z obowiązkowym poziomem bazowym huba. Przeznaczone do sytuacji awaryjnych i programistycznych; nigdy nie działa po cichu — wszędzie tam, gdzie pobranie sprawdziłoby podpis, ostrzega, że weryfikacja została globalnie wyłączona. Domyślnie false. Wartość domyślna: false
buildobjectnieUstawienia rygoru na etapie budowania i wskazówki dla autorów. authoring_release dostarcza LSP wskazówkę current Release dla diagnostyki w edytorze; halt_on_deprecated_severity określa, jak budowanie reaguje na użycie przestarzałych encji; yaml_indent ustawia szerokość wcięcia każdego renderowanego artefaktu YAML.
pluginsobjectnieDołączenia pluginów Wasm na poziomie obszaru roboczego. Każde gniazdo (governance, linter, importer) przyjmuje tablicę odwołań do pluginów; budowanie wywołuje udokumentowaną funkcję wejściową każdego pluginu zgodnie z kontraktem jego gniazda. Lista providers wiąże możliwości z pluginami renderującymi dostawców, które je obsługują.
lintobjectnieUstawienia rygoru poszczególnych reguł.
parse_cacheobjectnieLimity usuwania z pamięci podręcznej parsowania demona. Oba limity obowiązują jednocześnie — pętla usuwania LRU działa po każdym wstawieniu do pamięci podręcznej i usuwa najdawniej używane wpisy, dopóki zarówno liczba wpisów, jak i łączna liczba bajtów nie mieszczą się w limitach. Zero w którymkolwiek oznacza unbounded on that axis, co przydaje się w scenariuszach CI, w których pamięć podręczna istnieje tylko przez jedno wywołanie. Różni się od artifact_cache_dir, czyli dyskowej pamięci podręcznej treści.
compiled_module_cacheobjectnieLimit rozmiaru dyskowej pamięci podręcznej skompilowanych modułów, czyli magazynu kodu maszynowego, który kompilator ponownie wykorzystuje, aby plugin Wasm był kompilowany raz na maszynę zamiast raz na budowanie. Jest współdzielona przez wszystkie obszary robocze na maszynie, więc ten klucz należy umieścić w globalnym pliku konfiguracyjnym, jeśli ma obowiązywać jedna wartość dla całej maszyny. Limit jest stosowany raz na wywołanie, przed załadowaniem jakiegokolwiek pluginu, przez usuwanie całych wpisów, od najdawniej skompilowanych, aż reszta się zmieści — nigdy w trakcie kompilacji podczas budowania. Usunięcie wpisu kosztuje jedynie późniejszą ponowną kompilację, więc limit można bezpiecznie obniżyć. aggrega cache status podaje bieżący rozmiar magazynu, a aggrega cache evict --max-size przycina go na żądanie do limitu podanego w wierszu poleceń. Różni się od artifact_cache_dir (pobrana treść rejestrów) i od parse_cache (pamięć podręczna parsowania demona w pamięci operacyjnej).
concurrencyobjectnieUstawienia współbieżności rozdzielania żądań demona. Demon odczytuje żądania z jednego strumienia stdin i przekazuje każde do puli wątków roboczych, która opróżnia ograniczoną kolejkę żądań; odpowiedzi są emitowane w kolejności nadejścia żądań, niezależnie od kolejności ich ukończenia.
serveobjectnieUstawienia działania demona (aggrega serve) dla kompilatora jako usługi, z którego korzystają integracje z IDE.
mcpobjectnieUstawienia serwera Model Context Protocol (aggrega mcp). transport określa, jak łączy się z serwerem — przez standardowe wejście i wyjście procesu albo przez HTTP — i jest odczytywany niezależnie od wybranej opcji. announce_tools również jest odczytywany w obu transportach, ponieważ to, jakie narzędzia są oferowane klientowi, jest właściwością serwera, a nie sposobu, w jaki klient się z nim połączył. Każdy inny klucz konfiguruje nasłuch uruchamiany przez transport HTTP i nie jest używany, gdy serwer komunikuje się przez standardowe wejście i wyjście — łącznie z listen, który jest tam odczytywany tylko po to, by serwer mógł w jednym wierszu swojego strumienia błędów poinformować, że adres nie jest używany. Przy każdym kluczu poniżej podano, do której grupy należy. Różni się od serve, który konfiguruje demona zaplecza edytora.
registriesRegistryConfig[]nieUstawienia poszczególnych rejestrów i polityka zaufania do podpisów, indeksowane hostem rejestru. Rejestr niewymieniony tutaj używa wartości domyślnych: obecny podpis jest weryfikowany, a brak podpisu jest tolerowany, z wyjątkiem hub.aggrega.ai, którego wbudowany poziom bazowy wymaga zweryfikowanego podpisu nawet bez jawnego wpisu. Jawny wpis dla hosta zastępuje poziom bazowy tego hosta. Wartość domyślna: []
signingSigningConfignieBlok podpisywania najwyższego poziomu, obowiązujący wszystkie rejestry: adresy URL usług podpisywania bezkluczowego, opcjonalna ścieżka do klucza oraz stanowisko zaufania dla wszystkich rejestrów (required i kinds). Blok signing dla danego rejestru zastępuje domyślne punkty końcowe dla tego hosta i niesie to samo stanowisko required/kinds ograniczone do tego hosta — jedna nazwa, jedno zadanie, zakres wynikający z umiejscowienia. Polityka required/kinds najwyższego poziomu składa się monotonicznie w kaskadzie konfiguracji. Bezpieczeństwo: ten blok nie zawiera żadnych sekretów — token tożsamości OIDC nigdy nie jest polem konfiguracji (jest dostarczany w czasie działania przez flagę lub otaczające środowisko OIDC), a key_path to ścieżka do pliku klucza, nigdy bajty klucza wpisane bezpośrednio.

Dodatkowe właściwości są niedozwolone.

aggrega-config.workspace

Znacznik katalogu głównego obszaru roboczego. Sama jego obecność oznacza katalog jako katalog główny obszaru roboczego; zawiera wyłącznie katalogi katalogów definiujące katalog główny — własne katalogi obszaru roboczego oraz te, które encja Release otrzymuje jako własne. Każde ustawienie, które nie definiuje katalogu głównego, znajduje się na najwyższym poziomie, a nie tutaj. Aby oznaczyć katalog główny bez dołączonych katalogów katalogów, należy napisać workspace: {}.

WłaściwośćTypWymaganaOpis
catalog_dirsstring[]nieOpcjonalne katalogi katalogu encji, z których ten obszar roboczy odczytuje encje lokalne, sprawdzane przed przejściem do rejestru. Każdy wpis jest ścieżką w systemie plików, rozwiązywaną względem pliku, który go deklaruje. Lista jest uporządkowanym stosem wyszukiwania, w którym wygrywa pierwszy wpis: najwcześniej wymieniony katalog deklarujący daną tożsamość jest jej właścicielem, a ta sama tożsamość w późniejszym katalogu zostaje przesłonięta. Katalog catalog w katalogu głównym obszaru roboczego jest również odczytywany, po wszystkich wymienionych wpisach i tylko wtedy, gdy istnieje — chyba że któryś z wymienionych wpisów już go zawiera; wtedy jest odczytywany jako część tego wpisu — więc wymienienie katalogu dodaje coś do tego, co obszar roboczy już odczytywał, zamiast to zastępować. Pominięcie tego klucza i zapisanie go jako pustej listy to dwa różne stwierdzenia: po pominięciu obszar roboczy nadal odczytuje catalog; zapisany jako [] nie odczytuje żadnego lokalnego katalogu, i w ten sposób obszar roboczy deklaruje, że go nie ma. Encja Release, której przypisano własne katalogi w releases, odczytuje je zamiast tej listy. Zakres katalogu głównego: lokalne katalogi należą do tego katalogu głównego obszaru roboczego, dlatego znajdują się w znaczniku katalogu głównego, a nie na najwyższym poziomie.
catalog_dirs_appendstring[]nieOpcjonalne uzupełnienie (tylko dopisywanie) efektywnej listy catalog_dirs. Na każdej warstwie pierwszeństwa wpisy z tego miejsca są dołączane do rozwiązanej listy bazowej, dzięki czemu konfiguracje obszaru roboczego i globalna mogą łączyć katalogi zamiast się wzajemnie przesłaniać. Interakcja w obrębie jednej warstwy: gdy na jednej warstwie podano zarówno catalog_dirs, jak i catalog_dirs_append, rozwiązana wartość na tej warstwie to lista bazowa, a po niej lista dopisywana. Default: []
releasesmapa ReleaseCatalogConfignieOpcjonalne własne katalogi encji Release, dla obszaru roboczego, który utrzymuje obok siebie kilka wariantów katalogu i buduje każdą encję Release względem jednego z nich. Każdy klucz to plik Release, zapisany jako ścieżka względna wobec pliku, który go deklaruje; każda wartość zawiera catalog_dirs i catalog_dirs_append o takim samym znaczeniu jak w tym bloku, ograniczonym do tej jednej encji Release. Wymieniona tu encja Release odczytuje własne catalog_dirs zamiast listy tego bloku, a po nich własne catalog_dirs_append; wpis pomijający catalog_dirs zachowuje listę tego bloku i dodaje po niej swoje catalog_dirs_append. Kolejność wyszukiwania, katalog catalog w katalogu głównym obszaru roboczego oraz znaczenie pustej listy są takie same jak dla własnej listy tego bloku, a encja Release, której ta mapa nie wymienia, odczytuje listę tego bloku dokładnie tak jak wcześniej. Encja Release odczytuje te katalogi niezależnie od sposobu budowania — w terminalu, z edytora przez aggrega serve lub przez aggrega mcp — a katalog --catalog jest nadal przeszukiwany przed nimi dla jednego wywołania. Wpis wskazujący nieistniejący plik jest odrzucany podczas ładowania konfiguracji, z podaniem wpisu i pliku, więc zmiana nazwy pliku Release nie może po cichu zmienić katalogu, względem którego jest budowana. Między plikami konfiguracji wpis każdej encji Release łączy się tak samo jak własne klucze tego bloku: catalog_dirs z bliższego pliku dla tej encji Release zastępuje to z dalszego pliku, a catalog_dirs_append z każdego pliku jest dodawane w kolejności kaskady. AGGREGA_CATALOG_DIRS ustawia listę tego bloku i nie dotyczy żadnego wpisu tutaj. Operacja, która nie dotyczy pojedynczej encji Release — lint lub walidacja całego katalogu, wyszukanie encji po nazwie albo wylistowanie encji obszaru roboczego przez edytor — odczytuje listę tego bloku, a nie te katalogi.

Dodatkowe właściwości są niedozwolone.

aggrega-config.build

Ustawienia rygoru na etapie budowania i wskazówki dla autorów. authoring_release dostarcza LSP wskazówkę current Release dla diagnostyki w edytorze; halt_on_deprecated_severity określa, jak budowanie reaguje na użycie przestarzałych encji; yaml_indent ustawia szerokość wcięcia każdego renderowanego artefaktu YAML.

WłaściwośćTypWymaganaOpis
authoring_releasestringnieŚcieżka do pliku YAML encji Release, który LSP traktuje jako kontekst current Release dla diagnostyki w tekście. Opcjonalne.
yaml_indentintegernieSzerokość wcięcia (w spacjach) każdego renderowanego artefaktu YAML — plików docker-compose, szablonów i wartości chartów Helm oraz manifestów Kubernetes. Domyślnie 2, zgodnie z konwencją dla tych formatów. Minimum: 2. Maksimum: 9. Domyślnie: 2
halt_on_deprecated_severitystring (enum)niePoziom ważności w uporządkowanym zbiorze warning < error < retracted, od którego (włącznie) zarejestrowany znacznik wycofania zatrzymuje budowanie. Dotyczy obu miejsc, w których znacznik jest rejestrowany: pliku blokady, dla wszystkiego, co budowanie odtwarza bajt po bajcie, oraz leżącego obok rejestru zaufania pluginów, dla pluginu dołączonego w roli zwracającej werdykt akceptacji lub odrzucenia — dołączenia plugins.governance w ir-verdict lub render-verdict oraz każdego dołączenia plugins.linter. Jedno pokrętło, jedna reguła, oba magazyny. Domyślnie nieustawione, a nieustawione oznacza, że żaden zarejestrowany znacznik nie zatrzymuje budowania: znacznik jest rejestrowany dla wersji już przypiętej, więc budowanie, które raz się powiodło, nadal się powodzi. Powiadamianie i rozwiązywanie to dwie odrębne osie i żadna z nich nie jest tym pokrętłem. Każda powierzchnia odczytująca którykolwiek z rejestrów zgłasza każde przypięte przestarzałe odwołanie i każdy zaufany plugin ze znacznikiem — na każdym poziomie ważności — podając go, jego poziom ważności i komunikat: aggrega build, aggrega validate --release, aggrega lint --release, demon dla edytorów oraz narzędzia AI-native build, describe i validate. Podniesienie tego progu nigdy więc nie ogranicza tego, co jest zgłaszane. To pokrętło dotyczy wyłącznie budowania: zatrzymuje aggrega build (oraz narzędzie AI-native build, które jest tą samą operacją), a powierzchnie raportujące podają znacznik i kontynuują. Tylko znacznik retracted wpływa na to, do której wersji rozwiązuje się odwołanie, i dzieje się to, gdy aggrega pull wybiera wersję, a nie podczas budowania. Dozwolone wartości: "warning", "error", "retracted"

Dodatkowe właściwości są niedozwolone.

aggrega-config.plugins

Dołączenia pluginów Wasm na poziomie obszaru roboczego. Każde gniazdo (governance, linter, importer) przyjmuje tablicę odwołań do pluginów; budowanie wywołuje udokumentowaną funkcję wejściową każdego pluginu zgodnie z kontraktem jego gniazda. Lista providers wiąże możliwości z pluginami renderującymi dostawców, które je obsługują.

WłaściwośćTypWymaganaOpis
governancePluginRef[]nieWtyczki gniazda governance. Każdy wpis określa role w potoku, na której jest dołączony (annotation-transform, label-transform, ir-verdict lub render-verdict); rola wyznacza zarówno to, co wtyczka może emitować, jak i jej domyślną funkcję wejściową (annotation-transform → transform_annotations; label-transform → mutate; ir-verdict → verdict_ir; render-verdict → verdict_render). Wartość domyślna: []
governance_appendPluginRef[]nieDopisywane uzupełnienie efektywnej listy governance. Wpisy z tego miejsca są dołączane do rozwiązanej listy bazowej na każdej warstwie pierwszeństwa, dzięki czemu konfiguracje obszaru roboczego i globalna składają dołączenia governance, zamiast się wzajemnie przesłaniać. Wartość domyślna: []
linterPluginRef[]nieWtyczki gniazda linter. Domyślna funkcja wejściowa: lint_rules. Eksporty wtyczki lintera muszą zaczynać się od lint_, więc function: w jednym z tych wpisów wskazuje eksport z tym prefiksem. Wartość domyślna: []
linter_appendPluginRef[]nieDopisywane uzupełnienie efektywnej listy linter. Ta sama semantyka składania zamiast przesłaniania co w governance_append. Wartość domyślna: []
importerFixedEntryPluginRef[]nieWtyczki gniazda importer. Gniazdo wywołuje funkcję wejściową import; dołączenie jej nie wskazuje. Wartość domyślna: []
importer_appendFixedEntryPluginRef[]nieDopisywane uzupełnienie efektywnej listy importer. Ta sama semantyka składania zamiast przesłaniania co w governance_append. Wartość domyślna: []
providersFixedEntryPluginRef[]nieWybór dostawcy dla poszczególnych możliwości. Każdy wpis wiąże jedną możliwość dostawcy (samą nazwę możliwości, którą encja Recipe wiąże przez spec.capability, np. helm lub compose) z samą tożsamością wtyczki renderującej dostawcy, która ją obsługuje (tożsamość encji Plugin, czyli jej metadata.pluginType i metadata.name połączone ukośnikiem, np. provider/helm), z opcjonalnym końcowym :version w tych samych trzech formach co przypięcie wersji (bez wersji, dokładna :1.0.0 lub zakres zgodny co do wersji głównej :^1.0.0). Jest to miejsce rozstrzygania niejednoznaczności i nadpisywania dla katalogu sfederowanego, w którym tę samą możliwość obsługuje więcej niż jedna wtyczka dostawcy: powiązanie wybiera, wtyczka którego wydawcy renderuje daną możliwość. Gdy możliwość obsługuje dokładnie jedna wtyczka dostawcy, wpis nie jest potrzebny. W złożonej liście dozwolony jest dokładnie jeden wpis na możliwość; zduplikowana możliwość głośno zatrzymuje rozwiązywanie. Rozwiązywanie odbywa się przy pull: pull zapisuje rozwiązane powiązanie w pliku blokady danej encji Release, a build odczytuje plik blokady — zmiana w tym miejscu po pull nie jest przyjmowana do następnego pull, więc wynik budowania jest na nią niezmienny (deterministyczny wynik). Każde budowanie i każda walidacja encji Release sprawdza też każdy wpis w tym miejscu, niezależnie od tego, czy jakaś encja Recipe prosi o jego możliwość: wpis wskazujący wtyczkę, którą build posiada, a która nie obsługuje możliwości wpisu, zatrzymuje budowanie, podając, co ta wtyczka obsługuje, oraz pisownię odległą o jedną edycję, jeśli taka istnieje; wpis wskazujący możliwość, a nie wtyczkę, gdy żadna wtyczka dostawcy odczytywana przez build nie obsługuje tej możliwości, jest zgłaszany jako ostrzeżenie zamiast zatrzymania, ponieważ obsługująca ją wtyczka może być odczytywana tylko przez inną encję Release; a wpis dla możliwości, którą obsługuje jakaś wtyczka, ale o którą ta encja Release nigdy nie prosi, jest dozwolony i nie jest zgłaszany, ponieważ wpisy pisze się dla całego obszaru roboczego, a budowanie dotyczy jednej encji Release. capability zawierające dwukropek jest odrzucane przy wczytywaniu konfiguracji: spec.capability encji Recipe jest odczytywane jako możliwość do ostatniego dwukropka i przypięcie wersji po nim, więc żadna encja Recipe nie mogłaby dotrzeć do takiego wpisu. Brak wpisu dla możliwości obsługiwanej jednoznacznie nie jest błędem; brak wpisu dla możliwości obsługiwanej niejednoznacznie głośno zatrzymuje pull, wymieniając wtyczki kandydujące. Współistnienie wersji jest zachowane: powiązanie wybiera repozytorium wtyczki dla danej możliwości, a przypięcie wersji w spec.capability każdej encji Recipe wybiera wersję w tym repozytorium, więc dwie encje Recipes przypinające różne wersje jednego dostawcy nadal współistnieją. Wartość domyślna: []
providers_appendFixedEntryPluginRef[]nieDopisywane uzupełnienie efektywnej listy providers. Wpisy z tego miejsca są dołączane do rozwiązanej listy bazowej na każdej warstwie pierwszeństwa, dzięki czemu konfiguracje obszaru roboczego i globalna składają powiązania dostawców, zamiast się wzajemnie przesłaniać. Ta sama semantyka składania zamiast przesłaniania co w governance_append. Zasada jednego wpisu na możliwość dotyczy złożonej listy, więc dopisany wpis wskazujący możliwość już powiązaną przez niższą warstwę głośno zatrzymuje rozwiązywanie. Wartość domyślna: []
cliCLIPluginRef[]nieWtyczki rozszerzające CLI, instalowane jako polecenia najwyższego poziomu aggrega. Każdy wpis przypina jedną wtyczkę CLI przez jej rozwiązane, przypięte do wersji odwołanie do artefaktu oraz skrót treści bajtów gościa, na które to odwołanie zostało rozwiązane w chwili instalacji. W odróżnieniu od czterech przekrojowych list gniazd, których lista bazowa jest w kaskadzie konfiguracji zastępowana w całości, lista CLI jest składana: wtyczka CLI w konfiguracji globalnej rejestruje swoje polecenia w każdym obszarze roboczym, wtyczka w konfiguracji obszaru roboczego rejestruje się tylko w tym projekcie, a obie rejestrują się razem — dlatego lista nie potrzebuje towarzyszącego _append. Nazwy poleceń i pomoc, które wnosi każda wtyczka, pochodzą z jej własnego samoopisu, odczytywanego z dyskowej pamięci podręcznej opisów kluczowanej przez digest (przy zimnej pamięci podręcznej rozwiązaniem awaryjnym jest załadowanie gościa); lista zawiera tylko przypięcie. Przy wywołaniu polecenia rozwiązane bajty są ponownie haszowane i porównywane z digest; niezgodność głośno zatrzymuje polecenie i nakazuje ponowne przypięcie, więc wtyczka, której bajty zmieniły się od przypięcia, nigdy nie zostanie uruchomiona niepostrzeżenie. Wartość domyślna: []

Dodatkowe właściwości są niedozwolone.

aggrega-config.lint

Ustawienia rygoru poszczególnych reguł.

WłaściwośćTypWymaganaOpis
publishing_disciplineobjectnieBramki zestawu reguł lintera publikacji obowiązujące w całym obszarze roboczym. Flagi allow_* łagodzą poszczególne kontrole zniechęcające. Niezmienności artefaktów nie można tu skonfigurować: aggrega push bezwarunkowo odmawia nadpisania opublikowanej wersji.

Dodatkowe właściwości są niedozwolone.

aggrega-config.lint.publishing_discipline

Bramki zestawu reguł lintera publikacji obowiązujące w całym obszarze roboczym. Flagi allow_* łagodzą poszczególne kontrole zniechęcające. Niezmienności artefaktów nie można tu skonfigurować: aggrega push bezwarunkowo odmawia nadpisania opublikowanej wersji.

WłaściwośćTypWymaganaOpis
allow_dynamic_refslogicznanieGdy ma wartość true, linter publikacji akceptuje konstrukcje JSON Schema $dynamicRef / $dynamicAnchor w treści katalogu. Domyślnie false; te konstrukcje są odradzane, ponieważ sprawiają, że kompozycja schematów w czasie kompilacji przestaje być lokalna. Domyślnie: false
allow_id_overrideslogicznanieGdy ma wartość true, linter publikacji akceptuje nadpisania $id w podschematach w treści schematu encji. Domyślnie false; nadpisania $id łamią konwencję jednego kanonicznego identyfikatora na schemat, na której polegają zarówno resolver, jak i walidator JSON Schema. Domyślnie: false
allow_direct_x_aggrega_extensionslogicznanieGdy ma wartość true, sprawdzanie odradzanych konstrukcji w czasie budowania akceptuje słowa kluczowe x-aggrega-selector i x-aggrega-inject zapisane bezpośrednio w treści schematu. Domyślnie false; zalecaną ścieżką tworzenia jest usesSchema (dla gniazd zależności) lub featuresSchema (dla powiązań poświadczeń), które kompilator składa w te słowa kluczowe. Domyślnie: false
allow_aggrega_ai_prefixlogicznanieGdy ma wartość true, linter publikacji akceptuje klucze adnotacji używające zarezerwowanych przestrzeni nazw aggrega.ai/ i feature.aggrega.ai/ poza ich kanonicznymi kontekstami. Reguła zarezerwowanych prefiksów kontroluje metadata.annotations encji katalogu: sam prefiks aggrega.ai/ jest natywny dla platformy (dobrze znane klucze adnotacji są zwolnione niezależnie od tej flagi); prefiks feature.aggrega.ai/ jest kanoniczny tylko dla rodzaju Feature. Domyślnie false. Operatorzy ustawiają tę flagę, gdy narzędzia przedsiębiorstwa w uzasadniony sposób muszą użyć zarezerwowanego prefiksu; flaga rozluźnia oba prefiksy jednocześnie. Domyślnie: false
allow_nonstandard_nameslogicznanieGdy ma wartość true, linter publikacji akceptuje nazwy encji katalogu, które nie są zgodne z udokumentowanymi konwencjami nazewnictwa projektu. Domyślnie false; spójne nazewnictwo ma kluczowe znaczenie dla resolvera, wyboru według etykiet i wygody recenzentów. Domyślnie: false
allow_category_mismatcheslogicznanieGdy true, publishing-linter wyłącza regułę category-matches-directory. Konwencja standardowego katalogu wymaga, aby Components w core// deklarowały component.aggrega.ai/category={category} zgodne z segmentem katalogu, gdzie {category} jest jedną z wartości zamkniętego zbioru (np. ai-agent, ai-model, ai-tool, datastore, gateway, compute, …). Przestrzenie robocze z uzasadnionymi trwałymi wyjątkami mogą tu z niej zrezygnować. Domyślnie false. Domyślnie: false
allow_undeclared_recipe_provideslogicznanieGdy ma wartość true, linter publikacji wyłącza regułę deklarowania provides przez komponent. Ta reguła zgłasza każdy klucz, który encja Recipe publikuje w spec.provides, a którego encja Component wskazana przez jej spec.implements nie deklaruje w filarze provides swojego spec.schema. Są to dwie odrębne powierzchnie: to, co publikuje Recipe, jest wartością otrzymywaną przez konsumenta, natomiast to, co deklaruje Component, jest kontraktem wyjściowym, względem którego sprawdzane jest odwołanie inject from: — dlatego klucz opublikowany bez zadeklarowania powoduje zatrzymanie takiego odwołania. Poza tym Recipe publikujący więcej, niż deklaruje jego Component, jest akceptowany w czasie budowania, dlatego zgłoszenie ma charakter doradczy, a nie jest odmową publikacji. Domyślnie false. Domyślnie: false
allow_connection_credential_mismatcheslogicznanieGdy ma wartość true, linter publikacji wyłącza regułę zgodności poświadczenia połączenia z kluczem celu, którą aggrega lint --release uruchamia na wskazanej encji Release: na samej encji Release, na encji Aggregate, którą ona wdraża, oraz na Components używanych przez instancje tej encji Aggregate. Dla każdego połączenia, którego cel deklaruje klucz wymagany od wywołujących, reguła porównuje to, do czego odwołują się oba końce: poświadczenie przedstawiane przez połączenie i klucz, który cel przechowuje we własnym slocie. Zgłasza końce wskazujące różne sekrety oraz klucz zadeklarowany tylko na jednym końcu, i nigdy nie cytuje żadnego z nich. Żaden koniec nie widzi powiązań drugiego, więc ich zgodność zależy wyłącznie od dyscypliny autorów — zwykle jeden parametr zasila oba — a budowanie akceptuje je w obu przypadkach, dlatego zgłoszenie ma charakter doradczy. Przestrzeń robocza, w której oba końce celowo się różnią, może tu z niej zrezygnować. Domyślnie false. Domyślnie: false

Dodatkowe właściwości są niedozwolone.

aggrega-config.parse_cache

Limity usuwania z pamięci podręcznej parsowania demona. Oba limity obowiązują jednocześnie — pętla usuwania LRU działa po każdym wstawieniu do pamięci podręcznej i usuwa najdawniej używane wpisy, dopóki zarówno liczba wpisów, jak i łączna liczba bajtów nie mieszczą się w limitach. Zero w którymkolwiek oznacza unbounded on that axis, co przydaje się w scenariuszach CI, w których pamięć podręczna istnieje tylko przez jedno wywołanie. Różni się od artifact_cache_dir, czyli dyskowej pamięci podręcznej treści.

WłaściwośćTypWymaganaOpis
max_entriesintegernieLimit liczby buforowanych wyników parsowania. Domyślnie 1000. 0 wyłącza oś liczby wpisów (liczba wpisów nie wyzwala usuwania). Minimum: 0. Domyślnie: 1000
max_bytesintegernieLimit łącznego rozmiaru, w bajtach, dokumentów przechowywanych w pamięci podręcznej. Domyślnie 100000000 (100 MB). 0 wyłącza oś bajtów (łączna liczba bajtów nie wyzwala usuwania). Minimum: 0. Domyślnie: 100000000

Dodatkowe właściwości są niedozwolone.

aggrega-config.compiled_module_cache

Limit rozmiaru dyskowej pamięci podręcznej skompilowanych modułów, czyli magazynu kodu maszynowego, który kompilator ponownie wykorzystuje, aby plugin Wasm był kompilowany raz na maszynę zamiast raz na budowanie. Jest współdzielona przez wszystkie obszary robocze na maszynie, więc ten klucz należy umieścić w globalnym pliku konfiguracyjnym, jeśli ma obowiązywać jedna wartość dla całej maszyny. Limit jest stosowany raz na wywołanie, przed załadowaniem jakiegokolwiek pluginu, przez usuwanie całych wpisów, od najdawniej skompilowanych, aż reszta się zmieści — nigdy w trakcie kompilacji podczas budowania. Usunięcie wpisu kosztuje jedynie późniejszą ponowną kompilację, więc limit można bezpiecznie obniżyć. aggrega cache status podaje bieżący rozmiar magazynu, a aggrega cache evict --max-size przycina go na żądanie do limitu podanego w wierszu poleceń. Różni się od artifact_cache_dir (pobrana treść rejestrów) i od parse_cache (pamięć podręczna parsowania demona w pamięci operacyjnej).

WłaściwośćTypWymaganaOpis
max_bytesintegernieLimit bajtów, które pamięć podręczna skompilowanych modułów zajmuje na dysku. Domyślnie 53687091200 (50 GiB) — to pułap powstrzymujący nieograniczony wzrost, a nie budżet, który ma być odczuwalny: pojedynczy skompilowany plugin zajmuje setki megabajtów, więc maszyna budująca wiele wersji pluginów gromadzi gigabajty. Należy ustawić go powyżej tego, co kompiluje jedno budowanie: limit jest stosowany, zanim budowanie cokolwiek skompiluje, więc limit mniejszy niż zbiór roboczy pojedynczego budowania sprawia, że każde budowanie odrzuca i ponownie kompiluje te same moduły, a magazyn przestaje cokolwiek oszczędzać. Ponieważ limit jest stosowany najpierw, a budowanie zapisuje potem to, co skompiluje, magazyn może między budowaniami przekraczać limit; jest ponownie przycinany na początku następnego. 0 wyłącza limit (magazyn rośnie bez ograniczeń i nic nie jest nigdy usuwane automatycznie). Ponieważ magazyn jest jednym katalogiem współdzielonym przez wszystkie przestrzenie robocze, ten limit nie dotyczy pojedynczego projektu, nawet gdy zawiera go plik projektu: wartość jest rozstrzygana tak samo jak każdy inny klucz, z pierwszeństwem bliższego pliku, ale magazyn nadal ma tylko jeden rozmiar. Obowiązuje limit z ostatniego budowania, więc dwa projekty ustawiające go inaczej działają na zmianę, a niski limit w jednym odrzuca kod maszynowy skompilowany przez drugi. Jednorazowe ustawienie go w globalnym pliku konfiguracyjnym daje całej maszynie jedną odpowiedź. aggrega config show --origin wskazuje plik, z którego pochodzi efektywna wartość każdego ustawienia. Minimum: 0. Domyślnie: 53687091200

Dodatkowe właściwości są niedozwolone.

aggrega-config.concurrency

Ustawienia współbieżności rozdzielania żądań demona. Demon odczytuje żądania z jednego strumienia stdin i przekazuje każde do puli wątków roboczych, która opróżnia ograniczoną kolejkę żądań; odpowiedzi są emitowane w kolejności nadejścia żądań, niezależnie od kolejności ich ukończenia.

WłaściwośćTypWymaganaOpis
pool_sizeintegernieLiczba procesów roboczych obsługujących kolejkę żądań. Domyślnie 4, co pozwala obsługiwać do czterech żądań współbieżnie; ustawienie 1 powoduje wykonywanie żądań szeregowo w kolejności nadejścia. Wartość mniejsza niż 1 jest podnoszona do 1 przy uruchomieniu demona. Minimum: 1. Wartość domyślna: 4

Dodatkowe właściwości są niedozwolone.

aggrega-config.serve

Ustawienia działania demona (aggrega serve) dla kompilatora jako usługi, z którego korzystają integracje z IDE.

WłaściwośćTypWymaganaOpis
build_on_inspectlogicznanieOkreśla, czy demon uruchamia etap renderowania artefaktów podczas inspekcji grafu IR, tak aby ostrzeżenia zgłaszane przez aggrega build podczas renderowania pojawiały się również jako problemy w edytorze. Nie dodaje żadnego ze sprawdzeń, na których kompilacja się zatrzymuje. W żadnym przypadku nic nie jest zapisywane na dysk — ani wyrenderowane artefakty, ani katalog wyjściowy, ani plik blokady — a etap renderowania nigdy nie modyfikuje grafu, więc tam, gdzie inspekcja zwraca graf, jest to w obu przypadkach ten sam graf. Domyślnie false, zgodnie z aggrega inspect: polecenie terminalowe nie dochodzi do etapu renderowania podczas inspekcji grafu, więc także nie zgłasza takich ostrzeżeń, a inspekcja w edytorze, która ich nie zgłasza, pokazuje to samo co terminal. Ustawienie true powoduje, że edytor otrzymuje tę dodatkową warstwę. Wartość domyślna: false
lint_on_validatelogicznanieOkreśla, czy demon uruchamia sprawdzenie konwencji publikowania podczas walidacji encji katalogu, tak aby wyniki zgłaszane przez aggrega lint dla tej encji pojawiały się również jako problemy w edytorze. Wyniki mają charakter doradczy: dokument, który je wywołuje, nadal przechodzi walidację, a jego Release nadal jest rozwiązywany i renderowany. Uruchamiane jest tylko sprawdzenie odczytujące lokalną treść — żaden rejestr nie jest odpytywany, nic nie jest pobierane ani zapisywane — i jest ono wykonywane na buforze przechowywanym przez edytor, a nie na pliku na dysku, więc poprawiona nazwa przestaje być zgłaszana jeszcze przed zapisaniem. Domyślnie false: sesja edytora informuje, czy dokument jest poprawny, i nie mówi nic o tym, czy encję można opublikować, dopóki nie zażąda się tej drugiej warstwy. Ustawienie true powoduje jej włączenie. Niezależnie od tego klucza edytor zawsze może zażądać sprawdzenia bezpośrednio; w ten sposób dostępne jest również porównanie przed publikacją z wcześniej opublikowaną wersją. Wartość domyślna: false

Dodatkowe właściwości są niedozwolone.

aggrega-config.mcp

Ustawienia serwera Model Context Protocol (aggrega mcp). transport określa, jak łączy się z serwerem — przez standardowe wejście i wyjście procesu albo przez HTTP — i jest odczytywany niezależnie od wybranej opcji. announce_tools również jest odczytywany w obu transportach, ponieważ to, jakie narzędzia są oferowane klientowi, jest właściwością serwera, a nie sposobu, w jaki klient się z nim połączył. Każdy inny klucz konfiguruje nasłuch uruchamiany przez transport HTTP i nie jest używany, gdy serwer komunikuje się przez standardowe wejście i wyjście — łącznie z listen, który jest tam odczytywany tylko po to, by serwer mógł w jednym wierszu swojego strumienia błędów poinformować, że adres nie jest używany. Przy każdym kluczu poniżej podano, do której grupy należy. Różni się od serve, który konfiguruje demona zaplecza edytora.

WłaściwośćTypWymaganaOpis
transportstring (enum)nieSposób połączenia z serwerem: stdio obsługuje protokół przez standardowe wejście i wyjście procesu, w ten sposób łączy się klient uruchamiający polecenie jako podproces; http udostępnia go przez HTTP pod adresem wskazanym w listen, a przez HTTPS tam, gdzie tls wskazuje certyfikat i klucz. aggrega mcp --transport stdio|http nadpisuje ten klucz dla jednego wywołania. Domyślnie stdio, więc obszar roboczy, który nigdy nie wskazuje transportu, jest obsługiwany przez standardowe wejście i wyjście niezależnie od pozostałej zawartości tego bloku — nasłuch uruchamia się tylko tam, gdzie wybrano http, tutaj lub w wierszu poleceń. Każda inna wartość jest odrzucana przy ładowaniu konfiguracji. Należy ustawić http w konfiguracji serwera, z którym wywołujący łączą się przez sieć, i pozostawić klucz nieustawiony tam, gdzie klient sam uruchamia serwer: przy wybranym stdio adres w listen nie jest używany, a serwer informuje o tym jednym wierszem w strumieniu błędów. Dozwolone wartości: "stdio", "http" Wartość domyślna: "stdio"
listenstringnieAdres, z którym wiąże się nasłuch, gdy wybrano transport HTTP. Wskazuje, gdzie nasłuchiwać, i niczego nie wybiera: wybór transportu należy do transport, a przy wybranym stdio ten klucz nie jest używany. Akceptowane są dwie formy: host:port dla adresu TCP oraz unix:, po którym następuje ścieżka w systemie plików, dla gniazda domeny Unix. aggrega mcp --listen <address> nadpisuje ten klucz dla jednego wywołania. Domyślnie pusty, a transport HTTP wymaga adresu z jednego lub drugiego źródła: bez żadnego z nich uruchomienie, które go wybiera, jest odrzucane, zanim cokolwiek zostanie powiązane. Adres bez szyfrowania — taki, do którego dostęp odbywa się bez certyfikatu i klucza w tls — jest akceptowany tylko na interfejsie loopback (127.0.0.1, ::1 lub localhost rozwiązywany na jeden z nich) lub na gnieździe Unix, co jest układem stosowanym przez serwer, gdy TLS kończy stojący przed nim serwer proxy; każdy inny adres jest odrzucany, zanim cokolwiek zostanie powiązane, z komunikatem wskazującym mcp.tls.cert_file i mcp.tls.key_file. Te same dwie formy są jedynymi akceptowanymi, z certyfikatem lub bez, tam, gdzie ustawiono authorization.trusted_proxy, ponieważ nagłówkowi można zaufać jako poświadczeniu tylko tam, gdzie nikt poza serwerem proxy nie może go ustawić. Wartość domyślna: ""
tlsobjectnieCertyfikat i klucz do kończenia TLS wewnątrz procesu serwującego. Ustawienie obu powoduje udostępnianie HTTPS bezpośrednio z nasłuchu wskazanego w listen. Pozostawienie obu nieustawionych powoduje udostępnianie bez szyfrowania, co ogranicza listen do interfejsu loopback lub gniazda Unix — układu, który należy stosować, gdy certyfikat przechowuje stojący przed nim serwer proxy. Oba klucze są ścieżkami do plików na dysku; żaden nie zawiera materiału klucza bezpośrednio.
allowed_originsstring[]nieŹródła akceptowane w nagłówku Origin żądania. Żądanie, którego nagłówek Origin wskazuje źródło nieobecne na tej liście, jest odrzucane z kodem 403; żądanie wskazujące źródło z listy lub w ogóle bez nagłówka Origin jest obsługiwane. Wpis jest porównywany z nagłówkiem dokładnie, więc każdy zapisuje się tak, jak przeglądarka wysyła źródło: schemat małymi literami, ://, host małymi literami — nazwa, adres IPv4 lub adres IPv6 w nawiasach kwadratowych — oraz : z portem, jeśli nie jest domyślny dla schematu, i nic więcej. Na przykład https://app.example.com lub http://localhost:3000. Wpis w innej postaci nigdy nie mógłby być równy temu, co wysyła przeglądarka, więc jest odrzucany przy ładowaniu pliku konfiguracyjnego z komunikatem wskazującym plik i wpis: wpis z końcowym / lub ścieżką (https://app.example.com/), wpis bez schematu (app.example.com) oraz wpis zawierający wielką literę lub spację. Domyślnie pusta, więc żadne źródło nie jest akceptowane i obsługiwany jest tylko wywołujący, który nie wysyła nagłówka Origin. Klient działający w przeglądarce musi więc mieć tu wpisane swoje źródło; klient, który nie jest przeglądarką, nie wysyła takiego nagłówka i nie potrzebuje wpisu. Każdy wpis pasuje do wzorca ^[a-z][a-z0-9+.-]*://(?:[a-z0-9._-]+|\[[0-9a-f:.]+\])(?::[0-9]{1,5})?$. Wartość domyślna: []
limitsobjectnieLimity, które nasłuch HTTP stosuje do przyjmowanego ruchu, aby jeden wywołujący nie mógł wyczerpać zasobów procesu serwującego. Ograniczają rozmiar pojedynczego żądania, liczbę żądań wykonywanych jednocześnie oraz tempo, w jakim jeden wywołujący może wysyłać żądania. Żadnego z nich nie można wyłączyć.
authorizationobjectnieCo ten serwer deklaruje na temat tokenów okaziciela (bearer), które przedstawiają jego wywołujący: który serwer autoryzacji je wydaje, adres, który ten serwer publikuje o sobie jako zasób, dla którego są wydawane, opcjonalnie plik, z którego należy odczytać klucze weryfikacyjne tamtego serwera, oraz opcjonalnie nagłówki ustawiane przez serwer proxy stojący przed nim, gdy to on zamiast tego weryfikuje tokeny. issuer i resource są wymagane zawsze, gdy wybrany jest transport HTTP, a bez nich nasłuch zostaje odrzucony, zanim cokolwiek zostanie powiązane z adresem; serwer komunikujący się przez standardowe wejście i wyjście nie odczytuje żadnego z tych kluczy. Oba są publikowane w dokumencie metadanych chronionego zasobu OAuth udostępnianym przez nasłuch, który jest jedyną odpowiedzią, jaką wywołujący przez HTTP otrzymuje bez żądania poświadczeń, ponieważ klient odczytuje go, aby dowiedzieć się, gdzie uzyskać token. Ten blok nie zawiera żadnych tajnych danych: token jest przedstawiany przez wywołującego w wysyłanym przez niego żądaniu i nigdy nie jest polem konfiguracji, a jwks_file wskazuje publiczne klucze weryfikacyjne, a nie cokolwiek, co podpisuje.
deny_reachstring (enum)[]nieRodzaje zasięgu, których ten serwer nie obsługuje, niezależnie od tego, co mówi token wywołującego. Każda operacja deklaruje, jak daleko sięgają jej skutki — none dla operacji, która odczytuje lub renderuje i nie pozostawia niczego po sobie, workspace dla operacji zapisującej wewnątrz obszaru roboczego obsługiwanego przez ten proces, registry dla operacji, która publikuje, podpisuje lub wycofuje, oraz machine dla operacji zmieniającej to, co współdzielą wszystkie obszary robocze na hoście — a wskazanie tu rodzaju wycofuje z tego serwera każde narzędzie tego rodzaju. Wycofane narzędzie nie występuje na liście narzędzi ani w odpowiedzi describe-capabilities, dla żadnego wywołującego, a próba jego wywołania mimo to zostaje odrzucona ze wskazaniem tego ustawienia, ponieważ żaden zakres uprawnień nie mógłby go dopuścić. Domyślnie pusta, więc serwer obsługuje wszystko, co dopuszczają zakresy uprawnień jego wywołujących. Jest to ograniczenie, które serwer nakłada sam na siebie, ponad ograniczeniem nakładanym na każdego wywołującego przez zakresy uprawnień: serwer obsługujący wyłącznie odczyt wskazuje tu trzy rodzaje zapisujące i wtedy nie może publikować nawet dla wywołującego, którego token zawiera wszystkie zakresy. Wskazanie machine jest akceptowane i niczego nie zmienia — żadne narzędzie tego rodzaju nie jest w ogóle oferowane przez HTTP, co jest właściwością transportu, a nie ustawieniem. Odczytywane podczas uruchamiania nasłuchu: wartość spoza tych czterech zostaje odrzucona przy wczytywaniu konfiguracji, a jej zmiana wymaga ponownego uruchomienia. W ogóle nieodczytywane, gdy serwer komunikuje się przez standardowe wejście i wyjście, gdzie wywołującym jest osoba, która uruchomiła proces. Dozwolone wartości każdego wpisu: "none", "workspace", "registry", "machine". Domyślnie: []
announce_toolsstring[]nieNarzędzia ogłaszane przez ten serwer, nazwane dokładnie tak, jak podaje je lista narzędzi. Jeśli klucz zostanie pominięty, ogłaszane jest każde narzędzie, które ten serwer posiada, czego oczekuje klient zgodny z protokołem: pobiera on całą listę narzędzi i sam decyduje, jaką jej część przedstawić modelowi. Jeśli zostanie podana lista, ogłaszane są dokładnie te narzędzia — narzędzie pominięte nie występuje na liście narzędzi ani w odpowiedzi describe-capabilities, a wywołanie go po nazwie zostaje odrzucone ze wskazaniem tego ustawienia. Jeśli zostanie podana pusta lista, nic nie jest ogłaszane. Należy to ustawić tam, gdzie klient po drugiej stronie ogranicza liczbę narzędzi, które zarejestruje — niektóre klienty stosują ten limit łącznie dla wszystkich serwerów, z którymi są jednocześnie połączone — i wskazać narzędzia potrzebne temu klientowi. Ustawienie to zawęża to, co jest ogłaszane, i nic więcej: nie może poszerzyć deny_reach, które całkowicie wycofuje daną możliwość, ani zakresów uprawnień zawartych w tokenie wywołującego. Narzędzie wskazane tutaj, a należące do rodzaju wycofanego przez deny_reach, pozostaje poza listą narzędzi i jego wywołanie zostaje odrzucone ze wskazaniem tamtego ustawienia; narzędzie wskazane tutaj, którego zakresy uprawnień wywołującego nie dopuszczają, nadal jest wymienione na liście, a jego wywołanie zostaje odrzucone ze wskazaniem zakresu, który by je dopuścił. Każda nazwa musi należeć do narzędzia, które ten plik binarny posiada: nazwa, której nie odpowiada żadne narzędzie, zostaje odrzucona przy uruchamianiu serwera, ponieważ w przeciwnym razie ten, kto prosił o węższy zestaw, otrzymałby inny bez żadnej informacji o tym. Nazwa z rodziny cli-, która uruchamia polecenie aggrega w osobnym procesie, jest akceptowana w obu transportach i przez HTTP niczego nie ogłasza, ponieważ tam żadne takie narzędzie nie jest oferowane żadnemu wywołującemu. Odczytywane w obu transportach podczas uruchamiania serwera, więc ogłaszany zestaw jest stały przez cały czas życia procesu, a jego zmiana wymaga ponownego uruchomienia.
healthobjectnieMiejsce, w którym nadzorca pyta, czy ten proces działa i czy jest gotowy odpowiedzieć na wywołanie. Obie kontrole są obsługiwane pod osobnym adresem, nigdy pod adresem wskazanym przez listen: każde żądanie do punktu końcowego zawiera token okaziciela, więc sonda obsługiwana tam dawałaby każdemu, kto może dotrzeć do punktu końcowego, nieuwierzytelniony odczyt stanu procesu wraz z darmowym sposobem na zmuszenie go do pracy. Punkt końcowy odpowiada na /healthz i /readyz tym samym kodem 404, który zwraca dla każdej ścieżki, której nie obsługuje, zarówno z tokenem, jak i bez niego.

Dodatkowe właściwości są niedozwolone.

aggrega-config.mcp.tls

Certyfikat i klucz do kończenia TLS wewnątrz procesu serwującego. Ustawienie obu powoduje udostępnianie HTTPS bezpośrednio z nasłuchu wskazanego w listen. Pozostawienie obu nieustawionych powoduje udostępnianie bez szyfrowania, co ogranicza listen do interfejsu loopback lub gniazda Unix — układu, który należy stosować, gdy certyfikat przechowuje stojący przed nim serwer proxy. Oba klucze są ścieżkami do plików na dysku; żaden nie zawiera materiału klucza bezpośrednio.

WłaściwośćTypWymaganaOpis
cert_filestringnieŚcieżka do łańcucha certyfikatów PEM przedstawianego przez nasłuch, odczytywanego przy uruchamianiu procesu. Ustawiana razem z key_file. Domyślnie pusta, więc nasłuch obsługuje ruch niezaszyfrowany, a listen jest ograniczone do interfejsu pętli zwrotnej lub gniazda Unix. Domyślnie: ""
key_filestringnieŚcieżka do klucza prywatnego PEM dla certyfikatu z cert_file, odczytywanego przy uruchamianiu procesu. Ustawiana razem z nim. Ścieżka do pliku, nigdy materiał klucza podany bezpośrednio. Domyślnie pusta, więc nasłuch obsługuje ruch niezaszyfrowany, a listen jest ograniczone do interfejsu pętli zwrotnej lub gniazda Unix. Domyślnie: ""

Dodatkowe właściwości są niedozwolone.

aggrega-config.mcp.limits

Limity, które nasłuch HTTP stosuje do przyjmowanego ruchu, aby jeden wywołujący nie mógł wyczerpać zasobów procesu serwującego. Ograniczają rozmiar pojedynczego żądania, liczbę żądań wykonywanych jednocześnie oraz tempo, w jakim jeden wywołujący może wysyłać żądania. Żadnego z nich nie można wyłączyć.

WłaściwośćTypWymaganaOpis
max_body_bytesintegernieNajwiększa treść żądania akceptowana przez nasłuch, w bajtach. Żądanie, którego treść przekracza tę wartość, zostaje odrzucone z kodem 413, a treść nie jest odczytywana poza limit. Domyślnie 4194304 (4 MiB), co znacznie przekracza wywołanie narzędzia zawierające cały dokument autorski i jest znacznie poniżej wartości, która pozwoliłaby jednemu wywołującemu zająć znaczną część pamięci procesu. Minimum wynosi 1, więc żadna wartość nie wyłącza limitu; należy go zwiększyć tam, gdzie wywołujący w uzasadniony sposób wysyłają większe dokumenty. Minimum: 1. Domyślnie: 4194304
max_concurrent_requestsintegernieLiczba żądań, które nasłuch obsługuje jednocześnie. Żądanie przychodzące, gdy tyle żądań jest już w toku, zostaje odrzucone z kodem 503 zamiast umieszczenia w kolejce, więc wywołujący otrzymuje informację, aby ponowić próbę, zamiast czekać za pracą, której nie widzi. Domyślnie 16, co zostawia miejsce na kilka równoczesnych wywołań narzędzi, a jednocześnie utrzymuje responsywność małego hosta; na większym hoście należy tę wartość zwiększyć. Minimum wynosi 1, więc żadna wartość nie wyłącza limitu. Minimum: 1. Domyślnie: 16
requests_per_minuteintegernieLiczba żądań, które jeden wywołujący może wysłać w ciągu minuty. Jest liczona dla każdego wywołującego, a nie dla całego serwera — względem podmiotu wskazanego w tokenie wywołującego lub względem tożsamości potwierdzonej przez zaufany serwer proxy — więc jeden intensywnie działający wywołujący nie może zużyć limitu innego. Wywołujący może wysłać tyle żądań naraz; limit odnawia się następnie równomiernie, o jedno żądanie co 60 / requests_per_minute sekund, a żądanie przychodzące po wyczerpaniu limitu zostaje odrzucone z kodem 429. Domyślnie 120, czyli dwa na sekundę w sposób ciągły: znacznie więcej, niż wysyła asystent obsługujący obszar roboczy, a przy tym nadal ograniczenie dla klienta, który wpadł w pętlę. Minimum wynosi 1, więc żadna wartość nie wyłącza limitu. Minimum: 1. Domyślnie: 120

Dodatkowe właściwości są niedozwolone.

aggrega-config.mcp.authorization

Co ten serwer deklaruje na temat tokenów okaziciela (bearer), które przedstawiają jego wywołujący: który serwer autoryzacji je wydaje, adres, który ten serwer publikuje o sobie jako zasób, dla którego są wydawane, opcjonalnie plik, z którego należy odczytać klucze weryfikacyjne tamtego serwera, oraz opcjonalnie nagłówki ustawiane przez serwer proxy stojący przed nim, gdy to on zamiast tego weryfikuje tokeny. issuer i resource są wymagane zawsze, gdy wybrany jest transport HTTP, a bez nich nasłuch zostaje odrzucony, zanim cokolwiek zostanie powiązane z adresem; serwer komunikujący się przez standardowe wejście i wyjście nie odczytuje żadnego z tych kluczy. Oba są publikowane w dokumencie metadanych chronionego zasobu OAuth udostępnianym przez nasłuch, który jest jedyną odpowiedzią, jaką wywołujący przez HTTP otrzymuje bez żądania poświadczeń, ponieważ klient odczytuje go, aby dowiedzieć się, gdzie uzyskać token. Ten blok nie zawiera żadnych tajnych danych: token jest przedstawiany przez wywołującego w wysyłanym przez niego żądaniu i nigdy nie jest polem konfiguracji, a jwks_file wskazuje publiczne klucze weryfikacyjne, a nie cokolwiek, co podpisuje.

WłaściwośćTypWymaganaOpis
issuerstringnieAdres serwera autoryzacji, który wydaje tokeny akceptowane przez ten nasłuch, zapisany tak, jak ten serwer podaje własny identyfikator wystawcy — na przykład https://login.example.com. Jest publikowany na liście authorization_servers dokumentu metadanych chronionego zasobu, z którego klient dowiaduje się, gdzie uzyskać token dla tego nasłuchu. Domyślnie pusty, co nie jest użyteczną wartością: nasłuch zostaje odrzucony, zanim cokolwiek zostanie powiązane z adresem, chyba że zawiera on pełny adres, łącznie ze schematem i hostem. Jest to adres https, chyba że serwer autoryzacji działa na tej maszynie: zwykłe http jest akceptowane tylko dla hosta pętli zwrotnej, takiego jak localhost, 127.0.0.1 lub ::1, a wystawca ze zwykłym http na każdym innym hoście zostaje odrzucony, zanim cokolwiek zostanie powiązane z adresem, ze wskazaniem tego klucza i żądaniem adresu https. Obowiązuje to niezależnie od tego, czy klucze są odczytywane od wystawcy, z jwks_file, czy tokeny sprawdza stojący przed nim trusted_proxy, ponieważ każdy klient jest kierowany do wystawcy, aby uzyskać swój token. Domyślnie: ""
resourcestringnieAdres, który ten serwer publikuje o sobie, tak jak dociera do niego wywołujący — na przykład https://mcp.example.com/mcp. Należy podać adres faktycznie używany przez wywołujących, łącznie z hostem przedstawianym przez stojący przed nim serwer proxy, ponieważ jest to identyfikator, który klient przekazuje serwerowi autoryzacji, prosząc o token dla tego serwera, i jest on publikowany bez zmian jako pole resource dokumentu metadanych chronionego zasobu. Miejsce udostępniania tego dokumentu jest z niego wyprowadzane przez wstawienie /.well-known/oauth-protected-resource między host a ścieżkę: serwer opublikowany jako https://mcp.example.com/mcp udostępnia go pod https://mcp.example.com/.well-known/oauth-protected-resource/mcp, a także pod tą ścieżką well-known bez niczego po niej, gdzie klient szuka w drugiej kolejności. Token jest akceptowany tylko wtedy, gdy ten adres znajduje się wśród wskazanych w nim odbiorców. Domyślnie pusty, co nie jest użyteczną wartością: nasłuch zostaje odrzucony, zanim cokolwiek zostanie powiązane z adresem, chyba że zawiera on pełny adres, łącznie ze schematem i hostem. Domyślnie: ""
jwks_filestringnieŚcieżka do pliku zawierającego zestaw kluczy JSON Web Key Set, względem którego weryfikowane są tokeny akceptowane przez ten serwer, odczytywanego przy uruchamianiu procesu. Domyślnie pusta, co jest typowym przypadkiem: klucze są odczytywane od samego serwera autoryzacji, przez zapytanie issuer, gdzie je publikuje, i pobranie ich ze wskazanego adresu, a ponownie są odczytywane jednokrotnie, gdy nadejdzie token podpisany kluczem o identyfikatorze, którego przechowywany zestaw nie zawiera. Należy to ustawić, gdy obszar roboczy działa offline; wtedy bez tego nasłuch zostaje odrzucony, zanim cokolwiek zostanie powiązane z adresem, ponieważ obszar roboczy offline nie wykonuje żądań sieciowych i nie ma innego sposobu uzyskania kluczy; plik zawiera wówczas jedyne akceptowane klucze, a z serwerem autoryzacji nigdy nie następuje kontakt. Plik zawiera publiczne klucze weryfikacyjne i nigdy nic, co podpisuje. Ścieżka względna jest rozwiązywana względem katalogu pliku konfiguracyjnego, który ją zadeklarował. Domyślnie: ""
trusted_proxyobjectnieOdczytuje tożsamość wywołującego z nagłówków ustawianych przez stojący przed nim serwer proxy, zamiast weryfikować tutaj token okaziciela. Należy to ustawić tylko wtedy, gdy spełnione są oba warunki: stojący przed nim serwer proxy sam weryfikuje tokeny i nic poza tym serwerem proxy nie może dotrzeć do nasłuchu: przy tym ustawieniu listen musi wskazywać interfejs pętli zwrotnej lub gniazdo Unix, a każdy inny adres zostaje odrzucony, zanim cokolwiek zostanie powiązane z adresem, ze wskazaniem obu ustawień. Nagłówek jest wiarygodny dokładnie w takim stopniu, jak zbiór wywołujących, którzy mogą go ustawić, a pod adresem osiągalnym z sieci każdy wywołujący może ustawić dowolny nagłówek, więc nasłuch w tym trybie pod takim adresem pozwoliłby każdemu wywołującemu podawać się za kogokolwiek. Przy tym ustawieniu żaden token nie jest w ogóle odczytywany — ani z nagłówka Authorization, ani z żadnego innego miejsca, i żaden zestaw kluczy nie jest pobierany — tożsamością wywołującego jest wartość principal_header, na żądanie bez tego nagłówka odpowiedzią jest 401, a dwa wskazane tu nagłówki są jedynymi odczytywanymi. Jeśli zostanie pominięte, co jest ustawieniem domyślnym, ten serwer sam weryfikuje tokeny okaziciela.

Dodatkowe właściwości są niedozwolone.

aggrega-config.mcp.authorization.trusted_proxy

Odczytuje tożsamość wywołującego z nagłówków ustawianych przez stojący przed nim serwer proxy, zamiast weryfikować tutaj token okaziciela. Należy to ustawić tylko wtedy, gdy spełnione są oba warunki: stojący przed nim serwer proxy sam weryfikuje tokeny i nic poza tym serwerem proxy nie może dotrzeć do nasłuchu: przy tym ustawieniu listen musi wskazywać interfejs pętli zwrotnej lub gniazdo Unix, a każdy inny adres zostaje odrzucony, zanim cokolwiek zostanie powiązane z adresem, ze wskazaniem obu ustawień. Nagłówek jest wiarygodny dokładnie w takim stopniu, jak zbiór wywołujących, którzy mogą go ustawić, a pod adresem osiągalnym z sieci każdy wywołujący może ustawić dowolny nagłówek, więc nasłuch w tym trybie pod takim adresem pozwoliłby każdemu wywołującemu podawać się za kogokolwiek. Przy tym ustawieniu żaden token nie jest w ogóle odczytywany — ani z nagłówka Authorization, ani z żadnego innego miejsca, i żaden zestaw kluczy nie jest pobierany — tożsamością wywołującego jest wartość principal_header, na żądanie bez tego nagłówka odpowiedzią jest 401, a dwa wskazane tu nagłówki są jedynymi odczytywanymi. Jeśli zostanie pominięte, co jest ustawieniem domyślnym, ten serwer sam weryfikuje tokeny okaziciela.

WłaściwośćTypWymaganaOpis
principal_headerstringtakNagłówek, w którym stojący przed nim serwer proxy umieszcza tożsamość wywołującego — na przykład X-Forwarded-User. Zapisuje się go jako nazwę nagłówka HTTP: litery, cyfry i łączniki oraz inne znaki dozwolone w nazwie nagłówka (!#$%&'*+.^_|~ i grawis), bez spacji, dwukropka ani innego separatora. Nazwa w innej postaci zostaje odrzucona przy wczytywaniu pliku konfiguracyjnego ze wskazaniem pliku i klucza, ponieważ żadne żądanie nie może zawierać takiego nagłówka. Pusta również zostaje odrzucona: sprawiłaby, że ten serwer sam sprawdzałby tokeny, podczas gdy blok mówi, że robi to stojący przed nim serwer proxy. Aby wyłączyć ten tryb, należy pominąć trusted_proxy. Wartość nagłówka jest przyjmowana dokładnie tak, jak została zapisana, i nie jest z niczym porównywana, tak samo jak podmiot tokenu weryfikowanego przez sam serwer jest rejestrowany i nie jest z niczym porównywany. W tym trybie stanowi całe poświadczenie, dlatego jest wymagana zawsze, gdy ustawiono trusted_proxy, a na żądanie bez niej odpowiedzią jest 401. Wzorzec: ^[!#$%&'*+.^_`|~0-9A-Za-z-]+$.
scopes_headerstringnieNagłówek, w którym stojący przed nim serwer proxy umieszcza przyznane wywołującemu zakresy uprawnień, rozdzielone spacjami — na przykład X-Forwarded-Scopes. Zapisuje się go jako nazwę nagłówka HTTP, w tej samej postaci co principal_header, lub pozostawia pusty. Nazwa w innej postaci zostaje odrzucona przy wczytywaniu pliku konfiguracyjnego ze wskazaniem pliku i klucza, ponieważ żadne żądanie nie może zawierać takiego nagłówka i żaden wywołujący nigdy nie otrzymałby zakresu uprawnień. Domyślnie pusty, co nie potwierdza żadnych zakresów dla żadnego wywołującego. Niezależnie od nazwy, poza tym nagłówkiem i principal_header żaden inny nagłówek nie jest odczytywany. Wzorzec: ^[!#$%&'*+.^_`|~0-9A-Za-z-]*$. Domyślnie: ""

Dodatkowe właściwości są niedozwolone.

aggrega-config.mcp.health

Miejsce, w którym nadzorca pyta, czy ten proces działa i czy jest gotowy odpowiedzieć na wywołanie. Obie kontrole są obsługiwane pod osobnym adresem, nigdy pod adresem wskazanym przez listen: każde żądanie do punktu końcowego zawiera token okaziciela, więc sonda obsługiwana tam dawałaby każdemu, kto może dotrzeć do punktu końcowego, nieuwierzytelniony odczyt stanu procesu wraz z darmowym sposobem na zmuszenie go do pracy. Punkt końcowy odpowiada na /healthz i /readyz tym samym kodem 404, który zwraca dla każdej ścieżki, której nie obsługuje, zarówno z tokenem, jak i bez niego.

WłaściwośćTypWymaganaOpis
listenstringnieAdres, pod którym obsługiwane są kontrole żywotności i gotowości, w tych samych dwóch postaciach, które przyjmuje listen: host:port albo unix:, po którym następuje ścieżka w systemie plików. Domyślnie pusty, więc drugi nasłuch nie jest uruchamiany i żadna z kontroli nie jest nigdzie obsługiwana. Gdy adres jest ustawiony, na GET /healthz odpowiedzią jest 200 od chwili, gdy proces działa, a na GET /readyz odpowiedzią jest 503, dopóki obszar roboczy nie zostanie rozwiązany, a punkt końcowy powiązany z adresem, i 200 od tej pory — to właśnie rozróżnienie, którego potrzebuje nadzorca, ponieważ proces, który działa, nie jest jeszcze procesem, który może odpowiedzieć na wywołanie. Każda odpowiedź to kod stanu z pustą treścią, żaden token nie jest wymagany i żaden nagłówek nie jest odczytywany; każda inna ścieżka pod tym adresem daje 404, a każda inna metoda dla tych dwóch ścieżek daje 405. W odróżnieniu od listen ten adres nie jest ograniczony do pętli zwrotnej ani gniazda Unix i żaden adres nie jest dla niego odrzucany: należy wskazać jeden z nich, do czego jest przeznaczony, i pamiętać, że wszystko, co może dotrzeć do wybranego adresu, może odczytać te dwie odpowiedzi. Domyślnie: ""

Dodatkowe właściwości są niedozwolone.

Definicje

ReleaseCatalogConfig

Własne katalogi encji jednego Release: te same dwa klucze, które zawiera blok workspace, o zakresie ograniczonym do tej encji Release.

WłaściwośćTypWymaganaOpis
catalog_dirsstring[]nieKatalogi, z których ta encja Release odczytuje lokalne encje zamiast z catalog_dirs obszaru roboczego; każdy jest rozwiązywany względem pliku, który go deklaruje. Jest to ten sam uporządkowany stos wyszukiwania „pierwszy wygrywa” co lista obszaru roboczego, a katalog catalog w katalogu głównym obszaru roboczego jest odczytywany po nim, gdy ten katalog istnieje i żaden wymieniony wpis go już nie zawiera. Jeśli klucz zostanie pominięty, encja Release zachowuje listę obszaru roboczego; zapisany jako [] powoduje, że nie jest odczytywany żaden lokalny katalog.
catalog_dirs_appendstring[]nieKatalogi dodawane po liście tej encji Release — jej własnym catalog_dirs, jeśli wpis je zapisuje, a w przeciwnym razie liście obszaru roboczego — każdy rozwiązywany względem pliku, który go deklaruje. Domyślnie: []

Dodatkowe właściwości są niedozwolone.

RegistryConfig

Ustawienia i polityka zaufania do podpisów o zakresie ograniczonym do jednego hosta rejestru OCI.

WłaściwośćTypWymaganaOpis
hoststringtakHost rejestru, którego dotyczą te ustawienia (np. hub.aggrega.ai). Jest porównywany z hostem rejestru celu operacji push/pull, więc zapisuje się go w pisowni, w jakiej odbywa się to porównanie: nazwa hosta małymi literami zawierająca kropkę, localhost, pojedyncza nazwa z portem (registry:5000), adres IPv4 lub adres IPv6 w nawiasach kwadratowych, każdy z opcjonalnym :port — bez schematu, ścieżki, poświadczeń, białych znaków i wielkich liter. Port 443 na hoście osiąganym przez HTTPS jest domyślnym portem tego hosta, a jego zapisanie jest odrzucane podczas ładowania konfiguracji z komunikatem wskazującym host, który należy zapisać bez niego, ponieważ wpis zapisany w ten sposób nigdy nie zostałby odnaleziony; localhost i inne adresy pętli zwrotnej są osiągane przez zwykły HTTP, więc 443 jest tam zwykłym portem i zostaje zachowany. aggrega registry add i aggrega config init --registry zapisują wpis pod hostem wskazanym przez ich argument i odrzucają host zapisany inaczej. Host jest oceniany wyłącznie po pisowni: nie jest sprawdzane, czy nazwa się rozwiązuje ani czy odpowiada pod nią rejestr. Wzorzec: ^(?:(?:(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z](?:[a-z0-9-]{0,61}[a-z0-9])?|localhost|(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])(?:\.(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])){3}|\[(?:(?:[0-9a-f]{1,4}:){7}[0-9a-f]{1,4}|(?:[0-9a-f]{1,4}:){1,7}:|(?:[0-9a-f]{1,4}:){1,6}:[0-9a-f]{1,4}|(?:[0-9a-f]{1,4}:){1,5}(?::[0-9a-f]{1,4}){1,2}|(?:[0-9a-f]{1,4}:){1,4}(?::[0-9a-f]{1,4}){1,3}|(?:[0-9a-f]{1,4}:){1,3}(?::[0-9a-f]{1,4}){1,4}|(?:[0-9a-f]{1,4}:){1,2}(?::[0-9a-f]{1,4}){1,5}|[0-9a-f]{1,4}:(?::[0-9a-f]{1,4}){1,6}|:(?:(?::[0-9a-f]{1,4}){1,7}|:))\])(?::(?:[1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]))?|[a-z](?:[a-z0-9-]{0,61}[a-z0-9])?:(?:[1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]))$.
namestringnieOpcjonalny przyjazny alias tego rejestru. Tożsamością jest host; name to wygodny selektor, który rozwiązuje się do hosta tego wpisu wszędzie tam, gdzie wskazywany jest rejestr (na przykład --registry lub default_registry). Alias musi być unikalny wśród wpisów.
trusted_identitiesTrustedIdentity[]nieZbiór alternatywny (OR) tożsamości podpisywania bezkluczowego akceptowanych dla artefaktów pobieranych z tego rejestru. Podpis zostaje zweryfikowany, gdy jego certyfikat pasuje do dowolnego wpisu. Używane przez ścieżkę weryfikacji bezkluczowej. Domyślnie: []
trusted_deprecation_identitiesTrustedIdentity[]nieZbiór alternatywny (OR) tożsamości bezkluczowych dodatkowo uprawnionych do podpisania wstecznego znacznika wycofania artefaktu pobranego z tego rejestru. Znacznik wycofania jest honorowany, gdy jego podpis pasuje do podpisującego oryginalny artefakt LUB do dowolnego wpisu tutaj — dzięki temu właściciel rejestru lub zespół bezpieczeństwa może wycofać artefakt, do którego pierwotny wydawca nie ma już dostępu, bez obdarzania go zaufaniem do podpisywania samych artefaktów. Używane wyłącznie przez ścieżkę wykrywania wycofań; nigdy nie poszerza zbioru zaufania dla podpisów artefaktów. Domyślnie: []
public_keystringniePrzypięty klucz publiczny zgodny z cosign dla rejestru w trybie kluczowym, zapisany bezpośrednio jako blok PEM: tekst od wiersza -----BEGIN PUBLIC KEY----- (lub -----BEGIN RSA PUBLIC KEY-----) do odpowiadającego mu wiersza -----END, tak jak kopiuje go z pliku klucza aggrega registry add --key. Gdy jest ustawiony, podpisy z tego rejestru są weryfikowane offline względem tego klucza, a nie względem tożsamości bezkluczowych. Wartość bez wiersza -----BEGIN … PUBLIC KEY----- jest odrzucana podczas ładowania pliku konfiguracji z komunikatem wskazującym plik i wpis; tak samo odrzucany jest klucz prywatny wklejony tu przez pomyłkę. Wiersz może znajdować się w dowolnym miejscu wartości, ponieważ klucz jest odczytywany z bloku PEM zawartego w wartości, a tekst przed tym blokiem jest ignorowany. Tutaj sprawdzany jest tylko ten wiersz: to, czy blok zawiera dający się zdekodować klucz, okazuje się dopiero przy weryfikacji względem niego podpisu z tego rejestru. Wartość jest oznaczona jako wrażliwa (x-aggrega-sensitive), więc odrzucona wartość — przede wszystkim klucz prywatny wybrany przez pomyłkę — nigdy nie jest cytowana: komunikat o odrzuceniu wskazuje plik, wpis i ograniczenie, którego wartość nie spełniła — powyższy wzorzec lub typ string — i pokazuje <redacted> w miejscu wartości. Klucz publiczny, który się załaduje, jest odczytywany i pokazywany w postaci zapisanej. Wzorzec: -----BEGIN [A-Z ]*PUBLIC KEY-----.
trusted_rootstringnieOpcjonalna ścieżka do przypiętego pakietu korzenia zaufania Sigstore na potrzeby weryfikacji bezkluczowej w środowiskach odizolowanych. Gdy jest ustawiona, kotwica zaufania dla weryfikacji bezkluczowej jest ładowana z tego pliku bez użycia sieci; gdy jest pusta, publiczny korzeń zaufania (public-good) jest pobierany i buforowany.
advisorylogicznanieGdy ma wartość true, niepowodzenie weryfikacji podpisu dla tego rejestru jest obniżane do ostrzeżenia zamiast przerywać pobieranie. Weryfikacja nadal jest wykonywana, a niepowodzenie jest zgłaszane; pobieranie jest kontynuowane. Domyślnie false. Domyślnie: false
skip_signature_verificationlogicznanieAwaryjne (break-glass) wyłączenie weryfikacji podpisów dla pojedynczego hosta — ten sam przełącznik skip_signature_verification co globalny, o zakresie ograniczonym przez umiejscowienie do tego hosta. Nie unieważnia polityki signing.required najwyższego poziomu: podpis wymagany przez organizację jest na tym hoście nadal weryfikowany niezależnie od tego przełącznika; wyłączyć to może tylko przełącznik globalny. Ustawienie go razem z signing.required dla rejestru na tym samym hoście jest dozwolone i łączy podpis wymagany przy push z weryfikacją pomijaną przy pull: po stronie weryfikacji wygrywa pominięcie, ponieważ wymóg ustawiony dla hosta (w przeciwieństwie do wymogu najwyższego poziomu) nie jest odporny na pominięcie ustawione dla hosta. Domyślnie false. Domyślnie: false
signingSigningConfignieBlok podpisywania tego rejestru: adresy URL usług podpisywania bezkluczowego, opcjonalna ścieżka do klucza w trybie kluczowym i stanowisko zaufania dla hosta. Pola punktów końcowych zastępują globalny blok signing przy operacjach push do tego hosta; flaga CLI zastępuje oba. required i kinds odczytują zakres z umiejscowienia — we wpisie rejestru ograniczają jedno stanowisko zaufania do tego hosta (publikowanie niepodpisanego artefaktu objętego zakresem jest odrzucane i pobieranie niepodpisanego również jest odrzucane); to ta sama koncepcja, którą blok signing najwyższego poziomu stosuje do wszystkich rejestrów.

Dodatkowe właściwości są niedozwolone.

SigningConfig

Blok podpisywania: adresy URL usług bezkluczowych, opcjonalne wskazanie pliku klucza dla trybu z kluczem oraz stanowisko zaufania (required i kinds). Umieszczony na najwyższym poziomie dotyczy wszystkich rejestrów; umieszczony we wpisie registries[] dotyczy tego hosta — każde pole odczytuje swój zakres z miejsca umieszczenia. required to jedno stanowisko zaufania obejmujące oba kierunki (niepodpisany push w zakresie jest odrzucany i niepodpisany pull w zakresie jest odrzucany). Bezpieczeństwo: blok nie przechowuje żadnych tajnych danych — token tożsamości OIDC nigdy nie jest polem konfiguracji (jest krótkotrwały i dostarczany w czasie działania), a key_path to ścieżka do pliku klucza, nigdy bajty klucza wpisane bezpośrednio. Odzwierciedla to asymetrię strony weryfikacji: tam dozwolony jest bezpośrednio wpisany public_key, ale strona podpisywania przechowuje tylko ścieżkę klucza. Serwer aggrega mcp osiągany przez HTTP nie korzysta z key_path w żadnym z miejsc umieszczenia, więc podpisywanie kluczem jest przez taki listener nieosiągalne: wywołanie, na które odpowiada, podpisuje tylko tokenem tożsamości przenoszonym przez to wywołanie.

WłaściwośćTypWymaganaOpis
fulcio_urlstringnieAdres URL urzędu certyfikacji Fulcio do podpisywania bezkluczowego. Gdy nie jest ustawiony, używana jest publiczna instancja Fulcio (public-good). Zapisuje się go jako bezwzględny adres URL https: https://, host oraz opcjonalnie port i ścieżka, bez białych znaków — na przykład https://fulcio.sigstore.dev. Wartość o innej postaci, np. bez schematu (fulcio.example.com) lub zaczynająca się od http://, jest odrzucana podczas wczytywania pliku konfiguracyjnego, z podaniem pliku i klucza. Plik jest sprawdzany, zanim cokolwiek innego zostanie na nim nałożone, więc ten sam punkt końcowy podany przez AGGREGA_SIGNING_FULCIO_URL, flagą --fulcio-url lub w żądaniu publikacji z edytora albo asystenta nie podlega wymogowi tej postaci. Wzorzec: ^https://[^\s/?#]+(?:[/?#]\S*)?$.
rekor_urlstringnieAdres URL dziennika przejrzystości Rekor do podpisywania bezkluczowego. Gdy nie jest ustawiony, używana jest publiczna instancja Rekor (public-good). Zapisuje się go jako bezwzględny adres URL https: https://, host oraz opcjonalnie port i ścieżka, bez białych znaków — na przykład https://rekor.sigstore.dev. Wartość o innej postaci, np. bez schematu (rekor.example.com) lub zaczynająca się od http://, jest odrzucana podczas wczytywania pliku konfiguracyjnego, z podaniem pliku i klucza. Plik jest sprawdzany, zanim cokolwiek innego zostanie na nim nałożone, więc ten sam punkt końcowy podany przez AGGREGA_SIGNING_REKOR_URL, flagą --rekor-url lub w żądaniu publikacji z edytora albo asystenta nie podlega wymogowi tej postaci. Wzorzec: ^https://[^\s/?#]+(?:[/?#]\S*)?$.
timestamp_urlstringnieAdres URL urzędu znaczników czasu RFC3161 do podpisywania bezkluczowego. Nie ma wartości domyślnej: gdy nie jest ustawiony, żaden urząd znaczników czasu nie jest odpytywany, a zaufany czas podpisu bezkluczowego pochodzi z jego wpisu w dzienniku przejrzystości. Zapisuje się go jako bezwzględny adres URL https: https://, host oraz opcjonalnie port i ścieżka, bez białych znaków — na przykład https://tsa.example.com/api/v1/timestamp. Wartość o innej postaci, np. bez schematu (tsa.example.com) lub zaczynająca się od http://, jest odrzucana podczas wczytywania pliku konfiguracyjnego, z podaniem pliku i klucza. Plik jest sprawdzany, zanim cokolwiek innego zostanie na nim nałożone, więc ten sam punkt końcowy podany przez AGGREGA_SIGNING_TIMESTAMP_URL, flagą --timestamp-url lub w żądaniu publikacji z edytora albo asystenta nie podlega wymogowi tej postaci. Wzorzec: ^https://[^\s/?#]+(?:[/?#]\S*)?$.
key_pathstringnieŚcieżka do przechowywanego pliku PEM z kluczem prywatnym ECDSA P-256 do podpisywania z kluczem w trybie offline. Ścieżka do pliku, nigdy bezpośrednio wpisany materiał klucza. Gdy nie jest ustawiona, używana jest ścieżka bezkluczowa. Serwer aggrega mcp osiągany przez HTTP nigdy nie korzysta z tego klucza, niezależnie od miejsca jego ustawienia — w bloku signing najwyższego poziomu, w bloku wpisu rejestru czy przez AGGREGA_SIGNING_KEY_PATH: wywołanie, na które odpowiada taki listener, podpisuje tylko tokenem tożsamości przenoszonym przez samo wywołanie albo jest odrzucane. Serwer osiągany przez standardowe wejście i wyjście podpisuje tym kluczem tak jak terminal.
requiredlogicznanieJedno stanowisko zaufania dla zakresu tego bloku: gdy ma wartość true, publikacja artefaktu rodzaju objętego zakresem wymaga podpisu (niepodpisany push w zakresie jest odrzucany), a jego pobranie również wymaga podpisu (niepodpisany pull w zakresie jest odrzucany). Zakres wynika z miejsca umieszczenia — w bloku signing najwyższego poziomu obejmuje każdy rejestr; w bloku signing wpisu registries[] obejmuje ten jeden host. Jedna nazwa, jedno zadanie, oba zakresy. Zasada najwyższego poziomu składa się monotonicznie w kaskadzie konfiguracji — każda warstwa, która ustawia ją na true, czyni ją efektywnie true, a żadna warstwa o niższym priorytecie nie może jej z powrotem wyłączyć — więc nie da się jej usunąć zwykłą edycją konfiguracji. Domyślnie false. Wartość domyślna: false
kindsstring[]nieOgranicza required do określonych rodzajów artefaktów. Pusta lista lub pojedynczy wpis all oznacza każdy rodzaj, który można podpisać; w przeciwnym razie stanowisko dotyczy dokładnie wymienionych rodzajów, dopasowywanych do wartości kind: encji (np. Component, Feature, Recipe, FeatureRecipe, SchemaLibrary, MappingLibrary, Aggregate, Plugin). W bloku signing najwyższego poziomu składa się jako suma w kaskadzie — warstwa może poszerzyć zakres, ale nigdy go nie zawęzić. Zakres wynika z miejsca umieszczenia, tak samo jak w przypadku required. Wartość domyślna: []

Dodatkowe właściwości są niedozwolone.

TrustedIdentity

Jedna akceptowana tożsamość podpisywania bezkluczowego: podmiot certyfikatu (tożsamość OIDC) w parze z wystawcą OIDC, który za nią poręczył.

WłaściwośćTypWymaganaOpis
identitystringnieDokładna alternatywna nazwa podmiotu certyfikatu — tożsamość OIDC powiązana z krótkotrwałym certyfikatem podpisującym (np. adres e-mail opiekuna lub URI workflow CI).
identity_regexpstringnieWyrażenie regularne dopasowywane do podmiotu certyfikatu, używane zamiast dokładnej wartości identity (np. aby akceptować dowolny workflow w organizacji).
issuerstringtakAdres URL wystawcy OIDC, który wydał token tożsamości (np. https://accounts.google.com lub https://token.actions.githubusercontent.com).

Dodatkowe właściwości są niedozwolone.

PluginRef

Odwołanie do wtyczki Wasm dołączanej w gnieździe, którego funkcję wejściową może wskazać dołączenie — listy governance i linter. Gniazda o stałym punkcie wejścia używają zamiast tego FixedEntryPluginRef, który zawiera te same pola bez function. uri i capability razem wybierają wtyczkę: samo uri oznacza bezpośrednie dołączenie (wtyczka o tej tożsamości jest dołączana dosłownie — ścieżka gniazd przekrojowych, ponieważ ich wtyczki nie deklarują obsługiwanych możliwości); samo capability rozwiązuje wtyczkę obsługującą tę możliwość (gołą nazwę możliwości, którą encja Recipe wiąże przez spec.capability, np. helm); oba razem rozstrzygają niejednoznaczność — capability wskazuje, co rozwiązać, a uri wybiera, wtyczka którego wydawcy ją obsługuje, według gołej tożsamości tej wtyczki, w katalogu federacyjnym, w którym tę możliwość obsługuje więcej niż jedna wtyczka. function nadpisuje domyślną funkcję wejściową gniazda; w razie pominięcia obowiązuje udokumentowana wartość domyślna gniazda — we wpisie governance wynika ona z role. role wskazuje rolę dołączenia governance i jest odczytywane tylko we wpisie governance. with zawiera opcjonalne dane wejściowe czasu dołączenia, które odczytuje wtyczka.

WłaściwośćTypWymaganaOpis
uristringnieIdentyfikator wtyczki: goła tożsamość encji Plugin — ścieżka <pluginType>/<name>, np. governance/redact lub provider/helm — lokalna ścieżka w systemie plików albo alias rejestru. Opcjonalny: wpis może zamiast tego wybrać wtyczkę przez capability. Opcjonalny końcowy :version przypina wersję w tych samych trzech formach co każde przypięcie wersji (goła, dokładna :1.0.0 lub zakres zgodny co do wersji głównej :^1.0.0).
rolestring (enum)nieRola w potoku, z którą jest związane dołączenie governance, odczytywana tylko we wpisie governance: annotation-transform wstrzykuje adnotacje do rozwiązanych komponentów przed rozwinięciem adnotacji, więc związane wstrzyknięcia stają się dołączeniami encji Feature; label-transform automatycznie oznacza etykiety węzłów grafu topologii podczas budowy topologii; ir-verdict wydaje werdykt akceptacji/odrzucenia dla grafu IR podczas analizy statycznej; render-verdict wydaje werdykt dla wyrenderowanych artefaktów podczas renderowania. To rola — a nie zadeklarowany rodzaj wtyczki — określa, co wtyczka może emitować: wynik roli werdyktu może być odczytany tylko jako werdykt, nigdy zastosowany jako zmiana; wynik roli transformacji jest ograniczony przez hosta do jej aspektu (adnotacji lub etykiet). Rola wybiera też domyślną funkcję wejściową (annotation-transform → transform_annotations; label-transform → mutate; ir-verdict → verdict_ir; render-verdict → verdict_render). Dozwolone wartości: "annotation-transform", "label-transform", "ir-verdict", "render-verdict"
capabilitystringnieMożliwość dostawcy, dla której ten wpis wybiera wtyczkę — goła nazwa możliwości, którą encja Recipe wiąże przez spec.capability (np. helm, compose). Opcjonalna: wpis może zamiast tego dołączyć wtyczkę bezpośrednio przez uri. Powiązania dostawców używają jej, by wybrać, wtyczka którego wydawcy obsługuje możliwość w katalogu federacyjnym; gniazda przekrojowe pozostawiają ją pustą i dołączają przez uri.
functionstringnieOpcjonalne nadpisanie domyślnej funkcji wejściowej gniazda. W razie pominięcia obowiązuje udokumentowana wartość domyślna gniazda (governance annotation-transform → transform_annotations, governance label-transform → mutate, governance ir-verdict → verdict_ir, governance render-verdict → verdict_render, linter → lint_rules). Nadpisanie może wskazać dowolny eksport zadeklarowany przez wtyczkę, a wskazany eksport musi zwracać kształt wyniku odczytywany przez to gniazdo: kompilacja zostaje przerwana, gdy wynik zawiera pole najwyższego poziomu, którego kształt nie deklaruje, z podaniem wywołanego eksportu i nieoczekiwanego pola. Sprawdzenie odczytuje, które nazwy pól najwyższego poziomu są obecne, a nie których brakuje ani co jest pod nimi zagnieżdżone, więc nie jest pełną walidacją wyniku.
withPluginRefWithnieOpcjonalne dane wejściowe czasu dołączenia, które odczytuje wtyczka. Oba elementy są opcjonalne i agnostyczne wobec gniazda, więc każde gniazdo może ponownie użyć tej powierzchni.

Dodatkowe właściwości są niedozwolone.

FixedEntryPluginRef

Odwołanie do wtyczki Wasm dołączanej w gnieździe, którego punkt wejścia jest stały, a nie wskazywany przez dołączenie — lista importer i powiązania providers. Zawiera te same pola co PluginRef bez function: gniazdo importera wywołuje jedyną funkcję wejściową wskazaną w kontrakcie gniazda, a dostawca obsługuje stały zestaw eksportów przypisanych do faz zamiast jednego wybieralnego wejścia, więc na żadnej z tych list nie ma wejścia, które function mogłoby wskazać, i klucz ten nie jest tam akceptowany. uri i capability razem wybierają wtyczkę: samo uri oznacza bezpośrednie dołączenie (wtyczka o tej tożsamości jest dołączana dosłownie — ścieżka gniazda importera, ponieważ jego wtyczki nie deklarują obsługiwanych możliwości); samo capability rozwiązuje wtyczkę obsługującą tę możliwość (gołą nazwę możliwości, którą encja Recipe wiąże przez spec.capability, np. helm); oba razem rozstrzygają niejednoznaczność — capability wskazuje, co rozwiązać, a uri wybiera, wtyczka którego wydawcy ją obsługuje, według gołej tożsamości tej wtyczki, w katalogu federacyjnym, w którym tę możliwość obsługuje więcej niż jedna wtyczka. role jest tu akceptowane, ale nie jest odczytywane na żadnej z list obsługiwanych przez ten kształt: wskazywana przez nie rola dołączenia governance jest odczytywana we wpisie governance, który używa PluginRef, więc rola ustawiona w jednym z tych wpisów nie ma skutku. with zawiera opcjonalne dane wejściowe czasu dołączenia, które odczytuje wtyczka; powiązanie dostawcy pobiera konfigurację renderowania z encji Recipe, więc with: w takim powiązaniu jest odrzucane przy wczytywaniu.

WłaściwośćTypWymaganaOpis
uristringnieIdentyfikator wtyczki: goła tożsamość encji Plugin — ścieżka <pluginType>/<name>, np. governance/redact lub provider/helm — lokalna ścieżka w systemie plików albo alias rejestru. Opcjonalny: wpis może zamiast tego wybrać wtyczkę przez capability. Opcjonalny końcowy :version przypina wersję w tych samych trzech formach co każde przypięcie wersji (goła, dokładna :1.0.0 lub zakres zgodny co do wersji głównej :^1.0.0).
rolestring (enum)nieRola dołączenia governance. Żadna z list używających tego kształtu jej nie odczytuje — rola jest odczytywana we wpisie governance, a te wpisy używają PluginRef — więc rola ustawiona tutaj jest akceptowana i nie ma skutku. Dozwolone wartości to cztery role governance, a znaczenie każdej z nich opisano przy PluginRef. Dozwolone wartości: "annotation-transform", "label-transform", "ir-verdict", "render-verdict"
capabilitystringnieMożliwość dostawcy, dla której ten wpis wybiera wtyczkę — goła nazwa możliwości, którą encja Recipe wiąże przez spec.capability (np. helm, compose). Opcjonalna: wpis może zamiast tego dołączyć wtyczkę bezpośrednio przez uri. Powiązania dostawców używają jej, by wybrać, wtyczka którego wydawcy obsługuje możliwość w katalogu federacyjnym; gniazda przekrojowe pozostawiają ją pustą i dołączają przez uri.
withPluginRefWithnieOpcjonalne dane wejściowe czasu dołączenia, które odczytuje wtyczka. Oba elementy są opcjonalne i agnostyczne wobec gniazda, więc każde gniazdo może ponownie użyć tej powierzchni.

Dodatkowe właściwości są niedozwolone.

CLIPluginRef

Przypięty plugin rozszerzenia CLI zainstalowany jako polecenie najwyższego poziomu aggrega: rozwiązana, przypięta do wersji referencja artefaktu, którą polecenie rozwiązuje i uruchamia, oraz skrót zawartości bajtów gościa, na które ta referencja została rozwiązana w chwili instalacji. Razem przypinają dokładnie to, które bajty wykonuje polecenie; skrót jest też kluczem pamięci podręcznej describe, która dostarcza nazwy i pomoc polecenia bez ładowania gościa.

WłaściwośćTypWymaganaOpis
uristringtakRozwiązana, przypięta do wersji referencja artefaktu, którą polecenie rozwiązuje i uruchamia, np. oci://hub.aggrega.ai/plugin/cli/<name>:1.2.0, przypinana przy instalacji.
digeststringtakSkrót zawartości bajtów gościa .wasm, na które referencja została rozwiązana przy instalacji, zapisany jako sha256:, po którym następują 64 cyfry szesnastkowe (małymi literami) skrótu SHA-256 tych bajtów — w zapisie, który rejestruje aggrega plugin add cli, i w zapisie, w którym porównywane są rozwiązane bajty. Skrót w każdym innym zapisie — sam zapis szesnastkowy bez prefiksu sha256:, wielkie litery lub inna długość — nigdy nie mógłby być mu równy, dlatego jest odrzucany przy ładowaniu pliku konfiguracji, z podaniem pliku i wpisu. Przypina dokładnie te bajty, które uruchamia polecenie — późniejsze rozwiązanie, którego bajty mają inny skrót, zatrzymuje polecenie — i jest kluczem do pamięci podręcznej describe, która generuje pomoc polecenia bez ładowania gościa. Wzorzec: ^sha256:[0-9a-f]{64}$.

Dodatkowe właściwości są niedozwolone.

PluginRefWith

Opcjonalne dane wejściowe podawane przy dołączaniu, które odczytuje plugin. Oba elementy są opcjonalne, a ta powierzchnia jest ogólna, więc każde gniazdo może jej używać.

WłaściwośćTypWymaganaOpis
sourcesstring[]nieŚcieżki plików definicji, które host odczytuje w czasie kompilacji i przekazuje pluginowi. Każdy wpis jest ścieżką w systemie plików rozwiązywaną względem katalogu deklarującego pliku konfiguracji.
settingsobjectnieObiekt ustawień o dowolnej postaci, przekazywany pluginowi bez zmian. Host nie interpretuje jego kształtu; to plugin definiuje klucze, które odczytuje.

Dodatkowe właściwości są niedozwolone.