Diese Seite wurde maschinell übersetzt. Englisches Original lesen.

Component

core/ai-agent/agenta-api

The control-plane API of an agent workspace: the service that holds the agents a team builds, each agent's instructions, tools, skills, permissions and version history, and the record of every run. It serves the REST API the console renders from and an external client calls, and it is the tier that reads and writes the platform's relational model. It holds no state of its own: a relational backend, a cache, a queue and an object store do, each wired through a socket of its own, and it reaches the authentication core wired through auth_core for every sign-in and every session check. Wire here for the platform's own data plane. It is the counterpart of core/ai-agent/agenta-services, which owns completions, chat and the dispatch of an agent run to the runner, so a caller that wants to invoke a model reaches that service rather than this one. Realized on Kubernetes via its Helm Recipe, which synthesizes the service as a stateless Deployment behind a ClusterIP Service on its HTTP port. It exports its host, port, endpoint and protocol to consumers.

Herkunft

OffiziellSigniert von einer Signaturidentität, die dieser Katalog als offiziellen Herausgeber anerkennt.
Inhalts-Digest
sha256:4f4386baa75d06eb78086e19737b007745d76247b3b684ebf92fbe57caa1bcc0
Veröffentlicht
2026-11-10T10:07:14Z
Signaturidentität
https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

Signatur

  • Offiziellapplication/vnd.dev.sigstore.bundle.v0.3+json

    https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

    sha256:5a82941a9c4c4a7aeb81161941eb7745567c5b120de9c7c56541c172f989fbf8

Referenz zu dieser Version

oci://hub.aggrega.ai/component/core/ai-agent/agenta-api:1.0.0

Entwicklerparameter

Werte, die der Entwickler im Aggregate festlegt.

NameTypStandardwertErforderlichBeschreibung
email_sign_in_enabledbooleantrueneinAllow an account to sign in with an email address and a password. Turned off, only the sign-in methods configured elsewhere remain.
allowed_email_domainsstring—neinComma-separated list of email domains an account may be created under. Left unset, any domain is accepted.
password_min_lengthinteger (min 1)8neinFewest characters a password may have. The authentication core enforces it at sign-up and at password change.

Dimensionierung durch den Operator

Infrastrukturdimensionierung, die der Operator pro Umgebung anpasst.

NameTypStandardwertErforderlichBeschreibung
portinteger (min 1024, max 65535)8000neinPort the service serves its HTTP API on; consumers connect here. Most operators should omit this and let the Recipe assign the default (8000).
external_base_urlstring—neinExternally reachable base URL of the whole platform, as a browser reaches it through the ingress tier — for example https://agenta.example.com. The service composes the addresses it hands out in links and mail from it. The compiler cannot know a cluster's external hostname, so this carries no default and the Kubernetes realization halts at build until it is set.
engine_versionstringv0.114.1neinPlatform API container image tag. The API service, the model-facing service, the two worker tiers, the scheduler and the schema-migration task run the same image, so a Release moves them together.
web_workersinteger (min 1)2neinNumber of request-serving worker processes in one container. Raising it raises throughput and the container's memory ceiling together, so it is sized with compute.memory.
log_levelstring (DEBUG | INFO | WARNING | ERROR | CRITICAL)INFOneinLog verbosity the service emits.
computeobject—nein—
overridesobject (open)—neinProvider-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads.

Ausgabevertrag

Werte, die diese Komponente über die uses-Topologie an Konsumenten veröffentlicht.

NameTypStandardwertErforderlichBeschreibung
hoststring—jaIn-cluster DNS name of the Service fronting the control-plane API. The other tiers of the workspace, and any external client routed inward, dial this name.
portinteger—jaTCP port that Service accepts API requests on. It follows the port an operator set in the Release, so a consumer reads it rather than assuming a default.
endpointstring—jaFull in-cluster base URL of the control-plane API, with the host and the port already composed. It is the address a peer tier calls, not the address a browser reaches, which the ingress tier publishes separately.
protocolstring—neinURL scheme to reach `host` and `port` over, for a consumer composing its own address rather than reading `endpoint`.

uses-Sockets

Die Abhängigkeits-Sockets, über die sich diese Komponente verbindet. Das Ziel jeder über einen Socket verdrahteten Verbindung muss dessen Label-Selektor erfüllen, und jede Verbindung kann in den Slots, die der Socket deklariert, eine Anbindung tragen. Einen erforderlichen Slot muss jede Verbindung füllen, die das Aggregate oder das Release über den Socket verdrahtet.

backend

Selektor
component.aggrega.ai/category=datastore
Injektion
env

Slots, die jede Verbindung über diesen Socket füllen kann

SlotSelektorErforderlichInjektionSensibelBeschreibung
credentialfeature.aggrega.ai/kind=secretneinenvjaPassword the service authenticates to the relational backend this connection reaches with. Delivered as an env secret reference and substituted into the connection URL at run time, so the value never appears in the rendered manifest. Unattached, the Recipe emits the development literal `apppass`, the default the standard-library relational Recipes leave in place; this catalog publishes it, so every Release that leaves the slot unattached shares that password.

cache

