Component

core/ai-model/tgi

Text Generation Inference running in-cluster as a self-hosted inference server. A Recipe synthesizes the runtime directly: a weights-pull initContainer resolves the model pointer into a model-cache volume the serving container mounts, and a ClusterIP Service fronts the API. The model value is a deterministic pointer resolved at pod start, never fetched at compile time. Exports its host, port, endpoint, model, and protocol to consumers via the uses topology, so an agent reaches the model without hardcoding an endpoint. Each Recipe also publishes where Prometheus finds the server's metrics: one address as `metrics_endpoint`, or, while the Kubernetes realization runs more than one replica, the Service a scraper discovers every replica behind. On a cluster running the Prometheus Operator, `core/prometheus-exporter` attached with its port set to `http` emits a ServiceMonitor for it instead.

Provenance

OfficialSigned by a signing identity this catalog recognizes as an official publisher.
Content digest
sha256:19e35931d9753f81e3143869dcffd919cf89b93a2770da756bbadc8066853021
Published
2026-11-10T10:09:37Z
Signing identity
https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

Signature

  • Officialapplication/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:46a2f0e5c8b71d3f5bff94a62a3523fdb3f5b0b89eac6aac1b53f1705bdd5090

Reference at this version

oci://hub.aggrega.ai/component/core/ai-model/tgi:1.0.0

Developer parameters

Values the developer sets in the Aggregate.

Extends BaseComponents#/schemas/BaseModelParameter

Operator sizing

Infrastructure sizing the operator tunes per environment.

NameTypeDefaultRequiredDescription
portinteger (min 1024, max 65535)8080noServer listen port for the model API. Most operators should omit this and let the Recipe assign the default (8080).
engine_versionstring3.0.1noText Generation Inference runtime image tag. Selects the image tag on the synthesized serving and weights-pull containers.
replicasinteger (min 1)1noNumber of serving replicas. Each replica holds its own model-cache volume and pulls the weights independently.
min_replicasinteger (min 1)—noLower bound for the replica count when horizontal autoscaling is configured. Declared ahead of rendering — the synth recipes serve a fixed replica count and do not yet emit an autoscaler; set it to record the intended lower bound.
max_replicasinteger (min 1)—noUpper bound for the replica count when horizontal autoscaling is configured. Declared ahead of rendering — the synth recipes serve a fixed replica count and do not yet emit an autoscaler; set it to record the intended upper bound.
computeobject—no—
model_cacheobject—noPer-replica model-weights cache volume. Sized for the pulled model; each serving replica gets its own claim.
model_artifactstring—noOptional OCI reference to the model weights, an alternative weights source to the Hugging Face model id in values.model. A deterministic pointer the runtime resolves at pod start; the compiler never fetches it. Declared ahead of rendering — the synth recipes resolve weights from values.model and do not yet consume this pointer.
overridesobject (open)—noProvider-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads.
gpuobject—noOptional GPU scheduling for the serving container. When set, the Recipe requests GPUs as the extended resource nvidia.com/gpu and, when a runtime class is named, schedules the pod under it. Requires a GPU-capable cluster and, for runtime_class, a matching RuntimeClass configured in the cluster. Omit the whole object to serve on CPU.

Output contract

Values this component publishes to consumers over the uses topology.

NameTypeDefaultRequiredDescription
hoststring—yesIn-cluster DNS name of the Service fronting the inference server. A consumer that composes its own address dials this name; one that does not reads `endpoint` instead.
portinteger—yesTCP port that Service accepts generation requests on. It follows the port an operator set in the Release, so a consumer reads it rather than assuming a default.
endpointstring—yesFull base URL of the generation API, with the host, the port and the API path already composed. A consumer hands it to a client library as its base URL.
modelstring—yesName a request must ask this server for, which is the model whose weights it loaded rather than a provider catalogue name.
protocolstring—noURL scheme to reach `host` and `port` over, for a consumer composing its own address rather than reading `endpoint`.
metrics_endpointstring—noThe full address Prometheus scrapes this server's metrics at — scheme, host, port and path, `http://<host>:<port>/metrics`, on the port the API is served on. Empty while the Kubernetes realization runs more than one replica, which then publishes `metrics_service` instead.
metrics_servicestring—noName of the Service every replica's metrics sit behind, for a scraper that discovers each endpoint of that Service rather than scraping one address. Set by the Kubernetes realization while infra.replicas is above one, beside `metrics_service_port` and `metrics_path`; empty otherwise.
metrics_service_portstring—noName of the port of `metrics_service` that carries the metrics, `http`. Set and empty together with `metrics_service`.
metrics_pathstring—noPath the metrics are served at, `/metrics`, published beside `metrics_service`. Empty where the server publishes `metrics_endpoint`, which carries its own path.

Uses sockets

The dependency sockets this component connects through. The target of every connection wired through a socket must satisfy its label selector, and each connection may carry an attachment in the slots the socket declares. A required slot is owed by each connection the Aggregate or the Release wires through the socket.

No uses sockets declared.

Attachment slots

Named binding points at which a Feature attaches to this component. A slot's selector constrains which Feature may fill it and its inject list names how the Feature's material may be delivered. A required slot must be bound on every instance, by an attachment on the instance or at a scope above it, and a sensitive slot is declared to handle secret material. A Feature may also attach under a name no slot declares.

SlotSelectorRequiredInjectSensitiveDescription
model_pull_tokenfeature.aggrega.ai/kind=secretnoenvyesOptional model-registry pull credential for gated model weights. When attached, the weights-pull initContainer receives it as an environment variable; unattached, weights are pulled anonymously.
api_keyfeature.aggrega.ai/kind=secretnoenvyesOptional key the server requires of every caller. When attached, the Recipe delivers it as API_KEY, the variable Text Generation Inference reads at startup, and each generation request must then carry it as a bearer token in the Authorization header. The server checks this one key, so every caller must present the same key. Text Generation Inference accepts the key whatever its letter case, so two keys differing only in case are one key to it, and a key's strength is judged on its case-folded form. Unattached, the server requires none.

Self-inject allowlist

env

Relationships

Typed edges to and from other published entities. A reference with no published target renders as a broken edge rather than a link.

Uses

Used by

Component concept reference →

The Aggrega catalog — an open index of components, features, recipes, and the plugins that render them.

Built with the shared Aggrega design system.

Privacy