Skip to content
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

📖 book/tilt: update prerequisites #6102

Merged
merged 1 commit into from
Feb 11, 2022
Merged

📖 book/tilt: update prerequisites #6102

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
27 changes: 7 additions & 20 deletions docs/book/src/developer/tilt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,30 +7,17 @@ workflow that offers easy deployments and rapid iterative builds.

## Prerequisites

1. [Docker](https://docs.docker.com/install/) v19.03 or newer
1. [kind](https://kind.sigs.k8s.io) v0.9 or newer (other clusters can be
1. [Docker](https://docs.docker.com/install/): v19.03 or newer
1. [kind](https://kind.sigs.k8s.io): v0.9 or newer (other clusters can be
used if `preload_images_for_kind` is set to false)
1. [kustomize](https://kubectl.docs.kubernetes.io/installation/kustomize/)
standalone (`kubectl kustomize` does not work because it is missing
some features of kustomize v3)
1. [Tilt](https://docs.tilt.dev/install.html) v0.22.2 or newer
1. [envsubst](https://github.com/drone/envsubst) or similar to handle
clusterctl var replacement. Note: drone/envsubst releases v1.0.2 and
earlier do not have the binary packaged under cmd/envsubst. It is
available in Go pseudo-version `v1.0.3-0.20200709231038-aa43e1c1a629`
1. Clone the [Cluster
API](https://github.com/kubernetes-sigs/cluster-api) repository
1. [Tilt](https://docs.tilt.dev/install.html): v0.22.2 or newer
1. [kustomize](https://github.com/kubernetes-sigs/kustomize): provided via `make kustomize`
1. [envsubst](https://github.com/drone/envsubst): provided via `make envsubst`
1. [helm](https://github.com/helm/helm): v3.7.1 or newer
1. Clone the [Cluster API](https://github.com/kubernetes-sigs/cluster-api) repository
locally
Copy link
Member Author

Choose a reason for hiding this comment

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

I can keep l.27-l.28 if there is a good way to do it. I inlined the make envsubst and then l.27-l.28 seemed out of place.

Not sure if we really have to mention it here.

Copy link
Contributor

Choose a reason for hiding this comment

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

I like the way you have it now. I think it's simpler and more clear having it just mention the "provided by make X".

1. Clone the provider(s) you want to deploy locally as well

We provide a make target to generate the envsubst binary if desired.
See the [provider contract](./../clusterctl/provider-contract.md) for
more details about how clusterctl uses variables.

```
make envsubst
```

## Getting started

### Create a kind cluster
Expand Down