Selektor
component.aggrega.ai/category=datastore
Injektion
env

Slots, die jede Verbindung über diesen Socket füllen kann

SlotSelektorErforderlichInjektionSensibelBeschreibung
server_cafeature.aggrega.ai/kind=secretneinfilejaOptional authority the platform's Redis client checks the cache's certificate against while the cache publishes protocol valkey-tls or redis-tls, where the image does not already trust the authority that signs it. Its Secret holds ca.crt. The Recipe mounts the whole Secret read-only and names the file in the connection's URL. The build halts on a server_ca publishing no Secret name, and on one wired to a cache served without TLS. Fill it with core/referenced-secret.

queue

Selektor
component.aggrega.ai/category=datastore
Injektion
env

Slots, die jede Verbindung über diesen Socket füllen kann

SlotSelektorErforderlichInjektionSensibelBeschreibung
server_cafeature.aggrega.ai/kind=secretneinfilejaOptional authority the platform's Redis client checks the queue's certificate against while the queue publishes protocol valkey-tls or redis-tls, where the image does not already trust the authority that signs it. Its Secret holds ca.crt. The Recipe mounts the whole Secret read-only and names the file in the connection's URL. The build halts on a server_ca publishing no Secret name, and on one wired to a queue served without TLS. Fill it with core/referenced-secret.

auth_core

Selektor
component.aggrega.ai/category=security
Injektion
env

Slots, die jede Verbindung über diesen Socket füllen kann

SlotSelektorErforderlichInjektionSensibelBeschreibung
credentialfeature.aggrega.ai/kind=secretneinenvjaAPI key presented to the authentication core this connection reaches. The core issues none by default and accepts every caller that can reach its address, so where a key is attached to the core, the same one is attached here. Unattached, no key is sent.

store

Selektor
component.aggrega.ai/type=resource,component.aggrega.ai/category=storage
Injektion
env

Slots, die jede Verbindung über diesen Socket füllen kann

SlotSelektorErforderlichInjektionSensibelBeschreibung
credential_idfeature.aggrega.ai/kind=secretneinenvjaAccess-key identifier the S3 client authenticates to the object store this connection reaches with, the identifier half of the pair whose secret half is this connection's credential. It names an account on that store, so it matches whatever the store itself was given. Unattached, the Recipe presents the identifier admin.
credentialfeature.aggrega.ai/kind=secretneinenvjaSecret key paired with this connection's credential_id. There is no default: the build halts when nothing fills this slot, unless the connection's values set unauthenticated: true.

runner

Selektor
component.aggrega.ai/category=ai-agent
Injektion
env

Slots, die jede Verbindung über diesen Socket füllen kann

SlotSelektorErforderlichInjektionSensibelBeschreibung
credentialfeature.aggrega.ai/kind=secretneinenvjaToken presented on every call to the runner this connection reaches, which rejects an untokened request. The same credential is attached to the runner's own slot so both ends agree. Unattached, the Recipe emits the pinned development literal `dev-agenta-runner-change-me`, suitable for evaluation only and published in this catalog, so every Release that leaves the slot unattached shares it.

Anbindungs-Slots

Benannte Bindungspunkte, an denen ein Feature an diese Komponente angebunden wird. Der Selektor eines Slots schränkt ein, welches Feature ihn füllen darf, und seine inject-Liste benennt, wie das Feature sein Material liefern darf. Ein erforderlicher Slot muss auf jeder Instanz gebunden sein, durch eine Anbindung an der Instanz oder in einem darüberliegenden Geltungsbereich, und ein sensibler Slot ist für den Umgang mit geheimem Material deklariert. Ein Feature kann auch unter einem Namen angebunden werden, den kein Slot deklariert.

SlotSelektorErforderlichInjektionSensibelBeschreibung
auth_keyfeature.aggrega.ai/kind=secretjaenvjaRequired key the platform signs its own internal tokens with. Every workload of the platform that issues or verifies one carries the same value, so attaching a credential here attaches it to each of them. There is no default: the build halts when nothing fills this slot.
crypt_keyfeature.aggrega.ai/kind=secretjaenvjaRequired key the stored model-provider credentials and connected-application tokens are encrypted under. It must be the same value on every workload of the platform that reads them, and changing it makes what is already stored unreadable. There is no default: the build halts when nothing fills this slot.
services_internal_keyfeature.aggrega.ai/kind=secretneinenvjaKey this service and the model-facing service present to each other on internal calls. Both ends carry the same value. Unattached, the Recipe emits the pinned development literal `dev-agenta-internal-change-me`, suitable for evaluation only and published in this catalog, so every Release that leaves the slot unattached shares it.

Zulassungsliste für Selbstinjektion

env

Beziehungen

Typisierte Kanten zu und von anderen veröffentlichten Entitäten. Eine Referenz ohne veröffentlichtes Ziel wird als unterbrochene Kante statt als Link dargestellt.

Verwendet

Verwendet von

Konzeptreferenz zu Component →

Der Aggrega-Katalog — ein offener Index von Komponenten, Funktionen, Rezepten und den Plugins, die sie rendern.

Erstellt mit dem gemeinsamen Aggrega-Designsystem.

Datenschutz