Skip to content

Commit ecbefe6

Browse files
committed
Fix docs regarding helm chart installs
1 parent 7e8c9cd commit ecbefe6

File tree

4 files changed

+49
-5
lines changed

4 files changed

+49
-5
lines changed

docs/README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,9 @@ helm install capi-operator capi-operator/cluster-api-operator --create-namespace
9191

9292
The operator Helm chart supports a "quickstart" option for bootstrapping a management cluster. The user experience is relatively similar to [clusterctl init](https://cluster-api.sigs.k8s.io/clusterctl/commands/init.html?highlight=init#clusterctl-init):
9393

94+
> **Warning**
95+
> The `--wait` flag is REQUIRED for the helm install command to work with providers. If the --wait flag is not used, the helm install command will not wait for the resources to be created and will return immediately.
96+
9497
```bash
9598
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system --set infrastructure=docker:v1.4.2 --wait --timeout 90s # core Cluster API with kubeadm bootstrap and control plane providers will also be installed
9699
```
@@ -115,10 +118,13 @@ The operator Helm chart provides multiple ways to configure deployment. For inst
115118

116119
#### Helm installation example
117120

118-
The following command will install cert-manager, CAPI operator itself with modified log level, Core CAPI provider with kubeadm bootstrap and control plane, and Docker infrastructure.
121+
The following commands will install cert-manager, CAPI operator itself with modified log level, Core CAPI provider with kubeadm bootstrap and control plane, and Docker infrastructure.
119122

120123
```bash
121-
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system --set infrastructure=docker:v1.5.0 --set cert-manager.enabled=true --set logLevel=4 --wait --timeout 90s
124+
helm repo add jetstack https://charts.jetstack.io --force-update
125+
helm repo update
126+
helm install cert-manager jetstack/cert-manager --namespace cert-manager --create-namespace --set installCRDs=true
127+
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system --set infrastructure=docker:v1.5.0 --wait --timeout 90s
122128
```
123129

124130
## Configuration

docs/book/src/01_user/02_quick-start.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,29 @@ kubectl create secret generic "${CREDENTIALS_SECRET_NAME}" --from-literal=AWS_B6
2828

2929
### Installing Cluster API Operator
3030

31-
Add helm repository:
31+
Add CAPI Operator & cert manager helm repository:
3232

3333
```bash
3434
helm repo add capi-operator https://kubernetes-sigs.github.io/cluster-api-operator
35+
helm repo add jetstack https://charts.jetstack.io --force-update
3536
helm repo update
3637
```
3738

38-
Deploy Cluster API components with docker provider using a single command during operator installation
39+
Install cert manager:
40+
41+
```bash
42+
helm install cert-manager jetstack/cert-manager --namespace cert-manager --create-namespace --set installCRDs=true
43+
```
44+
45+
Deploy Cluster API components with docker provider using a single command during operator installation.
46+
47+
<aside class="note warning">
48+
49+
<h1> Warning </h1>
50+
51+
The `--wait` flag is REQUIRED for the helm install command to work. If the --wait flag is not used, the helm install command will not wait for the resources to be created and will return immediately. This will cause the helm install command to fail because the webhooks will not be ready in time. The --timeout flag is optional and can be used to specify the amount of time to wait for the resources to be created.
52+
53+
</aside>
3954

4055
```bash
4156
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system --set infrastructure=docker --set configSecret.name=${CREDENTIALS_SECRET_NAME} --set configSecret.namespace=${CREDENTIALS_SECRET_NAMESPACE} --wait --timeout 90s

docs/book/src/02_installation/04_helm-chart-installation.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@ helm install capi-operator capi-operator/cluster-api-operator --create-namespace
1212

1313
The operator Helm chart supports a "quickstart" option for bootstrapping a management cluster. The user experience is relatively similar to [clusterctl init](https://cluster-api.sigs.k8s.io/clusterctl/commands/init.html?highlight=init#clusterctl-init):
1414

15+
<aside class="note warning">
16+
17+
<h1> Warning </h1>
18+
19+
The `--wait` flag is REQUIRED for the helm install command to work with providers.
20+
21+
</aside>
22+
1523
```bash
1624
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system --set infrastructure=docker:v1.4.2 --wait --timeout 90s # core Cluster API with kubeadm bootstrap and control plane providers will also be installed
1725
```

docs/quickstart.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,30 @@ kubectl create secret generic "${CREDENTIALS_SECRET_NAME}" --from-literal=AWS_B6
2727

2828
### Installing Cluster API Operator
2929

30-
Add helm repository:
30+
Add CAPI Operator & cert manager helm repository:
3131

3232
```bash
3333
helm repo add capi-operator https://kubernetes-sigs.github.io/cluster-api-operator
34+
helm repo add jetstack https://charts.jetstack.io --force-update
3435
helm repo update
3536
```
3637

38+
Install cert manager:
39+
40+
```bash
41+
helm install cert-manager jetstack/cert-manager --namespace cert-manager --create-namespace --set installCRDs=true
42+
```
43+
3744
Deploy Cluster API components with docker provider using a single command during operator installation
3845

46+
<aside class="note warning">
47+
48+
<h1> Warning </h1>
49+
50+
The `--wait` flag is REQUIRED for the helm install command to work. If the --wait flag is not used, the helm install command will not wait for the resources to be created and will return immediately. This will cause the helm install command to fail because the webhooks will not be ready in time. The --timeout flag is optional and can be used to specify the amount of time to wait for the resources to be created.
51+
52+
</aside>
53+
3954
```bash
4055
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system --set infrastructure=docker --set cert-manager.enabled=true --set configSecret.name=${CREDENTIALS_SECRET_NAME} --set configSecret.namespace=${CREDENTIALS_SECRET_NAMESPACE} --wait --timeout 90s
4156
```

0 commit comments

Comments
 (0)