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

Aggrega-Schema für die Workload

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

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

Plattformeigene abstrakte Spezifikation einer Arbeitslast. Ein Recipe im synthetisierten Modus deklariert genau eine Workload über das Schlüsselwort workload: (inline als Block-Skalar oder workload: { $import: } gemäß dem einheitlichen Vokabular für Dateiimporte). Der Ziel-Provider übersetzt die Workload in providernative Manifeste (K8s Deployment/StatefulSet/Services/PVCs für helm; compose-Services + Volumes + Netzwerke für compose; usw.). Eine Workload trägt keine eigenen Metadaten — keinen Namen, keine Labels, keine Annotationen. Identität und Labels stammen von der Komponenteninstanz, die sie deklariert: Der Ziel-Provider leitet den Namen jeder gerenderten Ressource von dieser Instanz ab und stempelt die Herkunftsschlüssel aggrega.ai/* für diesen Knoten auf die Ressource. Die Art Workload ist KEINE Katalogentität — diese veröffentlichte Datei ist das kanonische JSON Schema der Workload, und der Compiler validiert eine Workload dagegen.

Siehe die Authoring-Referenz zur Workload für Anleitungen in Prosaform zum Verfassen von Workload-Entitäten; diese Seite dokumentiert das strukturelle Schema, das diese Referenz beschreibt.

Typ der obersten Ebene: object

Eigenschaften

EigenschaftTypErforderlichBeschreibung
apiVersionconst “aggrega.ai/v1beta1”jaKonstante: "aggrega.ai/v1beta1"
kindconst “Workload”jaKonstante: "Workload"
formstring (enum)neinAbstrakte Absicht zur Controller-Form der Arbeitslast. Wählt die Art des Laufzeit-Lebenszyklus, den die Arbeitslast hat, unabhängig von jeder Zielplattform: stateless (austauschbare, lang laufende Replikate), stateful (Replikate mit stabiler Identität und eigenem Speicher pro Replikat), daemon (eine Instanz pro geeignetem Host), scheduled (wiederkehrende, zeitgesteuerte Ausführungen), task (eine einzelne Ausführung bis zum Abschluss), reference (ein externer Endpunkt ohne Rechenressourcen — kein Controller; helm erzeugt einen ExternalName-Service, compose trägt den Endpunkt über den Injektionsvertrag weiter). Ein leerer Wert wird als stateless behandelt. Jeder Ziel-Provider bildet die Form auf seine eigene native Gestalt ab; die Form selbst trägt keine plattformnativen Ressourcenarten. Ein persistentTemplate-Volume ist ein Begleiter von stateful und nur auf einer stateful-Arbeitslast gültig. Eine reference-Arbeitslast deklariert endpoint (und optional port) und keine Container und trägt kein eigenes Feld für Zugangsdaten, weil der Name der Umgebungsvariablen dem Konsumenten gehört und nicht dem Endpunkt. Ein Konsument, der für den Endpunkt Zugangsdaten benötigt, deklariert den Slot im featuresSchema seiner eigenen Component und füllt ihn aus dem attachments-Block seines Containers, wo die inject-Liste dieses Slots die Zustellung erlaubt. Zulässige Werte: "stateless", "stateful", "daemon", "scheduled", "task", "reference" Standardwert: "stateless"
endpointstringneinExterner Endpunkt für form: reference — ein Host oder eine URL. Der Compiler reicht ihn als deterministischen Zeiger-String durch; er wird zur Kompilierzeit nie aufgelöst (AOT). Erforderlich, wenn form reference ist, und nur dann von Bedeutung. helm erzeugt ihn als externalName eines ExternalName-Service (den Host-Teil); compose trägt ihn über die provides des Rezepts zu den Konsumenten.
portintegerneinOptionaler Port für den reference-Endpunkt (form: reference). helm erzeugt ihn als Port am ExternalName-Service. Minimum: 1. Maximum: 65535.
schedulestringneinCron-Zeitplan für form: scheduled — ein standardmäßiger crontab-Ausdruck mit 5 Feldern (zum Beispiel ‘0 0 * * *’) oder eines der Makros @hourly, @daily, @weekly, @monthly, @yearly. Erforderlich, wenn form scheduled ist, und nur dann von Bedeutung; der Ziel-Provider reicht ihn unverändert in das Feld schedule der geplanten Ressource durch.
suspendbooleschneinHält den wiederkehrenden Zeitplan einer Arbeitslast mit form: scheduled an. Bei true wird die geplante Ressource mit ihrem Zeitplan gerendert, aber aus diesem Zeitplan startet keine Ausführung, bis er fortgesetzt wird; eine Ausführung kann weiterhin von Hand aus der Ressource erstellt werden — auf Kubernetes mit kubectl create job —from=cronjob/. suspend: false rendert genau wie ein fehlendes suspend. Nur mit form: scheduled von Bedeutung. helm erzeugt es als spec.suspend des CronJob. compose hat keine geplante Form und bricht bei einer Arbeitslast mit form: scheduled ab, ob sie angehalten ist oder nicht. Standardwert: false
replicasintegerneinAnzahl der Replikate. Standardwert 1. Auf einem compose-Ziel erreicht der Wert keinen Teil der Ausgabe, und eine Warnung meldet ihn, wann immer er verfasst ist — auch ein explizites 1. Minimum: 0. Standardwert: 1
initContainerscontainer[]neinGeordnete Liste von Containern, die bis zum Abschluss laufen, bevor die Haupt-Container starten.
containersMap von containerneinGeordnete Map von Containername → Container-Spezifikation. Mindestens ein Eintrag ist erforderlich. Die Reihenfolge des Autors bleibt erhalten. Mindestens 1 Eintrag.
volumesMap von volumeneinGeordnete Map von Volume-Name → Volume-Spezifikation. Jede Volume-Spezifikation deklariert genau eines von: ephemeral, configmap, secret, persistent, persistentTemplate.
servicesMap von serviceneinGeordnete Map von Service-Name → Service-Spezifikation. Auf helm wird jeder Eintrag zu einem separaten K8s-Service, und ein Eintrag, dessen type Loopback ist, bricht den Build ab. Auf compose gibt es kein separates Service-Primitiv, daher werden Einträge nicht eins zu eins abgebildet: Ein Eintrag, dessen type NodePort oder LoadBalancer ist, veröffentlicht seine Ports auf jeder Host-Schnittstelle des eigenen compose-Service der Arbeitslast, ein Eintrag, dessen type Loopback ist, veröffentlicht seine Ports dort nur auf der Loopback-Adresse des Hosts, ein Eintrag, dessen type ClusterIP oder Headless ist, veröffentlicht nichts, und jeder veröffentlichte Port wird in der Portliste dieses einen Service gesammelt, wobei der Host-Port dem Container-Port entspricht. Auf helm heißt jeder Service <name>-<key>: der Name, den das eigene Deployment (oder ein anderer Controller) der Arbeitslast trägt, dann ein Bindestrich und der Schlüssel des Eintrags, sodass eine Workload, die services.http deklariert und deren Deployment api-server heißt, einen Service namens api-server-http rendert. Auf compose benennt ein Schlüssel nichts in der Ausgabe.
schedulingobjectneinK8s-native Scheduling-Einschränkungen. Für helm direkt übersetzt. Auf einem compose-Ziel erreichen diese Einschränkungen keinen Teil der Ausgabe, und eine Warnung meldet den Block, wenn er verfasst ist.
podSecurityContextobjectnein
serviceAccountstringneinName des ServiceAccount, unter dem diese Arbeitslast läuft. Das eigentliche RBAC (ServiceAccount/Role/RoleBinding-Ressourcen) sollte über Features oder Artefakte erzeugt werden, nicht über dieses Feld.
imagePullSecretsstring[]neinNamen von Image-Pull-Secrets zum Abrufen von Images aus privaten Registries. helm erzeugt pod.imagePullSecrets. compose hat kein Gegenstück in der Datei — die Registry-Authentifizierung wird separat über docker login konfiguriert — und lässt es weg.
priorityClassNamestringneinName der PriorityClass, die die Scheduling-Priorität dieser Arbeitslast bestimmt. helm erzeugt pod.priorityClassName. compose hat kein Gegenstück für eine Scheduling-Priorität auf einem einzelnen Host und lässt es weg.
runtimeClassNamestringneinName der RuntimeClass, die die Container-Runtime auswählt, unter der diese Arbeitslast läuft (zum Beispiel eine GPU-fähige Runtime wie ‘nvidia’). Der Compiler reicht den Namen unverändert durch; der Cluster löst ihn zum Scheduling-Zeitpunkt zu einer konfigurierten RuntimeClass auf. helm erzeugt pod.runtimeClassName. compose hat kein Gegenstück für eine Runtime-Klasse und lässt es weg. Nur für Rechenressourcen: auf einer reference-Arbeitslast nicht zulässig.
terminationGracePeriodSecondsintegerneinSekunden zwischen SIGTERM und SIGKILL beim Herunterfahren. helm erzeugt pod.terminationGracePeriodSeconds; compose erzeugt stop_grace_period. Minimum: 0.
dnsPolicystring (enum)neinDNS-Richtlinie des Pods. helm erzeugt pod.dnsPolicy. compose hat kein Gegenstück für eine DNS-Richtlinie und lässt sie weg (compose bildet stattdessen nameservers/searches von dnsConfig direkt ab). Zulässige Werte: "Default", "ClusterFirst", "ClusterFirstWithHostNet", "None"
dnsConfigobjectneinBenutzerdefinierte DNS-Konfiguration des Pods. helm erzeugt pod.dnsConfig. compose bildet nameservers auf dns und searches auf dns_search ab; options haben in compose kein Gegenstück und werden dort weggelassen.
hostAliasesobject[]neinStatische Zuordnungen von Hostname zu IP, die in die hosts-Datei des Pods eingefügt werden. helm erzeugt pod.hostAliases; compose erzeugt extra_hosts (ein Eintrag hostname:ip pro Hostname).
hostNetworkbooleschneinFührt die Arbeitslast im eigenen Netzwerk-Namespace des Host-Knotens statt in einem isolierten aus. Die Ports, die die Arbeitslast öffnet, sind dann über die eigenen Adressen des Knotens erreichbar, und die Arbeitslast sieht die Netzwerkschnittstellen des Knotens. Damit wird ein Netzwerk-Namespace gewählt und sonst nichts: Es werden keine Ports deklariert, und jeder Port, den die Arbeitslast öffnet, wird weiterhin unter containers..ports deklariert. helm erzeugt pod.hostNetwork. compose erzeugt network_mode: host auf dem eigenen Service der Arbeitslast; ein compose-Service in diesem Modus ist nicht an das Boundary-Netzwerk angeschlossen, daher erreichen ihn seine Peers über die Adressen des Knotens statt über den Service-Namen, und der Service jedes Init-Containers tritt dem Boundary-Netzwerk eigenständig bei. Nur für Rechenressourcen: auf einer reference-Arbeitslast nicht zulässig.

Zusätzliche Eigenschaften sind nicht zulässig.

workload.scheduling

K8s-native Scheduling-Einschränkungen. Für helm direkt übersetzt. Auf einem compose-Ziel erreichen diese Einschränkungen keinen Teil der Ausgabe, und eine Warnung meldet den Block, wenn er verfasst ist.

EigenschaftTypErforderlichBeschreibung
nodeSelectorMap von stringnein
affinityobjectnein
tolerationsobject[]nein
topologySpreadConstraintsobject[]nein

Zusätzliche Eigenschaften sind nicht zulässig.

workload.podSecurityContext

EigenschaftTypErforderlichBeschreibung
runAsUserintegernein
runAsGroupintegernein
fsGroupintegernein
supplementalGroupsinteger[]nein

Zusätzliche Eigenschaften sind nicht zulässig.

workload.dnsConfig

Benutzerdefinierte DNS-Konfiguration des Pods. helm erzeugt pod.dnsConfig. compose bildet nameservers auf dns und searches auf dns_search ab; options haben in compose kein Gegenstück und werden dort weggelassen.

EigenschaftTypErforderlichBeschreibung
nameserversstring[]nein
searchesstring[]nein
optionsobject[]nein

Zusätzliche Eigenschaften sind nicht zulässig.

workload.hostAliases[]

EigenschaftTypErforderlichBeschreibung
ipstringja
hostnamesstring[]ja

Zusätzliche Eigenschaften sind nicht zulässig.

Definitionen

container

EigenschaftTypErforderlichBeschreibung
namestringneinOptionaler Containername. Bei einem positionalen initContainers-Eintrag legt er den Namen des erzeugten Containers fest und fällt, wenn er weggelassen wird, auf einen generierten Namen init- (die Position des Eintrags in der Liste) zurück. Bei einem Eintrag der Map containers ist der Map-Schlüssel der Containername, und dieses Feld wird ignoriert.
imagestringjaReferenz auf das Container-Image (z. B. ‘nginx:1.27-alpine’, ‘ghcr.io/example/app:v1.2.3’).
imagePullPolicystring (enum)neinImage-Pull-Richtlinie. helm erzeugt sie als container.imagePullPolicy. compose bildet sie auf das pull_policy des Service ab (Always auf always, Never auf never, IfNotPresent auf if_not_present). Zulässige Werte: "Always", "Never", "IfNotPresent"
commandstring[]neinÜberschreibt den Entrypoint des Images. K8s: .command. Compose: entrypoint.
argsstring[]neinArgumente, die an command übergeben werden (oder an den Entrypoint des Images, wenn command fehlt). K8s: .args. Compose: command.
variablesMap von stringneinUmgebungsvariablen als String-Schlüssel-Wert-Paare. K8s: spec.template.spec.containers[].env[]. Compose: services..environment.
attachmentsMap von containerAttachmentneinGeordnete Map von Env- oder Dateiname → { from, as, key?, path?, connection? }. Jeder Eintrag referenziert einen Slot, der im featuresSchema der Component deklariert ist — oder, wenn der Eintrag eine Verbindung nennt, einen Slot, den der Socket dieser Verbindung deklariert —, und liefert, was die Anbindung, die diesen Slot füllt, veröffentlicht hat. Das Feld ‘as’ wählt den Zustellmechanismus, der in der Allowlist des Arrays inject: des Slots stehen muss. Blackbox-Slots (inject: []) DÜRFEN hier NICHT erscheinen.
envFromobject[]neinGesammelte Umgebung, importiert aus einer ConfigMap- oder Secret-Quelle. helm erzeugt container.envFrom (configMapRef/secretRef). compose hat kein env-from-object-Primitiv — eine Quellreferenz ist keine Host-Datei, daher würde eine Umdeutung als env_file stillschweigend die Bedeutung ändern; eine Arbeitslast, die envFrom deklariert, bricht auf einem compose-Ziel mit einer deutlichen Fehlermeldung ab.
portsMap von integer oder objectneinBenannte Container-Ports. Ein Port wird entweder als bloße Portnummer verfasst (web: 8080) oder als Objekt, das die Nummer zusammen mit dem Transportprotokoll trägt, das der Port führt (dns: { port: 53, protocol: UDP }); wo kein Protokoll deklariert ist, bedeuten beide Formen dasselbe. Die zulässigen Protokollwerte sind TCP, UDP und SCTP, und das Weglassen des Schlüssels lässt den eigenen Standardwert des Ziels gelten. Portnamen werden von services.*.ports und von der Portauflösung einer http-Probe referenziert, und ein Service-Port übernimmt seinen Transport von dem Container-Port, zu dem sein Name aufgelöst wird, sodass der Transport einmal deklariert wird. K8s: containerPort, mit protocol nur dort, wo eines deklariert ist. Compose: Ein Container-Port erreicht die Ausgabe nur dort, wo eine Service-Spezifikation ihn veröffentlicht; der Container-Port selbst hat kein separates compose-Feld, und ein veröffentlichter Port trägt einen deklarierten Transport als Suffix /protocol am veröffentlichten Eintrag — ein Transport, den compose nicht ausdrücken kann, bricht den Build ab, statt einen Port zu veröffentlichen, der einen anderen führen würde.
resourcesobjectnein
healthobjectneinDie Health-Probes des Containers — ready, live und startup —, jeweils deklariert als http, tcp oder exec. Für helm in K8s httpGet/tcpSocket/exec übersetzt. Für compose trägt ein Service einen einzigen healthcheck: http und tcp werden zu CMD-SHELL-Tests, exec wird zu einem CMD-Test, und wo mehr als eine Probe deklariert ist, wird nur eine behalten — eine Warnung nennt die übersetzte Probe und die verworfenen.
volumeMountsobject[]nein
restartPolicystring (enum)neinZulässige Werte: "Always", "OnFailure", "Never"
lifecycleobjectneinLebenszyklus-Hooks des Containers. Für helm in K8s container.lifecycle (postStart/preStop) übersetzt. compose hat kein Lebenszyklus-Hook-Primitiv; eine Arbeitslast, die lifecycle deklariert, bricht auf einem compose-Ziel mit einer deutlichen Fehlermeldung ab, statt den Hook stillschweigend zu verwerfen.
securityContextobjectnein

Zusätzliche Eigenschaften sind nicht zulässig.

container.envFrom[]

EigenschaftTypErforderlichBeschreibung
configMapstringneinName einer ConfigMap-Quelle, die von der artifacts-Eingabe dieses Recipe oder von einem angebundenen Feature erzeugt wird.
secretstringneinName eines featuresSchema-Slots — des eigenen der Component oder, wenn connection gesetzt ist, eines Slots, den der Socket dieser Verbindung deklariert; der Name des importierten Secret wird aus den provides des Slots aufgelöst.
connectionstringneinAlias einer Verbindung, die die Komponente zieht — der Name, unter dem sie im uses-Block der Komponente geschrieben ist, im Aggregate oder im Release. Wenn gesetzt, nennt secret einen Slot, den der Socket deklariert, über den diese Verbindung verdrahtet ist, und das importierte Secret ist dasjenige, das die Anbindung, die diese Verbindung in diesem Slot trägt, veröffentlicht hat, sodass eine Komponente, die mehrere Ziele erreicht, das jeweils eigene Secret jedes Ziels importiert. Nur neben secret von Bedeutung. Eine Verbindung, die die Komponente nicht zieht, oder ein Slot, den ihr Socket nicht deklariert, wird unter Nennung beider abgelehnt.
prefixstringneinOptionales Präfix, das jedem importierten Umgebungsvariablennamen vorangestellt wird.

Zusätzliche Eigenschaften sind nicht zulässig.

container.resources

EigenschaftTypErforderlichBeschreibung
requestsresourceListnein
limitsresourceListnein

Zusätzliche Eigenschaften sind nicht zulässig.

container.health

Die Health-Probes des Containers — ready, live und startup —, jeweils deklariert als http, tcp oder exec. Für helm in K8s httpGet/tcpSocket/exec übersetzt. Für compose trägt ein Service einen einzigen healthcheck: http und tcp werden zu CMD-SHELL-Tests, exec wird zu einem CMD-Test, und wo mehr als eine Probe deklariert ist, wird nur eine behalten — eine Warnung nennt die übersetzte Probe und die verworfenen.

EigenschaftTypErforderlichBeschreibung
readyprobenein
liveprobenein
startupprobenein

Zusätzliche Eigenschaften sind nicht zulässig.

container.volumeMounts[]

EigenschaftTypErforderlichBeschreibung
namestringjaMuss einem Schlüssel in der Map volumes: auf oberster Ebene entsprechen.
pathstringjaEinhängepunkt innerhalb des Containers.
subPathstringneinHängt eine einzelne Datei oder ein einzelnes Unterverzeichnis aus dem Volume unter path ein, ohne andere Dateien im Zielverzeichnis zu verdecken.
readonlybooleschneinStandardwert: false

Zusätzliche Eigenschaften sind nicht zulässig.

container.lifecycle

Lebenszyklus-Hooks des Containers. Für helm in K8s container.lifecycle (postStart/preStop) übersetzt. compose hat kein Lebenszyklus-Hook-Primitiv; eine Arbeitslast, die lifecycle deklariert, bricht auf einem compose-Ziel mit einer deutlichen Fehlermeldung ab, statt den Hook stillschweigend zu verwerfen.

EigenschaftTypErforderlichBeschreibung
postStartlifecycleHooknein
preStoplifecycleHooknein

Zusätzliche Eigenschaften sind nicht zulässig.

container.securityContext

EigenschaftTypErforderlichBeschreibung
runAsUserintegernein
runAsGroupintegernein
runAsNonRootbooleschnein
readOnlyRootFilesystembooleschnein
allowPrivilegeEscalationbooleschnein
capabilitiesobjectnein

Zusätzliche Eigenschaften sind nicht zulässig.

container.securityContext.capabilities
EigenschaftTypErforderlichBeschreibung
addstring[]nein
dropstring[]nein

Zusätzliche Eigenschaften sind nicht zulässig.

containerAttachment

EigenschaftTypErforderlichBeschreibung
fromstringjaName eines Slots, der im featuresSchema der Component deklariert ist — oder, wenn connection gesetzt ist, eines Slots, den der Socket deklariert, über den diese Verbindung verdrahtet ist.
connectionstringneinAlias einer Verbindung, die die Komponente zieht — der Name, unter dem sie im uses-Block der Komponente geschrieben ist, im Aggregate oder im Release. Wenn gesetzt, nennt from einen Slot, den der Socket deklariert, über den diese Verbindung verdrahtet ist (usesSchema..featuresSchema), und der Eintrag liefert, was die Anbindung, die diese Verbindung in diesem Slot trägt, veröffentlicht hat, sodass eine Komponente, die mehrere Ziele erreicht, jedem ihre eigenen Zugangsdaten vorlegt. Die inject:-Allowlist des Slots bestimmt as, genau wie bei einem Slot, den die Component deklariert. Eine Verbindung, die die Komponente nicht zieht, oder ein Slot, den ihr Socket nicht deklariert, wird unter Nennung beider abgelehnt.
asstring (enum)jaZustellmechanismus. Muss in der Allowlist des Arrays inject: des Slots stehen. Zulässige Werte: "env", "file"
keystringneinBei as: env der bestimmte Datenschlüssel des Secret des referenzierten Slots, den dieser Eintrag liest. Setzen Sie ihn, wenn das Secret des Slots mehrere Datenschlüssel trägt, damit dieser Eintrag einen davon nach Namen auswählt; zwei Einträge können denselben Slot mit unterschiedlichen Schlüsseln referenzieren, um mehrere Schlüssel aus einem Secret zu lesen. Wenn er weggelassen wird, liest der Eintrag den einzigen veröffentlichten Schlüssel des Slots. Bei as: file ignoriert, das das gesamte Secret einhängt.
pathstringneinDateipfad innerhalb des Containers (erforderlich bei as: file).

Zusätzliche Eigenschaften sind nicht zulässig.

resourceList

EigenschaftTypErforderlichBeschreibung
cpustringneinCPU-Menge (z. B. ‘100m’, ‘0.5’, ‘2’). helm erzeugt sie unverändert unter resources.{requests,limits}.cpu. compose bildet sie auf deploy.resources.{reservations,limits}.cpus als Bruchteile von Kernen ab — eine Millicpu-Menge wird umgerechnet (500m wird zu 0.5); eine einfache Kernmenge wird durchgereicht. Eine Menge, die compose nicht umrechnen kann, bricht mit einer deutlichen Fehlermeldung ab, statt einen falschen Wert auszugeben.
memorystringneinSpeichermenge (z. B. ‘128Mi’, ‘1Gi’). helm erzeugt sie unverändert unter resources.{requests,limits}.memory. compose bildet sie auf deploy.resources.{reservations,limits}.memory als exakte Byteanzahl ab. Eine Menge, die eine ganze Zahl von Bytes ergibt, wird exakt umgerechnet (1.5Gi wird zu 1610612736); eine, bei der das nicht der Fall ist oder die keine Menge ist, bricht mit einer deutlichen Fehlermeldung ab, statt zu runden.

Zusätzliche Schlüssel: Eine erweiterte (hersteller- bzw. domänenspezifische) Ressourcenmenge, geschlüsselt über einen vollqualifizierten Namen ’/’ (zum Beispiel ‘nvidia.com/gpu’: ‘1’, ‘amd.com/gpu’: ‘2’). Das Domänensegment enthält mindestens einen Punkt, was einen erweiterten Schlüssel von den bloßen Mengen cpu/memory unterscheidet. Der Compiler reicht die Menge unverändert durch; das Device-Plugin des Clusters löst sie zum Scheduling-Zeitpunkt auf und weist sie zu. helm erzeugt sie unter resources.{requests,limits}.. compose reserviert eine Anzahl ‘nvidia.com/gpu’ als NVIDIA-Gerätereservierung auf dem Service des Containers — die Anzahl des Limits, wo ein Limit geschrieben ist, andernfalls die der Anforderung, und keine Reservierung bei einer Anzahl von 0 — und bricht bei einer Anzahl ab, die keine ganze Zahl von Geräten ist, oder bei einer Anforderung und einem Limit, die unterschiedliche Anzahlen verlangen. compose hat für keinen anderen erweiterten Schlüssel ein Gegenstück und lässt ihn weg, wobei es einmal pro unterschiedlichem erweitertem Schlüssel warnt und diesen Schlüssel nennt, sodass das Weglassen gemeldet wird, statt stillschweigend zu geschehen. Muster: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)+/[A-Za-z0-9]([-A-Za-z0-9_.]*[A-Za-z0-9])?$.

Keine andere Eigenschaft ist zulässig.

probe

EigenschaftTypErforderlichBeschreibung
httpstringneinHTTP-GET-Probe: Der Pfad wird gegen den Container-Port geprüft, dessen Name alphabetisch zuerst kommt.
tcpintegerneinTCP-Socket-Probe auf der angegebenen Container-Portnummer. Minimum: 1. Maximum: 65535.
execstring[]neinExec-Probe — der Befehl, der innerhalb des Containers ausgeführt wird. Mindestens 1 Eintrag.
timeoutSecondsintegerneinMinimum: 1.
initialDelaySecondsintegerneinMinimum: 0.
periodSecondsintegerneinMinimum: 1.
failureThresholdintegerneinMinimum: 1.
successThresholdintegerneinMinimum: 1.

Zusätzliche Eigenschaften sind nicht zulässig.

lifecycleHook

EigenschaftTypErforderlichBeschreibung
execstring[]neinMindestens 1 Eintrag.
httpGetobjectneinDie K8s-native httpGet-Form (path, port, scheme, host, httpHeaders). An helm durchgereicht. Auf einem compose-Ziel bricht eine Arbeitslast, die einen Lebenszyklus-Hook deklariert, ab, weil compose kein Lebenszyklus-Hook-Primitiv hat — der Hook wird nie stillschweigend verworfen.

Zusätzliche Eigenschaften sind nicht zulässig.

volume

EigenschaftTypErforderlichBeschreibung
ephemeralobjectnein
configmapobjectnein
secretobjectnein
persistentobjectnein
persistentTemplateobjectneinClaim-Template pro Replikat. Erfordert form: stateful, weil nur die stateful-Form jedem Replikat die stabile Identität gibt, die ein Claim pro Replikat braucht. Auf Kubernetes wird es zu StatefulSet.volumeClaimTemplates. Auf einem compose-Ziel wird es zu einem einzigen benannten Volume herabgestuft, das alle Replikate gemeinsam nutzen, und eine Warnung meldet die Herabstufung.

Zusätzliche Eigenschaften sind nicht zulässig.

volume.ephemeral

EigenschaftTypErforderlichBeschreibung
sizeLimitstringneinK8s-Menge (z. B. ‘1Gi’). K8s: emptyDir.sizeLimit. Compose: Das Volume wird zu einem tmpfs-Eintrag, der keine Größe trägt, daher erreicht dieser Wert keinen Teil der Ausgabe — eine Warnung meldet ihn, wenn er verfasst ist.

Zusätzliche Eigenschaften sind nicht zulässig.

volume.configmap

EigenschaftTypErforderlichBeschreibung
sourcestringjaName der ConfigMap, erzeugt von diesem Recipe über artifacts: oder von einem angebundenen Feature; eine ConfigMap, die ein anderes Recipe erzeugt, wird hier nicht referenziert.
itemsobject[]neinOptionale Auswahl von Schlüssel zu Pfad.

Zusätzliche Eigenschaften sind nicht zulässig.

volume.secret

EigenschaftTypErforderlichBeschreibung
sourcestringja
itemsobject[]nein

Zusätzliche Eigenschaften sind nicht zulässig.

volume.persistent

EigenschaftTypErforderlichBeschreibung
sizestringjaK8s-Menge (z. B. ‘10Gi’).
classstringneinStorageClassName. Optional.
accessModesstring (enum)[]neinPVC-Zugriffsmodi. helm erzeugt spec.accessModes, mit [ReadWriteOnce] als Standardwert, wenn sie weggelassen werden. compose-Volumes kennen kein Konzept von Zugriffsmodi und lassen es weg. Zulässige Werte für jeden Eintrag: "ReadWriteOnce", "ReadOnlyMany", "ReadWriteMany", "ReadWriteOncePod".

Zusätzliche Eigenschaften sind nicht zulässig.

volume.persistentTemplate

Claim-Template pro Replikat. Erfordert form: stateful, weil nur die stateful-Form jedem Replikat die stabile Identität gibt, die ein Claim pro Replikat braucht. Auf Kubernetes wird es zu StatefulSet.volumeClaimTemplates. Auf einem compose-Ziel wird es zu einem einzigen benannten Volume herabgestuft, das alle Replikate gemeinsam nutzen, und eine Warnung meldet die Herabstufung.

EigenschaftTypErforderlichBeschreibung
sizestringja
classstringnein
accessModesstring (enum)[]neinPVC-Zugriffsmodi für das Claim-Template pro Replikat. helm erzeugt spec.accessModes, mit [ReadWriteOnce] als Standardwert, wenn sie weggelassen werden. compose kennt kein Konzept von Zugriffsmodi und lässt es weg. Zulässige Werte für jeden Eintrag: "ReadWriteOnce", "ReadOnlyMany", "ReadWriteMany", "ReadWriteOncePod".

Zusätzliche Eigenschaften sind nicht zulässig.

service

EigenschaftTypErforderlichBeschreibung
typestring (enum)jaService-Typ: wie weit die Ports des Eintrags reichen. ClusterIP hält sie im eigenen Netzwerk des Ziels, erreichbar von den Peers der Arbeitslast; Headless ebenso und rendert auf helm einen K8s-Service mit clusterIP: None; NodePort und LoadBalancer veröffentlichen sie über dieses Netzwerk hinaus; Loopback veröffentlicht sie nur auf der eigenen Loopback-Adresse des Hosts, erreichbar von der Maschine, auf der die Arbeitslast läuft, und von nirgendwo sonst. helm rendert ClusterIP, NodePort und LoadBalancer als den gleichnamigen Typ des K8s-Service und lehnt einen Loopback-Eintrag namentlich ab, weil ein K8s-Service keinen Typ hat, der an die Loopback-Adresse eines Hosts bindet. compose veröffentlicht nichts für ClusterIP und Headless, veröffentlicht NodePort- und LoadBalancer-Ports auf jeder Host-Schnittstelle als host:container und veröffentlicht Loopback-Ports auf der IPv4-Loopback-Adresse als 127.0.0.1:host:container; ein Port, den auch ein NodePort- oder LoadBalancer-Eintrag veröffentlicht, wird auf jeder Schnittstelle veröffentlicht. Zulässige Werte: "ClusterIP", "NodePort", "LoadBalancer", "Headless", "Loopback"
portsMap von integerjaMap von Service-Portname → Container-Portnummer. Portnamen müssen Schlüsseln in containers..ports entsprechen. Ein Service-Port trägt kein eigenes Transportprotokoll: Er übernimmt den Transport des Container-Ports, zu dem sein Name aufgelöst wird, sodass der Transport eines Ports einmal deklariert wird, am Container-Port, und die Service-Freigabe nicht von dem abweichen kann, was der Container geöffnet hat.

Zusätzliche Eigenschaften sind nicht zulässig.