Zum Inhalt springen
AggregaAggrega
Sprache wählen: Deutsch
Diese Seite wurde maschinell übersetzt. Das englische Original lesen.

Aggrega-Schema für die Workspace-Konfiguration

Generierte Referenz. Nicht von Hand bearbeiten — aus dem veröffentlichten JSON Schema neu generieren.

Schema-ID: https://aggrega.ai/schemas/aggrega-config-v1beta1.schema.json

Konfigurationsdatei pro Workspace, die von der aggrega CLI gelesen wird. Liegt unter .aggrega-config.yaml. Der Block workspace ist die Wurzelmarkierung: Sein Vorhandensein markiert die Wurzel des Workspace, und er enthält nur Katalogverzeichnisse. Jeder andere Schlüssel ist eine Einstellung und liegt auf der obersten Ebene, in diesen Klassen — woher Inhalte abgerufen, gepinnt und zwischengespeichert werden (Registry-Auswahl, offline, Auto-Pull- und Pinning-Verhalten, Speicherorte und Größenobergrenzen der Caches für Artefakte und kompilierte Module), wie Inhalten vertraut wird (Signieren und Verhalten der Signaturprüfung), wie streng das Authoring beurteilt wird (Lint-Regler pro Regel, Strenge bei Veraltungen und der Hinweis auf das Authoring-Release), welche Wasm-Plugins workspace-weit angebunden sind (Governance, Linter, Importer und zielspezifische Provider-Rendering-Bindungen) und wie die CLI läuft (Nebenläufigkeit, Dienstbetrieb und Obergrenzen für die Verdrängung aus dem Parse-Cache des Daemons). Die Eigenschaften unten sind die vollständige und maßgebliche Liste; diese Zusammenfassung nennt die Klassen statt der Schlüssel, sodass das Hinzufügen eines Schlüssels sie nicht widerlegen kann. Flache Form auf oberster Ebene, keine apiVersion/kind-Hülle, getrennt von Kataloginhalten. Disziplin der Schemaentwicklung: Das Hinzufügen eines neuen Schlüssels auf oberster Ebene ist eine SemVer-MINOR-Erhöhung (additiv); das Entfernen oder Verlagern eines Schlüssels oder das Verschärfen einer Einschränkung ist ein SemVer-MAJOR-Bruch.

Typ der obersten Ebene: object

Eigenschaften

EigenschaftTypErforderlichBeschreibung
workspaceobjectneinWurzelmarkierung des Workspace. Allein ihr Vorhandensein markiert das Verzeichnis als Wurzel des Workspace; sie trägt nur die Katalogverzeichnisse, die die Wurzel definieren — die eigenen des Workspace und alle, die einem Release als eigene gegeben werden. Jede Einstellung, die die Wurzel nicht definiert, liegt auf der obersten Ebene statt hier. Schreiben Sie workspace: {}, um eine Wurzel ohne mitgelieferte Katalogverzeichnisse zu markieren.
default_registrystringneinStandard-OCI-Registry, in der Entitäten veröffentlicht und aus der Abhängigkeiten aufgelöst werden, wenn eine Entität nicht ausdrücklich eine Registry nennt: aggrega push veröffentlicht dort und aggrega pull ruft von dort ab. Standardmäßig hub.aggrega.ai. Schreiben Sie den name eines Eintrags unter registries, der dann für den host dieses Eintrags steht; den Host selbst; oder den Host gefolgt von / und einem Repository-Pfad, etwa ghcr.io/acme oder harbor.example.com/platform. Ein Name wird zuerst abgeglichen: Ein Wert, der der name eines Eintrags ist, ist der Host dieses Eintrags, auch wenn er zugleich wie ein Host geschrieben ist, sodass Veröffentlichen, Pullen, Signaturprüfung und jede Vertrauenseinstellung pro Registry diesen einen Host verwenden; ein Wert, nach dem zwei Einträge benannt sind, wird als mehrdeutig abgelehnt, und ein Name gefolgt von einem Pfad wird abgelehnt, weil ein Name für den Host eines Eintrags steht und nicht für einen Ort darunter. Jeder andere Wert muss ein Host sein, geschrieben in der Schreibweise, unter der seine Vertrauensrichtlinie geführt wird: ein kleingeschriebener Hostname, der einen Punkt enthält (registry.example.com), localhost, ein einzelner Name gefolgt von einem Port (registry:5000), eine IPv4-Adresse oder eine IPv6-Adresse in eckigen Klammern ([::1]), jeweils mit optionalem :port und ohne Schema, Anmeldedaten, Leerzeichen oder Großbuchstaben — optional gefolgt von einem Repository-Pfad: ein oder mehrere Segmente aus Kleinbuchstaben und Ziffern, verbunden durch /, die innerhalb eines Segments durch ., _, __ oder Bindestriche getrennt sein dürfen, ohne Tag, Digest oder abschließenden /. Der Pfad ist der Ort, an dem veröffentlicht und abgerufen wird: Jede über die Standard-Registry veröffentlichte Entität wird unter <host>/<path>/ veröffentlicht, und jede über sie aufgelöste Entität wird von dort abgerufen, sodass das eine findet, was das andere veröffentlicht. Er ist nie Teil davon, wie einer Registry vertraut wird: Der registries-Eintrag, dessen Richtlinie gilt, eine Anmeldung, eine Signaturanforderung und die vertrauenswürdigen Identitäten werden alle allein über den Host gefunden. Port 443 auf einem über HTTPS erreichten Host ist der Standardport dieses Hosts, und ihn zu schreiben wird abgelehnt, wobei die Schreibweise ohne ihn genannt wird; localhost und die anderen Loopback-Adressen werden über einfaches HTTP erreicht, daher ist 443 dort ein gewöhnlicher Port und bleibt erhalten. Ein leerer Wert nennt keine Standard-Registry. Der Wert wird beim Laden der Konfiguration beurteilt statt durch dieses Schema, weil der Eintrag, auf den sich ein Name bezieht, in einer anderen Konfigurationsdatei deklariert sein kann: Er wird nach jeder Konfigurationsdatei und der Umgebungsvariablen AGGREGA_DEFAULT_REGISTRY gelesen und mit denselben Worten abgelehnt, gleich welche davon ihn gesetzt hat, wobei diese Datei oder die Variable genannt wird. Das Flag --registry, das für einen einzelnen Aufruf das Ziel einer Veröffentlichung nennt, wird auf dieselbe Weise mit den Namen der Einträge abgeglichen; jeder andere Wert, den es trägt, kann eine Referenz sein, und der Host, den diese Referenz nennt, unterliegt derselben Schreibweise und ist der Ort, an dem die Veröffentlichung landet, ohne Repository-Pfad. Der Host wird allein nach seiner Schreibweise beurteilt: Ob der Name aufgelöst wird oder dort eine Registry antwortet, wird nicht geprüft. Standardwert: "hub.aggrega.ai"
offlinebooleschneinWenn true, kontaktiert der Build keine Registry; nur zwischengespeicherte Artefakte und mitgelieferte Kataloginhalte werden herangezogen. Standardmäßig false. Standardwert: false
auto_pullbooleschneinWenn false (Standard), ist aggrega build schreibgeschützt: Es schreibt nie Quell-Pins, und ein fehlendes oder unvollständiges Lockfile pro Release bricht den Build deutlich sichtbar mit einer Diagnose ab, die anweist, zuerst aggrega pull --release <release> auszuführen. Wenn true, führt aggrega build vor dem Build einen Pull-Schritt im selben Prozess aus — und löst dabei die Abhängigkeiten des Release in das Lockfile und den Cache auf —, sodass ein erster Build gegen ein Release keinen expliziten Pull-Schritt erfordert. Dasselbe Opt-in für einen einzelnen Build ist auf der Kommandozeile als aggrega build --auto-pull verfügbar; pull bleibt der einzige, der das Lockfile schreibt. offline: true schaltet den Pull-Schritt nicht ab: Er läuft über das, was die Maschine bereits vorhält — den Cache und die lokalen Katalogverzeichnisse —, ohne eine Registry zu erreichen, und eine Referenz, die keines von beiden vorhält, bricht den Build mit der eigenen Ablehnung des Pulls ab, die diese Referenz nennt. Standardwert: false
pin_sources_at_pullbooleschneinWenn false (Standard), verzeichnet ein Pull keinen Pin neben einer Entität: Bei einem Recipe oder FeatureRecipe in einem der Katalogverzeichnisse dieses Workspace, das das Release baut, bricht er ab, wenn das entity.lock neben der Entität nicht für jede Eingabe, die die Entität liest, einen Pin verzeichnet — eine entfernte source:, deren Koordinaten vollständig ausgeschrieben sind, eine Datei, die ein artifacts-Eintrag importiert, oder jede Datei einer lokalen source: neben der Entität —, und nennt dabei die Entität, jede Eingabe und ihre Klasse sowie aggrega pin als den Schritt, der sie verzeichnet. Das Pinnen ist der Schritt des Entitätsautors, daher ist eine Entität, die niemand gepinnt hat, noch nicht bereit zur Verwendung. Wenn true, führt stattdessen jeder Pull in diesem Workspace diesen Schritt aus, über dieselben Entitäten, und schreibt dieselben entity.lock-Bytes, die aggrega pin schreibt; so verzeichnet ein Workspace, der Entitäten verwendet, die jemand anderes nicht gepinnt hat, deren Pins einmalig, statt abzubrechen. Ein Build, der sein eigenes Lockfile füllt, ist ein Pull und folgt dieser Einstellung. aggrega pull --pin-sources pinnt für einen einzelnen Aufruf und --pin-sources=false bricht für einen einzelnen Aufruf ab, unabhängig davon, was diese Einstellung sagt. Eine Entität, die aus dem Cache statt aus einem Katalogverzeichnis aufgelöst wird, hat keinen Ort, an den ein Lock geschrieben werden könnte, und wird von einem Pull nie gepinnt oder angehalten. Standardwert: false
pin_sources_at_pushbooleschneinWenn true, führt jedes aggrega push in diesem Workspace den Pin-Schritt des Entitätsautors für die Entität aus, die es veröffentlicht, bevor es sie bündelt, sodass das entity.lock, das der Schritt neben die Entität schreibt, Teil dessen ist, was veröffentlicht wird; wenn false (Standard), führt Push keinen Pin-Schritt aus und lehnt ein Recipe oder FeatureRecipe ab, dessen entity.lock nicht jeden Pin verzeichnet, den dieser Schritt verzeichnen würde, und nennt dabei aggrega pin. Der Schritt schreibt neben die Entität, daher läuft er nur dort, wo die Entität einen beschreibbaren Ort hat, den ein Push immer hat: Er veröffentlicht eine durch ihr Dokument benannte Entität. aggrega push --pin-sources pinnt für einen einzelnen Aufruf und --pin-sources=false nicht, unabhängig davon, was diese Einstellung sagt. Es ist derselbe Schritt, den aggrega pin ausführt, und er schreibt dieselben Bytes. Standardwert: false
artifact_cache_dirstringneinLokales Cache-Verzeichnis für Artefakte/Inhalte (Pulls aus Registries, OCI-Manifeste, kompilierte Fixtures). Standardmäßig .aggrega/cache. Sollte per Konvention in gitignore stehen. Der Pfad wird relativ zur Wurzel des Workspace interpretiert, gleich von wo der Befehl ausgeführt wird; ein absoluter Wert wird beim Laden der Konfiguration abgelehnt, weil jeder Leser dieser Einstellung sie gegen diese Wurzel auflöst und ein absoluter Pfad einen Ort nennen würde, den sie nie erreichen. Der Cache darf innerhalb eines Katalogverzeichnisses liegen — der Standard tut das, da ein Katalogverzeichnis häufig die Wurzel des Workspace ist —, darf aber nicht selbst eines SEIN: Ein Katalog-Scan überspringt den Cache, daher lässt ein Wert, der ein Katalogverzeichnis nennt, den gesamten Inhalt dieses Verzeichnisses aus dem Scan heraus. Ein Wert, der die Wurzel des Workspace selbst nennt (. oder eine Schreibweise, die sich darauf reduziert), wird genau aus diesem Grund beim Laden der Konfiguration abgelehnt. Ein Wert, der ein anderes Katalogverzeichnis nennt, wird nicht abgelehnt: Er lädt fehlerfrei, und der Scan findet dann nichts in diesem Verzeichnis, daher liegt es bei Ihnen zu prüfen, dass der Cache außerhalb der in workspace.catalog_dirs aufgeführten Verzeichnisse bleibt. Getrennt von parse_cache, das den Parse-Cache des Daemons im Arbeitsspeicher begrenzt, und von compiled_module_cache, das den maschinenweiten Speicher kompilierter Module begrenzt. Standardwert: ".aggrega/cache"
skip_signature_verificationbooleschneinGlobaler, deutlich sichtbarer Opt-out aus der Signaturprüfung. Wenn true, ist die Signaturprüfung für jede Registry deaktiviert, einschließlich der verpflichtenden Baseline des Hubs. Gedacht für Notfall- (Break-Glass-) und Entwicklungsszenarien; er ist nie still — überall dort, wo ein Pull eine Signatur geprüft hätte, warnt er, dass die Prüfung global deaktiviert wurde. Standardmäßig false. Standardwert: false
buildobjectneinStrenge-Regler zur Build-Zeit und Authoring-Hinweise. authoring_release gibt dem LSP einen Hinweis current Release für Inline-Diagnosen; halt_on_deprecated_severity steuert, wie der Build auf die Verwendung veralteter Entitäten reagiert; yaml_indent legt die Einrückungsbreite jedes gerenderten YAML-Artefakts fest.
pluginsobjectneinWasm-Plugin-Anbindungen auf Workspace-Ebene. Jeder Socket (Governance, Linter, Importer) nimmt ein Array von Plugin-Referenzen; der Build ruft die dokumentierte Einstiegsfunktion jedes Plugins gemäß seinem Socket-Vertrag auf. Die Liste providers bindet Fähigkeiten an die Provider-Rendering-Plugins, die sie bedienen.
lintobjectneinStrenge-Regler pro Regel.
parse_cacheobjectneinObergrenzen für die Verdrängung aus dem Parse-Cache des Daemons. Beide Obergrenzen gelten gleichzeitig — die LRU-Verdrängungsschleife läuft nach jedem Einfügen in den Cache und entfernt die am längsten nicht verwendeten Einträge, bis sowohl die Anzahl der Einträge als auch die Gesamtzahl der Bytes innerhalb der Grenzen liegen. Null bei einer von beiden bedeutet unbounded on that axis, nützlich für CI-Szenarien, in denen der Cache nur für einen einzelnen Aufruf existiert. Getrennt von artifact_cache_dir, dem Inhalts-Cache auf der Festplatte.
compiled_module_cacheobjectneinGrößenobergrenze für den Cache kompilierter Module auf der Festplatte, den Maschinencode-Speicher, den der Compiler wiederverwendet, sodass ein Wasm-Plugin einmal pro Maschine statt einmal pro Build kompiliert wird. Er wird von jedem Workspace auf der Maschine gemeinsam genutzt, daher gehört dieser Schlüssel in die globale Konfigurationsdatei, wenn Sie eine einzige Antwort für die ganze Maschine wollen. Die Obergrenze wird einmal pro Aufruf angewendet, bevor ein Plugin geladen wird, indem ganze Einträge entfernt werden, die am frühesten kompilierten zuerst, bis der Rest hineinpasst — nie während ein Build kompiliert. Das Entfernen eines Eintrags kostet eine spätere Neukompilierung und sonst nichts, daher kann die Obergrenze gefahrlos gesenkt werden. aggrega cache status meldet die aktuelle Größe des Speichers, und aggrega cache evict --max-size kürzt ihn bei Bedarf auf eine auf der Kommandozeile angegebene Obergrenze. Getrennt von artifact_cache_dir (aus Registries abgerufene Inhalte) und von parse_cache (dem Parse-Cache des Daemons im Arbeitsspeicher).
concurrencyobjectneinNebenläufigkeitseinstellungen für die Anfrageverteilung des Daemons. Der Daemon liest Anfragen aus einem einzigen stdin-Stream und führt jede über einen Worker-Pool aus, der eine begrenzte Anfragewarteschlange abarbeitet; Antworten werden in der Reihenfolge des Eintreffens der Anfragen ausgegeben, unabhängig von der Reihenfolge ihrer Fertigstellung.
serveobjectneinVerhaltenseinstellungen des Daemons (aggrega serve) für den Compiler als Dienst, der von IDE-Integrationen genutzt wird.
mcpobjectneinEinstellungen für den Model-Context-Protocol-Server (aggrega mcp). transport wählt, wie der Server erreicht wird — über die Standardeingabe und Standardausgabe des Prozesses oder über HTTP — und wird gelesen, welche der beiden es auch wählt. Auch announce_tools wird auf beiden Transporten gelesen, weil die Frage, welche Werkzeuge einem Client angeboten werden, eine Eigenschaft des Servers ist und nicht davon abhängt, wie ein Client ihn erreicht hat. Jeder andere Schlüssel konfiguriert den Listener, den der HTTP-Transport startet, und wird nicht verwendet, solange der Server über Standardeingabe und Standardausgabe kommuniziert — listen eingeschlossen, das dort nur gelesen wird, damit der Server in einer Zeile auf seinem Fehlerstrom mitteilen kann, dass die Adresse nicht verwendet wird. Jeder Schlüssel unten gibt an, um welchen Fall es sich handelt. Getrennt von serve, das den Editor-Backend-Daemon konfiguriert.
registriesRegistryConfig[]neinEinstellungen pro Registry und Vertrauensrichtlinie für Signaturen, nach Registry-Host geschlüsselt. Eine hier nicht aufgeführte Registry verwendet die Standardwerte: Eine vorhandene Signatur wird geprüft und eine fehlende Signatur wird toleriert, außer bei hub.aggrega.ai, dessen eingebettete Baseline auch ohne expliziten Eintrag eine geprüfte Signatur vorschreibt. Ein expliziter Eintrag für einen Host überschreibt die Baseline dieses Hosts. Standardwert: []
signingSigningConfigneinSignier-Block auf oberster Ebene, der für alle Registries gilt: die URLs der Keyless-Dienste, ein optionaler Schlüsselpfad für schlüsselbasiertes Signieren und die Vertrauenshaltung für alle Registries (required und kinds). Ein signing-Block pro Registry überschreibt die Endpunkt-Standardwerte für diesen Host und trägt dieselbe Haltung required/kinds, auf diesen Host beschränkt — ein Name, eine Aufgabe, der Geltungsbereich ergibt sich aus der Platzierung. Die Richtlinie required/kinds auf oberster Ebene setzt sich monoton über die Kaskade der Konfigurationen zusammen. Sicherheit: Dieser Block enthält kein geheimes Material — das OIDC-Identitätstoken ist nie ein Konfigurationsfeld (es wird zur Laufzeit über ein Flag oder die umgebende OIDC-Umgebung bereitgestellt), und key_path ist ein Pfad zu einer Schlüsseldatei, nie inline angegebene Schlüsselbytes.

