fleetkit

A parameterized NixOS fleet framework: fleet manifest schema, terranix emitters (Proxmox VE, Xen Orchestra, Cloudflare, Grafana), colmena integration via lib.mkFleet, an operator CLI (fleet), and a generic infra module tree.

Every site-specific value lives behind the options documented here — fleet.* (the manifest schema: compute, network, settings) and infra.* (the NixOS service modules). Nothing is baked in.

Start from the template:

$ nix flake init -t github:alexanderjerome/fleetkit
$ fleet secrets init

The Fleet manifest and Infra modules references are generated from the module declarations on every build — they cannot drift from the code.

Compute surface and networking modes

Every knob the community-scripts LXC/VM wizard asked for has a home in fleet.compute.<name> (see the fleet.compute reference). This page maps the two.

From the wizard to `fleet.compute`

community-scripts (`build.func` / `vm-core.func`)	fleetkit
`CT_TYPE` / `var_unprivileged`	`privileged`
`CT_ID` / `VMID`	`vm_id`
`HN`	attribute name / `name`
`DISK_SIZE`, `CORE_COUNT`, `RAM_SIZE`	`root_disk_gb`, `cpu_cores`, `memory_mb` (+ `swap_mb`)
storage picker (`var_container_storage`)	`root_disk_datastore` (default `fleet.settings.providers.proxmox.defaultDatastore`)
template storage (`var_template_storage`)	`fleet.settings.providers.proxmox.lxcTemplateDatastore`
`BRG` / SDN vnet	`interfaces[].bridge` / `interfaces[].vnet` (+ `sdn-zone`/`sdn-vnet` resources)
`NET` dhcp / static / range	`interfaces[].ipv4` = `"dhcp"` / `"a.b.c.d/nn"` (ranges are not declarative)
`GATE`	`interfaces[].gateway`
`IPV6_METHOD` auto/dhcp/static/none/disable	`interfaces[].ipv6.method` (disable ≡ none)
`MTU`, `VLAN`, `MAC`	`interfaces[].mtu`, `.vlan`, `.mac`
`NS`, `SD`	`dns.servers`, `dns.domain`
`ENABLE_FUSE`, `ENABLE_NESTING`, `ENABLE_KEYCTL`, `ENABLE_MKNOD`, `ALLOW_MOUNT_FS`	`features.{fuse,nesting,keyctl,mknod,mount}`
`ENABLE_TUN`, `ENABLE_GPU`, Coral, USB serial	`devices` (+ `lxc_extra_conf` for hot-plug cgroup rules)
`PROTECT_CT`	`protection`
`TAGS`	`tags`
`var_post_install` hook	`hook_script` (PVE hook), or a NixOS activation script
`CT_TIMEZONE`	NixOS `time.timeZone` in the host’s `hostsRegistry` entry
`PW`, `SSH`, `SSH_AUTHORIZED_KEY`	not applicable: NixOS hosts are key-only (`fleet.network.sysadmin_ssh_key`), root has no password
`APT_CACHER`, `HTTP_PROXY`, `INHERIT_HOST_CA`	NixOS `nix.settings.substituters`, `networking.proxy`, `security.pki`
VM `MACHINE`, `BIOS`, `CPU_TYPE`, `DISK_CACHE`, `scsihw`, `-tablet 0`	`vm.machine`, `vm.bios` (+ `vm.efi`), `vm.cpu_type`, `vm.root_disk.cache`, `vm.scsi_hardware`, `vm.tablet`
VM cloud-init on/off	`cloud_init.enable`, `cloud_init.datastore`
VM cloud image (`qm importdisk`)	`image = "import:<datastore>:import/<file>"` with a `download` resource
`START_VM`, `-onboot 1`	`start_on_create`, `onboot`, `startup`

Network modes

network_mode = "declared" is the general form: interfaces lists every NIC with its bridge or VNet, IPv4 (dhcp, manual, or a CIDR with an explicit prefix), gateway, IPv6, VLAN, MTU, MAC and firewall flag; entry i becomes net<i> (LXC: eth<i>).

The fixed shapes (single-internal, single-external, dual, lxc-router, custom-*) predate it and remain for existing fleets. They append fleet.network.internal_prefix_len / lan_prefix_len (derived from the CIDRs, else 24) to the bare internal_ip / ip. New hosts should use declared; the legacy modes will be deprecated once the origin fleet has migrated.

Escape hatch

lxc_extra_conf writes raw lines into /etc/pve/lxc/<vmid>.conf inside a marker block through a terraform_data local-exec over root SSH to the node (fleet.providers.proxmox.<inst>.cluster.node_addresses). Use it only for what devices cannot express.

Fleet manifest

The declarative fleet description: what your fleet is. Consumers set these in the modules passed to mkFleet.

fleet.settings — 62 options
fleet.network — 18 options
fleet.compute — 154 options
fleet.providers — 285 options
fleet.resources — 8 options
fleet.other — 65 options

fleet.settings

62 options

`fleet.settings.acmeEmail`

Email for ACME account registration (internal CA and public Let’s Encrypt). null ⇒ no ACME issuance; required (asserted) by infra.ingress and by host-cert when an internal CA is configured.

Type: null or string

Default:

null

Example:

"admin@example.com"

Declared by: nix/fleet/settings.nix

`fleet.settings.adminSshKeys`

SSH public keys authorized for the built-in operator accounts (sysadmin / colmena / dev / root) on every fleet host. REQUIRED BY THE BASE LAYER — every NixOS fleet host creates these accounts, so building any host toplevel forces this option.

Type: list of string

Default:

[ ]

Example:

[
  "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIREPLACEMEexamplekeyexamplekeyexample operator@example.com"
]

Declared by: nix/fleet/settings.nix

`fleet.settings.auth.oidcBaseUrl`

Base URL of the fleet’s OIDC identity provider (e.g. Authentik). Required by modules that enable OIDC login (e.g. infra.observability.stack.oidc).

Type: null or string

Default:

null

Example:

"https://auth.example.dev"

Declared by: nix/fleet/settings.nix

`fleet.settings.auth.outpostUrl`

Base URL of the identity provider’s forward-auth outpost (e.g. the Authentik embedded outpost). null ⇒ no forward_auth injection by default.

Type: null or string

Default:

null

Example:

"http://192.0.2.13:9000"

Declared by: nix/fleet/settings.nix

`fleet.settings.backend.bucket`

Tofu S3 state bucket (type = s3). Shared estate substrate (ADR-097) — fleet separation is the state KEY prefix, not the bucket. When set, mkFleet’s backend argument may be omitted.

Type: null or string

Default:

null

Example:

"acme-tofu"

Declared by: nix/fleet/settings.nix

`fleet.settings.backend.perStack`

Per-stack backend overrides, keyed by stack SLUG (the dot-path with “.” replaced by “-”, e.g. “platform.core” -> “platform-core”). Each value is merged over the fleet-wide backend, so an override may set only what differs (usually just type).

The backend block is already emitted per stack, so this costs nothing structurally. Two uses it exists for:

Keep working when the shared bucket is unreachable — provision a NEW stack on type = "local" while every existing stack stays pointed at the remote it already lives in.
Break a bootstrap cycle — a stack that provisions the fleet’s own object storage should not keep its state inside that storage.

DELIBERATE ACT, NOT A FALLBACK. Pointing an EXISTING stack at an empty backend makes tofu read its entire inventory as “not created yet”, and an apply from there would recreate the fleet. Override a stack that has no remote state yet, or migrate the state first and record that you did.

Type: attribute set of attribute set of raw value

Default:

{ }

Example:

{ "platform-mcp" = { type = "local"; }; }

Declared by: nix/fleet/settings.nix

`fleet.settings.backend.pg.connStrSopsPath`

SOPS path to the libpq connection string, exported as PG_CONN_STR at run time.

The connection string is DELIBERATELY not emitted into the backend block: config.tf.json is built by Nix and therefore lands in /nix/store, which is world-readable. A password baked in there is readable by every user on every machine that builds the stack, and no amount of file permissions afterwards takes it back. OpenTofu reads PG_CONN_STR from the environment for exactly this reason.

Type: null or string

Default:

null

Example:

"[\"dbs\"][\"tofu-db\"][\"tofu\"][\"conn_str\"]"

Declared by: nix/fleet/settings.nix

`fleet.settings.backend.pg.schemaPrefix`

Schema-name prefix for the pg backend. Each stack gets its own schema (<prefix><slug>), which is how stacks stay isolated in one database — the equivalent of the S3 key prefix.

