Skip to content

Commit aa03bb5

Browse files
committed
Align cluster-template.yaml and cluster-template-machinepool.yaml, use external cloud controller and CSI
1 parent 2fe1c84 commit aa03bb5

File tree

5 files changed

+1008
-1065
lines changed

5 files changed

+1008
-1065
lines changed

docs/book/src/topics/external-cloud-provider-with-ebs-csi-driver.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,15 @@ For clusters that will use external CCM, `cloud-provider: external` flag needs t
2727

2828

2929
External CCM and EBS CSI driver can be installed manually or using ClusterResourceSets (CRS) onto the CAPA workload cluster.
30-
To install them with CRS, create a CRS resource on the management cluster with labels, for example `csi: external` and `ccm: external` labels.
30+
To install them with CRS, create a CRS resource on the management cluster with labels, for example `csi: external` and `ccm: external` labels.
3131
Then, when creating `Cluster` objects for workload clusters that should have this CSR applied, create them with matching labels `csi: external` and `ccm: external` for CSI and CCM, respectively.
3232

33-
Manifests for installing the AWS CCM and the AWS EBS CSI driver are available from their respective
34-
GitHub repositories (see [here for the AWS CCM](https://github.com/kubernetes/cloud-provider-aws) and
33+
Manifests for installing the AWS CCM and the AWS EBS CSI driver are available from their respective
34+
GitHub repositories (see [here for the AWS CCM](https://github.com/kubernetes/cloud-provider-aws) and
3535
[here for the AWS EBS CSI driver](https://github.com/kubernetes-sigs/aws-ebs-csi-driver)).
3636

37-
An example of a workload cluster manifest with labels assigned for matching to a CRS can be found
38-
[here](https://github.com/kubernetes-sigs/cluster-api-provider-aws/tree/main/templates/cluster-template-external-cloud-provider.yaml).
37+
An example of a workload cluster manifest with labels assigned for matching to a CRS can be found
38+
[here](https://github.com/kubernetes-sigs/cluster-api-provider-aws/tree/main/templates/cluster-template.yaml).
3939

4040
### Verifying dynamically provisioned volumes with CSI driver
4141
Once you have the cluster with external CCM and CSI controller running successfully, you can test the CSI driver functioning with following steps after switching to workload cluster:
@@ -113,14 +113,14 @@ spec:
113113
3. Once you apply the above manifest, the EBS volumes will be created and attached to the worker nodes.
114114
115115
>**IMPORTANT WARNING:** The CRDs from the AWS EBS CSI driver and AWS external cloud provider gives issue while installing the respective controllers on the AWS Cluster, it doesn't allow statefulsets to create the volume on existing EC2 instance.
116-
> We need the CSI controller deployment and CCM pinned to the control plane which has right permissions to create, attach
116+
> We need the CSI controller deployment and CCM pinned to the control plane which has right permissions to create, attach
117117
> and mount the volumes to EC2 instances. To achieve this, you should add the node affinity rules to the CSI driver controller deployment and CCM DaemonSet manifests.
118118
> ```yaml
119119
> tolerations:
120120
> - key: node-role.kubernetes.io/master
121121
> effect: NoSchedule
122122
> - effect: NoSchedule
123-
> key: node-role.kubernetes.io/control-plane
123+
> key: node-role.kubernetes.io/control-plane
124124
> affinity:
125125
> nodeAffinity:
126126
> requiredDuringSchedulingIgnoredDuringExecution:
@@ -132,14 +132,14 @@ spec:
132132
> - key: node-role.kubernetes.io/master
133133
> operator: Exists
134134
>```
135-
135+
136136

137137
## Validated upgrade paths for existing clusters
138138

139139
From Kubernetes 1.23 onwards, `CSIMigrationAWS` flag is enabled by default, which requires the installation of [external CSI driver](https://github.com/kubernetes-sigs/aws-ebs-csi-driver), unless `CSIMigrationAWS` is disabled by the user.
140140
For installing external CSI/CCM in the upgraded cluster, CRS can be used, see the section above for details.
141141

142-
CCM and CSI do not need to be migrated to use external plugins at the same time,
142+
CCM and CSI do not need to be migrated to use external plugins at the same time,
143143
external CSI drivers works with in-tree CCM (Warning: using in-tree CSI with external CCM does not work).
144144

145145
**Following 3 upgrade paths are validated:**

0 commit comments

Comments
 (0)