Skip to content

docs: update EKS documentation with k3d load balancer note #185

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Sep 11, 2025
Merged

docs: update EKS documentation with k3d load balancer note #185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d1fdf2d
Update EKS documentation with k3d load balancer note
quetzalliwrites Sep 11, 2025
e1791d5
remove deprecated note
quetzalliwrites Sep 11, 2025
e5142f8
updated config doc eks table
quetzalliwrites Sep 11, 2025
dfd38c7
Update src/content/docs/aws/capabilities/config/configuration.md
quetzalliwrites Sep 11, 2025
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
3 changes: 2 additions & 1 deletion src/content/docs/aws/capabilities/config/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,8 @@ This section covers configuration options that are specific to certain AWS servi
| `EKS_K3S_IMAGE_TAG` | `v1.31.5-k3s1` (default) | Custom tag of the `rancher/k3s` image used to spin up Kubernetes clusters locally. |
| `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) |
| `EKS_K3S_IMAGE_REPOSITORY` | `rancher/k3s` (default) | Custom repository of the `rancher/k3s` image used to spin up Kubernetes clusters locally. |

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

### ElastiCache

| Variable | Example Values | Description |
Expand Down
14 changes: 9 additions & 5 deletions src/content/docs/aws/services/eks.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,15 @@ The default approach for creating Kubernetes clusters using the local EKS API is
LocalStack seamlessly manages the download and installation process, making it hassle-free for users.
In most cases, the installation is automatic, eliminating the need for any manual customizations.

:::note
The Traefik ingress controller and the default k3d load balancer containers are no longer started automatically when creating an EKS cluster.
To restore the previous behavior, set the following configuration variable:

```bash
EKS_START_K3D_LB_INGRESS=1
```
:::

You can create a new cluster using the [`CreateCluster`](https://docs.aws.amazon.com/eks/latest/APIReference/API_CreateCluster.html) API.
Run the following command:

Expand Down Expand Up @@ -524,11 +533,6 @@ awslocal eks create-cluster \
}
```

:::note
Note that the tag was previously referred to as `__k3d_volume_mount__`, but it has now been renamed to `_volume_mount_`.
As a result, the tag name `__k3d_volume_mount__` is considered deprecated and will be removed in an upcoming release.
:::

After creating your cluster with the `_volume_mount_` tag, you can create your path with volume mounts as usual.
The configuration for the volume mounts can be set up similar to this:

Expand Down