Skip to content

update eks docs to include config for the cluster token#543

Open
blkgrlcto wants to merge 1 commit intomainfrom
doc-133-eks-cluster-token
Open

update eks docs to include config for the cluster token#543
blkgrlcto wants to merge 1 commit intomainfrom
doc-133-eks-cluster-token

Conversation

@blkgrlcto
Copy link
Copy Markdown
Contributor

This PR addresses DOC-133


## Configuring the k3d Cluster Token

When LocalStack creates a k3d-backed EKS cluster, it starts the k3s server with an explicit cluster token. This token is used to authenticate agent nodes joining the cluster, ensuring consistent behavior across k3d versions and enabling dynamic node registration (for example, when using Karpenter).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's not mention Karpenter in our docs since we don't fully support this yet. Also version compatibility is not very relevant as a pro for this change.

Suggested change
When LocalStack creates a k3d-backed EKS cluster, it starts the k3s server with an explicit cluster token. This token is used to authenticate agent nodes joining the cluster, ensuring consistent behavior across k3d versions and enabling dynamic node registration (for example, when using Karpenter).
When LocalStack creates a k3d-backed EKS cluster, it starts the k3s server with an explicit cluster token. This token is used to authenticate agent nodes joining the cluster, enabling dynamic node registration.

## Configuring the k3d Cluster Token

When LocalStack creates a k3d-backed EKS cluster, it starts the k3s server with an explicit cluster token. This token is used to authenticate agent nodes joining the cluster, ensuring consistent behavior across k3d versions and enabling dynamic node registration (for example, when using Karpenter).
By default, LocalStack uses localstack-k3d-cluster-token as the cluster token. You can override this value using the `EKS_K3D_CLUSTER_TOKEN` configuration variable:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
By default, LocalStack uses localstack-k3d-cluster-token as the cluster token. You can override this value using the `EKS_K3D_CLUSTER_TOKEN` configuration variable:
By default, LocalStack uses `localstack-k3d-cluster-token` as the cluster token. You can override this value using the `EKS_K3D_CLUSTER_TOKEN` configuration variable:

Copy link
Copy Markdown
Contributor

@nik-localstack nik-localstack left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new configuration variable should be added also in https://docs.localstack.cloud/aws/capabilities/config/configuration/#eks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants