Skip to content

Commit 66b277e

Browse files
authored
Merge pull request #1 from tilt-dev/nicks/README
add a readme
2 parents e4bfecf + 37c9e73 commit 66b277e

File tree

1 file changed

+39
-1
lines changed

1 file changed

+39
-1
lines changed

README.md

+39-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,40 @@
11
# ctlptl
2-
Making local Kubernetes clusters fun and easy to set up
2+
3+
Want to mess around with Kubernetes, but don't want to spend an ocean on
4+
hardware?
5+
6+
Maybe you need a `ctlptl`.
7+
8+
## What is ctlptl?
9+
10+
`ctlptl` (pronounced "cuddle puddle") is a CLI for declaratively setting up
11+
local Kubernetes clusters.
12+
13+
Inspired by `kubectl` and
14+
[ClusterAPI's](https://github.com/kubernetes-sigs/cluster-api) `clusterctl`, you
15+
declare your local cluster with YAML and use `ctlptl` to set it up.
16+
17+
## Why did you make this?
18+
19+
At [Tilt](https://tilt.dev/), we want to make Kubernetes a nice environment for local dev.
20+
21+
We found ourselves spending too much time helping teams debug misconfigurations in their dev environment.
22+
23+
We wrote docs like [Choosing a local dev
24+
cluster](https://docs.tilt.dev/choosing_clusters.html) and example repos like
25+
[kind-local](https://github.com/tilt-dev/kind-local),
26+
[minikube-local](https://github.com/tilt-dev/minikube-local), and
27+
[k3d-local](https://github.com/tilt-dev/k3d-local) to help people get set up.
28+
29+
`ctlptl` is a culmination of what we've learned.
30+
31+
## How do I try it?
32+
33+
We're still writing it! Stay tuned.
34+
35+
## License
36+
37+
Copyright 2020 Windmill Engineering
38+
39+
Licensed under [the Apache License, Version 2.0](LICENSE)
40+

0 commit comments

Comments
 (0)