Übersicht der Entitätsreferenz
Das Authoring-Vokabular von Aggrega umfasst Aggregate, Component, Feature, Recipe, FeatureRecipe, Plugin, Manifest, Release, SchemaLibrary, MappingLibrary, WorkloadLibrary und ArtifactLibrary — dazu die plattformeigene Art Workload, die in die synthetisierte Eingabe einer Recipe eingebettet ist. Jede Entität ist ein YAML-Dokument, das einem JSON Schema entspricht; jedes Feld, jedes Schlüsselwort und jede entitätsübergreifende Referenz, die diese Referenz beschreibt, ist Teil dieses Authoring-Vertrags.
Diese Kapitelgruppe behandelt die Authoring-Oberfläche: welche Felder jede Entität akzeptiert, was jedes Feld für den Autor bedeutet und wie Felder entitätsübergreifend zusammenwirken (das implements: einer Recipe, das die Component nennt, die sie implementiert, der manifest:-Zeiger eines Release auf ein Manifest, containers.<name>.attachments einer Workload, das auf im featuresSchema der Component deklarierte Slots verweist). Die konzeptionelle Rolle jeder Entität — warum die Taxonomie die Form hat, die sie hat, welche Domäne welche Entität besitzt, wie die vier Domänen die Authoring-Belange trennen — wird in ../architecture/04-entity-taxonomy.md beschrieben. Die architektonische Rolle der Art Workload als eine der drei Eingabearten einer Recipe wird in ../architecture/16-recipe-input-composition.md beschrieben.
Wie diese Referenz aufgebaut ist
Zwei Oberflächen dokumentieren das Authoring-Vokabular, und sie beantworten unterschiedliche Fragen.
Jede oben aufgeführte Art hat eine generierte Schema-Referenz. Diese Seiten werden aus den Schemas generiert, die der Compiler selbst veröffentlicht, und schema/README.md indiziert die vollständige Menge — Entitätsarten, Wire-Formen von Plugins und Workspace-Dateien gleichermaßen. Greifen Sie zur Schema-Referenz, um die Frage „Was darf dieses Dokument enthalten?“ zu beantworten: jedes Feld, seinen Typ, ob es erforderlich ist, und die Einschränkungen, die der Envelope durchsetzt.
Die folgenden Seiten sind die Authoring-Leitfäden. Sie sind von Hand geschrieben, um zu vermitteln, was das Schema nicht kann: wofür eine Art gedacht ist, wie ihre Felder mit anderen Arten zusammenwirken, welche Authoring-Form zu welcher Situation passt und welche Konventionen der Katalog der Standardbibliothek befolgt. Greifen Sie zu einem Authoring-Leitfaden, um die Frage „Wie schreibe ich eines, und warum hat es diese Form?“ zu beantworten.
Referenz nach Entität
- Aggregate — das deklarative Absichtsartefakt des Entwicklers. Deklariert Komponenten, ihre Topologie über
uses, Parameterverträge für umgebungsspezifische Variation und Feature-Anbindungen. - Component — vom Platform Architect verfasste Katalogentität, die eine wiederverwendbare Komponentenart definiert. Deklariert ihre
values- undinfra-Schemas (jeweils eine JSON-Schema-2020-12-Deklaration in Kompakt- oder Vollform), ihrenprovides-Ausgabevertrag, ihrenusesSchema-Vertrag für eingehende Kanten und Slots für Anmeldedaten überfeaturesSchema. - Feature — vom Platform Architect verfasste Katalogentität für einen querschnittlichen Belang (Monitoring-Sidecar, Datenmaskierung, Routing-Richtlinie). Deklariert seine
values- undinfra-Schemas (jeweils eine JSON-Schema-2020-12-Deklaration),appliesTo-Anbindungsselektoren und Interoperabilitätseinschränkungen. - Recipe — von Ops verfasste Übersetzung einer Component für einen bestimmten Provider. Setzt drei Eingabearten zusammen (
source:+valuesMapping:,workload:,artifacts:— jede akzeptiert Inline-Inhalt oder$import:gemäß dem einheitlichen Dateiimport-Vokabular) sowie einenprovides-Block, der den Vertrag zur Injektion beim Aufrufer bildet. - FeatureRecipe — von Ops verfasste Übersetzung eines Feature für einen bestimmten Provider. Verwendet denselben Vertrag mit drei Eingabearten wie die Recipe, dazu ein
injectMapping, das die Inject-Pipe für das aufruferseitige Umschreiben von Variablen abfängt. - Plugin — inhaltsadressiertes WebAssembly-Plugin. Deklariert den einen Socket-Typ, den es implementiert —
provider,linter,pipeline-step,governance,cli,parseroderimporter—, seine ABI-Version und die Fähigkeiten, die dieser Socket-Typ bedient. Ein Provider-Rendering-Plugin (pluginType: provider) deklariert den oder die Provider-Namen, die es bedient, inspec.provider.capabilitiesund trägt seine Provider-Socket-Metadaten —workloadSchemaundwellKnownAnnotations— in demselbenspec.provider-Block. - Manifest — projektbezogene Mapping-Tabelle. Bindet abstrakte Component- und Feature-Typen an konkrete Recipe- und FeatureRecipe-URIs, unter
componentsundfeatures, mit der Suchreihenfolgename> versioniertertype> unversioniertertype. - Release — umgebungsspezifischer Bereitstellungsrouter. Bindet ein Aggregate an ein Manifest, ordnet Komponenten physischen Grenzen zu, liefert umgebungsspezifische Parameterwerte und bindet von Ops verwaltete Features an.
Bibliotheksentitäten
Die vier Bibliotheksarten gehören zu Stufe 3 — optionale Entitäten zur Wiederverwendung. Ein Katalog deklariert eine davon, wenn derselbe Inhalt in seinen Entitäten wiederkehrt, und kommt andernfalls ohne sie aus. Jede enthält eine Inhaltsart, und das Fragment in einer Referenz (#/schemas/, #/mappings/, #/workloads/, #/artifacts/) gibt an, welche Bibliothek eine Referenz adressiert.
- SchemaLibrary — wiederverwendbare JSON-Schema-2020-12-Definitionen sowie optionale parametrisierte Helfer, die aus den Schemas einer Component oder eines Feature über
$ref: <Library>#/schemas/<name>referenziert werden. - MappingLibrary — wiederverwendbare Go-Template-Fragmente, die über
$import: <Library>#/mappings/<name>in dasvaluesMapping:einer Recipe oder eines FeatureRecipe importiert werden. - WorkloadLibrary — wiederverwendbarer Workload-Inhalt, der über
$import: <Library>#/workloads/<name>in dasworkload:einer Recipe oder eines FeatureRecipe importiert wird. - ArtifactLibrary — wiederverwendbare Bündel von Hilfsausgabedateien, die über
$import: <Library>#/artifacts/<name>in dieartifacts:einer Recipe oder eines FeatureRecipe importiert werden. Ein Bündel ist die Einheit der Wiederverwendung: Ein Import wird zu einer Ausgabe pro Datei im Bündel erweitert.
Plattformeigene Arten
- Workload — plattformeigene Compiler-Art (keine vom Benutzer verfasste Katalogentität). Eingebettet in das Feld
workload:einer Recipe (inline oder über$import:); beschreibt die Bereitstellungsform, die der Provider zu providernativen Manifesten synthetisiert.