Component
core/devtool/harbor
A Harbor container registry, declared as one component and deployed as one unit: an API and token-service control plane, an OCI blob store, a web console, an asynchronous worker tier, a vulnerability scanner, a relational backend and a key-value cache, so the registry stands up with nothing else declared beside it. An Aggregate declaring it gets a registry container clients log in to, push to and pull from, and a console to administer it, both behind the one in-cluster address `provides` publishes. Six keys and shared secrets have no default and the build halts until each slot is filled: token_key, the key the token service signs with and its certificate; core_secret, jobservice_secret and registry_http_secret, the secrets its services authenticate to each other and sign upload state with; csrf_key, the key the control plane signs request-forgery tokens with; and secret_key, the key it encrypts stored credentials with. Each is read from a Kubernetes Secret by name, so none reaches the rendered artifact. The passwords — the administrator's, in its slot, and the backend's and the blob store's account, in `infra` — take development values the Recipe states when left unattached and unset, for evaluation and development. Those values are published in this catalog: a Release serving real traffic replaces them. With `values.metrics_enabled` true the Recipe turns on the Prometheus metrics of the control plane, worker tier, blob store and exporter and publishes their four Services as `metrics_service`; false, those keys are empty. The switch also opens the blob store's debug listener — profiling, execution traces and runtime variables, no caller check — to every in-cluster caller.
Provenance
- Content digest
- sha256:25d89a6d6fb7205d31f43b5b859b78b01d47f95942ca76a01d8ce8a2f6c9f39f
- Published
- 2026-11-10T10:11:34Z
- 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:98cb969e18ee651a7aa4cf25df2d375fe6b2cabe65777885a693d68331a59f53
Reference at this version
oci://hub.aggrega.ai/component/core/devtool/harbor:1.0.0Developer parameters
Values the developer sets in the Aggregate.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| log_level | string | — | no | Log verbosity the registry's services run at (debug, info, warning, error or fatal). Omit to use the product's default (info). |
| metrics_enabled | boolean | false | no | Turns on the registry's own metrics, in the Prometheus format at /metrics on port 8001 of the control plane, the worker tier, the blob store and the exporter, puts that port on each one's Service, and publishes the four Services for a scraper to discover as `metrics_service`, beside `metrics_service_port` and `metrics_path`; while false those keys are empty. The same setting moves the blob store's debug listener from the pod's loopback address onto every interface and names its port on the blob store's Service, newly opening it to every in-cluster caller that reaches the pod. That listener checks no caller and, beside the metrics, serves /debug/pprof (CPU profiles and execution traces on request, heap and goroutine dumps, the command line) and /debug/vars (the command line, memory statistics and runtime counters); it has no route that changes the registry. The registry's chart offers no way to turn the metrics on without it. |
Operator sizing
Infrastructure sizing the operator tunes per environment.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| port | integer (min 1, max 65535) | 80 | no | Port the registry's single published address accepts traffic on. It sets the Service port only — the reverse proxy behind it listens on a port the product fixes — so any value in range is servable, including the privileged ports a registry is conventionally reached on. |
| external_base_url | string | — | no | Externally reachable address of the registry, as assembled at the ingress tier — scheme, host and, where it is not the scheme's default, port, with no path; for example https://registry.example.com. The registry composes from this the token-service address it returns to a container client that logs in, and the push and pull commands its console shows, so a client outside the cluster is sent somewhere it can reach. A container client addresses a registry at the root of a host, so the Recipe halts the build on an address carrying a path. Omitted, the Recipe gives the registry its in-cluster address, which is correct for a registry nobody reaches from outside the cluster. |
| engine_version | string | v2.15.2 | no | Harbor container image tag. The product ships every one of its service images on a single tag, so this one value selects them all. Moving it away from the Recipe's default is not guaranteed to match the chart the Recipe pulls; move source_version with it. |
| source_version | string | — | no | Version of the Helm chart the Recipe pulls. Changing it away from the Recipe's default does not guarantee value-mapping compatibility with the new chart. |
| compute | object | — | no | — |
| storage | object | — | no | — |
| database_password | string | — | no | Password for the account the control plane connects to its relational backend as. Left unset, helm/harbor-chart uses the development literal `apppass`, which this catalog publishes, so every Release that leaves it unset shares that password. |
| registry_username | string | harbor_registry_user | no | Account name the control plane and the worker tier present to the blob store. Set it together with registry_password and registry_htpasswd, or set none of the three. |
| registry_password | string | — | no | Password the control plane and the worker tier present to the blob store. Set it together with registry_username and registry_htpasswd, or set none of the three. Left unset, helm/harbor-chart uses the development literal `harbor_registry_password` and a development htpasswd line in place of registry_htpasswd, both published in this catalog, so every Release that leaves the three unset shares that account. |
| registry_htpasswd | string | — | no | The other two keys as a single htpasswd line — `<registry_username>:<bcrypt hash of registry_password>` — which is the form the blob store checks a presented account against. Produce it with `htpasswd -nbB <username> <password>`. Set it together with the other two, or set none of the three. |
| 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 whole registry. A container client logs in, pushes and pulls against this name, and a browser reaches the console on it. |
| port | integer | — | yes | TCP port that Service accepts traffic 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_service | string | — | no | Names of the Services the registry's metrics sit behind, comma-separated — the control plane's, the blob store's, the worker tier's and the exporter's, `<host>-core,<host>-registry,<host>-jobservice,<host>-exporter` where `<host>` is the published host — for a scraper that discovers each endpoint of those Services rather than scraping one address. Published beside `metrics_service_port` and `metrics_path` while values.metrics_enabled is true; empty otherwise. |
| metrics_service_port | string | — | no | Name of the port of each of those Services that carries the metrics, `http-metrics`. Set and empty together with `metrics_service`. |
| metrics_path | string | — | no | Path the metrics are served at on that port, `/metrics`. Set and empty together with `metrics_service`. |
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 |
|---|---|---|---|---|---|
| token_key | feature.aggrega.ai/kind=secret | yes | — | yes | Required credential holding the RSA private key the registry's token service signs its tokens with, and the certificate over that key: a Kubernetes Secret carrying the PEM key under the data key tls.key and the PEM certificate under tls.crt, as a kubernetes.io/tls Secret does. The Recipe names that Secret, so the key never appears in the rendered artifact. There is no default: the build halts when nothing fills this slot, and when the credential filling it publishes no Secret name. |
| core_secret | feature.aggrega.ai/kind=secret | yes | — | yes | Required credential holding the shared secret the control plane, the worker tier and the blob store's controller authenticate to each other with: a Kubernetes Secret carrying it under the data key secret, exactly 16 characters. The Recipe names that Secret, so the secret never appears in the rendered artifact. There is no default: the build halts when nothing fills this slot, and when the credential filling it publishes no Secret name. |
| csrf_key | feature.aggrega.ai/kind=secret | yes | — | yes | Required credential holding the key the control plane signs its cross-site request forgery tokens with. It must be exactly 32 characters; a shorter or longer value is refused by the control plane at start-up. The Recipe names the Secret and the data key the credential publishes. There is no default: the build halts when nothing fills this slot, and when the credential filling it publishes no Secret name and data key. |
| secret_key | feature.aggrega.ai/kind=secret | yes | — | yes | Required credential holding the key the control plane encrypts stored credentials with — the credentials of the upstream registries it replicates from and to: a Kubernetes Secret carrying it under the data key secretKey, exactly 16 characters. Changing it on a registry that already holds replication credentials makes those credentials unreadable, so it is set once, when the registry is first stood up. The Recipe names that Secret, so the key never appears in the rendered artifact. There is no default: the build halts when nothing fills this slot, and when the credential filling it publishes no Secret name. |
| jobservice_secret | feature.aggrega.ai/kind=secret | yes | — | yes | Required credential holding the shared secret the worker tier and the control plane authenticate to each other with, 16 characters as the registry's Helm chart documents it. The Recipe names the Secret and the data key the credential publishes, so the secret never appears in the rendered artifact. There is no default: the build halts when nothing fills this slot, and when the credential filling it publishes no Secret name and data key. |
| registry_http_secret | feature.aggrega.ai/kind=secret | yes | — | yes | Required credential holding the secret the blob store signs its upload state with, which every replica of the blob store must share, 16 characters as the registry's Helm chart documents it. The Recipe names the Secret and the data key the credential publishes, so the secret never appears in the rendered artifact. There is no default: the build halts when nothing fills this slot, and when the credential filling it publishes no Secret name and data key. |
| admin_password | feature.aggrega.ai/kind=secret | no | — | yes | Optional credential for the registry's built-in administrator account, the account the web console and the API are first administered through. Unattached, helm/harbor-chart sets its password to the development literal `Harbor12345`, which this catalog publishes, so every Release that leaves the slot unattached shares that password. |
Self-inject allowlist
No self-inject pipes declared.
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 «backend»
uses socket «databases»
uses socket «etcd»
uses socket «backend»
uses socket «backend»
uses socket «forward_target»
uses socket «scrape_target»
uses socket «backend»
uses socket «database»
applies to
applies to
applies to
implements