ctlptl

README

ctlptl

Want to mess around with Kubernetes, but don't want to spend an ocean on hardware?

Maybe you need a ctlptl.

What is ctlptl?

ctlptl (pronounced "cattle paddle") is a CLI for declaratively setting up local Kubernetes clusters.

Inspired by kubectl and ClusterAPI's clusterctl, you declare your local cluster with YAML and use ctlptl to set it up.

How do I install it?

Homebrew (Mac/Linux)

brew install tilt-dev/tap/ctlptl

Scoop (Windows)

scoop bucket add tilt-dev https://github.com/tilt-dev/scoop-bucket
scoop install ctlptl

How do I use it?

ctlptl supports 3 major commands:

• ctlptl apply -f cluster.yaml - ensure a cluster exists, or create one
• ctlptl delete -f cluster.yaml - delete a cluster and its state
• ctlptl get - see all running clusters

Examples

Turn on Kubernetes in Docker for Mac and make sure it has at least 4 CPU:

cat <<EOF | ctlptl apply -f -
apiVersion: ctlptl.dev/v1alpha1
kind: Cluster
product: docker-desktop
minCPUs: 4
EOF

Reset and shutdown the Kubernetes cluster in Docker for Mac:

ctlptl delete cluster docker-desktop

Create a KIND cluster with a built-in registry:

cat <<EOF | ctlptl apply -f -
apiVersion: ctlptl.dev/v1alpha1
kind: Cluster
product: kind
registry: ctlptl-registry
EOF

Create a Minikube cluster with a built-in registry:

cat <<EOF | ctlptl apply -f -
apiVersion: ctlptl.dev/v1alpha1
kind: Cluster
product: minikube
registry: ctlptl-registry
EOF

For more details, see:

• Example configurations under ./examples
• Complete CLI docs under ./docs
• Cluster API reference under pkg.go.dev

Why did you make this?

At Tilt, we want to make Kubernetes a nice environment for local dev.

We found ourselves spending too much time helping teams debug misconfigurations in their dev environment.

We wrote docs like Choosing a local dev cluster and example repos like kind-local, minikube-local, and k3d-local to help people get set up.

ctlptl is a culmination of what we've learned.

Features

Current

• Docker for Mac
• Docker for Windows
• KIND and KIND with a registry
• Minikube and Minikube with a registry
• Allocating CPUs

In progress

• K3D
• Microk8s
• Allocating Memory

Community

ctlptl is a work in progress!

We welcome contributions from the Kubernetes community to help make this better.

We expect everyone -- users, contributors, followers, and employees alike -- to abide by our Code of Conduct.

Goals

• To support common local cluster setup operations, like create, delete, and reset

• To interoperate well with all local Kubernetes solutions, including docker-desktop, kind, minikube, k3d, or microk8s

• To connect other resources to a local cluster, like image registries, storage, and CPU/memory

• To help infra engineers manage a consistent dev environment

• To encourage standards that enable interop between devtools, lke KEP 1755

Non-Goals

• ctlptl is NOT a Kubernetes setup approach that competes with kind or minikube, but rather complements these tools.

• ctlptl is NOT intended to help you setup a remote cluster, or a remote dev sandbox. If you want to declaratively set up prod clusters, check out clusterapi.

License

Copyright 2020 Windmill Engineering

Licensed under the Apache License, Version 2.0