Zusätzliche Eigenschaften sind nicht zulässig.

aggrega-config.workspace

Wurzelmarkierung des Workspace. Allein ihr Vorhandensein markiert das Verzeichnis als Wurzel des Workspace; sie trägt nur die Katalogverzeichnisse, die die Wurzel definieren — die eigenen des Workspace und alle, die einem Release als eigene gegeben werden. Jede Einstellung, die die Wurzel nicht definiert, liegt auf der obersten Ebene statt hier. Schreiben Sie workspace: {}, um eine Wurzel ohne mitgelieferte Katalogverzeichnisse zu markieren.

EigenschaftTypErforderlichBeschreibung
catalog_dirsstring[]neinOptionale Katalogverzeichnisse, aus denen dieser Workspace lokale Entitäten liest und die vor dem Rückgriff auf die Registry herangezogen werden. Jeder Eintrag ist ein Dateisystempfad, aufgelöst relativ zu der Datei, die ihn deklariert. Die Liste ist ein geordneter Suchstapel, bei dem der erste Treffer gewinnt: Das am frühesten aufgeführte Verzeichnis, das eine Identität deklariert, besitzt sie, und dieselbe Identität in einem späteren Verzeichnis wird verdeckt. Das Verzeichnis catalog an der Wurzel des Workspace wird ebenfalls gelesen, nach jedem aufgeführten Eintrag und nur, wenn es existiert — es sei denn, ein aufgeführter Eintrag enthält es bereits; in diesem Fall wird es als Teil dieses Eintrags gelesen —, sodass das Aufführen eines Verzeichnisses das ergänzt, was der Workspace bereits gelesen hat, statt es zu ersetzen. Diesen Schlüssel wegzulassen und ihn als leere Liste zu schreiben sind unterschiedliche Aussagen: Weggelassen liest der Workspace weiterhin catalog; als [] geschrieben liest er überhaupt keinen lokalen Katalog, und so sagt ein Workspace, dass er keinen hat. Ein Release, dem unter releases eigene Katalogverzeichnisse gegeben werden, liest diese anstelle dieser Liste. Auf die Wurzel bezogen: Lokale Katalogverzeichnisse gehören zu dieser Workspace-Wurzel, daher liegen sie auf der Wurzelmarkierung statt auf der obersten Ebene.
catalog_dirs_appendstring[]neinOptionale, rein anhängende Ergänzung der effektiven Liste catalog_dirs. Auf jeder Vorrangebene werden die Einträge hier an die aufgelöste Basisliste angehängt, sodass Workspace- und globale Konfigurationen Katalogverzeichnisse zusammensetzen können, statt sie zu verdecken. Zusammenspiel auf derselben Ebene: Wenn auf einer Ebene sowohl catalog_dirs als auch catalog_dirs_append angegeben sind, ist der aufgelöste Wert auf dieser Ebene die Basisliste, gefolgt von der Anhängeliste. Standardwert: []
releasesMap von ReleaseCatalogConfigneinOptionale eigene Katalogverzeichnisse eines Release, für einen Workspace, der mehrere Katalogvarianten nebeneinander vorhält und jedes Release gegen eine davon baut. Jeder Schlüssel ist eine Release-Datei, geschrieben als Pfad relativ zu der Datei, die ihn deklariert; jeder Wert trägt catalog_dirs und catalog_dirs_append mit der Bedeutung, die sie in diesem Block haben, beschränkt auf dieses eine Release. Ein hier genanntes Release liest sein eigenes catalog_dirs anstelle der Liste dieses Blocks, gefolgt von seinem eigenen catalog_dirs_append; ein Eintrag, der catalog_dirs weglässt, behält die Liste dieses Blocks und hängt sein catalog_dirs_append danach an. Die Suchreihenfolge, das Verzeichnis catalog an der Wurzel des Workspace und die Bedeutung einer leeren Liste sind dieselben wie bei der eigenen Liste dieses Blocks, und ein Release, das diese Map nicht nennt, liest die Liste dieses Blocks genau wie zuvor. Das Release liest diese Verzeichnisse, wie auch immer es gebaut wird — in einem Terminal, aus einem Editor über aggrega serve oder über aggrega mcp —, und ein --catalog-Verzeichnis wird für einen einzelnen Aufruf weiterhin vor ihnen durchsucht. Ein Eintrag, der eine nicht existierende Datei nennt, wird beim Laden der Konfiguration abgelehnt, wobei der Eintrag und die Datei genannt werden, sodass das Umbenennen eines Release nicht unbemerkt den Katalog ändern kann, gegen den es gebaut wird. Über Konfigurationsdateien hinweg setzt sich der Eintrag jedes Release so zusammen wie die eigenen Schlüssel dieses Blocks: Das catalog_dirs einer näheren Datei für dieses Release ersetzt das einer entfernteren Datei, und das catalog_dirs_append jeder Datei dafür wird in Kaskadenreihenfolge angehängt. AGGREGA_CATALOG_DIRS setzt die Liste dieses Blocks und erreicht keinen Eintrag hier. Ein Vorgang, der kein einzelnes Release betrifft — ein Lint oder eine Validierung des gesamten Katalogs, das Nachschlagen einer Entität nach Namen oder die Auflistung der Entitäten des Workspace in einem Editor —, liest die Liste dieses Blocks und nicht diese.

Zusätzliche Eigenschaften sind nicht zulässig.

aggrega-config.build

Strenge-Regler zur Build-Zeit und Authoring-Hinweise. authoring_release gibt dem LSP einen Hinweis current Release für Inline-Diagnosen; halt_on_deprecated_severity steuert, wie der Build auf die Verwendung veralteter Entitäten reagiert; yaml_indent legt die Einrückungsbreite jedes gerenderten YAML-Artefakts fest.

EigenschaftTypErforderlichBeschreibung
authoring_releasestringneinPfad zu einer Release-YAML-Datei, die der LSP als Kontext current Release für Inline-Diagnosen behandelt. Optional.
yaml_indentintegerneinEinrückungsbreite (in Leerzeichen) für jedes gerenderte YAML-Artefakt — docker-compose-Dateien, Templates und Werte von Helm-Charts sowie Kubernetes-Manifeste. Standardmäßig 2, die konventionelle Breite für diese Formate. Minimum: 2. Maximum: 9. Standardwert: 2
halt_on_deprecated_severitystring (enum)neinSchweregrad in der geordneten Menge warning < error < retracted, ab dem eine verzeichnete Deprecation-Markierung den Build abbricht. Er regelt beide Orte, an denen eine Markierung verzeichnet wird: das Lockfile, für alles, was ein Build Byte für Byte reproduziert, und den Vertrauensdatensatz der Plugins daneben, für ein Plugin, das in einer Rolle angebunden ist, die ein Urteil über Annahme oder Ablehnung zurückgibt — eine plugins.governance-Anbindung bei ir-verdict oder render-verdict sowie jede plugins.linter-Anbindung. Ein Regler, eine Regel, beide Speicher. Standardmäßig nicht gesetzt, und nicht gesetzt bedeutet, dass keine verzeichnete Markierung einen Abbruch auslöst: Eine Markierung wird gegen eine Version verzeichnet, die Sie bereits gepinnt haben, sodass ein Build, der einmal erfolgreich war, weiterhin erfolgreich ist. Benachrichtigung und Auflösung sind zwei getrennte Achsen, und keine von beiden ist dieser Regler. Jede Oberfläche, die einen der beiden Datensätze liest, meldet jede veraltete Referenz, die sie pinnt, und jedes vertrauenswürdige Plugin, das eine Markierung trägt — bei jedem Schweregrad —, und nennt dabei die Referenz bzw. das Plugin, den Schweregrad und die Meldung: aggrega build, aggrega validate --release, aggrega lint --release, der editorseitige Daemon sowie die KI-nativen Tools build, describe und validate. Das Anheben dieses Schwellenwerts verringert also nie, was Ihnen mitgeteilt wird. Dieser Regler regelt allein den Build: Er stoppt aggrega build (und das KI-native Tool build, das derselbe Vorgang ist), während die meldenden Oberflächen die Markierung nennen und weiterarbeiten. Nur eine retracted-Markierung beeinflusst, zu welcher Version eine Referenz aufgelöst wird, und zwar wenn aggrega pull eine Version wählt, nicht beim Build. Zulässige Werte: "warning", "error", "retracted"

