nexcage

NexCage Documentation

nexcage is an OCI runtime for Proxmox VE, and it wears two faces from one binary.

A command line for LXC containers on a Proxmox VE cluster. It creates, starts, stops, deletes and inspects them through pct and the Proxmox API, on any node of the cluster, from templates, OCI bundles or — on Proxmox VE 9.1 and later — OCI registry images.

An OCI runtime a container engine drives, the way runc and crun are driven. podman, ctr, containerd’s CRI and CRI-O all run containers on it, and Kubernetes schedules pods onto it with a RuntimeClass. A RuntimeClass can also pick an isolation profile that the node’s administrator defined.

Start here

• Install — the .deb or the binary from a release (one binary with both backends since 0.17.0), a Kubernetes node, and source builds
• CLI Reference — every command, option and exit code
• Kubernetes integration — the runtime-spec command line, the engines it was verified against, and a pod on a real node

Going further

• Architecture — the backends and the router
• Troubleshooting — when something does not work
• Dev Quickstart — build and test from source
• CI/CD — the workflows and the self-hosted Proxmox runner
• Release notes — what changed, release by release

This site is open source. Improve this page.