kubectl configuration for EKS in AWS - Commands & Configuration

Introduction

When you create a Kubernetes cluster on AWS using EKS, you need to connect your local computer to that cluster. This connection lets you control and manage the cluster using commands. The kubectl configuration file stores the details needed to connect to your EKS cluster securely.

When you want to manage your EKS Kubernetes cluster from your local machine.

When you need to deploy applications to your EKS cluster using kubectl commands.

When you want to check the status of your EKS cluster resources like pods and services.

When you want to update or change your EKS cluster configuration remotely.

When you want to switch between multiple Kubernetes clusters including EKS clusters.

Commands

This command creates or updates the kubectl configuration file to connect to the EKS cluster named 'example-cluster' in the 'us-east-1' region. It sets up authentication and cluster details automatically.

Terminal

aws eks --region us-east-1 update-kubeconfig --name example-cluster

Expected Output

Added new context arn:aws:eks:us-east-1:123456789012:cluster/example-cluster to /home/user/.kube/config

→

--region - Specifies the AWS region where your EKS cluster is located.

→

--name - Specifies the name of your EKS cluster.

This command checks if kubectl can communicate with the EKS cluster by listing all the worker nodes in the cluster.

Terminal

kubectl get nodes

Expected Output

NAME                                           STATUS   ROLES    AGE   VERSION

ip-192-168-0-1.ec2.internal                    Ready    <none>   10m   v1.24.0

ip-192-168-0-2.ec2.internal                    Ready    <none>   10m   v1.24.0

This command shows all the Kubernetes contexts in your kubeconfig file, including the one for your EKS cluster. It helps you verify the current context and switch if needed.

Terminal

kubectl config get-contexts

Expected Output

CURRENT   NAME                                                   CLUSTER                                                AUTHINFO                                               NAMESPACE

*         arn:aws:eks:us-east-1:123456789012:cluster/example-cluster   arn:aws:eks:us-east-1:123456789012:cluster/example-cluster   arn:aws:eks:us-east-1:123456789012:cluster/example-cluster   default

Key Concept

If you remember nothing else from this pattern, remember: the aws eks update-kubeconfig command sets up your local kubectl to securely connect to your EKS cluster.

Common Mistakes

Not specifying the correct AWS region with --region flag.

kubectl configuration will point to the wrong region and fail to connect to your EKS cluster.

Always include the --region flag with the correct AWS region where your cluster is deployed.

Running kubectl commands before updating kubeconfig.

kubectl will not know how to connect to your cluster and will return connection errors.

Run aws eks update-kubeconfig first to set up the connection details.

Using an outdated or missing AWS CLI version that does not support EKS commands.

The update-kubeconfig command will fail or not be recognized.

Install or update AWS CLI to the latest stable version that supports EKS commands.

Summary

Use aws eks update-kubeconfig to create or update your kubectl config for EKS clusters.

Verify connection by running kubectl get nodes to see cluster worker nodes.

Check available contexts with kubectl config get-contexts to manage multiple clusters.

Practice

1. What is the main purpose of the aws eks update-kubeconfig command?

easy

A. To delete an existing EKS cluster

B. To configure kubectl to connect to an EKS cluster

C. To create a new EKS cluster

D. To update the AWS CLI version

Solution

1. Step 1: Understand the command's function

   The aws eks update-kubeconfig command updates the local kubeconfig file to include connection details for an EKS cluster.

2. Step 2: Identify the purpose related to kubectl

   This allows kubectl to communicate with the specified EKS cluster for management tasks.

3. Final Answer:

   To configure kubectl to connect to an EKS cluster -> Option B

4. Quick Check:

   Configure kubectl = update-kubeconfig [OK]

Hint: Remember: update-kubeconfig sets kubectl for EKS access [OK]

Common Mistakes:

• Confusing update-kubeconfig with cluster creation
• Thinking it updates AWS CLI version
• Assuming it deletes clusters

2. Which of the following is the correct syntax to update your kubeconfig for an EKS cluster named my-cluster in region us-west-2?

easy

A. kubectl update config --cluster my-cluster --region us-west-2

