Skip to content
This repository was archived by the owner on Jul 9, 2025. It is now read-only.

Commit 8d76314

Browse files
committed
Document new config variable EKS_K8S_PROVIDERand enhance documentation of local provider
1 parent e290135 commit 8d76314

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

content/en/references/configuration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,7 @@ This section covers configuration options that are specific to certain AWS servi
165165
| - | - | - |
166166
| `EKS_LOADBALANCER_PORT` | `8081` (default) | Local port on which the Kubernetes load balancer is exposed on the host. |
167167
| `EKS_K3S_IMAGE_TAG` | `v1.22.6-k3s1` (default) | Custom tag of the `k8s/rancher` image used to spin up Kubernetes clusters locally. |
168+
| `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)]({{< ref "user-guide/aws/eks" >}}) |
168169

169170
### ElastiCache
170171

content/en/user-guide/aws/eks/index.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -335,13 +335,24 @@ If your ingress and services are residing in a custom namespace, it is essential
335335
## Use an existing Kubernetes installation
336336

337337
You can also access the EKS API using your existing local Kubernetes installation.
338-
This can be achieved by mounting the `$HOME/.kube/config` file into the LocalStack container, especially when using a `docker-compose.yml` file:
338+
This can be achieved by setting the configuration variable `EKS_K8S_PROVIDER=local` and mounting the `$HOME/.kube/config` file into the LocalStack container.
339+
When using a `docker-compose.yml` file, you need to add a bind mount like this:
339340

340341
```yaml
341342
volumes:
342343
- "${HOME}/.kube/config:/root/.kube/config"
343344
```
344345
346+
When using the LocalStack CLI, please configure the `DOCKER_FLAGS` to mount the kubeconfig into the container:
347+
348+
{{< command >}}
349+
$ DOCKER_FLAGS="-v ${HOME}/.kube/config:/root/.kube/config" localstack start
350+
{{</ command >}}
351+
352+
{{< callout >}}
353+
Using an existing Kubernetes installation is currently only possible when the authentication with the cluster uses X509 client certificates: https://kubernetes.io/docs/reference/access-authn-authz/authentication/#x509-client-certificates
354+
{{< /callout >}}
355+
345356
In recent versions of Docker, you can enable Kubernetes as an embedded service running inside Docker.
346357
The picture below illustrates the Kubernetes settings in Docker for macOS (similar configurations apply for Linux/Windows).
347358
By default, the Kubernetes API is assumed to run on the local TCP port `6443`.

0 commit comments

Comments
 (0)