Skip to content

Commit 4a3e912

Browse files
docs: update EKS documentation with k3d load balancer note (#185)
Co-authored-by: Daniel Fangl <[email protected]>
1 parent eb7b686 commit 4a3e912

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

src/content/docs/aws/capabilities/config/configuration.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,8 @@ This section covers configuration options that are specific to certain AWS servi
198198
| `EKS_K3S_IMAGE_TAG` | `v1.31.5-k3s1` (default) | Custom tag of the `rancher/k3s` image used to spin up Kubernetes clusters locally. |
199199
| `EKS_K8S_PROVIDER` | `k3s` (default)\|`local` | The k8s provider which should be used to start the k8s cluster backing EKS. For more information on the providers, please see [Elastic Kubernetes Service (EKS)](/aws/services/eks) |
200200
| `EKS_K3S_IMAGE_REPOSITORY` | `rancher/k3s` (default) | Custom repository of the `rancher/k3s` image used to spin up Kubernetes clusters locally. |
201-
201+
| `EKS_START_K3D_LB_INGRESS` | `0` (default) | Whether to start the k3d load balancer and Traefik ingress controller automatically when creating an EKS cluster. Set to `1` to enable. |
202+
202203
### ElastiCache
203204

204205
| Variable | Example Values | Description |

src/content/docs/aws/services/eks.mdx

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,15 @@ The default approach for creating Kubernetes clusters using the local EKS API is
2929
LocalStack seamlessly manages the download and installation process, making it hassle-free for users.
3030
In most cases, the installation is automatic, eliminating the need for any manual customizations.
3131

32+
:::note
33+
The Traefik ingress controller and the default k3d load balancer containers are no longer started automatically when creating an EKS cluster.
34+
To restore the previous behavior, set the following configuration variable:
35+
36+
```bash
37+
EKS_START_K3D_LB_INGRESS=1
38+
```
39+
:::
40+
3241
You can create a new cluster using the [`CreateCluster`](https://docs.aws.amazon.com/eks/latest/APIReference/API_CreateCluster.html) API.
3342
Run the following command:
3443

@@ -524,11 +533,6 @@ awslocal eks create-cluster \
524533
}
525534
```
526535

527-
:::note
528-
Note that the tag was previously referred to as `__k3d_volume_mount__`, but it has now been renamed to `_volume_mount_`.
529-
As a result, the tag name `__k3d_volume_mount__` is considered deprecated and will be removed in an upcoming release.
530-
:::
531-
532536
After creating your cluster with the `_volume_mount_` tag, you can create your path with volume mounts as usual.
533537
The configuration for the volume mounts can be set up similar to this:
534538

0 commit comments

Comments
 (0)