Skip to main content

Configuration

Each field is set as HOUBA_<FIELD> (the property name upper-cased). JSON-typed fields (registries, transform_ca_certs, transform_package_mirrors, retention) take a JSON value whose shape is documented in the schemas section. The machine-readable contract is config.schema.json.

VariableTypeDefaultDescription
HOUBA_LABEL_PREFIXstringio.houbaPrefix for houba's own provenance annotations; empty ⇒ no houba labels (OCI-standard keys only).
HOUBA_REGISTRIESJSON object{}JSON map of logical registry name → RegistryConfig. At least one is needed to reconcile.
HOUBA_LOG_FORMATstringtextLog output format: text or json.
HOUBA_LOG_LEVELstringINFOMinimum log level.
HOUBA_DRY_RUN_TAGSbooleanfalseSkip image copies / pushes.
HOUBA_DRY_RUN_DELETIONSbooleanfalseSkip deletions.
HOUBA_DELETION_MODEstringpurgeGlobal baseline of the deletion-mode cascade.
HOUBA_RETENTIONJSON object(unset)Global tier of the retention cascade (a JSON Archive); unset ⇒ retention off everywhere.
HOUBA_WORK_DIRstring/tmp/houba-workScratch directory for build contexts.
HOUBA_TRANSFORM_CA_CERTSJSON object{}JSON map of name → CA source, resolved by the injectCA transform.
HOUBA_TRANSFORM_PACKAGE_MIRRORSJSON object{}JSON map of name → package mirror, resolved by rewritePackageSources.
HOUBA_BUILD_PLATFORMstringlinux/amd64Platform for the rebuild path (single-platform).
HOUBA_SBOM_FORMATSJSON list["spdx-json"]SBOM formats syft emits on every placed image (copy and rebuild), as a JSON list. Allowed: spdx-json, cyclonedx-json. Non-empty — the knob chooses which formats, never whether (always-on coverage).
HOUBA_MAX_CONCURRENCYinteger4Max parallel tag operations per run (1 = sequential).
HOUBA_ATTEST_SIGNERstring(empty)Signing mode for SLSA attestations on the rebuild path; empty ⇒ off.
HOUBA_ATTEST_KEY_REFstring(empty)KMS URI (kms) or key path (key).
HOUBA_ATTEST_FULCIO_URLstring(empty)Keyless CA URL; blank ⇒ public Fulcio.
HOUBA_ATTEST_REKOR_URLstring(empty)Transparency-log URL; blank ⇒ no log entry.
HOUBA_ATTEST_BUILDER_IDstring(empty)URI identifying this houba builder.
HOUBA_USAGE_ORACLE_CMDstring(unset)Executable speaking the usage-oracle contract; required to run houba purge.
HOUBA_USAGE_ORACLE_TIMEOUTinteger30Per-query timeout (seconds) for the usage oracle.
HOUBA_PURGE_MIN_IDLE_DAYSinteger(unset)Idle window houba purge requires before reaping a marked tag.