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.
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
Installation
System requirements, create cluster PKI, and connect kctl.
First cluster
Boot ISO, install to disk, approve the node, create your first VM.
Add a node
Agent nodes, HA controllers, and cross-DC expansion.
Virtual machines
VM creation
CLI and YAML creation, images, SSH keys, cloud-init, scheduling.
VM images
Controller downloads, node upload, formats, and readiness checks.
Containers
Networking
Networks
NAT, bridge, and VXLAN types, VLAN tagging, and network CRUD.
VXLAN overlay
Deep dive: VNI derivation, FDB entries, peer discovery, outbound NAT.
Storage
Storage backends
Filesystem, LVM, and ZFS backends, day-0 configuration.
Day-2 operations
Add disks, apply disko layouts, management modes.
vSAN (Ceph)
Upcoming distributed shared storage using Ceph.
Security
Security groups
YAML manifests, ingress rules, DNAT, VM and network attachment.
Compliance
Report categories, framework mappings, implemented and planned features.
Certificates & encryption
mTLS, PKI hierarchy, auto-renewal, LUKS disk encryption.
Reference
kctl CLI
Complete command reference: every command, subcommand, and flag.
YAML manifests
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.