Type: string

Default:

"tf_"

Declared by: nix/fleet/settings.nix

`fleet.settings.backend.region`

AWS region of the state bucket (type = s3).

Type: string

Default:

"us-east-1"

Declared by: nix/fleet/settings.nix

`fleet.settings.backend.s3.credsSopsPath`

SOPS path to the S3 state-backend credentials — a mapping with access_key_id, secret_access_key, and optionally region — exported as AWS_* at run time. Defaults to ["integrations"]["aws"].

This is a setting rather than a constant because the AWS name is a site opinion, not a fact about the backend: a fleet whose state lives in Garage or MinIO files those keys under its own tree. When the CLI guessed, the extract simply returned non-zero and the credentials silently stayed unset — surfacing much later as tofu reporting no valid credential sources, with nothing pointing at the real cause.

Type: null or string

Default:

null

Example:

"[\"integrations\"][\"tofu\"][\"garage\"]"

Declared by: nix/fleet/settings.nix

`fleet.settings.backend.type`

Tofu state backend kind. “local” keeps terraform.tfstate inside each stack’s working dir (.tf//) — no bucket, no cloud creds; fine for a homelab, but the state only exists on the machine that ran the apply. “s3” (default) is the shared-bucket estate model (ADR-097). “pg” is Postgres, the on-prem option that provides REAL locking via advisory locks — S3-compatible stores that cannot do conditional writes (Garage, by design) leave use_lockfile silently ineffective, which is unsafe wherever more than one operator or agent applies.

Type: one of "s3", "local", "pg"

Default:

"s3"

Declared by: nix/fleet/settings.nix

`fleet.settings.build.machines`

Remote build machines available to the fleet. Listing one here does NOT make any host use it: a host opts in via infra.build.remote.enable, because offloading means shipping that host an SSH private key.

Type: list of (submodule)

Default:

[ ]

Declared by: nix/fleet/settings.nix

`fleet.settings.build.machines.*.hostName`

Address the offloading host connects to over SSH. An in-fleet IP, not a public name.

Type: string

Default: none (required when its feature is enabled)

Example:

"192.0.2.101"

Declared by: nix/fleet/settings.nix

`fleet.settings.build.machines.*.maxJobs`

Jobs the offloading host may run on this machine concurrently.

Type: signed integer

Default:

Declared by: nix/fleet/settings.nix

`fleet.settings.build.machines.*.publicHostKey`

Base64 of the machine’s SSH host key line, produced by base64 -w0 < /etc/ssh/ssh_host_ed25519_key.pub. Leaving this null makes the offload depend on the client’s known_hosts, which nothing in the fleet populates — the first build then hangs on host-key verification rather than failing.

Type: null or string

Default:

null

Example:

"c3NoLWVkMjU1MTkgQUFBQUV4YW1wbGVFeGFtcGxlRXhhbXBsZQ=="

Declared by: nix/fleet/settings.nix

`fleet.settings.build.machines.*.speedFactor`

Relative speed weight. Only meaningful when more than one machine can serve the same system.

Type: signed integer

Default:

Declared by: nix/fleet/settings.nix

`fleet.settings.build.machines.*.sshUser`

User to connect as. Must appear in the builder’s infra.build.builder.trustedUsers, or its daemon refuses the store operations an offloaded build needs.

Type: string

Default:

"root"

Declared by: nix/fleet/settings.nix

`fleet.settings.build.machines.*.supportedFeatures`

Features this machine advertises. A derivation requiring a feature absent here is never sent to it. Do not advertise kvm on an unprivileged LXC builder.

Type: list of string

Default:

[
  "nixos-test"
  "benchmark"
  "big-parallel"
]

Example:

[
  "nixos-test"
  "benchmark"
  "big-parallel"
  "kvm"
]

Declared by: nix/fleet/settings.nix

`fleet.settings.build.machines.*.systems`

Platforms this machine will build for.

Type: list of string

Default:

[
  "x86_64-linux"
]

Declared by: nix/fleet/settings.nix

`fleet.settings.cache.substituters`

In-fleet nix binary caches trusted by fleet hosts (harmonia/attic/…).

Type: list of string

Default:

[ ]

Example:

[
  "http://192.0.2.101:5000"
]

Declared by: nix/fleet/settings.nix

`fleet.settings.cache.trustedPublicKeys`

Public keys matching substituters.

Type: list of string

Default:

[ ]

Example:

[
  "cache.example.dev:MExampleExampleExampleExampleExampleExampleExa="
]

Declared by: nix/fleet/settings.nix

`fleet.settings.cli.extensionsDir`

Repo-relative directory of consumer CLI extension modules (ADR-095 COMMANDS/ATTACH files).

Type: string

Default:

"cli-ext"

Declared by: nix/fleet/settings.nix

`fleet.settings.domain.base`

Public base domain (external DNS zone). null ⇒ no public-name features; required (asserted) by modules that mint public names: caddy devDomain vhosts, coredns split-horizon zone, acme-dns, hydra/grafana mail senders, pve-installer-answers.

Type: null or string

Default:

null

Example:

"example.dev"

Declared by: nix/fleet/settings.nix

`fleet.settings.domain.internal`

Internal search/zone domain served by fleet DNS. null ⇒ no internal-FQDN features; required (asserted) by caddy, coredns, host-cert (internal CA), step-ca, hydra, rabbitmq management vhosts.

Type: null or string

Default:

null

Example:

"example.pve"

Declared by: nix/fleet/settings.nix

`fleet.settings.domain.tailnetSuffix`

MagicDNS base domain of the fleet tailnet (headscale base_domain). null ⇒ no tailnet serveUI names; required (asserted) when infra.network.tailnet.serveUI entries exist.

Type: null or string

Default:

null

Example:

"hs.example.dev"

Declared by: nix/fleet/settings.nix

`fleet.settings.githubAccessTokens`

Provision a GitHub machine-user token (SOPS integrations/github/machine_user_token) into nix access-tokens on every host — needed when flake inputs fetch private GitHub repos.

Type: boolean

Default:

false

Declared by: nix/fleet/settings.nix

`fleet.settings.internalCa.acmeDirectory`

ACME directory URL of the internal CA. null ⇒ modules default to public Let’s Encrypt.

Type: null or string

Default:

null

Example:

"https://ca.example.lan:9000/acme/acme/directory"

Declared by: nix/fleet/settings.nix

`fleet.settings.internalCa.certFile`

Root certificate of the fleet-internal CA (step-ca). Trusted on every host and used as the Caddy ACME root when set.

Type: null or absolute path

Default:

null

Example:

./certs/fleet-root-ca.crt

Declared by: nix/fleet/settings.nix

`fleet.settings.mcp.grafanaTokenSopsPath`

Sops key path of the read-only Grafana service-account token used by fleet mcp config.

Type: null or string

Default:

null

Example:

"services/grafana/mcp_token"

Declared by: nix/fleet/settings.nix

`fleet.settings.name`

Short fleet/org slug. Used for branding and resource-name prefixes (attic cache name, hydra project, step-ca CA name, pgweb bookmarks).

Type: string

Default:

"fleet"

Example:

"acme"

Declared by: nix/fleet/settings.nix

`fleet.settings.network.lanCidr`

Fleet LAN CIDR (mirrors fleet.network.internal_cidr for module convenience). null ⇒ modules that default network ACLs from it (e.g. infra.data.postgresql.allowedSubnets) default to an empty list instead.

Type: null or string

Default:

null

Example:

"192.0.2.0/24"

Declared by: nix/fleet/settings.nix

`fleet.settings.network.mgmtCidr`

Hypervisor/management network CIDR, if separate from the LAN.

Type: null or string

Default:

null

Example:

"198.51.100.0/24"

Declared by: nix/fleet/settings.nix

`fleet.settings.network.staticWanCidrs`

VM name → WAN-side CIDR for legacy name-dispatch VMs whose fleet entry keeps ip = "" (so Colmena resolves internal_ip) but still needs a pinned WAN address on eth0. Consumed by the headscale-router branch of nix/lib/tf/proxmox.nix mkVm. {} ⇒ no pins; the emitter throws if a VM hits that branch without an entry here.

Type: attribute set of string

Default:

{ }

Example:

{
  headscale-router = "198.51.100.7/24";
}

Declared by: nix/fleet/settings.nix

`fleet.settings.network.upstreamResolvers`

Upstream DNS servers the fleet DNS forwards non-fleet queries to (e.g. the LAN gateway or public resolvers).

Type: list of string

Default:

[
  "1.1.1.1"
  "9.9.9.9"
]

Example:

[
  "198.51.100.1"
  "1.1.1.1"
]

Declared by: nix/fleet/settings.nix

`fleet.settings.network.wanIp`

Public WAN IP of the fleet edge (stable pointer for public DNS pins). null ⇒ no public-edge features; required (asserted) by infra.pki.acmeDns (glue/apex A records).

Type: null or string

Default:

null

Example:

"203.0.113.10"

Declared by: nix/fleet/settings.nix

`fleet.settings.observability.cpuAlertExcludeRegex`

Prometheus instance-label regex excluded from the fleet-wide high-CPU alert (hosts that legitimately run hot). “” ⇒ no exclusions.

Type: string

Default:

""

Example:

"chain-node-.*|miner-.*"

Declared by: nix/fleet/settings.nix

`fleet.settings.observability.grafanaDomain`

Domain Grafana serves on (server.domain / root_url). null ⇒ no observability stack; required (asserted) when infra.observability.stack is enabled.

Type: null or string

Default:

null

Example:

"grafana.example.pve"

Declared by: nix/fleet/settings.nix

`fleet.settings.observability.lokiPushUrl`

Loki push endpoint every fleet host’s Alloy agent ships logs to (usually the grafana-stack host). null (together with prometheusRemoteWriteUrl = null) ⇒ Alloy stays disabled by default fleet-wide; required (asserted) when infra.observability.alloy is enabled.

Type: null or string

Default:

null

Example:

"http://192.0.2.4:3100/loki/api/v1/push"

Declared by: nix/fleet/settings.nix

`fleet.settings.observability.lokiS3Endpoint`

S3-compatible endpoint (e.g. in-fleet Garage) Loki writes chunks and index to. null ⇒ no Loki chunk store; required (asserted) when infra.observability.stack is enabled.

Type: null or string

Default:

null

Example:

"http://s3.example.lan:3900"

Declared by: nix/fleet/settings.nix

`fleet.settings.observability.prometheusRemoteWriteUrl`

Prometheus remote-write endpoint every fleet host’s Alloy agent ships metrics to (usually the grafana-stack host). null (together with lokiPushUrl = null) ⇒ Alloy stays disabled by default fleet-wide; required (asserted) when infra.observability.alloy is enabled.

Type: null or string

Default:

null

Example:

"http://192.0.2.4:9090/api/v1/write"

Declared by: nix/fleet/settings.nix

`fleet.settings.observability.pveScrapeTargets`

Proxmox VE hypervisors scraped via prometheus-pve-exporter: instance label → node API address. {} ⇒ no PVE targets.

Type: attribute set of string

Default:

{ }

Example:

{
  pve1 = "198.51.100.1";
  pve2 = "198.51.100.2";
}

Declared by: nix/fleet/settings.nix

`fleet.settings.observability.tempoUrl`

HTTP URL of the fleet’s Tempo trace store. null ⇒ no Tempo datasource is provisioned in Grafana.

Type: null or string

Default:

null

Example:

"http://192.0.2.9:3200"

Declared by: nix/fleet/settings.nix

`fleet.settings.opsEmail`

Operations contact. null ⇒ the CLI derives ops@<domain.base>.

Type: null or string

Default:

null

Example:

"ops@example.dev"

Declared by: nix/fleet/settings.nix

`fleet.settings.pki.acmeDnsApiBase`

acme-dns registration API on the fleet’s DNS edge. Consumed by fleet pki (required, asserted there).

Type: null or string

Default:

null

Example:

"http://192.0.2.100:8081"

Declared by: nix/fleet/settings.nix

`fleet.settings.providers.proxmox.defaultDatastore`

PVE storage used wherever a compute entry does not name one: VM root/EFI/data disks, the cloud-init drive, clone targets, and the default of fleet.compute..root_disk_datastore. LEGACY DEFAULT “local-storage” is kept so existing fleets render unchanged; set it explicitly (PVE’s stock thin pool is “local-lvm”) — the default flips to “local-lvm” in the next major release.

Type: string

Default:

"local-storage"

Example:

"local-lvm"

Declared by: nix/fleet/settings.nix

`fleet.settings.providers.proxmox.hostTweaks`

Hypervisor-side conveniences the community tools/pve/*.sh scripts used to apply by hand, now driven by ansible (roles proxmox/base and proxmox/pve) from these values. fleet ansible inventory exports them as the fleet_pve_host_tweaks variable.

Type: submodule

Default:

{ }

Declared by: nix/fleet/settings.nix

`fleet.settings.providers.proxmox.hostTweaks.diskHealth`

Install smartmontools + nvme-cli and run a weekly SMART short self-test on every disk. Legacy disk-health.sh.

Type: boolean

Default:

false

Declared by: nix/fleet/settings.nix

`fleet.settings.providers.proxmox.hostTweaks.ipTag`

Run the IP-Tag service that keeps a <ip> tag on every guest in the PVE UI. Legacy add-iptag.sh. PVE nodes only.

Type: boolean

Default:

false

Declared by: nix/fleet/settings.nix

`fleet.settings.providers.proxmox.hostTweaks.kernelClean`

Purge old PVE kernels on each ansible run, keeping the running one and the newest. Legacy kernel-clean.sh.

Type: boolean

Default:

false

Declared by: nix/fleet/settings.nix

`fleet.settings.providers.proxmox.hostTweaks.kernelPin`

Pin the node to this kernel version with proxmox-boot-tool (null = unpinned). Legacy kernel-pin.sh.

Type: null or string

Default:

null

Example:

"6.14.8-2-pve"

Declared by: nix/fleet/settings.nix

`fleet.settings.providers.proxmox.hostTweaks.microcode`

Install the CPU microcode package for the node’s vendor (intel-microcode / amd64-microcode; enables non-free-firmware). Legacy microcode.sh.

Type: boolean

Default:

false

Declared by: nix/fleet/settings.nix

`fleet.settings.providers.proxmox.hostTweaks.monitorAll`

Run the ping-instances service that restarts guests that stop answering. Legacy monitor-all.sh. PVE nodes only.

Type: boolean

Default:

false

Declared by: nix/fleet/settings.nix

`fleet.settings.providers.proxmox.hostTweaks.nicOffloadingFix`

Disable NIC offloading (ethtool) on Intel e1000/e1000e adapters at boot to work around hangs. Legacy nic-offloading-fix.sh.

Type: boolean

Default:

false

Declared by: nix/fleet/settings.nix

`fleet.settings.providers.proxmox.hostTweaks.scalingGovernor`

CPU frequency scaling governor applied at boot (null = leave the kernel default). Legacy scaling-governor.sh.

Type: null or one of "performance", "powersave", "ondemand", "conservative", "schedutil"

Default:

null

Declared by: nix/fleet/settings.nix

`fleet.settings.providers.proxmox.lxcTemplateDatastore`

PVE storage (content type vztmpl) that holds the NixOS LXC template nixos-lxc-template-x86_64.tar.xz every NixOS container is created from. LEGACY DEFAULT “nix-store” (a cluster-wide NFS SR registered by the ansible proxmox/pve nfs-storage task); a single-node fleet uploads the template to “local” instead via a kind = "file" resource with source = “nixos-lxc-image”.

Type: string

Default:

"nix-store"

Example:

"local"

Declared by: nix/fleet/settings.nix

`fleet.settings.providers.proxmox.singleBridgeInstances`

Proxmox provider-instance names (the <inst> in a fleet entry’s provider_instance = "proxmox.<inst>") whose PVE nodes carry the internal LAN directly on vmbr0 (single-NIC nodes, e.g. PVE-on-XCP-ng VMs). Containers on these instances default their internal bridge to vmbr0 instead of vmbr1; a per-host internal_bridge override still wins.

Type: list of string

Default:

[ ]

Example:

[
  "colo"
]

Declared by: nix/fleet/settings.nix

`fleet.settings.pveInstall`

Unattended-PVE-install constants for fleet pve install (serve_host, iso_sr_uuid, iso_sr_name, main_sr_name, network_name, installer_iso, presets). Freeform: substrate constants whose long-term home is the typed provider nodes (ADR-096); keys pass to the catalog verbatim.

Type: attribute set of raw value

Default:

{ }

Example:

{
  iso_sr_name = "NFS ISO Library";
  serve_host = "192.0.2.91";
}

Declared by: nix/fleet/settings.nix

`fleet.settings.sopsFiles`

Which SOPS file owns which TOP-LEVEL key tree, for fleets that split their store by resource group. Keys are tree names (“integrations”, “services”, “dbs”, …); values are repo-relative paths. Anything not listed falls back to sopsSecretsFile.

Splitting a store and leaving the original populated is the trap this exists to close: a consumer aimed at the old file ERRORS when the key is gone, but returns a diverged old value when a stale duplicate survives — and that case never fails. Declaring routes once means a consumer cannot hold a private, wrong opinion about where a tree lives.

Type: attribute set of string

Default:

{ }

Example:

{ integrations = "nix/secrets/integrations.yaml"; }

Declared by: nix/fleet/settings.nix

`fleet.settings.sopsSecretsFile`

Repo-relative path of the default sops file the CLI’s secrets commands operate on.

Type: string

Default:

"nix/secrets/secrets.yaml"

Declared by: nix/fleet/settings.nix

`fleet.settings.tailnet.controlUrl`

Login/control server URL of the fleet tailnet (headscale). Used as –login-server by infra.network.tailnet.fleetNode. null ⇒ fleetNode emits no –login-server flag.

Type: null or string

Default:

null

Example:

"https://vpn.example.dev"

Declared by: nix/fleet/settings.nix

`fleet.settings.tailnet.preauthKeyUrl`

HTTPS endpoint returning a tailnet preauth key as raw text (e.g. a source-IP-gated headscale vhost). Used by infra.network.tailnet.fleetNode to auto-fetch enrollment keys. null ⇒ hosts fall back to a SOPS-held auth key.

Type: null or string

Default:

null

Example:

"https://vpn.example.dev/internal/preauth/fleet-bot"

Declared by: nix/fleet/settings.nix

`fleet.settings.tfSopsFile`

Repo-relative SOPS file the TERRANIX layer reads at tofu apply time (the data.sops_file.secrets source). These are provider credentials — integrations.* — which need not live in the same file NixOS hosts default to. A fleet that splits its SOPS store per resource group must point this at whichever file holds the integrations tree, or every tofu plan fails with “The given key does not identify an element in this collection value”.

Type: string

Default:

"nix/secrets/secrets.yaml"

Example:

"nix/secrets/integrations.yaml"

Declared by: nix/fleet/settings.nix

fleet.network

18 options

`fleet.network.dns_domain`

Internal search domain. null ⇒ no internal zone: fleet links pin no search domain, provisioned guests get no create-time DNS domain, and infra.network.dhcp (asserted) needs an explicit domain.

Type: null or string

Default:

null

Example:

"example.internal"

Declared by: nix/fleet/network

`fleet.network.dns_servers`

BOOTSTRAP/CREATE-TIME resolver list only: written into every VM’s cloud-init network-config drive and the PVE container/VM dnsConfig at create time (nix/lib/tf/proxmox.nix). Primary is the fleet DNS host (CoreDNS); a public resolver (e.g. 1.1.1.1) as fallback lets a fresh host resolve (nix cache, etc.) before its first Colmena deploy even if fleet DNS is briefly unreachable.

NOTE: this list is deliberately NOT used for the running systemd-networkd link DNS — see internal_resolvers and INFRA-107. A public resolver on the same link as the fleet routing domains causes systemd-resolved’s sticky per-link failover to leak internal names to public DNS (which may serve a real public zone of the same name → WAN IP → un-hairpinnable), taking hosts offline.

Type: list of string

Default:

[
  "1.1.1.1"
  "9.9.9.9"
]

Declared by: nix/fleet/network

`fleet.network.gateway`

Internal network gateway (typically a dedicated router host on the internal bridge; ADR-021 Phase 1.b). null ⇒ internal-bridge hosts get no default route (isolated lab fleets); set it for any fleet that expects egress.

Type: null or string

Default:

null

Example:

"192.0.2.1"

Declared by: nix/fleet/network

`fleet.network.internal_cidr`

Internal service network CIDR (vmbr1 bridge). Informational — no framework module consumes it today; consumed by the CLI catalog (ADR-097).

Type: null or string

Default:

null

Example:

"192.0.2.0/24"

Declared by: nix/fleet/network

`fleet.network.internal_prefix_len`

Prefix length for the internal bridge (vmbr1) network: appended to every bare internal_ip by the legacy network modes and by the fleet-member networkd config. Default: taken from internal_cidr, else 24.

Type: integer between 0 and 32 (both inclusive)

Default:

prefix length of fleet.network.internal_cidr, else 24

Example:

Declared by: nix/fleet/network

`fleet.network.internal_resolvers`

[] (default) ⇒ no fleet DNS: fleet links carry no per-link DNS and hosts fall back to systemd-resolved defaults. Set to your CoreDNS host(s) once fleet DNS exists.

Resolver(s) for the RUNNING systemd-networkd link config on fleet hosts (nix/modules/infra/base/fleet-member.nix). Must be fleet-DNS-only (CoreDNS) — never a public resolver. The search_domains zones are pinned to the link as routing domains, and the internal split-DNS answers (e.g. vpn. → an internal IP) are only correct from fleet DNS; a public fallback on the same link would let systemd-resolved’s sticky failover serve the public DNS answer (the WAN IP, which many routers can’t hairpin from the LAN). External names still resolve: fleet DNS forwards them, and a fleet-DNS outage falls back (non-stickily) to systemd-resolved’s built-in global FallbackDNS for external names only. (INFRA-107)

Type: list of string

Default:

[ ]

Example:

[
  "192.0.2.103"
]

Declared by: nix/fleet/network

`fleet.network.lan_cidr`

LAN CIDR (vmbr0 bridge). Informational — no framework module consumes it today; consumed by the CLI catalog (ADR-097).

Type: null or string

Default:

null

Example:

"198.51.100.0/24"

Declared by: nix/fleet/network

`fleet.network.lan_gateway`

LAN gateway (UDM router). Used by single-NIC hosts on vmbr0 (network_mode = “single-external”, e.g. landing-page) and by the dual-NIC + WAN-side branches of router/netgate. null ⇒ those host shapes get no WAN-side default route; set it before declaring any vmbr0-facing host.

Type: null or string

Default:

null

Example:

"198.51.100.1"

Declared by: nix/fleet/network

`fleet.network.lan_prefix_len`

Prefix length for the LAN bridge (vmbr0) network: appended to every bare ip by the single-external / dual / router / netgate paths and by the fleet-member networkd config. Default: taken from lan_cidr, else 24.

Type: integer between 0 and 32 (both inclusive)

Default:

prefix length of fleet.network.lan_cidr, else 24

Example:

Declared by: nix/fleet/network

`fleet.network.ldap.base_dn`

LDAP base DN for user/group searches. null ⇒ no LDAP directory; required (asserted) when infra.auth.sssd is enabled.

Type: null or string

Default:

null

Example:

"dc=ldap,dc=example,dc=com"

Declared by: nix/fleet/network

`fleet.network.ldap.group_ou`

OU holding group entries, relative to base_dn.

Type: string

Default:

"ou=groups"

Declared by: nix/fleet/network

`fleet.network.ldap.ssh_pubkey_attr`

LDAP attribute sssd reads for SSH public keys.

Type: string

Default:

"sshPublicKey"

Declared by: nix/fleet/network

`fleet.network.ldap.uri`

Authentik LDAP outpost URI (used by sssd + Proxmox realm). null ⇒ no LDAP directory; required (asserted) when infra.auth.sssd is enabled.

Type: null or string

Default:

null

Example:

"ldap://auth.example.internal:389"

Declared by: nix/fleet/network

`fleet.network.ldap.user_ou`

OU holding user entries, relative to base_dn.

Type: string

Default:

"ou=users"

Declared by: nix/fleet/network

`fleet.network.ntp_server`

null ⇒ no fleet NTP: non-container hosts keep chrony disabled and rely on their own time sources.

Fleet NTP server IP. Every NixOS host’s chrony client (wired in nix/modules/infra/base/core/default.nix) targets this address. The host running the chrony server overrides its own services.chrony.servers to public upstream pools.

Type: null or string

Default:

null

Example:

"192.0.2.101"

Declared by: nix/fleet/network

`fleet.network.search_domains`

DNS zones pinned as systemd-resolved routing domains on single-NIC fleet links (nix/modules/infra/base/fleet-member.nix), so queries for every fleet-served zone go to fleet DNS — including public zones the fleet answers with split-DNS internal IPs. Defaults to [ dns_domain ]; add the public base domain (and any other fleet-served zones) when fleet DNS serves split-DNS answers for them. (INFRA-107)

Type: list of string

Default:

lib.optional (config.fleet.network.dns_domain != null) config.fleet.network.dns_domain

Example:

[
  "example.pve"
  "example.dev"
]

Declared by: nix/fleet/network

`fleet.network.sysadmin_key_file`

Operator-local path to the sysadmin SSH private key. Single source of truth: the devShell (nix/shell.nix) loads it into ssh-agent; the terranix ansible emitter (nix/tf/compute/ansible.nix) and the launcher’s generated inventory both read it as ansible_ssh_private_key_file. A leading ~ is expanded by each consumer (Ansible expanduser; the devShell expands it for bash).

The framework exports no environment variable for this. A consumer with a hand-written Ansible inventory that resolves the key from the environment should export it as FLEET_SYSADMIN_KEY_FILE (INFRA-218 — this description previously named SK_SYSADMIN_KEY_FILE, an export that only ever existed in consumer-side shell.nix, never here).

Type: string

Default:

"~/.ssh/sysadmin-key"

Declared by: nix/fleet/network

`fleet.network.sysadmin_ssh_key`

sysadmin SSH public key — baked into every CT/VM by nix/images/bootstrap.nix and referenced by Colmena. REQUIRED BY THE PROVISIONING LAYER — rendering any provider stack (image bake + create-time key injection) forces this option.

Type: string

Default: none (required when its feature is enabled)

Example:

"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIExampleExampleExampleExampleExampleExa sysadmin@example.com"

Declared by: nix/fleet/network

fleet.compute

154 options

`fleet.compute`

Every LXC/VM across all providers and envs. Entries live in nix/hosts/**/.nix.

Type: attribute set of (submodule)

Default:

{ }

Example:

{
  app-db = {
    env = "platform";
    stack = "core";
    provider_instance = "proxmox.dev";
    kind = "container";
    vm_id = 204;
    internal_ip = "192.0.2.104";
    cpu_cores = 4;
    memory_mb = 8192;
    tags = [ "postgres" ];
    protect = true;
    mount_points = [
      { datastore = "local-storage"; path = "/data"; size = "64G"; }
    ];
  };
}

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.ansible_playbook`

Override the Ansible playbook the terranix ansible_playbook emitter chains to this host after provisioning. By convention the framework playbooks apply (non-NixOS containers → fleetkit’s ansible/playbooks/developer.yml, VMs tagged “pve-host” → ansible/playbooks/pve.yml); set this to a path string (absolute, or relative to the tofu working dir .tf//) to substitute a consumer playbook instead. Consumer playbooks resolve roles via ANSIBLE_ROLES_PATH, which the fleet CLI points at both the consumer’s ansible/roles and the framework tree. Only consulted for hosts the emitter’s conventions already match — it does not opt additional hosts into Ansible.

Type: null or string

Default:

null

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.arch`

Container CPU architecture (PVE arch, bpg cpu.architecture). Emitted only when not amd64. LXC only.

Type: one of "amd64", "arm64", "armhf", "i386"

Default:

"amd64"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.bootOrder`

XO VMs: explicit boot order (c=disk n=network d=dvd); null derives from tags (transient => dnc). Authored form of what the post-create boot-order hook applies.

Type: null or one of "cnd", "dnc"

Default:

null

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.cloneFrom`

If non-null, clone from this source VMID at provision time.

Type: null or signed integer

Default:

null

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.cloud_init`

Cloud-init user-data for VM guests (users, write_files, runcmd, hostname, VyOS config commands). Ignored for entries that don’t render cloud-init (e.g. LXC containers).

Type: submodule

Default:

{ }

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.cloud_init.datastore`

PVE storage the cloud-init drive is allocated on. null = fleet.settings.providers.proxmox.defaultDatastore.

Type: null or string

Default:

null

Example:

"local"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.cloud_init.enable`

Attach a cloud-init drive and emit the initialization block (hostname, DNS, ip_config, identity). false = no cloud-init at all — appliance images that configure themselves (the legacy CLOUD_INIT=no).

Type: boolean

Default:

true

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.cloud_init.hostname`

Override hostname (defaults to fleet.compute key).

Type: string

Default:

""

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.cloud_init.install_nix`

If true, append a Determinate Nix install command to cloud-init runcmd.

Type: boolean

Default:

false

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.cloud_init.runcmd`

Extra runcmd lines appended after install_nix. YAML quoting is the caller’s responsibility.

Type: list of string

Default:

[ ]

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.cloud_init.users`

Local users created by cloud-init’s users: directive.

Type: list of (submodule)

Default:

[ ]

Example:

[ { ref = "alice"; extra_groups = [ "docker" ]; } ]

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.cloud_init.users.*.extra_groups`

Linux groups added on this VM (e.g. “docker”). Independent of LDAP groups in fleet.access.users.

Type: list of string

Default:

[ ]

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.cloud_init.users.*.name`

Username (inline mode; ignored when ref is set).

Type: null or string

Default:

null

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.cloud_init.users.*.ref`

Registry key into fleet.access.users.

Type: null or string

Default:

null

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.cloud_init.users.*.ssh_keys`

SSH keys (inline mode; ignored when ref is set).

Type: list of string

Default:

[ ]

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.cloud_init.users.*.sudo`

Grant passwordless sudo on this VM.

Type: boolean

Default:

true

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.cloud_init.vyos_config_commands`

VyOS-specific cloud-init: a list of VyOS configuration tree commands (e.g. “set system host-name ‘router’”). When non-empty, renders as a top-level vyos_config_commands: block in the user-data — VyOS’s cloud-init module reads this and applies the commands at first boot inside a config transaction (load → set → commit → save). Non-VyOS substrates ignore the block. Used to bootstrap hostname, HTTPS API + token, base interface IPs, and SSH on a fresh VyOS install so the Terraform provider can take over from there.

Type: list of string

Default:

[ ]

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.cloud_init.write_files`

Files written to the VM filesystem before runcmd runs.

Type: list of (submodule)

Default:

[ ]

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.cloud_init.write_files.*.content`

Literal file contents, embedded verbatim in the cloud-init user-data.

Type: string

Default: none (required when its feature is enabled)

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.cloud_init.write_files.*.owner`

“user:group” ownership passed to cloud-init write_files.

Type: string

Default:

"root:root"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.cloud_init.write_files.*.path`

Absolute destination path of the file inside the guest.

Type: string

Default: none (required when its feature is enabled)

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.cloud_init.write_files.*.permissions`

Octal file mode string passed to cloud-init write_files.

Type: string

Default:

"0644"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.cpu_cores`

Number of CPU cores allocated to the guest.

Type: signed integer

Default:

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.data_disks`

Additional virtio data disks. Emitted as virtio1, virtio2, … and formatted/mounted by cloud-init.

Type: list of (submodule)

Default:

[ ]

Example:

[ { size_gb = 100; mount_path = "/data"; } ]

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.data_disks.*.datastore_id`

PVE storage to allocate the disk on. Defaults to fleet.settings.providers.proxmox.defaultDatastore.

Type: string

Default:

config.fleet.settings.providers.proxmox.defaultDatastore

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.data_disks.*.filesystem`

Filesystem to format with on first boot.

Type: string

Default:

"ext4"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.data_disks.*.mount_path`

Mountpoint (e.g. /data).

Type: string

Default: none (required when its feature is enabled)

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.data_disks.*.size_gb`

Disk size in GiB.

Type: signed integer

Default: none (required when its feature is enabled)

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.devices`

Host device nodes passed through into the container (bpg device_passthrough → PVE devN entries): TUN for VPN software, /dev/dri + /dev/kfd + /dev/nvidia* for GPU transcoding, /dev/apex_0 for a Coral TPU. Replaces the lxc.conf edits the community scripts made. LXC only.

Type: list of (submodule)

Default:

[ ]

Example:

[ { path = "/dev/net/tun"; }
  { path = "/dev/dri/renderD128"; gid = 44; }
  { path = "/dev/dri/card0"; gid = 44; } ]

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.devices.*.deny_write`

Expose the device read-only.

Type: boolean

Default:

false

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.devices.*.gid`

Owner gid of the node inside the container (community scripts use 44 = video for /dev/dri). Unprivileged CTs need this to match the guest’s group.

Type: null or integer between 0 and 65535 (both inclusive)

Default:

null

Example:

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.devices.*.mode`

Access mode of the node inside the container. null = PVE default.

Type: null or string matching the pattern ^0[0-7]{3}$

Default:

null

Example:

"0660"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.devices.*.path`

Host device node passed through into the LXC (PVE devN: entry). Examples: /dev/net/tun, /dev/dri/renderD128, /dev/dri/card0, /dev/kfd, /dev/apex_0.

Type: string matching the pattern ^/dev/.+

Default: none (required when its feature is enabled)

Example:

"/dev/dri/renderD128"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.devices.*.uid`

Owner uid of the node inside the container. null = PVE default (root).

Type: null or integer between 0 and 65535 (both inclusive)

Default:

null

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.dns`

Per-guest create-time DNS override ({ servers, domain }); nulls inherit fleet.network.dns_servers / dns_domain. The declarative twin of the legacy var_ns / var_searchdomain.

Type: submodule

Default:

{ }

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.dns.domain`

Create-time DNS search domain for this guest. null = inherit fleet.network.dns_domain; “” = explicitly none.

Type: null or string

Default:

null

Example:

"lab.example.internal"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.dns.servers`

Create-time resolvers written into this guest’s PVE config. null = inherit fleet.network.dns_servers.

Type: null or (list of string)

Default:

null

Example:

[
  "192.0.2.53"
  "1.1.1.1"
]

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.enabled`

Toggle for build-on-demand entries. When false, the entry is filtered out before validation + emission, so fleet deploy tf apply <stack> neither provisions nor preserves it. Flip to true to materialise; flip back to false (and apply) to destroy. See nix/hosts/xoa/xo-installer-v10.nix for the canonical pattern.

Type: boolean

Default:

true

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.env`

Logical env (infra / platform / dev / prod / …).

Type: string

Default: none (required when its feature is enabled)

Example:

"platform"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.features`

PVE container feature flags ({ nesting, fuse, keyctl } default true; { mknod, mount } default off; LXC only).

Type: submodule

Default:

{ }

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.features.fuse`

Allow FUSE filesystem mounts inside the LXC (PVE fuse feature).

Type: boolean

Default:

true

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.features.keyctl`

Allow the keyctl() syscall inside the LXC (PVE keyctl feature; needed by systemd-based guests).

Type: boolean

Default:

true

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.features.mknod`

Allow creating device nodes inside the LXC (PVE mknod feature). Emitted only when true — a non-root API token 403s on the field otherwise.

Type: boolean

Default:

false

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.features.mount`

Filesystem types the LXC may mount itself (PVE mount feature). PVE accepts nfs and cifs; FUSE is the separate fuse flag. Emitted only when non-empty.

Type: list of (one of "nfs", "cifs")

Default:

[ ]

Example:

[
  "nfs"
  "cifs"
]

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.features.nesting`

Allow nested containers/namespaces inside the LXC (PVE nesting feature; needed for systemd-nspawn, Docker, nix sandboxed builds).

Type: boolean

Default:

true

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.fleet_ns`

Fleet namespace this entry belongs to (ADR-097). null = the incumbent/default fleet (top-level provider tree; unprefixed stacks + legacy state keys). Set by the v2 normaliser when lifting from fleet.fleets. — not authored by hand.

Type: null or string

Default:

null

Example:

"jeirslab"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.hook_script`

PVE hook script file id (a snippets file, e.g. a kind = "file" resource) run by PVE at the guest’s lifecycle phases. LXC only.

Type: null or string

Default:

null

Example:

"local:snippets/post-create.sh"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.host_managed`

Override bpg-provider network_interface.host_managed for this host. null = use provider default (host_managed=0). true = let PVE configure the in-container interface from ip_config (legacy / bootstrap-friendly).

Type: null or boolean

Default:

null

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.ignore_changes`

Terraform attribute paths emitted into lifecycle.ignore_changes — drift on these attributes is ignored at plan time.

Type: list of string

Default:

[ ]

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.image`

Explicit guest image. VMs: “file:<file_id>” (a disk image file resource), “clone:” (full clone of a template VM), or “import::import/” (a raw/qcow2 uploaded to a storage with the import content type, e.g. through a kind = "download" resource — the appliance-image path; PVE 8.4+). Containers: a vztmpl reference for a non-NixOS rootfs.

Type: null or string

Default:

null

Example:

"import:local:import/example-cloud-amd64.qcow2"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.import`

Cross-provider import settings ({ from_uuid }). Set from_uuid to adopt an existing XO VM instead of creating a fresh one.

Type: submodule

Default:

{ }

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.import.from_uuid`

XO VM UUID for cross-provider imports (e.g. pve-prod).

Type: string

Default:

""

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.interfaces`

Ordered NIC list for network_mode = "declared"; index i becomes net (LXC: eth unless name says otherwise). Empty for every other mode (validator-enforced).

Type: list of (submodule)

Default:

[ ]

Example:

[ { bridge = "vmbr1"; ipv4 = "192.0.2.10/24"; gateway = "192.0.2.1"; vlan = 42; }
  { bridge = "vmbr0"; ipv4 = "dhcp"; ipv6.method = "auto"; mac = "BC:24:11:00:00:10"; } ]

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.interfaces.*.bridge`

PVE bridge this NIC attaches to (PVE’s stock default bridge is vmbr0). Ignored when vnet is set.

Type: string

Default:

"vmbr0"

Example:

"vmbr1"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.interfaces.*.firewall`

Enable the PVE firewall on this NIC.

Type: boolean

Default:

false

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.interfaces.*.gateway`

IPv4 default gateway (only with a static CIDR; at most one NIC per guest).

Type: null or string

Default:

null

Example:

"192.0.2.1"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.interfaces.*.ipv4`

IPv4 config: “dhcp”, “manual” (PVE ip=manual, the guest configures itself), a CIDR (the prefix is explicit — no hidden /24), or null (no IPv4 block).

Type: null or one of "dhcp", "manual" or string matching the pattern ^([0-9]{1,3}\.){3}[0-9]{1,3}/([0-9]|[12][0-9]|3[0-2])$

Default:

"dhcp"

Example:

"192.0.2.10/24"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.interfaces.*.ipv6`

IPv6 config ({ method, address, gateway }).

Type: submodule

Default:

{ }

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.interfaces.*.ipv6.address`

Static IPv6 address in CIDR notation (method = static).

Type: null or string

Default:

null

Example:

"2001:db8::10/64"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.interfaces.*.ipv6.gateway`

IPv6 default gateway (method = static only).

Type: null or string

Default:

null

Example:

"2001:db8::1"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.interfaces.*.ipv6.method`

IPv6 configuration for this NIC: none (nothing emitted — the legacy “disable” too), auto (SLAAC), dhcp, or static (address required).

Type: one of "none", "auto", "dhcp", "static"

Default:

"none"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.interfaces.*.mac`

Pinned MAC address, uppercase colon-separated. null = PVE assigns one.

Type: null or string matching the pattern ^([0-9A-F]{2}:){5}[0-9A-F]{2}$

Default:

null

Example:

"BC:24:11:00:00:10"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.interfaces.*.model`

Virtual NIC model (VMs only; LXC NICs are veth).

Type: one of "virtio", "e1000", "e1000e", "rtl8139", "vmxnet3"

Default:

"virtio"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.interfaces.*.mtu`

NIC MTU (PVE mtu=): 576-65535, or 1 on a VM NIC to inherit the bridge MTU.

Type: null or signed integer

Default:

null

Example:

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.interfaces.*.name`

In-guest interface name (LXC). null = eth. Ignored for VMs (the guest kernel names NICs).

Type: null or string

Default:

null

Example:

"eth0"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.interfaces.*.rate_limit_mbps`

Egress rate limit in MB/s (PVE rate=).

Type: null or (positive integer, meaning >0)

Default:

null

Example:

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.interfaces.*.vlan`

802.1Q VLAN tag (PVE tag=).

Type: null or integer between 1 and 4094 (both inclusive)

Default:

null

Example:

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.interfaces.*.vnet`

PVE SDN VNet id to attach to instead of a bridge (PVE writes it into the bridge= field). Declare the VNet as a kind = "sdn-vnet" resource on the same provider instance.

Type: null or string

Default:

null

Example:

"lab"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.internal_bridge`

Bridge the legacy single-internal mode attaches eth0 to. null = vmbr1, or vmbr0 when the provider instance is listed in fleet.settings.providers.proxmox.singleBridgeInstances. (Declared-mode hosts set the bridge per interface instead.)

Type: null or string

Default:

null

Example:

"vmbr2"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.internal_ip`

Internal fleet-LAN IPv4 address (bare, no prefix). Statically configured into the guest at create time and used as the host’s inventory/SSH address (hosts.json, DNS A records). Empty for hosts without an internal interface (e.g. DHCP’d XCP-ng VMs).

Type: string

Default:

""

Example:

"192.0.2.104"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.ip`

External/LAN IPv4 address (bare, no prefix — the emitter appends the prefix length). Used by the external leg of the dual / single-external / custom network modes. Empty when the host has no external interface.

Type: string

Default:

""

Example:

"198.51.100.20"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.kind`

LXC container or KVM VM.

Type: one of "container", "vm"

Default: none (required when its feature is enabled)

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.lxc_extra_conf`

Raw lines appended to /etc/pve/lxc/.conf inside a “# BEGIN/END fleetkit lxc_extra_conf” marker block — the escape hatch for what PVE’s devN passthrough cannot express (hot-plug USB cgroup wildcards, optional bind mounts, autodev hooks). Applied by a terraform_data local-exec over root SSH to the container’s node (fleet.providers.proxmox..cluster.node_addresses maps node names to SSH hosts), re-run whenever the lines change, rebooting the container if it is running. Emptying the list stops managing the block but leaves it in place. LXC only.

Type: list of string

Default:

[ ]

Example:

[ "lxc.cgroup2.devices.allow: c 188:* rwm"
  "lxc.mount.entry: /dev/serial/by-id dev/serial/by-id none bind,optional,create=dir" ]

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.mac_address_eth0`

Pin the eth0 MAC address (uppercase colon-separated, e.g. “BC:24:11:5B:EA:26”). null = bpg-provider auto-assigns. Currently honoured by lxc-router mode; extend the network-mode emitters as needed for other modes.

Type: null or string

Default:

null

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.mac_address_eth1`

Pin the eth1 MAC address. Required by internal-plus-lan-mac mode (a second NIC on the internal bridge carrying an ingress identity a LAN-router port-forward targets by MAC).

Type: null or string

Default:

null

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.memory_mb`

RAM in MiB. LXC containers pick up changes without a restart; VMs need a reboot.

Type: signed integer

Default:

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.mount_points`

Extra PVE mount-point volumes ({ datastore, path, size, backup }) attached to the container (LXC only).

Type: list of (submodule)

Default:

[ ]

Example:

[ { datastore = "local-storage"; path = "/data"; size = "64G"; } ]

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.mount_points.*.backup`

Include this volume in vzdump backups.

Type: boolean

Default:

true

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.mount_points.*.datastore`

PVE storage the mount-point volume is allocated on (e.g. “local-storage”).

Type: string

Default: none (required when its feature is enabled)

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.mount_points.*.path`

Mountpoint inside the container (e.g. “/data”).

Type: string

Default: none (required when its feature is enabled)

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.mount_points.*.size`

Size like “256G”. Stringly-typed to match bpg input.

Type: string

Default: none (required when its feature is enabled)

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.name`

Hostname for the machine (defaults to the fleet attrset key).

Type: string

Default:

"‹name›"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.network_mode`

Which NIC/bridge layout the emitter generates. “declared” = the NICs come from interfaces (any bridge/VNet, DHCP or explicit CIDR, VLAN, MTU, MAC, IPv6) — the general form; single-internal (one NIC on the internal bridge), single-external (one NIC on the LAN bridge), dual (both) and the custom/special-case layouts are the legacy fixed shapes kept for compatibility.

Type: one of "single-internal", "single-external", "dual", "custom-netgate", "custom-btc-testnet", "custom-vm", "lxc-router", "declared", "internal-plus-lan-mac"

Default:

"single-internal"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.node`

PVE cluster member name (e.g. “pve-data”). Empty = defaults to provider’s cluster.primary_node.

Type: string

Default:

""

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.note`

Structured PVE Notes content. Takes precedence over notes when set.

Type: null or (submodule)

Default:

null

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.note.extra`

Free-form markdown appended last.

Type: string

Default:

""

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.note.links`

Related links (dashboards, runbooks, tickets) rendered as a bullet list.

Type: list of (submodule)

Default:

[ ]

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.note.links.*.text`

Link label as rendered in the Notes markdown.

Type: string

Default: none (required when its feature is enabled)

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.note.links.*.url`

Link target URL.

Type: string

Default: none (required when its feature is enabled)

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.note.services`

Services running on the host, rendered as a bullet list (name, address, port).

Type: list of (submodule)

Default:

[ ]

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.note.services.*.address`

Address/URL the service is reachable at. Empty = omitted from the rendered line.

Type: string

Default:

""

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.note.services.*.name`

Service name shown in the Notes services table.

Type: string

Default: none (required when its feature is enabled)

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.note.services.*.port`

Service port. null = omitted from the rendered line.

Type: null or signed integer

Default:

null

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.note.stateful`

Render the STATEFUL/protected warning banner in the Notes panel. Informational only — destruction protection itself comes from protect / STATEFUL_TAGS.

Type: boolean

Default:

false

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.note.summary`

One-paragraph description rendered under the title.

Type: string

Default:

""

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.note.title`

Heading of the rendered Notes markdown. Empty = falls back to the host name.

Type: string

Default:

""

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.notes`

Free-text audit note. Plain-string fallback rendered in the PVE Notes panel (Summary tab) when the structured note is null.

Type: string

Default:

""

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.onboot`

Start the guest when the PVE node boots (onboot).

Type: boolean

Default:

true

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.pool`

Pool membership — pool_id of a fleet.resources pool entry.

Type: null or string

Default:

null

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.privileged`

Run this LXC in privileged mode (sets unprivileged = false in the Proxmox container). Only needed for hosts that run NAT or other kernel-capability-sensitive workloads.

Type: boolean

Default:

false

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.protect`

Emit lifecycle.prevent_destroy = true on the generated Terraform resource. Required (or a strict-destruction-policy provider) for entries carrying a fleet.STATEFUL_TAGS tag; fleet tf destroy refuses to target protected resources.

Type: boolean

Default:

false

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.protection`

PVE guest protection flag (blocks destroy/remove in the PVE UI and API). Distinct from protect, which is the Terraform prevent_destroy lifecycle. Emitted only when true.

Type: boolean

Default:

false

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.provider_instance`

Pointer to fleet.providers: “.” (e.g. “proxmox.dev”).

Type: string matching the pattern ^[a-z-]+\.[a-z][a-z0-9-]*$

Default: none (required when its feature is enabled)

Example:

"proxmox.dev"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.provides`

This machine IS a member (node) of the named provider instance — the ADR-096 recursive estate link. Its resource name must equal the member/node name it provides. Drives derived hypervisor scrape targets and layer-dependency queries.

Type: null or string

Default:

null

Example:

"proxmox.prod"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.provisioning`

“managed” = terranix/tofu-provisioned by this repo; “external” = provisioned elsewhere, NixOS-managed only.

Type: one of "managed", "external"

Default:

"managed"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.root_disk_datastore`

PVE storage the root disk is allocated on. Defaults to fleet.settings.providers.proxmox.defaultDatastore.

Type: string

Default:

config.fleet.settings.providers.proxmox.defaultDatastore

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.root_disk_gb`

Root disk size in GiB.

Type: signed integer

Default:

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.scope`

ADR-097 derivation contract: an “estate”-scoped resource is a singleton serving every fleet on this substrate (router/DNS edge, builder, observability) and may fold ALL fleets’ manifests into its config; “fleet”-scoped resources see only their own namespace. Enforcement lands with the second fleet — today this is declared intent + docs surface.

Type: one of "fleet", "estate"

Default:

"fleet"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.ssh_groups`

Authentik groups allowed SSH access (sssd simple_allow_groups).

Type: list of string

Default:

[
  "platform-admins"
]

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.stack`

Dot-path stack label within env.

Type: string

Default: none (required when its feature is enabled)

Example:

"bitcoin.mainnet"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.start_on_create`

Start the guest right after Terraform creates it. false = create stopped (appliance images that need a first manual step).

Type: boolean

Default:

true

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.startup`

PVE startup ordering ({ order, up_delay, down_delay }). null = not managed.

Type: null or (submodule)

Default:

null

Example:

{ order = 10; up_delay = 30; }

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.startup.down_delay`

Seconds PVE waits after stopping this guest before stopping the next one.

Type: null or (unsigned integer, meaning >=0)

Default:

null

Example:

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.startup.order`

PVE start/shutdown order (lower starts first). null = PVE default (any order).

Type: null or (unsigned integer, meaning >=0)

Default:

null

Example:

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.startup.up_delay`

Seconds PVE waits after starting this guest before starting the next one.

Type: null or (unsigned integer, meaning >=0)

Default:

null

Example:

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.startup_order`

Deprecated flat alias of startup.order — PVE LXC boot ordering (lower boots first). null = PVE default ordering. Prefer the structured startup option.

Type: null or signed integer

Default:

null

Example:

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.sudo_groups`

Authentik groups granted password-required sudo on this host (sssd → security.sudo.extraRules). In practice a subset of ssh_groups (you cannot sudo on a host you cannot log into). Empty = no LDAP user gets sudo here; local wheel accounts (core.nix) are unaffected. See ADR-028.

Type: list of string

Default:

[ ]

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.swap_mb`

Swap in MiB (LXC only).

Type: signed integer

Default:

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.tags`

Free-form tags (shown in the PVE UI, usable as Colmena deploy targets). Tags listed in fleet.STATEFUL_TAGS additionally force destruction protection (validator-enforced).

Type: list of string

Default:

[ ]

Example:

[
  "postgres"
  "monitoring"
]

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.vm`

VM-only hardware settings ({ machine, bios, efi, cpu_type, scsi_hardware, root_disk, serial_console, agent, boot_order, tablet }). Ignored for containers (validator rejects non-defaults there).

Type: submodule

Default:

{ }

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.vm.agent`

QEMU guest agent enabled. null = fleetkit’s rule (on for image-based and NixOS-template VMs).

Type: null or boolean

Default:

null

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.vm.bios`

Firmware. “ovmf” (UEFI) also emits an EFI vars disk from efi. null = PVE default (seabios).

Type: null or one of "seabios", "ovmf"

Default:

null

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.vm.boot_order`

Explicit boot device order (PVE boot: order=). null = PVE default.

Type: null or (list of string)

Default:

null

Example:

[
  "scsi0"
  "net0"
]

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.vm.cpu_type`

QEMU CPU model (PVE cpu:). “host” (fleetkit default) passes the node’s CPU through; community VMs default to kvm64 for migratability.

Type: string

Default:

"host"

Example:

"x86-64-v2-AES"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.vm.efi`

EFI vars disk settings, used when bios = ovmf.

Type: submodule

Default:

{ }

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.vm.efi.datastore`

PVE storage for the EFI vars disk. null = fleet.settings.providers.proxmox.defaultDatastore.

Type: null or string

Default:

null

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.vm.efi.pre_enrolled_keys`

Pre-enrol the distribution Secure Boot keys into the EFI vars disk (community default: off).

Type: boolean

Default:

false

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.vm.efi.type`

EFI vars disk size/type (PVE efitype; community default 4m).

Type: one of "2m", "4m"

Default:

"4m"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.vm.machine`

QEMU machine type: pc (i440fx, community default) or q35. null = PVE default.

Type: null or one of "pc", "q35"

Default:

null

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.vm.root_disk`

Root disk attributes beyond size/datastore ({ interface, cache, discard, iothread, ssd }).

Type: submodule

Default:

{ }

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.vm.root_disk.cache`

Disk cache mode (PVE cache=). null = PVE default.

Type: null or one of "none", "directsync", "writethrough", "writeback", "unsafe"

Default:

null

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.vm.root_disk.discard`

Pass discard/TRIM through to the storage (PVE discard=).

Type: null or one of "on", "ignore"

Default:

null

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.vm.root_disk.interface`

Bus/device of the root disk (community VMs use scsi0 with virtio-scsi-pci; fleetkit’s NixOS images boot from virtio0).

Type: string

Default:

"virtio0"

Example:

"scsi0"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.vm.root_disk.iothread`

Use a dedicated I/O thread (PVE iothread=).

Type: null or boolean

Default:

null

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.vm.root_disk.ssd`

Present the disk as an SSD to the guest (PVE ssd=).

Type: null or boolean

Default:

null

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.vm.scsi_hardware`

SCSI controller model (PVE scsihw). null = PVE default.

Type: null or one of "virtio-scsi-pci", "virtio-scsi-single", "lsi", "lsi53c810", "megasas", "pvscsi"

Default:

null

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.vm.serial_console`

Attach a serial socket so qm terminal <vmid> reaches the guest console.

Type: boolean

Default:

true

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.vm.tablet`

USB tablet device (community VMs pass -tablet 0). null = PVE default (on).

Type: null or boolean

Default:

null

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.vm_id`

Proxmox VMID.

Type: signed integer

Default: none (required when its feature is enabled)

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.vm_template`

Legacy: “nixos” clones VMID 9000, “debian-13” imports the prepared Debian qcow2 (ADR-013/018). Prefer image for new entries.

Type: one of "nixos", "debian-13"

Default:

"debian-13"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.xoa`

XCP-ng/XOA-specific compute config. Active when provider_instance starts with xen-orchestra.

Type: submodule

Default:

{ }

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.xoa.cloud_network_config`

Cloud-init network-config (v2 YAML) passed verbatim to xenorchestra_vm.cloud_network_config. Only meaningful for cloud-init guests (non-NixOS); use match: {macaddress: ...} stanzas against pinned xoa.networks[*].mac so the config is immune to guest interface naming (eth0 vs enX0 on Xen). NixOS VMs leave this null — networkd owns their config. (INFRA-194; also the path INFRA-174’s Ubuntu dev box needs.)

Type: null or string

Default:

null

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.xoa.disks`

Additional VDIs beyond the cloned template root disk.

Type: list of (submodule)

Default:

[ ]

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.xoa.disks.*.name`

VDI name label as shown in Xen Orchestra.

Type: string

Default: none (required when its feature is enabled)

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.xoa.disks.*.size_add_gb`

Additional GiB layered on top of size_gb, applied IMPERATIVELY by xoa-cli reconcile-disks (never by terraform — INFRA-172 / ADR-081). Live target = size_gb + size_add_gb; the reconciler grows the VDI when live < target and never shrinks. Grow a disk by editing this field and running the reconciler.

Type: signed integer

Default:

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.xoa.disks.*.size_gb`

BASE size in GiB — what terranix provisions at CREATE time. ForceNew in the vatesfr/xenorchestra provider; ignored for drift afterwards (mkXoLifecycle). Do NOT bump this to grow a live disk — use size_add_gb.

Type: signed integer

Default: none (required when its feature is enabled)

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.xoa.disks.*.sr_ref`

Full fleet.resources key for the SR (e.g. “xo-sr-main”).

Type: string

Default: none (required when its feature is enabled)

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.xoa.iso_ref`

Optional fleet.resources key for an ISO to attach as a CDROM (e.g. “xo-iso-nixos-minimal”). When set, the VM is created with the ISO pre-attached and the underlying VM’s boot order (“dc” — CD then disk in XOA’s UEFI default) makes it boot from the ISO on first power-on. Used for one-shot OS installs onto blank disks. After install, eject via xo-cli vm.ejectCd and the VM boots from disk on next start.

Type: null or string

Default:

null

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.xoa.networks`

Ordered NIC list. First entry becomes eth0 inside the guest.

Type: list of (submodule)

Default:

[ ]

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.xoa.networks.*.mac`

Pin MAC address; null = XCP-ng assigns one.

Type: null or string

Default:

null

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.xoa.networks.*.ref`

Full fleet.resources key for the network (e.g. “xo-network-wan”).

Type: string

Default: none (required when its feature is enabled)

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.xoa.pool_ref`

Full fleet.resources key for the target XCP-ng pool (e.g. “xo-pool-main”).

Type: string

Default:

"xo-pool-main"

Declared by: nix/fleet/compute.nix

`fleet.compute.<name>.xoa.template`

Full fleet.resources key for the source template (e.g. “xo-template-nixos”). Required for kind=vm on XOA.

Type: null or string

Default:

null

Declared by: nix/fleet/compute.nix

fleet.providers

285 options

`fleet.providers.ansible`

ansible/ansible — runs ansible-playbook from a terraform resource (ansible_playbook). Used to chain post-install Ansible against compute resources tofu just created, so fleet deploy tf apply does the whole “create the host + converge its config” cycle in one shot. The provider runs ansible-playbook locally on whoever runs tofu, so SSH key + inventory must be reachable there.

Type: null or (submodule)

Default:

null

Keyboard shortcuts

fleetkit