Show examples as

Documentation

Example preference: CLI — guides below emphasize kctl commands. Switch the toggle in the bar above to prioritize YAML manifests.

Example preference: YAML — use declarative manifests (kctl apply -f) wherever possible. Switch the toggle above for raw CLI command tables.

Guides include Terraform examples for provider kcorehypervisor/kcore 0.5.0.

Operator-focused guides for installing kcore, managing clusters, creating VMs and containers, configuring networking and storage, and securing your infrastructure. Technical architecture and contributor docs live in the kcore repository.

Getting started

System requirements, create cluster PKI, and connect kctl.

Boot ISO, install to disk, approve the node, create your first VM.

Agent nodes, HA controllers, and cross-DC expansion.

Cluster & node upgrades

Flake-pinned NixOS rollouts via ClusterUpdate: plan, apply, approve, observe.

Appliance console

Read-only local TUI, status pages, shortcuts, and console security model.

Virtual machines

CLI and YAML creation, images, SSH keys, cloud-init, scheduling.

Controller downloads, node upload, formats, and readiness checks.

Cold drain and Cloud Hypervisor live migration over shared RBD.

Import from VMware or Proxmox

Inventory a vCenter or Proxmox estate, convert exported disks, and apply with Terraform.

GPU passthrough

Named GPUs, cluster inventory, and cold migration onto a free card.

Containers

Container lifecycle

Create, start, stop, and delete OCI containers alongside VMs.

Networking

NAT, bridge, and VXLAN, optional IPv6, east-west filtering, and multi-homed VMs.

VNI derivation, peer discovery, address reuse, and outbound NAT.

Storage

Storage backends

Filesystem, LVM, and ZFS backends, day-0 configuration.

Day-2 operations

Declarative DiskLayout resources, classifier safety gates, per-node apply-disk push.

kcore SAN (Ceph)

Shared RBD disks, cold drain, and live migration with Ceph.

Cold drain and Cloud Hypervisor live migration over shared RBD.

Backup

Backup appliance: architecture, immutability, ZFS repository, and S3 Object Lock.

Security

Security groups

YAML manifests, ingress rules, DNAT, VM and network attachment.

Report categories, framework mappings, implemented and planned features.

Certificates & encryption

mTLS, PKI hierarchy, rotation, CRL/OCSP revocation, LUKS disk encryption.

Kubernetes

Kubernetes clusters

Create a cluster, keep an API VIP, announce Cilium L2 addresses, and mount LVM or ZFS volumes.

Reference

Complete command reference: every command, subcommand, and flag.

VM, Network, SshKey, Container, and SecurityGroup manifest reference with examples.

Licensing & editions

Open-core model, Community vs Standard vs Premium.

Related: the Debian 12 quickstart blog post walks through a full terminal session with an embedded recording.

Technical architecture, networking, replication, and contributor documentation lives in the docs/ directory of the kcore repository.