Skip to content

Commit 4eb0711

Browse files
authored
Merge pull request #794 from rbjorklin/docs-fix-helm-install-instructions
📖 fix helm install instructions
2 parents 114fdb2 + 439c9ad commit 4eb0711

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
lines changed

docs/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -95,19 +95,19 @@ The operator Helm chart supports a "quickstart" option for bootstrapping a manag
9595
> 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.
9696
9797
```bash
98-
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
98+
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system --set infrastructure.docker.version=v1.4.2 --wait --timeout 90s # core Cluster API with kubeadm bootstrap and control plane providers will also be installed
9999
```
100100

101101
```bash
102-
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
102+
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system --set infrastructure.docker.enabled=true,infrastructure.azure.enabled=true --wait --timeout 90s # core Cluster API with kubeadm bootstrap and control plane providers will also be installed
103103
```
104104

105105
```bash
106-
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
106+
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system --set infrastructure.docker.namespace=capd-custom-ns,infrastructure.docker.version=v1.4.2,infrastructure.azure.namespace=capz-custom-ns,infrastructure.azure.version=v1.10.0 --wait --timeout 90s # core Cluster API with kubeadm bootstrap and control plane providers will also be installed
107107
```
108108

109109
```bash
110-
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
110+
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system --set core.cluster-api.version=v1.4.2 --set controlPlane.kubeadm.version=v1.4.2 --set bootstrap.kubeadm.version=v1.4.2 --set infrastructure.docker.version=v1.4.2 --wait --timeout 90s
111111
```
112112

113113
For more complex operations, please refer to our API documentation.
@@ -124,7 +124,7 @@ The following commands will install cert-manager, CAPI operator itself with modi
124124
helm repo add jetstack https://charts.jetstack.io --force-update
125125
helm repo update
126126
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
127+
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system --set infrastructure.docker.version=v1.5.0 --wait --timeout 90s
128128
```
129129

130130
## Configuration

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ The `--wait` flag is REQUIRED for the helm install command to work. If the --wai
5353
</aside>
5454

5555
```bash
56-
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
56+
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system --set infrastructure.docker.enabled=true --set configSecret.name=${CREDENTIALS_SECRET_NAME} --set configSecret.namespace=${CREDENTIALS_SECRET_NAMESPACE} --wait --timeout 90s
5757
```
5858

5959
Docker provider can be replaced by any provider supported by [clusterctl](https://cluster-api.sigs.k8s.io/reference/providers.html#infrastructure).

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,19 @@ The `--wait` flag is REQUIRED for the helm install command to work with provider
2121
</aside>
2222

2323
```bash
24-
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
24+
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system --set infrastructure.docker.version=v1.4.2 --wait --timeout 90s # core Cluster API with kubeadm bootstrap and control plane providers will also be installed
2525
```
2626

2727
```bash
28-
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
28+
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system --set infrastructure.docker.enabled=true,infrastructure.azure.enabled=true --wait --timeout 90s # core Cluster API with kubeadm bootstrap and control plane providers will also be installed
2929
```
3030

3131
```bash
32-
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
32+
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system --set infrastructure.docker.namespace=capd-custom-ns,infrastructure.docker.version=v1.4.2,infrastructure.azure.namespace=capz-custom-ns,infrastructure.azure.version=v1.10.0 --wait --timeout 90s # core Cluster API with kubeadm bootstrap and control plane providers will also be installed
3333
```
3434

3535
```bash
36-
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
36+
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system --set core.cluster-api.version=v1.4.2 --set controlPlane.kubeadm.version=v1.4.2 --set bootstrap.kubeadm.version=v1.4.2 --set infrastructure.docker.version=v1.4.2 --wait --timeout 90s
3737
```
3838

3939
For more complex operations, please refer to our API documentation.

docs/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ The `--wait` flag is REQUIRED for the helm install command to work. If the --wai
5252
</aside>
5353

5454
```bash
55-
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
55+
helm install capi-operator capi-operator/cluster-api-operator --create-namespace -n capi-operator-system --set infrastructure.docker.enabled=true --set cert-manager.enabled=true --set configSecret.name=${CREDENTIALS_SECRET_NAME} --set configSecret.namespace=${CREDENTIALS_SECRET_NAMESPACE} --wait --timeout 90s
5656
```
5757

5858
Docker provider can be replaced by any provider supported by [clusterctl](https://cluster-api.sigs.k8s.io/reference/providers.html#infrastructure).

0 commit comments

Comments
 (0)