Prerequisites¶

This page lists all prerequisites for running kindplane.

Required¶

Docker¶

Docker is required to run Kind clusters. Kind uses Docker containers to simulate Kubernetes nodes.

brew install --cask docker

# Ubuntu/Debian
sudo apt-get update
sudo apt-get install docker-ce docker-ce-cli containerd.io

# Fedora
sudo dnf install docker-ce docker-ce-cli containerd.io

# Start and enable Docker
sudo systemctl start docker
sudo systemctl enable docker

sudo usermod -aG docker $USER
newgrp docker

Verify Docker is running:

docker version

kubectl¶

kubectl is needed to interact with your Kubernetes cluster.

brew install kubectl

curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl"
sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl

choco install kubernetes-cli

Verify kubectl is installed:

kubectl version --client

Optional¶

Cloud Provider CLIs¶

If you plan to use cloud provider credentials, you may need their respective CLIs:

AWS CLI¶

brew install awscli

curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
unzip awscliv2.zip
sudo ./aws/install

Configure credentials:

aws configure

Azure CLI¶

brew install azure-cli

curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash

Login to Azure:

az login

Task (Optional)¶

Task is a task runner used for development:

# macOS
brew install go-task

# Linux
sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b /usr/local/bin

System Requirements¶

Minimum Requirements¶

Recommended Requirements¶

Checking Prerequisites¶

kindplane includes a built-in doctor command to verify all prerequisites:

kindplane doctor

This checks:

• Docker is running
• kubectl is installed
• Sufficient disk space
• Optional tools (helm)

If any required checks fail, you'll see suggestions for how to fix them.

For more details, see the doctor command documentation.