Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

A simple and flexible commandline tool for AWS EKS management

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
ekscli-0.1.0rc5-py2.py3-none-any.whl (23.0 kB) Copy SHA256 hash SHA256 Wheel py2.py3
ekscli-0.1.0rc5.tar.gz (28.4 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page