Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(eks): add documentation about add-ons #30815

Merged
merged 5 commits into from
Jul 17, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions packages/aws-cdk-lib/aws-eks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ In addition, the library also supports defining Kubernetes resource manifests wi
- [Manually importing k8s specs and CRD's](#manually-importing-k8s-specs-and-crds)
- [Patching Kubernetes Resources](#patching-kubernetes-resources)
- [Querying Kubernetes Resources](#querying-kubernetes-resources)
- [Add-ons](#add-ons)
- [Using existing clusters](#using-existing-clusters)
- [Logging](#logging)
- [Known Issues and Limitations](#known-issues-and-limitations)
Expand Down Expand Up @@ -1837,6 +1838,20 @@ declare const cluster: eks.Cluster;
const loadBalancerAddress = cluster.getServiceLoadBalancerAddress('my-service');
```

## Add-ons

[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.

```ts
declare const cluster: eks.Cluster;

new eks.Addon(this, 'Addon', {
cluster,
addonName: 'aws-guardduty-agent',
addonVersion: 'v1.6.1',
});
```

## Using existing clusters

The Amazon EKS library allows defining Kubernetes resources such as [Kubernetes
Expand Down