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`.
Provenienza
- Digest del contenuto
- sha256:14315a4f9e45aa840f5eda92e409a7a4f10b6a62a9cece81d8509785853916b6
- Pubblicato
- 2026-11-10T10:13:36Z
- Identità di firma
- https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main
Firma
- Ufficialeapplication/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
Riferimento a questa versione
oci://hub.aggrega.ai/component/core/security/keycloak:1.0.0Parametri dello sviluppatore
Valori che lo sviluppatore imposta nell’Aggregate.
| Nome | Tipo | Predefinito | Obbligatorio | Descrizione |
|---|---|---|---|---|
| admin_user | string | admin | no | Bootstrap admin account username, seeded on first startup. |
| realm_imports | object | — | no | Realms 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_enabled | boolean | false | no | Turns 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. |
Dimensionamento dell’operatore
Dimensionamento dell’infrastruttura che l’operatore regola per ogni ambiente.
| Nome | Tipo | Predefinito | Obbligatorio | Descrizione |
|---|---|---|---|---|
| http_port | integer (min 1024, max 65535) | 8080 | no | HTTP port serving the account console, token endpoints, and admin API; consumers connect here. |
| management_port | integer (min 1024, max 65535) | 9000 | no | Management 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_url | string | — | no | Externally 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_version | string | 26.7.0 | no | Keycloak server container image tag. Selects the image tag on container targets; the chart-backed realization pins its own image tag. |
| source_version | string | — | no | Version 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. |
| compute | object | — | no | — |
| overrides | object (open) | — | no | Provider-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads. |
Contratto di output
Valori che questo componente pubblica verso i consumatori attraverso la topologia uses.
| Nome | Tipo | Predefinito | Obbligatorio | Descrizione |
|---|---|---|---|---|
| host | string | — | sì | In-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`. |
| port | integer | — | sì | TCP 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. |
| protocol | string | — | no | How the published address is spoken to — `http`, so a consumer composes an issuer URL on that scheme. |
| metrics_endpoint | string | — | no | The 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. |
Socket uses
I socket di dipendenza attraverso cui questo componente si connette. La destinazione di ogni connessione collegata attraverso un socket deve soddisfare il suo selettore di etichette, e ogni connessione può portare un aggancio negli slot che il socket dichiara. Uno slot obbligatorio deve essere riempito da ogni connessione che l’Aggregate o la Release collega attraverso il socket.
backend
- Selettore
- component.aggrega.ai/type=stateful-server
- Iniezione
- env
Slot che ogni connessione attraverso questo socket può riempire
| Slot | Selettore | Obbligatorio | Iniezione | Sensibile | Descrizione |
|---|---|---|---|---|---|
| credential | feature.aggrega.ai/kind=secret | no | env | sì | Optional 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. |
Slot di aggancio
Punti di associazione con nome in cui una Feature si aggancia a questo componente. Il selettore di uno slot limita quale Feature può riempirlo e la sua lista inject indica come può essere consegnato il materiale della Feature. Uno slot obbligatorio deve essere associato su ogni istanza, da un aggancio sull’istanza o a un ambito superiore, e uno slot sensibile è dichiarato per gestire materiale segreto. Una Feature può anche agganciarsi con un nome che nessuno slot dichiara.
| Slot | Selettore | Obbligatorio | Iniezione | Sensibile | Descrizione |
|---|---|---|---|---|---|
| admin_password | feature.aggrega.ai/kind=secret | no | env | sì | Optional 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. |
Elenco consentito di auto-iniezione
env
Relazioni
Archi tipizzati da e verso altre entità pubblicate. Un riferimento senza una destinazione pubblicata viene mostrato come arco interrotto anziché come link.
Usa
- usausa il socket «backend»
component.aggrega.ai/type=stateful-server
Slot di aggancio: credential
core/ai-agent/dify-plugin-daemon v1.0.0 →core/ai-tool/filesystem v1.0.0 →core/datastore/chroma v1.0.0 →core/datastore/cognee v1.0.0 →core/datastore/documentdb v1.0.0 →core/datastore/elasticsearch v1.0.0 →core/datastore/etcd v1.0.0 →core/datastore/ferretdb v1.0.0 →core/datastore/mariadb v1.0.0 →core/datastore/milvus v1.0.0 →core/datastore/mysql v1.0.0 →core/datastore/mysql-innodb-cluster v1.0.0 →core/datastore/opensearch v1.0.0 →core/datastore/pgvector v1.0.0 →core/datastore/postgres v1.0.0 →core/datastore/qdrant v1.0.0 →core/datastore/timescaledb v1.0.0 →core/datastore/weaviate v1.0.0 →core/devtool/harbor v1.0.0 →core/messaging/kafka v1.0.0 →core/messaging/rabbitmq v1.0.0 →core/observability/fluentd v1.0.0 →core/observability/jaeger v1.0.0 →core/observability/loki v1.0.0 →core/observability/prometheus v1.0.0 →core/observability/tempo v1.0.0 →core/security/openbao v1.0.0 →
Usato da
usa il socket «auth_core»
usa il socket «auth_core»
usa il socket «auth_core»
usa il socket «auth_core»
usa il socket «upstream»
usa il socket «forward_target»
usa il socket «scrape_target»
usa il socket «store»
usa il socket «jailbreak_detection»
si applica a
si applica a
si applica a
si applica a
si applica a
si applica a
si applica a
implementa
implementa