Zusätzliche Eigenschaften sind nicht zulässig.

aggrega-config.plugins

Wasm-Plugin-Anbindungen auf Workspace-Ebene. Jeder Socket (Governance, Linter, Importer) nimmt ein Array von Plugin-Referenzen; der Build ruft die dokumentierte Einstiegsfunktion jedes Plugins gemäß seinem Socket-Vertrag auf. Die Liste providers bindet Fähigkeiten an die Provider-Rendering-Plugins, die sie bedienen.

EigenschaftTypErforderlichBeschreibung
governancePluginRef[]neinDie Plugins des Governance-Sockets. Jeder Eintrag nennt die role der Pipeline, an der er angebunden ist (annotation-transform, label-transform, ir-verdict oder render-verdict); die Rolle legt sowohl fest, was das Plugin ausgeben darf, als auch seine Standard-Einstiegsfunktion (annotation-transform → transform_annotations; label-transform → mutate; ir-verdict → verdict_ir; render-verdict → verdict_render). Standardwert: []
governance_appendPluginRef[]neinRein anhängende Ergänzung der effektiven Liste governance. Die Einträge hier werden auf jeder Vorrangebene an die aufgelöste Basisliste angehängt, sodass Workspace- und globale Konfigurationen Governance-Anbindungen zusammensetzen können, statt sie zu verdecken. Standardwert: []
linterPluginRef[]neinDie Plugins des Linter-Sockets. Standard-Einstiegsfunktion: lint_rules. Die Exporte eines Linter-Plugins müssen mit lint_ beginnen, daher nennt function: bei einem dieser Einträge einen Export mit diesem Präfix. Standardwert: []
linter_appendPluginRef[]neinRein anhängende Ergänzung der effektiven Liste linter. Dieselbe Semantik des Zusammensetzens statt Verdeckens wie governance_append. Standardwert: []
importerFixedEntryPluginRef[]neinDie Plugins des Importer-Sockets. Der Socket ruft die Einstiegsfunktion import auf; eine Anbindung nennt keine. Standardwert: []
importer_appendFixedEntryPluginRef[]neinRein anhängende Ergänzung der effektiven Liste importer. Dieselbe Semantik des Zusammensetzens statt Verdeckens wie governance_append. Standardwert: []
providersFixedEntryPluginRef[]neinProvider-Auswahl pro Fähigkeit. Jeder Eintrag bindet eine Provider-Fähigkeit (den bloßen Namen der Fähigkeit, den ein Recipe über spec.capability bindet, z. B. helm oder compose) an die bloße Identität des Provider-Rendering-Plugins, das sie bedient (die Identität der Plugin-Entität, also ihr metadata.pluginType und ihr metadata.name, durch einen Schrägstrich verbunden, z. B. provider/helm), mit einem optionalen nachgestellten :version in denselben drei Formen wie ein Versions-Pin (bloß, exakt :1.0.0 oder mit der Hauptversion kompatibler Bereich :^1.0.0). Dies ist die Oberfläche für Disambiguierung und Überschreibung in einem föderierten Katalog, in dem mehr als ein Provider-Plugin dieselbe Fähigkeit bedient: Die Bindung wählt, welches Plugin welches Herausgebers diese Fähigkeit rendert. Wenn eine Fähigkeit von genau einem Provider-Plugin bedient wird, ist kein Eintrag nötig. Über die zusammengesetzte Liste hinweg ist genau ein Eintrag pro Fähigkeit zulässig; eine doppelte Fähigkeit bricht die Auflösung deutlich sichtbar ab. Die Auflösung erfolgt beim Pull: Der Pull verzeichnet die aufgelöste Bindung im Lockfile pro Release, und der Build liest das Lockfile — eine Änderung hier nach einem Pull wird erst mit dem nächsten Pull übernommen, sodass die Build-Ausgabe davon unberührt bleibt (deterministische Ausgabe). Jeder Build und jede Validierung eines Release prüft außerdem jeden Eintrag hier, ob ein Recipe nach seiner Fähigkeit fragt oder nicht: Ein Eintrag, der ein Plugin nennt, das der Build vorhält und das die Fähigkeit des Eintrags nicht bedient, bricht ab und nennt, was dieses Plugin bedient, sowie eine um eine Bearbeitung abweichende Schreibweise, sofern es eine gibt; ein Eintrag, der eine Fähigkeit und kein Plugin nennt, wobei kein Provider-Plugin, das der Build liest, diese Fähigkeit bedient, wird als Warnung gemeldet statt abzubrechen, weil das Plugin, das sie bedient, eines sein kann, das nur ein anderes Release liest; und ein Eintrag für eine Fähigkeit, die ein Plugin bedient, nach der dieses Release aber nie fragt, ist zulässig und wird gar nicht gemeldet, da Einträge für den gesamten Workspace geschrieben werden und ein Build einem einzigen Release gilt. Eine capability, die einen Doppelpunkt enthält, wird beim Laden der Konfiguration abgelehnt: Das spec.capability eines Recipe wird bis zu seinem letzten Doppelpunkt als Fähigkeit und danach als Versions-Pin gelesen, sodass kein Recipe einen solchen Eintrag erreichen könnte. Ein fehlender Eintrag für eine eindeutig bediente Fähigkeit ist kein Fehler; ein fehlender Eintrag für eine mehrdeutig bediente Fähigkeit bricht den Pull deutlich sichtbar ab und listet die infrage kommenden Plugins auf. Die Koexistenz von Versionen bleibt erhalten: Die Bindung wählt das Plugin-Repository pro Fähigkeit, und der eigene Versions-Pin in spec.capability jedes Recipe wählt die Version innerhalb dieses Repositorys, sodass zwei Recipes, die unterschiedliche Versionen eines Providers pinnen, weiterhin nebeneinander bestehen. Standardwert: []
providers_appendFixedEntryPluginRef[]neinRein anhängende Ergänzung der effektiven Liste providers. Die Einträge hier werden auf jeder Vorrangebene an die aufgelöste Basisliste angehängt, sodass Workspace- und globale Konfigurationen Provider-Bindungen zusammensetzen können, statt sie zu verdecken. Dieselbe Semantik des Zusammensetzens statt Verdeckens wie governance_append. Die Regel „ein Eintrag pro Fähigkeit“ gilt für die zusammengesetzte Liste, daher bricht ein angehängter Eintrag, der eine bereits von einer niedrigeren Ebene gebundene Fähigkeit nennt, die Auflösung deutlich sichtbar ab. Standardwert: []
cliCLIPluginRef[]neinCLI-Erweiterungs-Plugins, die als aggrega-Befehle auf oberster Ebene installiert werden. Jeder Eintrag pinnt ein CLI-Plugin über seine aufgelöste, auf eine Version gepinnte Artefaktreferenz und den Inhalts-Digest der Guest-Bytes, zu denen diese Referenz bei der Installation aufgelöst wurde. Anders als die vier übergreifenden Socket-Listen, deren Basisliste über die Kaskade der Konfigurationen hinweg vollständig ersetzt wird, setzt sich die CLI-Liste zusammen: Ein CLI-Plugin in der globalen Konfiguration registriert seine Befehle in jedem Workspace, eines in einer Workspace-Konfiguration registriert sich nur in diesem Projekt, und beide registrieren sich gemeinsam — daher braucht sie kein _append-Gegenstück. Die Befehlsnamen und die Hilfe, die jedes Plugin beisteuert, stammen aus der eigenen Selbstbeschreibung des Plugins, gelesen aus dem Describe-Cache auf der Festplatte, der nach digest geschlüsselt ist (ein Laden des Guests ist der Rückgriff bei kaltem Cache); die Liste trägt nur den Pin. Beim Aufruf des Befehls werden die aufgelösten Bytes erneut gehasht und mit digest verglichen; eine Abweichung bricht den Befehl deutlich sichtbar ab und weist an, neu zu pinnen, sodass ein Plugin, dessen Bytes sich seit dem Pinnen geändert haben, nie unbemerkt läuft. Standardwert: []

Zusätzliche Eigenschaften sind nicht zulässig.

aggrega-config.lint

Strenge-Regler pro Regel.

EigenschaftTypErforderlichBeschreibung
publishing_disciplineobjectneinWorkspace-weite Schalter für das Regelwerk des Veröffentlichungs-Linters. Die Flags allow_* lockern einzelne Prüfungen auf nicht empfohlene Muster. Die Unveränderlichkeit von Artefakten ist hier nicht konfigurierbar: aggrega push weigert sich bedingungslos, eine veröffentlichte Version zu überschreiben.

Zusätzliche Eigenschaften sind nicht zulässig.

aggrega-config.lint.publishing_discipline

Workspace-weite Schalter für das Regelwerk des Veröffentlichungs-Linters. Die Flags allow_* lockern einzelne Prüfungen auf nicht empfohlene Muster. Die Unveränderlichkeit von Artefakten ist hier nicht konfigurierbar: aggrega push weigert sich bedingungslos, eine veröffentlichte Version zu überschreiben.

EigenschaftTypErforderlichBeschreibung
allow_dynamic_refsbooleschneinWenn true, akzeptiert der Veröffentlichungs-Linter die JSON-Schema-Konstrukte $dynamicRef / $dynamicAnchor in Kataloginhalten. Standardmäßig false; von diesen Konstrukten wird abgeraten, weil sie die Schemakomposition zur Kompilierzeit nicht-lokal machen. Standardwert: false
allow_id_overridesbooleschneinWenn true, akzeptiert der Veröffentlichungs-Linter Überschreibungen von $id in Teilschemas innerhalb des Schemainhalts einer Entität. Standardmäßig false; Überschreibungen von $id brechen die Konvention eines kanonischen Bezeichners pro Schema, auf die sich sowohl der Resolver als auch der JSON-Schema-Validator stützen. Standardwert: false
allow_direct_x_aggrega_extensionsbooleschneinWenn true, akzeptiert die Prüfung auf nicht empfohlene Muster zur Build-Zeit die Schlüsselwörter x-aggrega-selector und x-aggrega-inject, wenn sie direkt im Schemainhalt geschrieben sind. Standardmäßig false; der empfohlene Authoring-Weg ist usesSchema (für Abhängigkeits-Sockets) oder featuresSchema (für Bindungen von Anmeldedaten), die der Compiler zu diesen Schlüsselwörtern zusammensetzt. Standardwert: false
allow_aggrega_ai_prefixbooleschneinWenn true, akzeptiert der Veröffentlichungs-Linter Annotationsschlüssel, die die reservierten Namensräume aggrega.ai/ und feature.aggrega.ai/ außerhalb ihrer kanonischen Kontexte verwenden. Die Regel für reservierte Präfixe kontrolliert die metadata.annotations von Katalogentitäten: Das bloße Präfix aggrega.ai/ ist plattformeigen (bekannte Annotationsschlüssel sind unabhängig von diesem Flag ausgenommen); das Präfix feature.aggrega.ai/ ist nur beim Typ Feature kanonisch. Standardmäßig false. Operatoren setzen dies, wenn Unternehmenswerkzeuge legitimerweise ein reserviertes Präfix verwenden müssen; es lockert beide Präfixe gemeinsam. Standardwert: false
allow_nonstandard_namesbooleschneinWenn true, akzeptiert der Veröffentlichungs-Linter Namen von Katalogentitäten, die nicht den dokumentierten Namenskonventionen des Projekts folgen. Standardmäßig false; eine einheitliche Benennung ist tragend für den Resolver, die Auswahl über Labels und die Ergonomie für Reviewer. Standardwert: false
allow_category_mismatchesbooleschneinWenn true, unterdrückt der Veröffentlichungs-Linter die Regel category-matches-directory. Die Konvention des Standardkatalogs verlangt, dass Components unter core// ein zum Verzeichnissegment passendes component.aggrega.ai/category={category} deklarieren, wobei {category} einer der Werte aus einer geschlossenen Menge ist (etwa ai-agent, ai-model, ai-tool, datastore, gateway, compute, …). Workspaces mit legitimen dauerhaften Ausnahmen steigen hier aus. Standardmäßig false. Standardwert: false
allow_undeclared_recipe_providesbooleschneinWenn true, unterdrückt der Veröffentlichungs-Linter die Regel provides-declared-by-component. Diese Regel meldet jeden Schlüssel, den ein Recipe in spec.provides veröffentlicht und den die durch sein spec.implements benannte Component nicht in der Säule provides ihres spec.schema deklariert. Die beiden sind getrennte Oberflächen: Was ein Recipe veröffentlicht, ist der Wert, den ein Konsument erhält, während das, was die Component deklariert, der Ausgabevertrag ist, gegen den eine Referenz inject from: geprüft wird — daher lässt ein Schlüssel, der veröffentlicht, aber nicht deklariert ist, eine solche Referenz abbrechen. Ein Recipe, das mehr veröffentlicht, als seine Component deklariert, wird ansonsten zur Build-Zeit akzeptiert, weshalb der Befund ein Hinweis und keine Ablehnung der Veröffentlichung ist. Standardmäßig false. Standardwert: false
allow_connection_credential_mismatchesbooleschneinWenn true, unterdrückt der Veröffentlichungs-Linter die Regel connection-credential-matches-target-key, die aggrega lint --release über das Release ausführt, das es nennt: das Release, das Aggregate, das es bereitstellt, und die Components, die die Instanzen dieses Aggregate verwenden. Für jede Verbindung, deren Ziel den Schlüssel deklariert, den es von seinen Aufrufern verlangt, vergleicht die Regel, worauf die beiden Enden verweisen: die Anmeldedaten, die die Verbindung vorlegt, und den Schlüssel, den das Ziel in seinem eigenen Slot hält. Sie meldet zwei Enden, die unterschiedliche Secrets nennen, und einen nur an einem Ende deklarierten Schlüssel, und sie zitiert keines von beiden. Keines der beiden Enden kann die Anbindungen des anderen sehen, daher stimmen die beiden nur durch Authoring-Disziplin überein — meist ein einziger Parameter, der beide speist —, und ein Build akzeptiert sie so oder so, weshalb der Befund ein Hinweis ist. Ein Workspace, dessen beide Enden absichtlich voneinander abweichen, steigt hier aus. Standardmäßig false. Standardwert: false

