Component
core/observability/grafana
A Grafana dashboards and visualization server. It keeps its own state — users, saved dashboards, preferences — in a local database, so it renders as a server backed by a persistent volume. It ships standalone: it declares no socket for a metrics or logs source to be wired in as a provisioned data source. Exports its web endpoint host and port to consumers. Grafana serves its own metrics in the Prometheus format at /metrics on its web port, on by default, and every Recipe publishes that address as `metrics_endpoint`. An admin account is always present: its username is a developer value and its password is wired through the optional `admin_password` credential slot. Unattached, the Recipe supplies a deterministic development default instead of a generated password, so the render stays byte-identical across runs. Realized for local development by a Compose Recipe, and on Kubernetes by two realizations the Manifest chooses between. `grafana` synthesizes the server as a workload and fetches nothing, so it is the one to reach for where the build must complete with no chart repository reachable. `grafana-chart` renders the community-maintained Grafana Helm chart, which additionally carries the server's own provisioning surface — data sources and dashboards declared in the Release through `infra.overrides` — so reach for it where a chart repository is reachable at build time.
Provenance
- Content digest
- sha256:ab7fe1c272c221228349de7a879d5fc5aa617b7bf9c72a1a0817ea27fb0637b2
- Published
- 2026-11-10T10:12:59Z
- 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:df5f02cc96cc0380b8a460b04b9c30d5f9011b9545fcc27dd853627ce411e716
Reference at this version
oci://hub.aggrega.ai/component/core/observability/grafana:1.0.0Developer parameters
Values the developer sets in the Aggregate.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| admin_user | string | admin | no | Grafana admin account username. The account is always created; its password is wired through the optional `admin_password` credential slot. |
Operator sizing
Infrastructure sizing the operator tunes per environment.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| port | integer (min 1024, max 65535) | 3000 | no | HTTP port the Grafana web and query endpoint listens on. Most operators should omit this and let the Recipe assign the default (3000). |
| external_base_url | string | — | no | Externally reachable base URL of the dashboards server, as assembled at the ingress tier, including any path the ingress serves it under — for example https://grafana.example.com or https://tools.example.com/grafana. The server composes from this every link it writes, the address it redirects a browser to, and the callback address it hands a sign-in provider, so a shared dashboard link and a sign-in both resolve from outside the cluster. The server keeps serving at its own root, so an ingress in front of it maps the address's path onto that root. Omitted, the server keeps its default root address, composed from its own listening port rather than from an address a browser uses, which suits a server nobody opens from outside the cluster. |
| engine_version | string | 12.1.1 | no | Grafana 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 and Compose realizations pull no source artifact and ignore it. Changing it away from the Recipe's default does not guarantee value-mapping compatibility with the new chart. |
| compute | object | — | no | — |
| storage | object | — | no | — |
| overrides | object (open) | — | no | Provider-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.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| host | string | — | yes | In-cluster DNS name of the Service fronting the web and query endpoint. A gateway routing browser traffic to the dashboards points its upstream at this name. |
| port | integer | — | yes | TCP port that Service serves the web and query endpoint on. It follows the port an operator set in the Release, so a consumer reads it rather than assuming a default. |
| protocol | string | — | no | How the published address is spoken to — `http`, so a consumer composes an address on that scheme. |
| metrics_endpoint | string | — | no | The full address Prometheus scrapes this component's metrics at — scheme, host, port and path, `http://<host>:<port>/metrics` on the web endpoint. Empty where the component serves none reachable. |
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.
| Slot | Selector | Required | Inject | Sensitive | Description |
|---|---|---|---|---|---|
| admin_password | feature.aggrega.ai/kind=secret | no | env | yes | Optional Grafana admin-password credential. When attached, supplies the admin password via the credential subsystem. Unattached, compose/grafana, helm/grafana and helm/grafana-chart set the admin password to the development literal `dev-grafana-admin-change-me`, 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
This entity uses nothing in the catalog.
Used by
uses socket «upstream»
uses socket «forward_target»
uses socket «scrape_target»
uses socket «store»
applies to
applies to
applies to
applies to
applies to
applies to
applies to
implements
implements
implements