Skip to content

readme: add docs #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 5, 2020
Merged

readme: add docs #34

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 69 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,61 @@ Inspired by `kubectl` and
[ClusterAPI's](https://github.com/kubernetes-sigs/cluster-api) `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: kind-registry
EOF
```

You can see more example configurations under [./examples](./examples).

## Why did you make this?

At [Tilt](https://tilt.dev/), we want to make Kubernetes a nice environment for local dev.
Expand All @@ -31,9 +86,21 @@ cluster](https://docs.tilt.dev/choosing_clusters.html) and example repos like

`ctlptl` is a culmination of what we've learned.

## How do I try it?
## Features

### Current

- Docker for Mac
- [KIND](https://kind.sigs.k8s.io/)
- [KIND with a registry](https://kind.sigs.k8s.io/docs/user/local-registry/)
- Allocating CPUs
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we only support this for D4M, right? i might nest this stuff:

- Docker for Mac
  - Allocating CPUs
- KIND
  - local registry

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

KIND runs in Docker for Mac! So it totally makes sense to have KIND with minCPUs, it will just set the Docker for Mac CPUs


### In progress

We're still writing it! Stay tuned.
- Minikube
- K3D
- Microk8s
- Allocating Memory

## Community

Expand Down