kubectl-eks

A kubectl plugin for managing Amazon EKS clusters. This plugin provides convenient commands for listing, inspecting, and switching between EKS clusters.

• Prerequisites
• Installation
  • Binary Installation
• Documentation
• Quick Start

Prerequisites

• AWS CLI: Ensure that aws is installed and configured with the appropriate credentials and region.
• kubectl: Ensure you have kubectl installed and configured.

Installation

We provide pre-built binaries for Linux and macOS (arm64 and x86-64). Follow the instructions below to install the plugin on your system.

Binary Installation

1. Download the binary for your operating system from the releases page.

2. Install the binary:

   chmod +x kubectl-eks
   mv kubectl-eks /usr/local/bin/

3. Verify installation:

   kubectl eks --help

Documentation

Full command reference documentation is available in the docs/ directory:

• kubectl eks - Main command and cluster information
• kubectl eks list - List all EKS clusters
• kubectl eks use - Switch to a different cluster
• kubectl eks mget - Get resources from multiple clusters
• kubectl eks stats - Get cluster statistics
• kubectl eks nodegroups - List cluster node groups
• kubectl eks insights - Get cluster insights
• kubectl eks updates - Check for updates
• kubectl eks stacks - Get CloudFormation stacks
• kubectl eks aws-profile - Get AWS profile
• kubectl eks completion - Generate shell autocompletion

Browse all commands and their options in the docs folder.

Quick Start

# List all EKS clusters
kubectl eks list

# Filter clusters by name
kubectl eks list --name-contains prod

# Switch to a specific cluster
kubectl eks use my-cluster

# Get resources from multiple clusters
kubectl eks mget pods -q prod

# View cluster statistics
kubectl eks stats

# Get insights about a cluster
kubectl eks insights my-cluster