OpenKor Project

OpenKor is an open source cloud infrastructure platform built to provide KVM-based virtual machine management, distributed storage, and virtual networking under a single, vendor-lock-free roof.

Written entirely in Go, built on libvirt/KVM, and designed so that every service can be deployed independently — OpenKor is a ground-up implementation of a modern, multi-service cloud platform.

• Architecture
• Services
• Quick Start
• API
• Repository Structure
• Roadmap
• Design Decisions
• Contributing
• License

OpenKor is not monolithic. Each service runs as its own process, manages its own database schema, and can be scaled and deployed independently.

                        ┌─────────────┐
                        │   korcli    │  ← CLI tool
                        └──────┬──────┘
                               │
                        ┌──────▼──────┐
                        │   korapi    │  ← API Gateway (all traffic flows through here)
                        └──────┬──────┘
                               │
          ┌────────────────────┼────────────────────┐
          │                    │                    │
   ┌──────▼──────┐      ┌──────▼──────┐      ┌──────▼──────┐
   │   korauth   │      │    korvm    │      │   korvol    │
   │  (Auth/IAM) │      │  (KVM/VMs)  │      │  (Storage)  │
   └─────────────┘      └─────────────┘      └─────────────┘
          │                    │                    │
   ┌──────▼─────────────────────────────────────────▼──────┐
   │                       PostgreSQL                        │
   └────────────────────────────────────────────────────────┘

Inter-service communication: REST in MVP — gRPC + NATS event bus in v2.

• Go 1.22+
• Docker & Docker Compose
• A Linux host with KVM/QEMU and libvirt installed
• PostgreSQL 15+

# Clone the repository
git clone https://github.com/OpenKorProject/openkor-installer
cd openkor

# Configure environment variables
cp .env.example .env

# Start the development environment
docker-compose up -d

Note: korvm and korvol run in privileged mode to access KVM and LVM. Make sure KVM virtualization is enabled on your host machine.

curl -X POST https://test-api.openkor.cloud/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username": "admin", "password": "changeme"}'

kor vm create --name my-vm --cpu 2 --memory 2048 --disk 20G --image ubuntu-22.04

All requests route through the korapi gateway. Individual services are never exposed directly.

Base URL:   https://test-api.openkor.cloud/v1/{service}
Auth:       Bearer <JWT Token>
Format:     JSON
Versioning: URL-based — /v1/, /v2/

Full API documentation: #TODO

• Project architecture and technical decisions

• kornet — VXLAN, floating IPs, security groups
• kormon — Prometheus integration, alerting system
• korbus — NATS-based event bus
• gRPC for inter-service communication
• Ceph integration (migration from LVM)
• Web UI (korui)

Why Go? Low memory footprint, strong concurrency primitives, and the maturity of the libvirt-go library.

Why a single PostgreSQL instance? Simplicity is the priority for MVP. Each service uses its own schema within the same instance; migration to per-service instances is planned for later versions.

Why not monolithic? So that each service can be deployed, scaled, and updated independently — without vendor lock-in and without the platform becoming a single point of failure.

Contributions are welcome! Please read CONTRIBUTING.md before getting started.

# Fork and create a branch
git checkout -b feature/your-feature-name

# Commit your changes
git commit -m "feat: add your feature"

# Open a pull request
git push origin feature/your-feature-name

For bugs or feature requests, please open an issue.

Apache 2.0 — © 2026 OpenKor Contributors