Skip to content

Commit bcefca4

Browse files
updates Readme
1 parent 940a527 commit bcefca4

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,53 @@ locals {
150150
}
151151

152152
```
153+
154+
## EKS Compatibility
155+
156+
This module supports AWS EKS (Elastic Kubernetes Service) by enabling per-subnet custom tagging. EKS requires specific tags on subnets for proper ALB/NLB provisioning and cluster auto-discovery.
157+
158+
### Required EKS Tags
159+
160+
- **Public subnets**: `kubernetes.io/role/elb = "1"`
161+
- **Private subnets**: `kubernetes.io/role/internal-elb = "1"`
162+
- **All subnets**: `kubernetes.io/cluster/<cluster-name> = "shared"` or `"owned"`
163+
164+
### Usage with Auto-Generated Subnets
165+
166+
Use `additional_public_subnet_tags` and `additional_private_subnet_tags` variables:
167+
168+
```hcl
169+
module "network" {
170+
# ... other configuration
171+
172+
additional_public_subnet_tags = {
173+
"kubernetes.io/role/elb" = "1"
174+
"kubernetes.io/cluster/my-eks-cluster" = "shared"
175+
}
176+
177+
additional_private_subnet_tags = {
178+
"kubernetes.io/role/internal-elb" = "1"
179+
"kubernetes.io/cluster/my-eks-cluster" = "shared"
180+
}
181+
}
182+
```
183+
184+
### Usage with Custom Subnets
185+
186+
Add `tags` field to each subnet in `subnet_map`:
187+
188+
```hcl
189+
subnet_map = {
190+
"public-subnet" = {
191+
# ... subnet configuration
192+
tags = {
193+
"kubernetes.io/role/elb" = "1"
194+
"kubernetes.io/cluster/my-eks-cluster" = "shared"
195+
}
196+
}
197+
}
198+
```
199+
153200
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
154201
## Requirements
155202

0 commit comments

Comments
 (0)