incus-contrib/README.md

incu-contrib

Peripheral tools, snippets, and scripts for working with Incus, IncusOS, and the broader ecosystem.

Primarily aimed at home lab environments but useful in production as well.

Contents

incusos/

Scripts for building IncusOS installation media and seed configurations:

• incusos-iso -- Build customized IncusOS ISO/IMG images using the official flasher-tool. Supports both architectures (x86_64, aarch64), multiple applications (Incus, Operations Center), automatic client certificate injection, and batch generation.

• incusos-seed -- Generate IncusOS seed archives (tar or FAT image) for installation customization. Covers all seed file types: install, applications, Incus preseed, Operations Center, network, and update configuration.

• incusos-proxmox -- Declarative IncusOS deployment on Proxmox VE. Define VMs in YAML, and the script handles seed generation, ISO upload, VM creation with correct settings (UEFI, TPM 2.0, VirtIO-SCSI), and automated installation.

See incusos/README.md for full documentation.

notes/

Guides and reference material (roughly in learning order):

• clustering-guide.md -- Detailed Incus clustering walkthrough (manual cluster formation via remotes).
• operations-center-guide.md -- Operations Center provisioning, cluster management, and tested limitations.
• networking-guide.md -- OVN overlay networking tutorial (bridge + OVN + LAN access).
• shared-storage-guide.md -- iSCSI + lvmcluster shared storage for instant migration.
• production-lab-guide.md -- Manual cluster + OVN + HA workloads (validated end-to-end).
• migration-guide.md -- Migration paths into Incus from Proxmox, UTM, VMware Fusion, and Docker.
• aether-guide.md -- Aether management platform: deployment, instance/blueprint lifecycle, API reference, OVN recovery, and node resizing.
• incus-version-compatibility.md -- Incus package versions across platforms and install instructions.
• utm-support.md -- Design document for future UTM support on macOS.

Quick Start

# Install the flasher-tool (requires Go 1.22+)
go install github.com/lxc/incus-os/incus-osd/cmd/flasher-tool@latest

# Build a default IncusOS ISO with your client cert injected
./incusos/incusos-iso

# Build for a specific architecture and application
./incusos/incusos-iso --arch aarch64 --app operations-center --defaults

# Generate all common ISO variants at once
./incusos/incusos-iso --batch

# Generate a standalone seed archive
./incusos/incusos-seed --app incus --defaults --output my-seed.tar

# Generate a SEED_DATA FAT image for external boot media
./incusos/incusos-seed --format fat --app incus --defaults --output seed.img

Requirements

• Go 1.22+ -- for installing the flasher-tool
• curl -- for downloading images from the CDN
• tar, gzip -- for seed archive creation and image decompression
• Incus client (recommended) -- for automatic client certificate detection. Works with any version; certificates are read directly from disk. See version compatibility notes for install instructions per platform (macOS, Debian/Ubuntu, Arch).
• mtools (optional) -- for creating FAT seed images

License

MIT