Skip to content

Commit 679c513

Browse files
committed
Add documentation
1 parent b4441d9 commit 679c513

File tree

3 files changed

+71
-6
lines changed

3 files changed

+71
-6
lines changed

userdocs/src/usage/addon-upgrade.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Default add-on updates
22

3+
!!! warning "New for 2024"
4+
eksctl now installs default addons as EKS addons instead of self-managed addons. Read more about its implications in [Cluster creation flexibility for default networking addons](#cluster-creation-flexibility-for-default-networking-addons).
5+
6+
!!! warning "New for 2024"
7+
For updating addons, `eksctl utils update-*` cannot be used for clusters created with eksctl v0.184.0 and above.
8+
This guide is only valid for clusters created before this change.
9+
310
There are 3 default add-ons that get included in each EKS cluster:
411
- `kube-proxy`
512
- `aws-node`

userdocs/src/usage/addons.md

Lines changed: 56 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ CNI plugin through the EKS API
66

77
## Creating addons (and providing IAM permissions via IRSA)
88

9+
!!! tip "New for 2024"
10+
eksctl now supports creating clusters without any default networking addons: [Cluster creation flexibility for default networking addons](#cluster-creation-flexibility-for-default-networking-addons).
11+
12+
!!! warning "New for 2024"
13+
eksctl now installs default addons as EKS addons instead of self-managed addons. Read more about its implications in [Cluster creation flexibility for default networking addons](#cluster-creation-flexibility-for-default-networking-addons).
14+
915
!!! tip "New for 2024"
1016
EKS Add-ons now support receiving IAM permissions, required to connect with AWS services outside of cluster, via [EKS Pod Identity Associations](/usage/pod-identity-associations/#eks-add-ons-support-for-pod-identity-associations)
1117

@@ -87,8 +93,8 @@ addons:
8793

8894
For addon create, the `resolveConflicts` field supports three distinct values:
8995

90-
- `none` - EKS doesn't change the value. The create might fail.
91-
- `overwrite` - EKS overwrites any config changes back to EKS default values.
96+
- `none` - EKS doesn't change the value. The create might fail.
97+
- `overwrite` - EKS overwrites any config changes back to EKS default values.
9298
- `preserve` - EKS doesn't change the value. The create might fail. (Similarly to `none`, but different from [`preserve` in updating addons](#updating-addons))
9399

94100
## Listing enabled addons
@@ -141,7 +147,7 @@ eksctl utils describe-addon-configuration --name vpc-cni --version v1.12.0-eksbu
141147
This returns a JSON schema of the various options available for this addon.
142148

143149
## Working with configuration values
144-
`ConfigurationValues` can be provided in the configuration file during the creation or update of addons. Only JSON and YAML formats are supported.
150+
`ConfigurationValues` can be provided in the configuration file during the creation or update of addons. Only JSON and YAML formats are supported.
145151

146152
For eg.,
147153

@@ -202,10 +208,10 @@ addons:
202208
resolveConflicts: preserve
203209
```
204210

205-
For addon update, the `resolveConflicts` field accepts three distinct values:
211+
For addon update, the `resolveConflicts` field accepts three distinct values:
206212

207213
- `none` - EKS doesn't change the value. The update might fail.
208-
- `overwrite` - EKS overwrites any config changes back to EKS default values.
214+
- `overwrite` - EKS overwrites any config changes back to EKS default values.
209215
- `preserve` - EKS preserves the value. If you choose this option, we recommend that you test any field and value changes on a non-production cluster before updating the add-on on your production cluster.
210216

211217
## Deleting addons
@@ -216,3 +222,48 @@ eksctl delete addon --cluster <cluster-name> --name <addon-name>
216222
This will delete the addon and any IAM roles associated to it.
217223

218224
When you delete your cluster all IAM roles associated to addons are also deleted.
225+
226+
## Cluster creation flexibility for default networking addons
227+
228+
When a cluster is created, EKS automatically installs VPC CNI, CoreDNS and kube-proxy as self-managed addons.
229+
To disable this behavior in order to use other CNI plugins like Cilium and Calico, eksctl now supports creating a cluster
230+
without any default networking addons. To create such a cluster, set `addonsConfig.disableDefaultAddons`, as in:
231+
232+
```yaml
233+
addonsConfig:
234+
disableDefaultAddons: true
235+
```
236+
237+
```shell
238+
$ eksctl create cluster -f cluster.yaml
239+
```
240+
241+
To create a cluster with only CoreDNS and kube-proxy and not VPC CNI, specify the addons explicitly in `addons`
242+
and set `addonsConfig.disableDefaultAddons`, as in:
243+
244+
```yaml
245+
addonsConfig:
246+
disableDefaultAddons: true
247+
addons:
248+
- name: kube-proxy
249+
- name: coredns
250+
```
251+
252+
```shell
253+
$ eksctl create cluster -f cluster.yaml
254+
```
255+
256+
As part of this change, eksctl now installs default addons as EKS addons instead of self-managed addons during cluster creation
257+
if `addonsConfig.disableDefaultAddons` is not explicitly set to true. As such, `eksctl utils update-*` commands can no
258+
longer be used for updating addons for clusters created with eksctl v0.184.0 and above:
259+
260+
- `eksctl utils update-aws-node`
261+
- `eksctl utils update-coredns`
262+
- `eksctl utils update-kube-proxy`
263+
264+
Instead, `eksctl update addon` should be used now.
265+
266+
To learn more, see [EKS documentation][eksdocs].
267+
268+
269+
[eksdocs]: https://aws.amazon.com/about-aws/whats-new/2024/06/amazon-eks-cluster-creation-flexibility-networking-add-ons/

userdocs/theme/main.html

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,18 @@
66
<code>eksctl</code> is now fully maintained by AWS. For more details check out
77
<a class="announce" href="https://github.com/aws/containers-roadmap/issues/2280">eksctl Support Status Update</a>.
88
</p>
9+
<p style="text-align: center;">
10+
<code>eksctl</code> now supports <a href="/usage/addons/#cluster-creation-flexibility-for-default-networking-addons">Cluster creation flexibility for networking add-ons</a>.
11+
</p>
12+
<p style="text-align: center;">
13+
<code>eksctl</code> now installs default addons as EKS addons instead of self-managed addons. To understand its implications, check out
14+
<a href="/usage/addons/#cluster-creation-flexibility-for-default-networking-addons">Cluster creation flexibility for networking add-ons</a>.
15+
</p>
916
{% endblock %}
1017

1118

1219
{% block scripts %}
1320
<!-- Add scripts that need to run before here -->
1421
{{ super() }}
1522

16-
{% endblock %}
23+
{% endblock %}

0 commit comments

Comments
 (0)