Zusätzliche Eigenschaften sind nicht zulässig.

aggrega-config.parse_cache

Obergrenzen für die Verdrängung aus dem Parse-Cache des Daemons. Beide Obergrenzen gelten gleichzeitig — die LRU-Verdrängungsschleife läuft nach jedem Einfügen in den Cache und entfernt die am längsten nicht verwendeten Einträge, bis sowohl die Anzahl der Einträge als auch die Gesamtzahl der Bytes innerhalb der Grenzen liegen. Null bei einer von beiden bedeutet unbounded on that axis, nützlich für CI-Szenarien, in denen der Cache nur für einen einzelnen Aufruf existiert. Getrennt von artifact_cache_dir, dem Inhalts-Cache auf der Festplatte.

EigenschaftTypErforderlichBeschreibung
max_entriesintegerneinObergrenze für die Anzahl zwischengespeicherter Parse-Ergebnisse. Standardmäßig 1000. 0 deaktiviert die Achse der Eintragsanzahl (keine durch die Eintragsanzahl ausgelöste Verdrängung). Minimum: 0. Standardwert: 1000
max_bytesintegerneinObergrenze für die kumulierte Größe der Dokumente im Cache, in Bytes. Standardmäßig 100000000 (100 MB). 0 deaktiviert die Byte-Achse (keine durch die Gesamtzahl der Bytes ausgelöste Verdrängung). Minimum: 0. Standardwert: 100000000

Zusätzliche Eigenschaften sind nicht zulässig.

aggrega-config.compiled_module_cache

Größenobergrenze für den Cache kompilierter Module auf der Festplatte, den Maschinencode-Speicher, den der Compiler wiederverwendet, sodass ein Wasm-Plugin einmal pro Maschine statt einmal pro Build kompiliert wird. Er wird von jedem Workspace auf der Maschine gemeinsam genutzt, daher gehört dieser Schlüssel in die globale Konfigurationsdatei, wenn Sie eine einzige Antwort für die ganze Maschine wollen. Die Obergrenze wird einmal pro Aufruf angewendet, bevor ein Plugin geladen wird, indem ganze Einträge entfernt werden, die am frühesten kompilierten zuerst, bis der Rest hineinpasst — nie während ein Build kompiliert. Das Entfernen eines Eintrags kostet eine spätere Neukompilierung und sonst nichts, daher kann die Obergrenze gefahrlos gesenkt werden. aggrega cache status meldet die aktuelle Größe des Speichers, und aggrega cache evict --max-size kürzt ihn bei Bedarf auf eine auf der Kommandozeile angegebene Obergrenze. Getrennt von artifact_cache_dir (aus Registries abgerufene Inhalte) und von parse_cache (dem Parse-Cache des Daemons im Arbeitsspeicher).

EigenschaftTypErforderlichBeschreibung
max_bytesintegerneinObergrenze für die Bytes, die der Cache kompilierter Module auf der Festplatte belegt. Standardmäßig 53687091200 (50 GiB), eine Höchstgrenze, die unbegrenztes Wachstum stoppt, statt eines Budgets, das spürbar sein soll — ein einzelnes kompiliertes Plugin erreicht Hunderte von Megabytes, daher sammelt eine Maschine, die viele Plugin-Versionen baut, Gigabytes an. Setzen Sie sie über das, was ein einzelner Build kompiliert: Die Obergrenze wird angewendet, bevor ein Build irgendetwas kompiliert, daher führt eine Obergrenze unter der eigenen Arbeitsmenge eines einzelnen Builds dazu, dass jeder Build dieselben Module verwirft und neu kompiliert, und der Speicher spart nichts mehr ein. Da die Obergrenze zuerst angewendet wird und der Build danach schreibt, was er kompiliert, kann der Speicher zwischen Builds über der Obergrenze liegen; er wird zu Beginn des nächsten Builds erneut gekürzt. 0 deaktiviert die Obergrenze (der Speicher wächst unbegrenzt, und nichts wird je automatisch entfernt). Da der Speicher ein einziges Verzeichnis ist, das sich alle Workspaces teilen, gilt diese Obergrenze nicht pro Projekt, selbst wenn die eigene Datei eines Projekts sie trägt: Der Wert wird auf dieselbe Weise aufgelöst wie jeder andere Schlüssel, wobei die nähere Datei gewinnt, aber der Speicher hat trotzdem nur eine Größe. Die geltende Obergrenze ist die des jüngsten Builds, daher wirken zwei Projekte, die sie unterschiedlich begrenzen, abwechselnd beide, und eine niedrige Obergrenze im einen verwirft Maschinencode, den das andere kompiliert hat. Sie einmal in der globalen Konfigurationsdatei zu setzen, gibt der ganzen Maschine eine einzige Antwort. aggrega config show --origin nennt die Datei, aus der der effektive Wert jeder Einstellung stammt. Minimum: 0. Standardwert: 53687091200

Zusätzliche Eigenschaften sind nicht zulässig.

aggrega-config.concurrency

Nebenläufigkeitseinstellungen für die Anfrageverteilung des Daemons. Der Daemon liest Anfragen aus einem einzigen stdin-Stream und führt jede über einen Worker-Pool aus, der eine begrenzte Anfragewarteschlange abarbeitet; Antworten werden in der Reihenfolge des Eintreffens der Anfragen ausgegeben, unabhängig von der Reihenfolge ihrer Fertigstellung.

EigenschaftTypErforderlichBeschreibung
pool_sizeintegerneinAnzahl der Worker, die die Anfragewarteschlange bedienen. Standardmäßig 4, womit bis zu vier Anfragen gleichzeitig verteilt werden; setzen Sie den Wert auf 1, um Anfragen nacheinander in der Reihenfolge ihres Eintreffens auszuführen. Ein Wert unter 1 wird beim Start des Daemons auf 1 angehoben. Minimum: 1. Standardwert: 4

Zusätzliche Eigenschaften sind nicht zulässig.

aggrega-config.serve

Verhaltenseinstellungen des Daemons (aggrega serve) für den Compiler als Dienst, der von IDE-Integrationen genutzt wird.

EigenschaftTypErforderlichBeschreibung
build_on_inspectbooleschneinOb der Daemon beim Inspizieren eines IR-Graphen die Artefakt-Rendering-Phase ausführt, sodass die Hinweise, die aggrega build beim Rendern ausgibt, auch als Probleme im Editor erscheinen. Es fügt keine der Prüfungen hinzu, bei denen ein Build abbricht. In keinem Fall wird etwas auf die Festplatte geschrieben — keine gerenderten Artefakte, kein Ausgabeverzeichnis, kein Lockfile —, und die Rendering-Phase verändert den Graphen nie, sodass es dort, wo die Inspektion mit einem Graphen antwortet, in beiden Fällen derselbe Graph ist. Standardmäßig false, passend zu aggrega inspect: Der Terminalbefehl erreicht beim Inspizieren eines Graphen die Rendering-Phase nicht, gibt also ebenfalls keinen solchen Hinweis aus, und eine Inspektion im Editor, die keinen ausgibt, zeigt Ihnen dasselbe wie das Terminal. Setzen Sie den Wert auf true, um den Editor um diese zusätzliche Ebene zu bitten. Standardwert: false
lint_on_validatebooleschneinOb der Daemon beim Validieren einer Katalogentität die Prüfung der Veröffentlichungskonventionen ausführt, sodass die Befunde, die aggrega lint zu dieser Entität meldet, auch als Probleme im Editor erscheinen. Die Befunde sind Hinweise: Ein Dokument, das sie auslöst, wird trotzdem validiert, und sein Release wird trotzdem aufgelöst und gerendert. Es läuft nur die Prüfung, die lokale Inhalte liest — keine Registry wird befragt, nichts wird abgerufen und nichts geschrieben —, und sie wird gegen den Puffer ausgewertet, den der Editor hält, statt gegen die Datei auf der Festplatte, sodass ein Name, den Sie korrigieren, nicht mehr gemeldet wird, bevor Sie speichern. Standardmäßig false: Eine Editor-Sitzung meldet, ob ein Dokument korrekt ist, und sagt nichts darüber, ob eine Entität veröffentlichbar ist, bis Sie diese zweite Ebene anfordern. Setzen Sie den Wert auf true, um sie anzufordern. Unabhängig von diesem Schlüssel kann ein Editor die Prüfung jederzeit direkt anfordern, und auf diesem Weg wird auch der Vergleich vor der Veröffentlichung mit der zuvor veröffentlichten Version erreicht. Standardwert: false

Zusätzliche Eigenschaften sind nicht zulässig.

aggrega-config.mcp

Einstellungen für den Model-Context-Protocol-Server (aggrega mcp). transport wählt, wie der Server erreicht wird — über die Standardeingabe und Standardausgabe des Prozesses oder über HTTP — und wird gelesen, welche der beiden es auch wählt. Auch announce_tools wird auf beiden Transporten gelesen, weil die Frage, welche Werkzeuge einem Client angeboten werden, eine Eigenschaft des Servers ist und nicht davon abhängt, wie ein Client ihn erreicht hat. Jeder andere Schlüssel konfiguriert den Listener, den der HTTP-Transport startet, und wird nicht verwendet, solange der Server über Standardeingabe und Standardausgabe kommuniziert — listen eingeschlossen, das dort nur gelesen wird, damit der Server in einer Zeile auf seinem Fehlerstrom mitteilen kann, dass die Adresse nicht verwendet wird. Jeder Schlüssel unten gibt an, um welchen Fall es sich handelt. Getrennt von serve, das den Editor-Backend-Daemon konfiguriert.

