Skip to content

Commit e12ecb1

Browse files
docs(eks): add documentation about add-ons (#30815)
### Issue # (if applicable) None ### Reason for this change Addon L2 construct is added by #30576 but there is no documentation about it in the README.md. ### Description of changes Add Add-ons documentation to README.md ### Description of how you validated changes None ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent 40a8e61 commit e12ecb1

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

packages/aws-cdk-lib/aws-eks/README.md

+15
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ In addition, the library also supports defining Kubernetes resource manifests wi
5555
- [Manually importing k8s specs and CRD's](#manually-importing-k8s-specs-and-crds)
5656
- [Patching Kubernetes Resources](#patching-kubernetes-resources)
5757
- [Querying Kubernetes Resources](#querying-kubernetes-resources)
58+
- [Add-ons](#add-ons)
5859
- [Using existing clusters](#using-existing-clusters)
5960
- [Logging](#logging)
6061
- [Known Issues and Limitations](#known-issues-and-limitations)
@@ -1837,6 +1838,20 @@ declare const cluster: eks.Cluster;
18371838
const loadBalancerAddress = cluster.getServiceLoadBalancerAddress('my-service');
18381839
```
18391840

1841+
## Add-ons
1842+
1843+
[Add-ons](https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html) is a software that provides supporting operational capabilities to Kubernetes applications. The EKS module supports adding add-ons to your cluster using the `eks.Addon` class.
1844+
1845+
```ts
1846+
declare const cluster: eks.Cluster;
1847+
1848+
new eks.Addon(this, 'Addon', {
1849+
cluster,
1850+
addonName: 'aws-guardduty-agent',
1851+
addonVersion: 'v1.6.1',
1852+
});
1853+
```
1854+
18401855
## Using existing clusters
18411856

18421857
The Amazon EKS library allows defining Kubernetes resources such as [Kubernetes

0 commit comments

Comments
 (0)