Component

core/security/keycloak

Keycloak, a database-backed identity and access-management server. Keycloak serves its account console and token endpoints on an HTTP port and keeps its realms, clients, and users in a PostgreSQL backend wired through its `backend` uses-socket, and it provisions and migrates its own schema on startup against that backend. Keycloak holds no persistent state of its own, so it renders as a stateless server. On Kubernetes there are two realizations and the Manifest chooses between them. `keycloak` synthesizes the server as a single stateless workload and fetches nothing, so it is the one to reach for where the build must complete with no chart repository reachable. `keycloak-chart` renders the codecentric Keycloak.X Helm chart, which additionally carries what the server needs to run as more than one replica, so reach for it where a chart repository is reachable at build time and the server will be scaled out. In both, `infra.external_base_url` becomes the server's hostname and the realms in `values.realm_imports` are imported when it starts. With `values.metrics_enabled` true, both serve the server's own metrics on its management port and publish their address as `metrics_endpoint`; false, that key is empty. The management port, which checks no caller, stays inside the cluster on `keycloak-chart` whatever `infra.overrides.service_type` says; LoadBalancer or NodePort publishes the console alone on `<rendered_name>-external`.

Provenance

OfficialSigned by a signing identity this catalog recognizes as an official publisher.
Content digest
sha256:14315a4f9e45aa840f5eda92e409a7a4f10b6a62a9cece81d8509785853916b6
Published
2026-11-10T10:13:36Z
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:1f24d430665b78d92b17c91dd560ede3eb4a62fbe3ffeb7c9d35482fe8c53fc0

Reference at this version

oci://hub.aggrega.ai/component/core/security/keycloak:1.0.0

Developer parameters

Values the developer sets in the Aggregate.

NameTypeDefaultRequiredDescription
admin_userstringadminnoBootstrap admin account username, seeded on first startup.
realm_importsobject—noRealms the server imports when it starts. Each key is a file name and each value is that file's content: a realm representation in JSON, the format the server's own realm export writes. The server reads a file as a realm only when it is named `<realm>-realm.json`, and it refuses one whose realm carries a different name, so the Recipes halt the build on a key ending any other way. A realm that already exists is left as it is, so an import seeds a realm once rather than keeping it in step with this value. The content is rendered into the Release's output exactly as written and is readable by anyone who can read that output, so it carries no credential material: a confidential client's secret, a user's password or an identity provider's client secret belongs in a credential slot, not here. Omitted, no realm is imported and the server starts with only its administrative realm.
metrics_enabledbooleanfalsenoTurns on the server's own metrics, in the Prometheus format, and publishes their address as `metrics_endpoint`; while false that key is empty. They are served on the management port, which checks no caller, so anything that reaches that port can read them.

Operator sizing

Infrastructure sizing the operator tunes per environment.

NameTypeDefaultRequiredDescription
http_portinteger (min 1024, max 65535)8080noHTTP port serving the account console, token endpoints, and admin API; consumers connect here.
management_portinteger (min 1024, max 65535)9000noManagement port serving health and metrics endpoints, which check no caller. `keycloak` puts it on its in-cluster Service only while values.metrics_enabled is true; `keycloak-chart` renders a chart that always puts it on the console Service, which that realization keeps inside the cluster whatever infra.overrides.service_type says, publishing an exposed console alone on `<rendered_name>-external`.
external_base_urlstring—noExternally reachable base URL of the server, as assembled at the ingress tier, including any path the ingress serves it under — for example https://id.example.com. The server composes from this the issuer it writes into every token and publishes in its discovery document, the address of every endpoint it advertises, and the links it puts in an email or redirects a browser to, so a token it issues verifies wherever it is presented. An application that reaches the server in-cluster and reads its discovery document is sent to this address too. Omitted, the Recipe leaves the server to take its address from each incoming request, which is correct for a server nobody reaches except at its in-cluster address.
engine_versionstring26.7.0noKeycloak server container image tag. Selects the image tag on container targets; the chart-backed realization pins its own image tag.
source_versionstring—noVersion of the Helm chart the chart-backed realization pulls. Read only by that realization; the workload-synthesis realization pulls no source artifact and ignores it. Changing it away from the Recipe's default does not guarantee value-mapping compatibility with the new chart.
computeobject—no—
overridesobject (open)—noProvider-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads.

Output contract

Values this component publishes to consumers over the uses topology.

NameTypeDefaultRequiredDescription
hoststring—yesIn-cluster DNS name of the Service fronting the account console, the token endpoints and the admin API. An application that redeems tokens dials this name together with `port`.
portinteger—yesTCP port that Service accepts requests on. It carries the HTTP port an operator set, never the management port, so a consumer reaches the endpoints it is meant to use.
protocolstring—noHow the published address is spoken to — `http`, so a consumer composes an issuer URL on that scheme.
metrics_endpointstring—noThe full address Prometheus scrapes this component's metrics at — scheme, host, port and path, `http://<host>:<management port>/metrics` under the path the realization serves the server at. Empty while values.metrics_enabled is false.

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.

backend

Selector
component.aggrega.ai/type=stateful-server
Inject
env

Slots each connection through this socket may fill

SlotSelectorRequiredInjectSensitiveDescription
credentialfeature.aggrega.ai/kind=secretnoenvyesOptional password the server presents to the backend this connection reaches, shared with that backend. When attached, supplies the backend password via the credential subsystem. Unattached, helm/keycloak and helm/keycloak-chart present the development literal `apppass`, which this catalog publishes, so every Release that leaves the slot unattached shares that password.

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
admin_passwordfeature.aggrega.ai/kind=secretnoenvyesOptional credential for the Keycloak bootstrap admin account. When attached, supplies the admin password via the credential subsystem. Unattached, helm/keycloak and helm/keycloak-chart set the bootstrap admin password to the development literal `admin`, which this catalog publishes, so every Release that leaves the slot unattached shares that password.

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