EigenschaftTypErforderlichBeschreibung
transportstring (enum)neinWie der Server erreicht wird: stdio spricht das Protokoll über die Standardeingabe und Standardausgabe des Prozesses, und so erreicht ihn ein Client, der den Befehl als Unterprozess startet; http stellt es über HTTP an der Adresse bereit, die listen nennt, und über HTTPS, wo tls ein Zertifikat und einen Schlüssel nennt. aggrega mcp --transport stdio|http überschreibt diesen Schlüssel für einen einzelnen Aufruf. Standardmäßig stdio, sodass ein Workspace, der nie einen Transport nennt, über Standardeingabe und Standardausgabe bedient wird, was auch immer dieser Block sonst enthält — ein Listener startet nur dort, wo http gewählt ist, hier oder auf der Kommandozeile. Jeder andere Wert wird beim Laden der Konfiguration abgelehnt. Setzen Sie http in der Konfiguration eines Servers, den Aufrufer über das Netzwerk erreichen, und lassen Sie den Schlüssel ungesetzt, wo ein Client den Server selbst startet: Ist stdio gewählt, wird eine Adresse in listen nicht verwendet, und der Server teilt das in einer Zeile auf seinem Fehlerstrom mit. Zulässige Werte: "stdio", "http" Standardwert: "stdio"
listenstringneinAdresse, an die sich der Listener bindet, wenn der HTTP-Transport gewählt ist. Sie nennt, wo gelauscht wird, und wählt nichts: Den Transport wählt transport, und ist stdio gewählt, wird dieser Schlüssel nicht verwendet. Zwei Formen werden akzeptiert: host:port für eine TCP-Adresse und unix: gefolgt von einem Dateisystempfad für einen Unix-Domain-Socket. aggrega mcp --listen <address> überschreibt diesen Schlüssel für einen einzelnen Aufruf. Standardmäßig leer, und der HTTP-Transport braucht eine Adresse aus dem einen oder dem anderen: Fehlen beide, wird ein Start, der ihn wählt, abgelehnt, bevor irgendetwas gebunden wird. Eine Klartextadresse — eine, die ohne Zertifikat und Schlüssel unter tls erreicht wird — wird nur auf einer Loopback-Adresse (127.0.0.1, ::1 oder localhost, das zu einer davon aufgelöst wird) oder auf einem Unix-Socket akzeptiert, der Form, die ein Server verwendet, wenn ein vorgelagerter Proxy TLS terminiert; jede andere Adresse wird abgelehnt, bevor irgendetwas gebunden wird, wobei mcp.tls.cert_file und mcp.tls.key_file genannt werden. Dieselben zwei Formen sind die einzigen, die akzeptiert werden, mit oder ohne Zertifikat, wo authorization.trusted_proxy gesetzt ist, weil einem Header nur dort als Anmeldedaten vertraut werden kann, wo nichts außer dem Proxy ihn setzen kann. Standardwert: ""
tlsobjectneinZertifikat und Schlüssel, um TLS innerhalb des bedienenden Prozesses zu terminieren. Setzen Sie beide, um HTTPS direkt über den Listener bereitzustellen, den listen nennt. Lassen Sie beide ungesetzt, um Klartext bereitzustellen, was listen auf eine Loopback-Adresse oder einen Unix-Socket beschränkt — die Form für den Fall, dass ein vorgelagerter Proxy das Zertifikat hält. Beide Schlüssel sind Pfade zu Dateien auf der Festplatte; keiner enthält Schlüsselmaterial inline.
allowed_originsstring[]neinUrsprünge, die im Origin-Header einer Anfrage akzeptiert werden. Eine Anfrage, deren Origin-Header einen Ursprung nennt, den diese Liste nicht enthält, wird mit 403 abgelehnt; eine Anfrage, die einen aufgeführten Ursprung nennt oder überhaupt keinen Origin-Header trägt, wird bedient. Ein Eintrag wird exakt mit dem Header verglichen, daher wird jeder so geschrieben, wie ein Browser einen Ursprung sendet: ein kleingeschriebenes Schema, ://, ein kleingeschriebener Host — ein Name, eine IPv4-Adresse oder eine IPv6-Adresse in eckigen Klammern — und : mit dem Port, wo dieser nicht der Standardport des Schemas ist, ohne etwas danach. Zum Beispiel https://app.example.com oder http://localhost:3000. Ein Eintrag in jeder anderen Form könnte nie dem entsprechen, was ein Browser sendet, daher wird er beim Laden der Konfigurationsdatei abgelehnt, wobei die Datei und der Eintrag genannt werden: einer mit abschließendem / oder einem Pfad (https://app.example.com/), einer ohne Schema (app.example.com) und einer, der einen Großbuchstaben oder ein Leerzeichen enthält. Standardmäßig leer, sodass kein Ursprung akzeptiert wird und nur ein Aufrufer bedient wird, der keinen Origin-Header sendet. Ein browserbasierter Client braucht daher seinen Ursprung hier aufgeführt; ein Client, der kein Browser ist, sendet keinen solchen Header und braucht keinen Eintrag. Jeder Eintrag entspricht dem Muster ^[a-z][a-z0-9+.-]*://(?:[a-z0-9._-]+|\[[0-9a-f:.]+\])(?::[0-9]{1,5})?$. Standardwert: []
limitsobjectneinObergrenzen, die der HTTP-Listener auf den angenommenen Datenverkehr anwendet, damit ein einzelner Aufrufer den bedienenden Prozess nicht erschöpfen kann. Sie begrenzen, wie groß eine einzelne Anfrage sein darf, wie viele Anfragen gleichzeitig laufen und wie schnell ein Aufrufer senden darf. Keine davon lässt sich abschalten.
authorizationobjectneinWas dieser Server über die Bearer-Token erklärt, die seine Aufrufer vorlegen: welcher Autorisierungsserver sie ausstellt, die Adresse, die dieser Server für sich selbst als die Ressource veröffentlicht, für die sie ausgestellt werden, optional eine Datei, aus der die Verifizierungsschlüssel dieses Servers gelesen werden, und optional die Header, die ein vorgelagerter Proxy setzt, wenn stattdessen dieser Proxy die Token validiert. issuer und resource sind immer erforderlich, wenn der HTTP-Transport gewählt ist, und ohne sie wird ein Listener abgelehnt, bevor irgendetwas gebunden wird; ein Server, der über Standardeingabe und Standardausgabe kommuniziert, liest keinen dieser Werte. Beide werden im OAuth-Metadatendokument der geschützten Ressource veröffentlicht, das der Listener bereitstellt; es ist die einzige Antwort, die ein HTTP-Aufrufer erhält, ohne dass Anmeldedaten verlangt werden, weil ein Client es liest, um herauszufinden, wo er ein Token erhält. Dieser Block enthält kein geheimes Material: Ein Token wird von einem Aufrufer mit der Anfrage vorgelegt, die er stellt, und ist nie ein Konfigurationsfeld, und jwks_file nennt öffentliche Verifizierungsschlüssel statt etwas, das signiert.
deny_reachstring (enum)[]neinArten von Reichweite, die dieser Server nicht anbietet, was auch immer das Token eines Aufrufers sagt. Jede Operation deklariert, wie weit ihre eigenen Wirkungen reichen — none für eine, die liest oder rendert und nichts zurücklässt, workspace für eine, die innerhalb des Workspace schreibt, den dieser Prozess bedient, registry für eine, die veröffentlicht, signiert oder zurückzieht, und machine für eine, die verändert, was alle Workspaces auf dem Host gemeinsam nutzen —, und eine Art hier zu nennen, entzieht diesem Server jedes Tool dieser Art. Ein entzogenes Tool fehlt in der Tool-Liste und in dem, was describe-capabilities antwortet, für jeden Aufrufer, und wird es dennoch aufgerufen, wird der Aufruf unter Nennung dieser Einstellung abgelehnt, weil kein Scope es zulassen könnte. Standardmäßig leer, sodass der Server alles anbietet, was die Scopes seiner Aufrufer zulassen. Es ist eine Grenze, die sich der Server selbst setzt, zusätzlich zu der Grenze pro Aufrufer, die Scopes setzen: Ein Server, der Lesezugriffe bedient und sonst nichts, nennt hier die drei schreibenden Arten und kann dann selbst für einen Aufrufer, dessen Token jeden Scope trägt, nichts veröffentlichen. machine zu nennen wird akzeptiert und ändert nichts — über HTTP wird überhaupt kein Tool dieser Art angeboten, was eine Eigenschaft des Transports ist und keine Einstellung. Wird beim Start des Listeners gelesen: Ein Wert außerhalb der vier wird beim Laden der Konfiguration abgelehnt, und eine Änderung erfordert einen Neustart. Wird überhaupt nicht gelesen, solange der Server über Standardeingabe und Standardausgabe kommuniziert, wo der Aufrufer die Person ist, die den Prozess gestartet hat. Zulässige Werte für jeden Eintrag: "none", "workspace", "registry", "machine". Standardwert: []
announce_toolsstring[]neinTools, die dieser Server ankündigt, genau so benannt, wie die Tool-Liste sie meldet. Lassen Sie den Schlüssel weg, wird jedes Tool angekündigt, das dieser Server anbietet, und das erwartet ein Client, der dem Protokoll folgt: Er ruft die gesamte Tool-Liste ab und entscheidet selbst, wie viel davon er einem Modell vorlegt. Schreiben Sie eine Liste, werden genau diese Tools angekündigt — ein ausgelassenes fehlt in der Tool-Liste, fehlt in dem, was describe-capabilities antwortet, und wird abgelehnt, wenn es per Name aufgerufen wird, wobei diese Einstellung genannt wird. Schreiben Sie eine leere Liste, wird nichts angekündigt. Setzen Sie den Schlüssel dort, wo der Client am anderen Ende begrenzt, wie viele Tools er registriert — manche Clients wenden diese Obergrenze auf alle Server an, mit denen sie gleichzeitig verbunden sind —, und nennen Sie die Tools, die dieser Client braucht. Er schränkt ein, was angekündigt wird, und sonst nichts: Er kann weder deny_reach erweitern, das eine Fähigkeit vollständig entzieht, noch die Scopes, die das Token eines Aufrufers trägt. Ein hier genanntes Tool einer Art, die deny_reach entzieht, bleibt aus der Tool-Liste heraus und wird beim Aufruf abgelehnt, wobei jene Einstellung genannt wird; eines, das hier genannt ist und das die Scopes des Aufrufers nicht zulassen, wird dennoch aufgeführt, und ein Aufruf des Tools wird unter Nennung des Scopes abgelehnt, der es zulassen würde. Jeder Name muss einer sein, den diese Binärdatei anbietet: Ein Name, auf den kein Tool hört, wird beim Start des Servers abgelehnt, weil derjenige, der eine engere Oberfläche angefordert hat, sonst eine andere bedient bekäme, ohne dass etwas darauf hinweist. Ein Name der Familie cli-, die einen aggrega-Befehl in einem separaten Prozess ausführt, wird auf beiden Transporten akzeptiert und kündigt über HTTP nichts an, wo keinem Aufrufer ein solches Tool angeboten wird. Wird auf beiden Transporten beim Start des Servers gelesen, sodass die angekündigte Menge für die Lebensdauer des Prozesses feststeht und eine Änderung einen Neustart erfordert.
healthobjectneinWo ein Supervisor fragt, ob dieser Prozess lebt und ob er bereit ist, einen Aufruf zu beantworten. Die beiden Prüfungen werden auf einer eigenen Adresse beantwortet und nie auf der Adresse, die listen nennt: Jede Anfrage an den Endpunkt trägt ein Bearer-Token, daher würde eine dort beantwortete Probe allem, was den Endpunkt erreichen kann, einen nicht authentifizierten Einblick in den Prozess geben und zugleich eine kostenlose Möglichkeit, ihn arbeiten zu lassen. Der Endpunkt beantwortet /healthz und /readyz mit demselben 404, das er für jeden Pfad liefert, den er nicht bedient, mit Token wie ohne.

Zusätzliche Eigenschaften sind nicht zulässig.

aggrega-config.mcp.tls

Zertifikat und Schlüssel, um TLS innerhalb des bedienenden Prozesses zu terminieren. Setzen Sie beide, um HTTPS direkt über den Listener bereitzustellen, den listen nennt. Lassen Sie beide ungesetzt, um Klartext bereitzustellen, was listen auf eine Loopback-Adresse oder einen Unix-Socket beschränkt — die Form für den Fall, dass ein vorgelagerter Proxy das Zertifikat hält. Beide Schlüssel sind Pfade zu Dateien auf der Festplatte; keiner enthält Schlüsselmaterial inline.

EigenschaftTypErforderlichBeschreibung
cert_filestringneinPfad zur PEM-Zertifikatskette, die der Listener vorlegt, gelesen beim Start des Prozesses. Wird zusammen mit key_file gesetzt. Standardmäßig leer, sodass der Listener Klartext bereitstellt und listen auf eine Loopback-Adresse oder einen Unix-Socket beschränkt ist. Standardwert: ""
key_filestringneinPfad zum privaten PEM-Schlüssel für das Zertifikat in cert_file, gelesen beim Start des Prozesses. Wird zusammen mit dieser Einstellung gesetzt. Ein Pfad zu einer Datei, nie Schlüsselmaterial inline. Standardmäßig leer, sodass der Listener Klartext bereitstellt und listen auf eine Loopback-Adresse oder einen Unix-Socket beschränkt ist. Standardwert: ""

Zusätzliche Eigenschaften sind nicht zulässig.

aggrega-config.mcp.limits

Obergrenzen, die der HTTP-Listener auf den angenommenen Datenverkehr anwendet, damit ein einzelner Aufrufer den bedienenden Prozess nicht erschöpfen kann. Sie begrenzen, wie groß eine einzelne Anfrage sein darf, wie viele Anfragen gleichzeitig laufen und wie schnell ein Aufrufer senden darf. Keine davon lässt sich abschalten.

EigenschaftTypErforderlichBeschreibung
max_body_bytesintegerneinGrößter Anfragerumpf, den der Listener akzeptiert, in Bytes. Eine Anfrage, deren Rumpf ihn überschreitet, wird mit 413 abgelehnt, und der Rumpf wird nicht über die Obergrenze hinaus gelesen. Standardmäßig 4194304 (4 MiB), was weit über einem Tool-Aufruf liegt, der ein ganzes Authoring-Dokument trägt, und weit unter dem, womit ein einzelner Aufrufer einen erheblichen Anteil des Arbeitsspeichers des Prozesses belegen könnte. Das Minimum ist 1, es gibt also keinen Wert, der die Obergrenze abschaltet; erhöhen Sie sie, wo Aufrufer berechtigterweise größere Dokumente senden. Minimum: 1. Standardwert: 4194304
max_concurrent_requestsintegerneinWie viele Anfragen der Listener gleichzeitig ausführt. Eine Anfrage, die eintrifft, während bereits so viele in Bearbeitung sind, wird mit 503 abgelehnt statt in eine Warteschlange gestellt, sodass ein Aufrufer aufgefordert wird, es erneut zu versuchen, statt hinter Arbeit zu warten, die er nicht sehen kann. Standardmäßig 16, was Raum für mehrere gleichzeitige Tool-Aufrufe lässt und einen kleinen Host dennoch reaktionsfähig hält; erhöhen Sie den Wert auf einem größeren Host. Das Minimum ist 1, es gibt also keinen Wert, der die Obergrenze abschaltet. Minimum: 1. Standardwert: 16
requests_per_minuteintegerneinWie viele Anfragen ein einzelner Aufrufer pro Minute senden darf. Gezählt wird pro Aufrufer statt pro Server — gegen das Subjekt, das das Token des Aufrufers nennt, oder gegen die Identität, die ein vertrauenswürdiger Proxy zugesichert hat —, sodass ein vielbeschäftigter Aufrufer nicht das Kontingent eines anderen aufbrauchen kann. Ein Aufrufer darf so viele in einem Schub senden; das Kontingent füllt sich dann gleichmäßig wieder auf, mit einer weiteren Anfrage alle 60 / requests_per_minute Sekunden, und eine Anfrage, die eintrifft, wenn nichts mehr davon übrig ist, wird mit 429 abgelehnt. Standardmäßig 120, also dauerhaft zwei pro Sekunde: weit über dem, was ein Assistent sendet, der einen Workspace steuert, und dennoch eine Grenze für einen Client, der in eine Schleife geraten ist. Das Minimum ist 1, es gibt also keinen Wert, der die Obergrenze abschaltet. Minimum: 1. Standardwert: 120

Zusätzliche Eigenschaften sind nicht zulässig.

aggrega-config.mcp.authorization

