Skip to content

Commit 508caed

Browse files
authored
Merge pull request #240 from Danil-Grigorev/update-readme
📖 Fix typo in helm command README, add recommended timeout value
2 parents 61cbbc4 + facf10b commit 508caed

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -92,19 +92,19 @@ CAPI operator Helm chart supports provisioning of cert-manager as a dependency.
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

9494
```bash
95-
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system --set infrastructure=docker:v1.4.2 --wait # core Cluster API with kubeadm bootstrap and control plane providers will also be installed
95+
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
9696
```
9797

9898
```bash
99-
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system —set infrastructure=docker,azure --wait # core Cluster API with kubeadm bootstrap and control plane providers will also be installed
99+
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system —set infrastructure="docker;azure" --wait --timeout 90s # core Cluster API with kubeadm bootstrap and control plane providers will also be installed
100100
```
101101

102102
```bash
103-
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system —set infrastructure="capd-custom-ns:docker:v1.4.2;capz-custom-ns:azure:v1.10.0" --wait # core Cluster API with kubeadm bootstrap and control plane providers will also be installed
103+
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system —set infrastructure="capd-custom-ns:docker:v1.4.2;capz-custom-ns:azure:v1.10.0" --wait --timeout 90s # core Cluster API with kubeadm bootstrap and control plane providers will also be installed
104104
```
105105

106106
```bash
107-
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system --set core=cluster-api:v1.4.2 --set controlPlane=kubeadm:v1.4.2 --set bootstrap=kubeadm:v1.4.2 --set infrastructure=docker:v1.4.2 --wait
107+
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system --set core=cluster-api:v1.4.2 --set controlPlane=kubeadm:v1.4.2 --set bootstrap=kubeadm:v1.4.2 --set infrastructure=docker:v1.4.2 --wait --timeout 90s
108108
```
109109

110110
For more complex operations, please refer to our API documentation.
@@ -118,7 +118,7 @@ The operator Helm chart provides multiple ways to configure deployment. For inst
118118
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.
119119

120120
```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
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
122122
```
123123

124124
## Configuration

0 commit comments

Comments
 (0)