B. aws eks create-kubeconfig --region us-west-2 --cluster my-cluster

C. aws eks update-kubeconfig --region us-west-2 --name my-cluster

D. aws eks config-update --name my-cluster --region us-west-2

Solution

1. Step 1: Recall the correct command and flags

   The correct command is aws eks update-kubeconfig with flags --region and --name to specify region and cluster name.

2. Step 2: Match the syntax to the options

   aws eks update-kubeconfig --region us-west-2 --name my-cluster matches the correct syntax exactly, while others use incorrect commands or flags.

3. Final Answer:

   aws eks update-kubeconfig --region us-west-2 --name my-cluster -> Option C

4. Quick Check:

   Correct syntax = aws eks update-kubeconfig --region us-west-2 --name my-cluster [OK]

Hint: Use --region and --name flags with update-kubeconfig [OK]

Common Mistakes:

• Using create-kubeconfig instead of update-kubeconfig
• Mixing kubectl commands with AWS CLI
• Incorrect flag names like --cluster or --config-update

3. After running aws eks update-kubeconfig --region us-east-1 --name test-cluster, what will be the output of kubectl config current-context?

medium

A. test-cluster

B. arn:aws:eks:us-east-1:123456789012:cluster/test-cluster

C. default

D. No context set

Solution

1. Step 1: Understand update-kubeconfig effect

   Running aws eks update-kubeconfig sets the current context in kubeconfig to the cluster name.

2. Step 2: Check kubectl current-context output

   The current context after update is the cluster name, here test-cluster.

3. Final Answer:

   test-cluster -> Option A

4. Quick Check:

   Current context = cluster name [OK]

Hint: Current context shows cluster name after update-kubeconfig [OK]

Common Mistakes:

• Expecting ARN instead of cluster name
• Assuming default context remains
• Thinking no context is set after update

4. You ran aws eks update-kubeconfig --region us-east-1 --name my-cluster but get an error: Unable to locate credentials. What is the most likely cause?

medium

A. kubectl is not installed

B. The region flag is misspelled

C. The cluster name is incorrect

D. AWS CLI is not configured with credentials

Solution

1. Step 1: Analyze the error message

   The error Unable to locate credentials means AWS CLI cannot find your access keys to authenticate.

2. Step 2: Identify the cause

   This usually happens if AWS CLI is not configured with credentials via aws configure or environment variables.

3. Final Answer:

   AWS CLI is not configured with credentials -> Option D

4. Quick Check:

   Missing AWS credentials cause this error [OK]

Hint: Check AWS CLI credentials setup if unable to locate credentials error [OK]

Common Mistakes:

• Assuming kubectl installation causes this error
• Blaming cluster name without checking credentials
• Ignoring region flag spelling

5. You want to configure kubectl to connect to two EKS clusters, clusterA in us-east-1 and clusterB in us-west-2. Which approach correctly sets up your kubeconfig to switch between these clusters?

hard

A. Run aws eks update-kubeconfig --region us-east-1 --name clusterA then aws eks update-kubeconfig --region us-west-2 --name clusterB, then use kubectl config use-context clusterB to switch

B. Run kubectl config set-context clusterA and kubectl config set-context clusterB manually without update-kubeconfig

C. Run aws eks create-cluster for both clusters, then kubectl auto-switches

D. Use aws eks update-kubeconfig only for one cluster and manually edit kubeconfig for the other

Solution

1. Step 1: Understand update-kubeconfig for multiple clusters

   Running aws eks update-kubeconfig multiple times adds each cluster's config to kubeconfig without overwriting.

2. Step 2: Switching contexts

   You can switch between clusters using kubectl config use-context with the cluster name as context.

3. Final Answer:

   Run update-kubeconfig for both clusters, then switch context with kubectl -> Option A

4. Quick Check:

   Multiple update-kubeconfig runs + use-context = multi-cluster setup [OK]

Hint: Run update-kubeconfig for each cluster, then switch context [OK]

Common Mistakes:

• Trying to create clusters instead of updating kubeconfig
• Manually editing kubeconfig without update-kubeconfig
• Assuming kubectl auto-switches clusters