Kubeasy Documentation

Welcome to the Kubeasy Documentation!

Kubeasy is an interactive learning platform that helps developers master Kubernetes by solving real-world challenges in a safe, local environment.

What is Kubeasy?

Kubeasy drops you into broken Kubernetes scenarios -- maybe a pod won't start, RBAC is blocking access, or a network policy is too restrictive. Your goal? Investigate, fix, and validate using real tools like kubectl.

No browser playgrounds. No multiple-choice questions. Just you, your terminal, and realistic problems to solve.

Documentation sections

For Users

Learn how to use Kubeasy to practice Kubernetes skills:

• Getting Started - Install the CLI and solve your first challenge
• How It Works - Understand the challenge workflow
• CLI Reference - Complete command reference
• Troubleshooting - Fix common issues

-> Start with the User Guide

For Developers

Learn how to create and contribute challenges:

• Challenge Structure - Anatomy of a challenge
• Creating Challenges - Build your first challenge
• Validation Rules - Define success criteria
• Validation Reference - Complete validation type specs
• Testing - Test challenges locally
• Contributing - Submission guidelines

-> Start with the Developer Guide

Key features

Local-first

Everything runs on your machine using Kind. No cloud account needed, no data leaves your system.

Real Kubernetes

Use kubectl, Lens, or any tool you prefer. The challenges run on actual Kubernetes, not a simulation.

Automated validation

The CLI validates your solutions directly against the cluster using 5 validation types:

• Condition - Checks resource conditions (Ready, Available)
• Status - Checks status fields with operators (restart count < 3)
• Log - Searches container logs for expected strings
• Event - Detects forbidden events (OOMKilled, Evicted)
• Connectivity - Tests HTTP connectivity between pods

Kyverno policies prevent bypasses by blocking invalid shortcuts.

Progressive learning

Challenges range from beginner-friendly scenarios to advanced multi-component debugging.

Quick start

For learners

# Download the CLI from GitHub Releases
# https://github.com/kubeasy-dev/kubeasy-cli/releases

# Login with your API key
kubeasy login

# Setup your local environment
kubeasy setup

# Start a challenge
kubeasy challenge start pod-evicted

For contributors

# Clone the challenges repository
git clone https://github.com/kubeasy-dev/challenges.git
cd challenges

# Create your challenge
mkdir -p my-challenge/manifests
mkdir -p my-challenge/policies

# Create challenge.yaml with metadata and objectives
# Test it locally
kubeasy setup
kubeasy challenge start my-challenge

Philosophy

Kubeasy believes the best way to learn Kubernetes is through practice, not theory. By simulating real issues in isolated environments, you can safely explore, break things, and rebuild -- developing a deeper understanding of how Kubernetes actually works.

Getting help

• User questions: GitHub Discussions
• Bug reports: GitHub Issues
• Website: kubeasy.dev

What's next?

• New to Kubeasy? -> User Guide
• Want to contribute? -> Developer Guide
• Need help? -> Troubleshooting