Skip to content

Commit

Permalink
Document overridesFolder config property
Browse files Browse the repository at this point in the history
  • Loading branch information
Warren Fernandes committed Mar 13, 2020
1 parent ed80ee6 commit 3ee5e8e
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions docs/book/src/clusterctl/developers.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,19 @@ in order to use them, please run:

clusterctl init --core cluster-api:v0.3.0 --bootstrap kubeadm:v0.3.0 --infrastructure aws:v0.5.0
```
<aside class="note warning">

<h1>Note</h1>

If you decide to move the overrides directory to a different location (e.g.
`~/workspace/dev-releases`) you can specify the overrides directory in the
clusterctl config file as

```yaml
overridesFolder: ~/workspace/dev-releases
```
</aside>
## Available providers
Expand Down Expand Up @@ -94,10 +107,10 @@ Before running the local-overrides hack:
- Run `make -C test/infrastructure/docker docker-build REGISTRY=gcr.io/k8s-staging-capi-docker` to build the docker provider image
using a specific REGISTRY (you can choose your own).

- Run `make -C test/infrastructure/docker generate-manifests REGISTRY=gcr.io/k8s-staging-capi-docker` to generate
- Run `make -C test/infrastructure/docker generate-manifests REGISTRY=gcr.io/k8s-staging-capi-docker` to generate
the docker provider manifest using the above registry/Image.

Run the local-overrides hack and save the `clusterctl init` command provided in the command output to be used later.
Run the local-overrides hack and save the `clusterctl init` command provided in the command output to be used later.

Edit the clusterctl config file located at `~/.cluster-api/clusterctl.yaml` and configure the docker provider
by adding the following lines (replace $HOME with your home path):
Expand Down Expand Up @@ -130,7 +143,7 @@ EOF
- Run `kind create cluster --config ./kind-cluster-with-extramounts.yaml` to create the management cluster using the above file

- Run `kind load docker-image gcr.io/k8s-staging-capi-docker/capd-manager-amd64:dev` to make the docker provider image available
for the kubelet in the management cluster.
for the kubelet in the management cluster.

Run `clusterctl init` command provided as output of the local-overrides hack.

Expand All @@ -157,7 +170,7 @@ sed -i -e "s/certificate-authority-data:.*/insecure-skip-tls-verify: true/g" ./c

### Known issues

A [known issue](https://github.com/kubernetes-sigs/kind/issues/891) affects Calico with the Docker provider v0.2.0.
A [known issue](https://github.com/kubernetes-sigs/kind/issues/891) affects Calico with the Docker provider v0.2.0.
After you deploy Calico, apply this patch to work around the issue:

```bash
Expand Down

0 comments on commit 3ee5e8e

Please sign in to comment.