Was dieser Server über die Bearer-Token erklärt, die seine Aufrufer vorlegen: welcher Autorisierungsserver sie ausstellt, die Adresse, die dieser Server für sich selbst als die Ressource veröffentlicht, für die sie ausgestellt werden, optional eine Datei, aus der die Verifizierungsschlüssel dieses Servers gelesen werden, und optional die Header, die ein vorgelagerter Proxy setzt, wenn stattdessen dieser Proxy die Token validiert. issuer und resource sind immer erforderlich, wenn der HTTP-Transport gewählt ist, und ohne sie wird ein Listener abgelehnt, bevor irgendetwas gebunden wird; ein Server, der über Standardeingabe und Standardausgabe kommuniziert, liest keinen dieser Werte. Beide werden im OAuth-Metadatendokument der geschützten Ressource veröffentlicht, das der Listener bereitstellt; es ist die einzige Antwort, die ein HTTP-Aufrufer erhält, ohne dass Anmeldedaten verlangt werden, weil ein Client es liest, um herauszufinden, wo er ein Token erhält. Dieser Block enthält kein geheimes Material: Ein Token wird von einem Aufrufer mit der Anfrage vorgelegt, die er stellt, und ist nie ein Konfigurationsfeld, und jwks_file nennt öffentliche Verifizierungsschlüssel statt etwas, das signiert.

EigenschaftTypErforderlichBeschreibung
issuerstringneinAdresse des Autorisierungsservers, der die Token ausstellt, die dieser Listener akzeptiert, so geschrieben, wie dieser Server seine eigene Ausstellerkennung angibt — zum Beispiel https://login.example.com. Sie wird in der Liste authorization_servers des Metadatendokuments der geschützten Ressource veröffentlicht, und so erfährt ein Client, wo er ein Token für diesen Listener erhält. Standardmäßig leer, was kein verwendbarer Wert ist: Ein Listener wird abgelehnt, bevor irgendetwas gebunden wird, sofern dieser Schlüssel keine vollständige Adresse einschließlich Schema und Host enthält. Es ist eine https-Adresse, es sei denn, der Autorisierungsserver läuft auf dieser Maschine: Einfaches http wird nur für einen Loopback-Host akzeptiert, etwa localhost, 127.0.0.1 oder ::1, und ein einfacher http-Aussteller auf jedem anderen Host wird abgelehnt, bevor irgendetwas gebunden wird, wobei dieser Schlüssel genannt und eine https-Adresse verlangt wird. Das gilt unabhängig davon, ob die Schlüssel vom Aussteller oder aus jwks_file gelesen werden oder ein vorgelagerter trusted_proxy die Token prüft, weil jeder Client zum Aussteller geschickt wird, um sein Token zu erhalten. Standardwert: ""
resourcestringneinAdresse, die dieser Server für sich selbst veröffentlicht, so wie ein Aufrufer ihn erreicht — zum Beispiel https://mcp.example.com/mcp. Schreiben Sie die Adresse, die Aufrufer tatsächlich verwenden, einschließlich des Hosts, den ein vorgelagerter Proxy präsentiert, denn dies ist die Kennung, die ein Client dem Autorisierungsserver übergibt, wenn er ein Token für diesen Server anfordert, und sie wird unverändert als Feld resource des Metadatendokuments der geschützten Ressource veröffentlicht. Wo dieses Dokument bereitgestellt wird, wird daraus abgeleitet, indem /.well-known/oauth-protected-resource zwischen Host und Pfad eingefügt wird: Ein als https://mcp.example.com/mcp veröffentlichter Server stellt es unter https://mcp.example.com/.well-known/oauth-protected-resource/mcp bereit und außerdem unter diesem Well-known-Pfad ohne etwas danach, wo ein Client als Zweites nachsieht. Ein Token wird nur akzeptiert, wenn diese Adresse unter den Audiences ist, die es nennt. Standardmäßig leer, was kein verwendbarer Wert ist: Ein Listener wird abgelehnt, bevor irgendetwas gebunden wird, sofern dieser Schlüssel keine vollständige Adresse einschließlich Schema und Host enthält. Standardwert: ""
jwks_filestringneinPfad zu einer Datei mit dem JSON Web Key Set, gegen das die Token geprüft werden, die dieser Server akzeptiert, gelesen beim Start des Prozesses. Standardmäßig leer, was der übliche Fall ist: Die Schlüssel werden vom Autorisierungsserver selbst gelesen, indem issuer gefragt wird, wo er sie veröffentlicht, und sie von der Adresse abgerufen werden, die er nennt, und sie werden einmal neu gelesen, wenn ein Token eintrifft, das mit einer Schlüsselkennung signiert ist, die der gehaltene Satz nicht enthält. Setzen Sie dies dort, wo der Workspace offline ist; in diesem Fall wird ein Listener ohne diesen Schlüssel abgelehnt, bevor irgendetwas gebunden wird, weil ein Offline-Workspace keine Netzwerkanfrage stellt und es keinen anderen Weg gibt, die Schlüssel zu erhalten; die Datei enthält dann die einzigen akzeptierten Schlüssel, und der Autorisierungsserver wird nie kontaktiert. Die Datei enthält öffentliche Verifizierungsschlüssel und nie etwas, das signiert. Ein relativer Pfad wird gegen das Verzeichnis der Konfigurationsdatei aufgelöst, die ihn deklariert hat. Standardwert: ""
trusted_proxyobjectneinLiest, wer ein Aufrufer ist, aus Headern, die ein vorgelagerter Proxy setzt, statt hier ein Bearer-Token zu validieren. Setzen Sie dies nur, wo beides zutrifft: Ein vorgelagerter Proxy validiert die Token selbst, und nichts außer diesem Proxy kann den Listener erreichen: Ist dies gesetzt, muss listen eine Loopback-Adresse oder ein Unix-Socket sein, und jede andere Adresse wird abgelehnt, bevor irgendetwas gebunden wird, wobei beide Einstellungen genannt werden. Ein Header ist genau so vertrauenswürdig wie die Menge der Aufrufer, die ihn setzen können, und auf einer Adresse, die das Netzwerk erreicht, kann jeder Aufrufer jeden beliebigen Header setzen, daher würde ein Listener in diesem Modus auf einer solchen Adresse jedem Aufrufer erlauben, sich als beliebige Person auszugeben. Ist dies gesetzt, wird überhaupt kein Token gelesen — nicht aus dem Authorization-Header, nicht von irgendwo sonst, und es wird kein Schlüsselsatz abgerufen —, die Identität des Aufrufers ist der Wert von principal_header, eine Anfrage, die diesen Header nicht trägt, wird mit 401 beantwortet, und die beiden hier genannten Header sind die einzigen, die gelesen werden. Lassen Sie es weg, was der Standard ist, und dieser Server validiert Bearer-Token selbst.

Zusätzliche Eigenschaften sind nicht zulässig.

aggrega-config.mcp.authorization.trusted_proxy

Liest, wer ein Aufrufer ist, aus Headern, die ein vorgelagerter Proxy setzt, statt hier ein Bearer-Token zu validieren. Setzen Sie dies nur, wo beides zutrifft: Ein vorgelagerter Proxy validiert die Token selbst, und nichts außer diesem Proxy kann den Listener erreichen: Ist dies gesetzt, muss listen eine Loopback-Adresse oder ein Unix-Socket sein, und jede andere Adresse wird abgelehnt, bevor irgendetwas gebunden wird, wobei beide Einstellungen genannt werden. Ein Header ist genau so vertrauenswürdig wie die Menge der Aufrufer, die ihn setzen können, und auf einer Adresse, die das Netzwerk erreicht, kann jeder Aufrufer jeden beliebigen Header setzen, daher würde ein Listener in diesem Modus auf einer solchen Adresse jedem Aufrufer erlauben, sich als beliebige Person auszugeben. Ist dies gesetzt, wird überhaupt kein Token gelesen — nicht aus dem Authorization-Header, nicht von irgendwo sonst, und es wird kein Schlüsselsatz abgerufen —, die Identität des Aufrufers ist der Wert von principal_header, eine Anfrage, die diesen Header nicht trägt, wird mit 401 beantwortet, und die beiden hier genannten Header sind die einzigen, die gelesen werden. Lassen Sie es weg, was der Standard ist, und dieser Server validiert Bearer-Token selbst.

