Skip to content

Commit 046ab29

Browse files
authored
Merge pull request #4220 from binchenX/doc
📖 misc fix for developer doc
2 parents 13b8097 + 086cdbc commit 046ab29

File tree

1 file changed

+25
-5
lines changed

1 file changed

+25
-5
lines changed

docs/book/src/clusterctl/developers.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,19 +37,20 @@ In order to build artifacts for the CAPI core provider, the kubeadm bootstrap pr
3737

3838
```
3939
make docker-build REGISTRY=gcr.io/k8s-staging-cluster-api
40-
make -C test/infrastructure/docker generate-manifests REGISTRY=gcr.io/k8s-staging-cluster-api
40+
make generate-manifests REGISTRY=gcr.io/k8s-staging-cluster-api PULL_POLICY=IfNotPresent
4141
```
4242

4343
In order to build docker provider artifacts
4444

4545
```
4646
make -C test/infrastructure/docker docker-build REGISTRY=gcr.io/k8s-staging-cluster-api
47-
make -C test/infrastructure/docker generate-manifests REGISTRY=gcr.io/k8s-staging-cluster-api
47+
make -C test/infrastructure/docker generate-manifests REGISTRY=gcr.io/k8s-staging-cluster-api PULL_POLICY=IfNotPresent
4848
```
4949

5050
### Create a clusterctl-settings.json file
5151

52-
Next, create a `clusterctl-settings.json` file and place it in your local copy of Cluster API. Here is an example:
52+
Next, create a `clusterctl-settings.json` file and place it in your local copy
53+
of Cluster API. This file will be used by [create-local-repository.py](#create-the-local-repository). Here is an example:
5354

5455
```yaml
5556
{
@@ -131,12 +132,12 @@ please note that each `provider_repo` should have its own `clusterctl-settings.j
131132
}
132133
```
133134

134-
## Create a kind cluster
135+
## Create a kind management cluster
135136

136137
[kind] can provide a Kubernetes cluster to be used a management cluster.
137138
See [Install and/or configure a kubernetes cluster] for more about how.
138139

139-
Before running clusterctl init, you must ensure all the required images are available in the kind cluster.
140+
*Before* running clusterctl init, you must ensure all the required images are available in the kind cluster.
140141

141142
This is always the case for images published in some image repository like docker hub or gcr.io, but it can't be
142143
the case for images built locally; in this case, you can use `kind load` to move the images built locally. e.g
@@ -150,6 +151,25 @@ kind load docker-image gcr.io/k8s-staging-cluster-api/capd-manager-amd64:dev
150151

151152
to make the controller images available for the kubelet in the management cluster.
152153

154+
When the kind cluster is ready and all the required images are in place, run
155+
the clusterctl init command generated by the create-local-repository.py
156+
script.
157+
158+
Optionally, you may want to check if the components are running properly. The
159+
exactly components are depend on which providers you have initialized, below
160+
is an example output with docker provider being installed.
161+
162+
```
163+
kubectl get deploy -A | grep "cap\|cert"
164+
capd-system capd-controller-manager 1/1 1 1 25m
165+
capi-kubeadm-bootstrap-system capi-kubeadm-bootstrap-controller-manager 1/1 1 1 25m
166+
capi-kubeadm-control-plane-system capi-kubeadm-control-plane-controller-manager 1/1 1 1 25m
167+
capi-system capi-controller-manager 1/1 1 1 25m
168+
cert-manager cert-manager 1/1 1 1 27m
169+
cert-manager cert-manager-cainjector 1/1 1 1 27m
170+
cert-manager cert-manager-webhook 1/1 1 1 27m
171+
```
172+
153173
## Additional Notes for the Docker Provider
154174

155175
### Select the appropriate kubernetes version

0 commit comments

Comments
 (0)