Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

ekscli

Build Status Documentation Status Version License MIT

A simple and flexible command-line tool for AWS EKS management

Prerequisites

  • Available AWS credentials (configured as boto3)

  • Heptio authenticator binary (Section To install heptio-authenticator-aws for Amazon EKS in AWS EKS User Guide)

  • [Optional] kubectl (1.10 and later) for kubernetes cluster operations

Quick Start

Installation

As easy as the standard python way by using pip.

$ pip install ekscli

Optionally, after installation, command-completion can be achieved with:

$ eval "$(_EKS_COMPLETE=source eks)"

Use ECKCLI

Note: AWS fees will be charged in your account for the AWS resources created by ekscli.

The simplest way to create a cluster by running ekscli with almost everything default.
This will create an EKS cluster including the control plane (managed master by AWS), a node group and a kubectl configuration file (KUBECONFIG or $HOME/.kube/config).
$ eks create cluster --name=dev

# EKS cluster name can be set as an environment variable
$ export EKS_CLUSTER_NAME=dev
$ eks create cluster

To create the EKS cluster’s control plane (master) only:

$ eks create cluster --name=dev --cp-only

To create the EKS cluster’s control plane (master) with existing subnets of a VPC, a predefined IAM role, an existing EC2 KeyPair etc.:

$ eks create cluster --name=dev --cp-only \
  --subnets=subnet-1234567,subnet-abcdef1 \
  --cp-role eks-default-role \
  --region us-west-2 \
  --kubconfig ./dev.conf \
  --heptio-auth /tmp/heptio-auth-aws \
  --keyname dev \
  --node-sg-ingress port=22,cidr=10.0.0.0/8 \
  --tags Env=dev,Project=eks-poc

The simplest way to create a node group

$ eks create node-group --name=dev --node-name=workers

To create a node group with more options

$ eks create node-group --name=dev --node-name=another \
  --node-role=eks-worker-s3 \
  --node-subnets=subnet-1234567 \
  --node-min=1 \
  --node-max=10
  --node-sg-ingress port=22,cidr=10.0.0.0/8 \
  --node-sg-ingress protocol=tcp,from=8080,to=8088,cidr=0.0.0.0/0 \
  --region us-west-2 \
  --kubconfig ./dev.conf \
  --heptio-auth /tmp/heptio-auth-aws \
  --keyname dev \
  --tags Env=dev,Project=eks-poc

Features

  • Simple and concise command line interface

  • Flexible configuration

  • Plain vanilla EKS cluster without unrequired resources running Kubernetes clusters

  • EKS resources managed by AWS CloudFormation

  • Command line auto-completion supported for Bash and Zsh

Roadmap

  • Output cluster information to different formats: yaml, json

  • Update the cluster and node groups

  • Create from templatable configuration files

Metadata

Release files for ekscli 0.1.0rc5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ekscli 0.1.0rc5
File Size Uploaded
ekscli-0.1.0rc5.tar.gz 28.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ekscli 0.1.0rc5
File Interpreter ABI Platform
ekscli-0.1.0rc5-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 51.5 kB

Release files / ekscli-0.1.0rc5.tar.gz

Download URL ekscli-0.1.0rc5.tar.gz
Size 28.4 kB
Tags Source
SHA-256 checksum
How to use checksums
e4e63559aa7a29f786bea224b0b28933758c3833cd70701e48f6d37f9a0562d3
BLAKE2b-256 checksum
How to use checksums
50c90aea5247b02566f2267b4906ec34a5cd682dc716664a33c51e2bc603e205
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / ekscli-0.1.0rc5-py2.py3-none-any.whl

Download URL ekscli-0.1.0rc5-py2.py3-none-any.whl
Size 23.0 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
b18680a7ae60736f5d59002e5381a49b6bb7e8baf8b95ef0883f0ec15a9665d9
BLAKE2b-256 checksum
How to use checksums
2a30181e615a1fdef917e13ce0e24059155dc8600a901982df1cf170bd57a8e8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page