EigenschaftTypErforderlichBeschreibung
principal_headerstringjaHeader, in den der vorgelagerte Proxy die Identität des Aufrufers schreibt — zum Beispiel X-Forwarded-User. Er wird als HTTP-Header-Name geschrieben: Buchstaben, Ziffern und Bindestriche sowie die anderen Zeichen, die ein Header-Name enthalten darf (!#$%&'*+.^_|~ und der Backtick), ohne Leerzeichen, Doppelpunkt oder anderes Trennzeichen. Ein Name in jeder anderen Form wird beim Laden der Konfigurationsdatei abgelehnt, wobei die Datei und der Schlüssel genannt werden, weil keine Anfrage einen solchen Header tragen kann. Ein leerer wird ebenfalls abgelehnt: Er würde diesen Server die Token selbst prüfen lassen, während der Block besagt, dass ein vorgelagerter Proxy dies tut. Um diesen Modus ausgeschaltet zu lassen, lassen Sie trusted_proxy weg. Der Wert des Headers wird genau so übernommen, wie er geschrieben ist, und mit nichts verglichen, ebenso wie das Subjekt eines Tokens, das dieser Server selbst validiert, verzeichnet und mit nichts verglichen wird. Er ist in diesem Modus die gesamten Anmeldedaten, daher ist er immer erforderlich, wenn trusted_proxy gesetzt ist, und eine Anfrage, die ohne ihn eintrifft, wird mit 401 beantwortet. Muster: ^[!#$%&'*+.^_`|~0-9A-Za-z-]+$.
scopes_headerstringneinHeader, in den der vorgelagerte Proxy die dem Aufrufer gewährten Scopes schreibt, durch Leerzeichen getrennt — zum Beispiel X-Forwarded-Scopes. Er wird als HTTP-Header-Name geschrieben, in derselben Form wie principal_header, oder leer gelassen. Ein Name in jeder anderen Form wird beim Laden der Konfigurationsdatei abgelehnt, wobei die Datei und der Schlüssel genannt werden, weil keine Anfrage einen solchen Header tragen kann und keinem Aufrufer je ein Scope gewährt würde. Standardmäßig leer, was für keinen Aufrufer Scopes zusichert. Wie auch immer er heißt, es wird kein anderer Header als dieser und principal_header gelesen. Muster: ^[!#$%&'*+.^_`|~0-9A-Za-z-]*$. Standardwert: ""

Zusätzliche Eigenschaften sind nicht zulässig.

aggrega-config.mcp.health

Wo ein Supervisor fragt, ob dieser Prozess lebt und ob er bereit ist, einen Aufruf zu beantworten. Die beiden Prüfungen werden auf einer eigenen Adresse beantwortet und nie auf der Adresse, die listen nennt: Jede Anfrage an den Endpunkt trägt ein Bearer-Token, daher würde eine dort beantwortete Probe allem, was den Endpunkt erreichen kann, einen nicht authentifizierten Einblick in den Prozess geben und zugleich eine kostenlose Möglichkeit, ihn arbeiten zu lassen. Der Endpunkt beantwortet /healthz und /readyz mit demselben 404, das er für jeden Pfad liefert, den er nicht bedient, mit Token wie ohne.

EigenschaftTypErforderlichBeschreibung
listenstringneinAdresse, auf der die Lebendigkeits- und Bereitschaftsprüfungen beantwortet werden, in denselben zwei Formen, die listen annimmt: host:port oder unix: gefolgt von einem Dateisystempfad. Standardmäßig leer, sodass kein zweiter Listener gestartet und keine der beiden Prüfungen irgendwo beantwortet wird. Ist eine Adresse gesetzt, wird GET /healthz ab dem Moment, in dem der Prozess läuft, mit 200 beantwortet, und GET /readyz wird mit 503 beantwortet, bis der Workspace aufgelöst ist und der Endpunkt gebunden hat, und ab dann mit 200 — das ist die Unterscheidung, die ein Supervisor braucht, denn ein Prozess, der läuft, ist noch kein Prozess, der einen Aufruf beantworten kann. Jede Antwort ist ein Statuscode mit leerem Rumpf, es wird kein Token verlangt und kein Header gelesen; jeder andere Pfad auf dieser Adresse ergibt 404, und jede andere Methode auf diesen beiden ergibt 405. Anders als bei listen ist diese Adresse nicht auf Loopback oder einen Unix-Socket beschränkt, und keine Adresse wird dafür abgelehnt: Richten Sie sie auf eine davon, wofür sie gedacht ist, und beachten Sie, dass alles, was die gewählte Adresse erreichen kann, diese beiden Antworten lesen kann. Standardwert: ""

Zusätzliche Eigenschaften sind nicht zulässig.

Definitionen

ReleaseCatalogConfig

Die eigenen Katalogverzeichnisse eines Release: dieselben zwei Schlüssel, die der Block workspace trägt, beschränkt auf dieses Release.

EigenschaftTypErforderlichBeschreibung
catalog_dirsstring[]neinKatalogverzeichnisse, aus denen dieses Release lokale Entitäten liest, anstelle des catalog_dirs des Workspace, jedes aufgelöst relativ zu der Datei, die es deklariert. Derselbe geordnete Suchstapel, bei dem der erste Treffer gewinnt, wie bei der Liste des Workspace, wobei das Verzeichnis catalog an der Wurzel des Workspace danach gelesen wird, wenn dieses Verzeichnis existiert und kein aufgeführter Eintrag es bereits enthält. Wird der Schlüssel weggelassen, behält das Release die Liste des Workspace; wird er als [] geschrieben, wird überhaupt kein lokaler Katalog gelesen.
catalog_dirs_appendstring[]neinKatalogverzeichnisse, die nach der Liste dieses Release angehängt werden — seinem eigenen catalog_dirs, wo der Eintrag eines schreibt, sonst dem des Workspace —, jedes aufgelöst relativ zu der Datei, die es deklariert. Standardwert: []

Zusätzliche Eigenschaften sind nicht zulässig.

RegistryConfig

Einstellungen und Vertrauensrichtlinie für Signaturen, beschränkt auf einen einzelnen OCI-Registry-Host.

EigenschaftTypErforderlichBeschreibung
hoststringjaDer Registry-Host, für den diese Einstellungen gelten (z. B. hub.aggrega.ai). Er wird mit dem Registry-Host des Push-/Pull-Ziels abgeglichen, daher wird er in der Schreibweise geschrieben, in der dieser Abgleich erfolgt: ein kleingeschriebener Hostname, der einen Punkt enthält, localhost, ein einzelner Name gefolgt von einem Port (registry:5000), eine IPv4-Adresse oder eine IPv6-Adresse in eckigen Klammern, jeweils mit optionalem :port — ohne Schema, Pfad, Anmeldedaten, Leerzeichen oder Großbuchstaben. Port 443 auf einem über HTTPS erreichten Host ist der Standardport dieses Hosts, und ihn zu schreiben wird beim Laden der Konfiguration abgelehnt, wobei der Host genannt wird, der ohne ihn zu schreiben ist, weil ein so geschriebener Eintrag nie derjenige wäre, der gefunden wird; localhost und die anderen Loopback-Adressen werden über einfaches HTTP erreicht, daher ist 443 dort ein gewöhnlicher Port und bleibt erhalten. aggrega registry add und aggrega config init --registry legen den Eintrag unter dem Host ab, den ihr Argument nennt, und lehnen einen nicht so geschriebenen ab. Der Host wird allein nach seiner Schreibweise beurteilt: Ob der Name aufgelöst wird oder dort eine Registry antwortet, wird nicht geprüft. Muster: ^(?:(?:(?:[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]))$.
namestringneinOptionaler sprechender Alias für diese Registry. Der Host ist die Identität; name ist ein bequemer Selektor, der überall, wo eine Registry genannt wird (zum Beispiel --registry oder default_registry), zum Host dieses Eintrags aufgelöst wird. Ein Alias muss über alle Einträge hinweg eindeutig sein.
trusted_identitiesTrustedIdentity[]neinOR-Menge von Keyless-Signieridentitäten, die für aus dieser Registry gepullte Artefakte akzeptiert werden. Eine Signatur besteht die Prüfung, wenn ihr Zertifikat zu irgendeinem Eintrag passt. Wird vom Keyless-Verifizierungspfad verwendet. Standardwert: []
trusted_deprecation_identitiesTrustedIdentity[]neinOR-Menge von Keyless-Identitäten, die zusätzlich akzeptiert werden, um eine rückwirkende Deprecation-Markierung für ein aus dieser Registry gepulltes Artefakt zu signieren. Eine Deprecation-Markierung wird berücksichtigt, wenn ihre Signatur zum Signierer des ursprünglichen Artefakts OR zu irgendeinem Eintrag hier passt — so kann ein Registry-Eigentümer oder ein Sicherheitsteam ein Artefakt zurückziehen, das der ursprüngliche Herausgeber nicht mehr erreichen kann, ohne dass ihm das Signieren der Artefakte selbst anvertraut wird. Wird nur vom Pfad zur Erkennung von Deprecations verwendet; er erweitert nie die Vertrauensmenge für Artefaktsignaturen. Standardwert: []
public_keystringneinGepinnter cosign-kompatibler öffentlicher Schlüssel für eine Registry im schlüsselbasierten Modus, inline als PEM-Block geschrieben: der Text von einer Zeile -----BEGIN PUBLIC KEY----- (oder -----BEGIN RSA PUBLIC KEY-----) bis zu ihrer passenden Zeile -----END, so wie aggrega registry add --key ihn aus einer Schlüsseldatei kopiert. Wenn gesetzt, werden Signaturen aus dieser Registry offline gegen diesen Schlüssel geprüft statt gegen Keyless-Identitäten. Ein Wert ohne eine Zeile -----BEGIN … PUBLIC KEY----- wird beim Laden der Konfigurationsdatei abgelehnt, wobei die Datei und der Eintrag genannt werden, und ebenso ein hier versehentlich eingefügter privater Schlüssel. Die Zeile darf an beliebiger Stelle im Wert stehen, weil der Schlüssel aus dem PEM-Block gelesen wird, den der Wert enthält, und jeder Text vor diesem Block ignoriert wird. Hier wird nur diese Zeile geprüft: Ob der Block einen dekodierbaren Schlüssel enthält, stellt sich heraus, wenn eine Signatur aus dieser Registry gegen ihn geprüft wird. Der Wert ist als sensibel deklariert (x-aggrega-sensitive), daher wird ein abgelehnter Wert — vor allem ein versehentlich gewählter privater Schlüssel — nie zitiert: Die Ablehnung nennt die Datei, den Eintrag und die Einschränkung, die der Wert nicht erfüllt hat — das obige Muster oder den Typ string — und zeigt <redacted> an der Stelle des Werts. Ein öffentlicher Schlüssel, der lädt, wird so gelesen und angezeigt, wie er geschrieben ist. Muster: -----BEGIN [A-Z ]*PUBLIC KEY-----.
trusted_rootstringneinOptionaler Pfad zu einem gepinnten Sigstore-Vertrauenswurzel-Bundle für Keyless-Verifizierung in netzwerkisolierten Umgebungen. Wenn gesetzt, wird der Keyless-Vertrauensanker ohne Netzwerk aus dieser Datei geladen; wenn leer, wird die Public-Good-Vertrauenswurzel abgerufen und zwischengespeichert.
advisorybooleschneinWenn true, wird ein Fehlschlag der Signaturprüfung für diese Registry zu einer Warnung herabgestuft, statt den Pull abzubrechen. Die Prüfung läuft dennoch, und der Fehlschlag wird gemeldet; der Pull wird fortgesetzt. Standardmäßig false. Standardwert: false
skip_signature_verificationbooleschneinNotfall- (Break-Glass-)Opt-out pro Host aus der Signaturprüfung — derselbe Schalter skip_signature_verification wie der globale, durch seine Platzierung auf diesen Host beschränkt. Er hebelt die Richtlinie signing.required auf oberster Ebene nicht aus: Eine von der Organisation verlangte Signatur wird auf diesem Host unabhängig von diesem Schalter weiterhin geprüft; nur der globale Schalter kann das abschalten. Ihn zusammen mit einem signing.required pro Registry auf demselben Host zu setzen ist zulässig und kombiniert eine beim Push verlangte Signatur mit einer beim Pull übersprungenen Prüfung: Auf der Prüfseite setzt sich das Überspringen durch, da eine pro Host festgelegte Haltung, die Signaturen verlangt (anders als die auf oberster Ebene), nicht immun gegen das Überspringen pro Host ist. Standardmäßig false. Standardwert: false
signingSigningConfigneinDer Signier-Block dieser Registry: die URLs der Keyless-Dienste, ein optionaler Schlüsselpfad für schlüsselbasiertes Signieren und die Vertrauenshaltung pro Host. Die Endpunktfelder überschreiben den globalen signing-Block für Pushes zu diesem Host; ein CLI-Flag überschreibt beide. required und kinds ergeben sich aus der Platzierung — unter einem Registry-Eintrag beschränken sie die eine Vertrauenshaltung auf diesen Host (das Veröffentlichen eines unsignierten Artefakts im Geltungsbereich wird abgelehnt, und das Verwenden eines unsignierten wird abgelehnt), dasselbe Konzept, das der signing-Block auf oberster Ebene für alle Registries trägt.

Zusätzliche Eigenschaften sind nicht zulässig.

SigningConfig

Ein Signier-Block: die URLs der Keyless-Dienste, ein optionaler Verweis auf eine Schlüsseldatei für schlüsselbasiertes Signieren und die Vertrauenshaltung (required und kinds). Auf oberster Ebene platziert, gilt er für alle Registries; unter einem registries[]-Eintrag platziert, gilt er für diesen Host — jedes Feld leitet seinen Geltungsbereich aus der Platzierung ab. required ist eine einzige Vertrauenshaltung, die beide Richtungen abdeckt (ein unsignierter Push im Geltungsbereich wird abgelehnt, und ein unsignierter Pull im Geltungsbereich wird abgelehnt). Sicherheit: Er enthält kein geheimes Material — das OIDC-Identitätstoken ist nie ein Konfigurationsfeld (kurzlebig, zur Laufzeit bereitgestellt), und key_path ist ein Pfad zu einer Schlüsseldatei, nie inline angegebene Schlüsselbytes. Das spiegelt die Asymmetrie der Verifizierungsseite: Dort ist ein inline angegebener public_key erlaubt, die Signierseite trägt dagegen nur einen Schlüsselpfad. Ein über HTTP erreichter aggrega mcp-Server zieht an keiner der beiden Platzierungen einen key_path heran, daher ist schlüsselbasiertes Signieren über einen solchen Listener nicht erreichbar: Ein Aufruf, den er beantwortet, signiert nur mit einem Identitätstoken, das dieser Aufruf mitbringt.

EigenschaftTypErforderlichBeschreibung
fulcio_urlstringneinURL der Fulcio-Zertifizierungsstelle für das Keyless-Signieren. Wenn nicht gesetzt, wird die Public-Good-Instanz von Fulcio verwendet. Sie wird als absolute https-URL geschrieben: https://, ein Host und optional ein Port und ein Pfad, ohne Leerzeichen — zum Beispiel https://fulcio.sigstore.dev. Ein Wert in jeder anderen Form, etwa einer ohne Schema (fulcio.example.com) oder einer, der mit http:// beginnt, wird beim Laden der Konfigurationsdatei abgelehnt, wobei die Datei und der Schlüssel genannt werden. Die Datei wird geprüft, bevor irgendetwas anderes darauf angewendet wird, daher unterliegt derselbe Endpunkt nicht dieser Form, wenn er über AGGREGA_SIGNING_FULCIO_URL, über das Flag --fulcio-url oder in einer Veröffentlichungsanfrage aus einem Editor oder einem Assistenten übergeben wird. Muster: ^https://[^\s/?#]+(?:[/?#]\S*)?$.
rekor_urlstringneinURL des Rekor-Transparency-Logs für das Keyless-Signieren. Wenn nicht gesetzt, wird die Public-Good-Instanz von Rekor verwendet. Sie wird als absolute https-URL geschrieben: https://, ein Host und optional ein Port und ein Pfad, ohne Leerzeichen — zum Beispiel https://rekor.sigstore.dev. Ein Wert in jeder anderen Form, etwa einer ohne Schema (rekor.example.com) oder einer, der mit http:// beginnt, wird beim Laden der Konfigurationsdatei abgelehnt, wobei die Datei und der Schlüssel genannt werden. Die Datei wird geprüft, bevor irgendetwas anderes darauf angewendet wird, daher unterliegt derselbe Endpunkt nicht dieser Form, wenn er über AGGREGA_SIGNING_REKOR_URL, über das Flag --rekor-url oder in einer Veröffentlichungsanfrage aus einem Editor oder einem Assistenten übergeben wird. Muster: ^https://[^\s/?#]+(?:[/?#]\S*)?$.
timestamp_urlstringneinURL der RFC3161-Zeitstempelstelle für das Keyless-Signieren. Sie hat keinen Standardwert: Wenn nicht gesetzt, wird keine Zeitstempelstelle kontaktiert, und die vertrauenswürdige Zeit einer Keyless-Signatur ergibt sich aus ihrem Eintrag im Transparency-Log. Sie wird als absolute https-URL geschrieben: https://, ein Host und optional ein Port und ein Pfad, ohne Leerzeichen — zum Beispiel https://tsa.example.com/api/v1/timestamp. Ein Wert in jeder anderen Form, etwa einer ohne Schema (tsa.example.com) oder einer, der mit http:// beginnt, wird beim Laden der Konfigurationsdatei abgelehnt, wobei die Datei und der Schlüssel genannt werden. Die Datei wird geprüft, bevor irgendetwas anderes darauf angewendet wird, daher unterliegt derselbe Endpunkt nicht dieser Form, wenn er über AGGREGA_SIGNING_TIMESTAMP_URL, über das Flag --timestamp-url oder in einer Veröffentlichungsanfrage aus einem Editor oder einem Assistenten übergeben wird. Muster: ^https://[^\s/?#]+(?:[/?#]\S*)?$.
key_pathstringneinPfad zu einer PEM-Datei mit einem eigenen privaten Schlüssel ECDSA P-256 für schlüsselbasiertes Offline-Signieren. Ein Pfad zu einer Datei, nie inline angegebenes Schlüsselmaterial. Wenn nicht gesetzt, wird der Keyless-Pfad verwendet. Ein über HTTP erreichter aggrega mcp-Server zieht diesen Schlüssel nie heran, wo immer er gesetzt ist — im signing-Block auf oberster Ebene, in dem eines Registry-Eintrags oder über AGGREGA_SIGNING_KEY_PATH: Ein Aufruf, den ein solcher Listener beantwortet, signiert nur mit einem Identitätstoken, das der Aufruf selbst mitbringt, oder wird abgelehnt. Ein über Standardeingabe und Standardausgabe erreichter Server signiert damit, wie es ein Terminal tut.
requiredbooleschneinDie eine Vertrauenshaltung für den Geltungsbereich dieses Blocks: Wenn true, erfordert das Veröffentlichen einer Artefaktart im Geltungsbereich eine Signatur (ein unsignierter Push im Geltungsbereich wird abgelehnt), und das Verwenden einer solchen erfordert eine Signatur (ein unsignierter Pull im Geltungsbereich wird abgelehnt). Der Geltungsbereich ergibt sich aus der Platzierung — auf dem signing-Block auf oberster Ebene umfasst er jede Registry; unter dem signing-Block eines registries[]-Eintrags umfasst er diesen einen Host. Ein Name, eine Aufgabe, beide Geltungsbereiche. Die Richtlinie auf oberster Ebene setzt sich monoton über die Kaskade der Konfigurationen zusammen — jede Ebene, die sie auf true setzt, macht sie effektiv true, und keine Ebene mit niedrigerem Vorrang kann sie wieder ausschalten —, sodass sie nicht durch eine gewöhnliche Konfigurationsänderung entfernt werden kann. Standardmäßig false. Standardwert: false
kindsstring[]neinBeschränkt required auf bestimmte Artefaktarten. Leer oder ein einzelner Eintrag all bedeutet jede signierbare Art; andernfalls gilt die Haltung genau für die aufgeführten Arten, passend zum kind:-Wert der Entität (z. B. Component, Feature, Recipe, FeatureRecipe, SchemaLibrary, MappingLibrary, Aggregate, Plugin). Auf dem signing-Block auf oberster Ebene setzt sie sich als Vereinigung über die Kaskade zusammen — eine Ebene kann den Geltungsbereich erweitern, aber nie verkleinern. Der Geltungsbereich ergibt sich aus der Platzierung, wie bei required. Standardwert: []

Zusätzliche Eigenschaften sind nicht zulässig.

TrustedIdentity

Eine akzeptable Keyless-Signieridentität: ein Zertifikatssubjekt (die OIDC-Identität), gepaart mit dem OIDC-Aussteller, der für sie gebürgt hat.

EigenschaftTypErforderlichBeschreibung
identitystringneinExakter alternativer Subjektname des Zertifikats — die OIDC-Identität, die in das kurzlebige Signierzertifikat eingebunden ist (z. B. die E-Mail-Adresse eines Maintainers oder die URI eines CI-Workflows).
identity_regexpstringneinRegulärer Ausdruck, der mit dem Zertifikatssubjekt abgeglichen und anstelle einer exakten identity verwendet wird (z. B. um jeden Workflow unter einer Organisation zu akzeptieren).
issuerstringjaURL des OIDC-Ausstellers, der das Identitätstoken ausgestellt hat (z. B. https://accounts.google.com oder https://token.actions.githubusercontent.com).

Zusätzliche Eigenschaften sind nicht zulässig.

PluginRef

Referenz auf ein Wasm-Plugin, das an einem Socket angebunden ist, dessen Einstiegsfunktion die Anbindung nennen darf — die Listen governance und linter. Die Sockets, deren Einstiegspunkt fest ist, verwenden stattdessen FixedEntryPluginRef, das dieselben Felder ohne function trägt. uri und capability wählen gemeinsam das Plugin: Nur uri ist eine direkte Anbindung (das Plugin mit dieser Identität wird unverändert angebunden — der Weg der übergreifenden Sockets, da deren Plugins keine bedienten Fähigkeiten deklarieren); nur capability löst das Plugin auf, das diese Fähigkeit bedient (den bloßen Namen der Fähigkeit, den ein Recipe über spec.capability bindet, z. B. helm); beide zusammen disambiguieren — capability nennt, was aufzulösen ist, und uri wählt anhand der bloßen Identität dieses Plugins, welches Plugin welches Herausgebers sie bedient, in einem föderierten Katalog, in dem mehr als ein Plugin die Fähigkeit bedient. function überschreibt die Standard-Einstiegsfunktion des Sockets; wenn es weggelassen wird, gilt der dokumentierte Standard des Sockets — bei einem Governance-Eintrag ergibt sich dieser Standard aus role. role nennt die Governance-Anbindungsrolle und wird nur bei einem Governance-Eintrag gelesen. with trägt optionale Eingaben zum Zeitpunkt der Anbindung, die das Plugin liest.

EigenschaftTypErforderlichBeschreibung
uristringneinPlugin-Bezeichner: die bloße Identität einer Plugin-Entität — der Pfad <pluginType>/<name>, z. B. governance/redact oder provider/helm —, ein lokaler Dateisystempfad oder ein Registry-Alias. Optional: Ein Eintrag kann das Plugin stattdessen über capability wählen. Ein optionales nachgestelltes :version pinnt die Version in denselben drei Formen wie jeder Versions-Pin (bloß, exakt :1.0.0 oder mit der Hauptversion kompatibler Bereich :^1.0.0).
rolestring (enum)neinDie Pipeline-Rolle, an die eine Governance-Anbindung gebunden ist, nur bei einem governance-Eintrag gelesen: annotation-transform fügt vor der Annotationserweiterung Annotationen in aufgelöste Komponenten ein, sodass gebundene Injektionen zu Feature-Anbindungen werden; label-transform vergibt beim Aufbau der Topologie automatisch Labels an die Knoten des Topologiegraphen; ir-verdict fällt bei der statischen Analyse ein Urteil über Annahme oder Ablehnung über den IR-Graphen; render-verdict fällt beim Rendern ein Urteil über die gerenderten Artefakte. Die Rolle — nicht die deklarierte Art des Plugins — legt fest, was das Plugin ausgeben darf: Die Ausgabe einer Urteilsrolle kann nur als Urteil gelesen, nie als Änderung angewendet werden; die Ausgabe einer Transformationsrolle wird vom Host auf ihre Facette (Annotationen oder Labels) beschränkt. Sie wählt außerdem die Standard-Einstiegsfunktion (annotation-transform → transform_annotations; label-transform → mutate; ir-verdict → verdict_ir; render-verdict → verdict_render). Zulässige Werte: "annotation-transform", "label-transform", "ir-verdict", "render-verdict"
capabilitystringneinDie Provider-Fähigkeit, für die dieser Eintrag ein Plugin wählt — der bloße Name der Fähigkeit, den ein Recipe über spec.capability bindet (z. B. helm, compose). Optional: Ein Eintrag kann stattdessen ein Plugin direkt über uri anbinden. Die Provider-Bindungen verwenden dies, um zu wählen, welches Plugin welches Herausgebers eine Fähigkeit in einem föderierten Katalog bedient; die übergreifenden Sockets lassen es leer und binden über uri an.
functionstringneinOptionale Überschreibung der Standard-Einstiegsfunktion des Sockets. Wenn weggelassen, gilt der dokumentierte Standard des Sockets (Governance annotation-transform → transform_annotations, Governance label-transform → mutate, Governance ir-verdict → verdict_ir, Governance render-verdict → verdict_render, Linter → lint_rules). Die Überschreibung darf jeden Export nennen, den das Plugin deklariert, und der genannte Export muss die Ausgabeform zurückgeben, die dieser Socket liest: Der Build bricht ab, wenn diese Ausgabe ein Feld auf oberster Ebene trägt, das die Form nicht deklariert, und nennt dabei den aufgerufenen Export und das unerwartete Feld. Die Prüfung liest, welche Feldnamen auf oberster Ebene vorhanden sind, nicht welche fehlen oder was darunter verschachtelt ist, daher ist sie keine vollständige Validierung der Ausgabe.
withPluginRefWithneinOptionale Eingaben zum Zeitpunkt der Anbindung, die das Plugin liest. Beide Mitglieder sind optional und agnostisch gegenüber dem Socket, sodass jeder Socket diese Oberfläche wiederverwenden kann.

Zusätzliche Eigenschaften sind nicht zulässig.

FixedEntryPluginRef

Referenz auf ein Wasm-Plugin, das an einem Socket angebunden ist, dessen Einstiegspunkt fest ist, statt von der Anbindung genannt zu werden — die Liste importer und die Bindungen providers. Sie trägt dieselben Felder wie PluginRef ohne function: Der Importer-Socket ruft die eine Einstiegsfunktion auf, die sein Socket-Vertrag nennt, und ein Provider steuert eine feste Menge nach Phasen geschlüsselter Exporte statt eines einzigen wählbaren Einstiegs, daher gibt es auf keiner der beiden Listen einen Einstieg, den function nennen könnte, und der Schlüssel wird dort nicht akzeptiert. uri und capability wählen gemeinsam das Plugin: Nur uri ist eine direkte Anbindung (das Plugin mit dieser Identität wird unverändert angebunden — der Weg des Importer-Sockets, da dessen Plugins keine bedienten Fähigkeiten deklarieren); nur capability löst das Plugin auf, das diese Fähigkeit bedient (den bloßen Namen der Fähigkeit, den ein Recipe über spec.capability bindet, z. B. helm); beide zusammen disambiguieren — capability nennt, was aufzulösen ist, und uri wählt anhand der bloßen Identität dieses Plugins, welches Plugin welches Herausgebers sie bedient, in einem föderierten Katalog, in dem mehr als ein Plugin die Fähigkeit bedient. role wird hier akzeptiert, aber auf keiner der beiden Listen gelesen, die diese Form bedient: Die Governance-Anbindungsrolle, die es nennt, wird bei einem governance-Eintrag gelesen, der PluginRef verwendet, daher hat eine bei einem dieser Einträge gesetzte Rolle keine Wirkung. with trägt optionale Eingaben zum Zeitpunkt der Anbindung, die das Plugin liest; eine Provider-Bindung bezieht ihre Render-Konfiguration stattdessen aus dem Recipe, daher wird with: bei einer solchen beim Laden abgelehnt.

EigenschaftTypErforderlichBeschreibung
uristringneinPlugin-Bezeichner: die bloße Identität einer Plugin-Entität — der Pfad <pluginType>/<name>, z. B. governance/redact oder provider/helm —, ein lokaler Dateisystempfad oder ein Registry-Alias. Optional: Ein Eintrag kann das Plugin stattdessen über capability wählen. Ein optionales nachgestelltes :version pinnt die Version in denselben drei Formen wie jeder Versions-Pin (bloß, exakt :1.0.0 oder mit der Hauptversion kompatibler Bereich :^1.0.0).
rolestring (enum)neinDie Governance-Anbindungsrolle. Keine der beiden Listen, die diese Form verwenden, liest sie — die Rolle wird bei einem governance-Eintrag gelesen, und diese Einträge verwenden PluginRef —, daher wird eine hier gesetzte Rolle akzeptiert und hat keine Wirkung. Die erlaubten Werte sind die vier Governance-Rollen, und was jede bedeutet, ist bei PluginRef beschrieben. Zulässige Werte: "annotation-transform", "label-transform", "ir-verdict", "render-verdict"
capabilitystringneinDie Provider-Fähigkeit, für die dieser Eintrag ein Plugin wählt — der bloße Name der Fähigkeit, den ein Recipe über spec.capability bindet (z. B. helm, compose). Optional: Ein Eintrag kann stattdessen ein Plugin direkt über uri anbinden. Die Provider-Bindungen verwenden dies, um zu wählen, welches Plugin welches Herausgebers eine Fähigkeit in einem föderierten Katalog bedient; die übergreifenden Sockets lassen es leer und binden über uri an.
withPluginRefWithneinOptionale Eingaben zum Zeitpunkt der Anbindung, die das Plugin liest. Beide Mitglieder sind optional und agnostisch gegenüber dem Socket, sodass jeder Socket diese Oberfläche wiederverwenden kann.

Zusätzliche Eigenschaften sind nicht zulässig.

CLIPluginRef

Ein gepinntes CLI-Erweiterungs-Plugin, das als aggrega-Befehl auf oberster Ebene installiert ist: die aufgelöste, auf eine Version gepinnte Artefaktreferenz, die der Befehl auflöst und ausführt, und der Inhalts-Digest der Guest-Bytes, zu denen diese Referenz bei der Installation aufgelöst wurde. Zusammen pinnen sie genau, welche Bytes der Befehl ausführt; der Digest ist außerdem der Schlüssel des Describe-Caches, der die Namen und die Hilfe des Befehls liefert, ohne den Guest zu laden.

EigenschaftTypErforderlichBeschreibung
uristringjaDie aufgelöste, auf eine Version gepinnte Artefaktreferenz, die der Befehl auflöst und ausführt, z. B. oci://hub.aggrega.ai/plugin/cli/<name>:1.2.0, bei der Installation gepinnt.
digeststringjaDer Inhalts-Digest der .wasm-Bytes des Guests, zu denen die Referenz bei der Installation aufgelöst wurde, geschrieben als sha256:, gefolgt von den 64 kleingeschriebenen Hexadezimalziffern des SHA-256 der Bytes — die Schreibweise, die aggrega plugin add cli verzeichnet, und die Schreibweise, in der die aufgelösten Bytes verglichen werden. Ein Digest in jeder anderen Schreibweise — bloßes Hexadezimal ohne das Präfix sha256:, Großbuchstaben oder eine andere Länge — könnte ihm nie gleich sein, daher wird er beim Laden der Konfigurationsdatei abgelehnt, wobei die Datei und der Eintrag genannt werden. Er pinnt genau die Bytes, die der Befehl ausführt — eine spätere Auflösung, deren Bytes einen anderen Hash ergeben, bricht den Befehl ab — und ist der Schlüssel in den Describe-Cache, der die Hilfe des Befehls erzeugt, ohne den Guest zu laden. Muster: ^sha256:[0-9a-f]{64}$.

Zusätzliche Eigenschaften sind nicht zulässig.

PluginRefWith

Optionale Eingaben zum Zeitpunkt der Anbindung, die ein Plugin liest. Beide Mitglieder sind optional, und die Oberfläche ist allgemein, sodass jeder Socket sie wiederverwenden kann.

EigenschaftTypErforderlichBeschreibung
sourcesstring[]neinPfade zu Definitionsdateien, die der Host zur Kompilierzeit liest und an das Plugin übergibt. Jeder Eintrag ist ein Dateisystempfad, der relativ zum Verzeichnis der deklarierenden Konfigurationsdatei aufgelöst wird.
settingsobjectneinFrei geformtes Einstellungsobjekt, das unverändert an das Plugin übergeben wird. Der Host interpretiert seine Form nicht; das Plugin definiert die Schlüssel, die es liest.

Zusätzliche Eigenschaften sind nicht zulässig.