Catalog Options Reference

Usage

nixda.catalog.

_nixda.versionDeclaration

Type: null or (submodule)

Populated by blueprint mk constructors (ADR-0001). Mirrors the service-submodule attribute of the same name so consumers can carry the version triple from config.nixda.catalog. into nixda.zones..services. via lib.recursiveUpdate.

_nixda.versionDeclaration.composed

Type: attribute set of string

Per-version-key fully-composed image string the blueprint would materialize from effective. Used by the drift module to detect silent image-string overrides.

Mirrors the service-submodule option of the same name in modules/service/interface.nix.

_nixda.versionDeclaration.declared

Type: null or (attribute set of string)

Consumer-supplied versions attrset captured at the blueprint mk call site. null means the consumer inherited blueprint defaults; a non-null value means the consumer explicitly pinned one or more keys.

Mirrors the service-submodule option of the same name in modules/service/interface.nix.

_nixda.versionDeclaration.effective

Type: attribute set of string

The version map that was actually composed into the runtime image string (i.e. declared merged over recommended). Populated by the blueprint constructor; not set by consumers.

Mirrors the service-submodule option of the same name in modules/service/interface.nix.

_nixda.versionDeclaration.recommended

Type: attribute set of string

The blueprint’s current default version map at the time of mk invocation. Populated by the blueprint constructor; not set by consumers.

Mirrors the service-submodule option of the same name in modules/service/interface.nix.

dependsOn

Type: list of string

Default: [ ]

Default service names (within the same zone) that must start before this service.

idleTimeout

Type: null or signed integer

Default: 43200

Default idle timeout in seconds (null to disable).

ports

Type: list of 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: [ ]

Default TCP ports the service listens on.

restart.delaySec

Type: signed integer

Default: 10

Initial delay between restarts in seconds.

restart.limitBurst

Type: signed integer

Default: 10

Maximum restart attempts within limitIntervalSec.

restart.limitIntervalSec

Type: signed integer

Default: 1800

Time window for restart limit in seconds.

restart.maxDelaySec

Type: signed integer

Default: 300

Maximum delay between restarts in seconds (exponential backoff ceiling).

restart.steps

Type: signed integer

Default: 5

Number of exponential backoff steps from delaySec to maxDelaySec.

runtime.native

Type: null or (submodule)

Native NixOS container runtime defaults.

runtime.native.configuration

Type: module

Default NixOS configuration for the container.

runtime.native.credentials

Type: attribute set of path

Default credential mappings (name -> host path).

runtime.native.volumes

Type: list of string

Default: [ ]

Default bind mounts.

runtime.oci

Type: null or (submodule)

OCI container runtime defaults.

runtime.oci.environment

Type: attribute set of string

Default environment variables.

runtime.oci.image

Type: string

OCI image reference.

runtime.oci.pod

Type: attribute set of (submodule)

Additional containers grouped into a Podman pod with the entrypoint.

runtime.oci.pod.<name>.cmd

Type: list of string

Default: [ ]

Override the container command.

runtime.oci.pod.<name>.environment

Type: attribute set of string

Environment variables for this pod member.

runtime.oci.pod.<name>.image

Type: string

OCI image reference.

runtime.oci.pod.<name>.volumes

Type: list of string

Default: [ ]

Default volume mounts for this pod member.

runtime.oci.volumes

Type: list of string

Default: [ ]

Default volume mounts (host:container).

runtime.system

Type: null or (submodule)

System service runtime defaults.

runtime.system.configuration

Type: null or module

Default configuration to apply to the host.

runtime.vm

Type: null or (submodule)

MicroVM runtime defaults.

runtime.vm.configuration

Type: module

Default NixOS configuration for the MicroVM.

runtime.vm.cores

Type: signed integer

Default: 1

Default CPU cores.

runtime.vm.ram

Type: signed integer

Default: 1024

Default RAM in MB.

runtime.vm.volumes

Type: list of string

Default: [ ]

Default shared directories/volumes.

stripPrefix

Type: boolean

Default: true

Whether to strip the service name prefix from request paths.