aws-k8s-tester

module

v1.0.0 Latest Latest Go to latest Published: Apr 5, 2020 License: Apache-2.0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/aws/aws-k8s-tester

Links

Open Source Insights

README ¶

aws-k8s-tester

https://github.com/kubernetes/enhancements/blob/master/keps/provider-aws/20181126-aws-k8s-tester.md

aws-k8s-tester is a set of utilities and libraries for "testing" Kubernetes on AWS.

Uses AWS CloudFormation for resource creation
Supports automatic rollback and resource deletion
Flexible add-on support via environmental variables
Extensible as a Go package; eks.Tester.Up to create EKS

Install

https://github.com/aws/aws-k8s-tester/releases

`aws-k8s-tester ec2`

Make sure AWS credential is located in your machine:

# confirm credential is valid
aws sts get-caller-identity --query Arn --output text

See https://github.com/aws/aws-k8s-tester/blob/master/ec2config/README.md for more.

ACCOUNT_ID=$(aws sts get-caller-identity --query Account --output text);
echo ${ACCOUNT_ID}


rm -f /tmp/${USER}-test-ec2*

cd /tmp
AWS_K8S_TESTER_EC2_ON_FAILURE_DELETE=true \
AWS_K8S_TESTER_EC2_REGION=us-west-2 \
AWS_K8S_TESTER_EC2_S3_BUCKET_CREATE=true \
AWS_K8S_TESTER_EC2_REMOTE_ACCESS_KEY_CREATE=true \
AWS_K8S_TESTER_EC2_ASGS_FETCH_LOGS=true \
AWS_K8S_TESTER_EC2_ASGS={\"${USER}-test-ec2-al2-cpu\":{\"name\":\"${USER}-test-ec2-al2-cpu\",\"remote-access-user-name\":\"ec2-user\",\"ami-type\":\"AL2_x86_64\",\"image-id-ssm-parameter\":\"/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-gp2\",\"asg-min-size\":1,\"asg-max-size\":1,\"asg-desired-capacity\":1,\"instance-types\":[\"c5.xlarge\"],\"volume-size\":40},\"${USER}-test-ec2-bottlerocket\":{\"name\":\"${USER}-test-ec2-bottlerocket\",\"remote-access-user-name\":\"ec2-user\",\"ami-type\":\"BOTTLEROCKET_x86_64\",\"image-id-ssm-parameter\":\"/aws/service/bottlerocket/aws-k8s-1.15/x86_64/latest/image_id\",\"ssm-document-name\":\"${USER}InstallBottleRocket\",\"ssm-document-create\":true,\"ssm-document-commands\":\"enable-admin-container\",\"ssm-document-execution-timeout-seconds\":3600,\"asg-min-size\":1,\"asg-max-size\":1,\"asg-desired-capacity\":1,\"instance-types\":[\"c5.xlarge\"],\"volume-size\":40}} \
AWS_K8S_TESTER_EC2_ROLE_CREATE=true \
AWS_K8S_TESTER_EC2_VPC_CREATE=true \
aws-k8s-tester ec2 create config -p /tmp/${USER}-test-ec2.yaml && cat /tmp/${USER}-test-ec2.yaml

<<COMMENT
# Or just run
aws-k8s-tester ec2 create config -p /tmp/${USER}-test-ec2.yaml
# to write initial configuration with default values
COMMENT

<<COMMENT
# to config a fixed name for EC2 ASG
AWS_K8S_TESTER_EC2_NAME=${NAME} \

# to reuse an existing S3 bucket
AWS_K8S_TESTER_EC2_S3_BUCKET_CREATE=false \
AWS_K8S_TESTER_EC2_S3_BUCKET_NAME=${BUCKET_NAME} \

# to reuse an existing EC2 key-pair
AWS_K8S_TESTER_EC2_REMOTE_ACCESS_KEY_CREATE=false \
AWS_K8S_TESTER_EC2_REMOTE_ACCESS_KEY_NAME=${KEY_NAME} \
AWS_K8S_TESTER_EC2_REMOTE_ACCESS_PRIVATE_KEY_PATH=${KEY_PATH} \

# to reuse an existing role
AWS_K8S_TESTER_EC2_ROLE_CREATE=false \
AWS_K8S_TESTER_EC2_ROLE_ARN=${ROLE_ARN} \

# to reuse an existing VPC
AWS_K8S_TESTER_EC2_VPC_CREATE=false \
AWS_K8S_TESTER_EC2_VPC_ID=${VPC_ID} \
COMMENT



cd /tmp
aws-k8s-tester ec2 create cluster -p /tmp/${USER}-test-ec2.yaml

cd /tmp
aws-k8s-tester ec2 delete cluster -p /tmp/${USER}-test-ec2.yaml

`aws-k8s-tester eks`

Make sure AWS credential is located in your machine:

# confirm credential is valid
aws sts get-caller-identity --query Arn --output text

See https://github.com/aws/aws-k8s-tester/blob/master/eksconfig/README.md for more.

ACCOUNT_ID=$(aws sts get-caller-identity --query Account --output text);
CLUSTER_ARN=arn:aws:eks:us-west-2:${ACCOUNT_ID}:cluster/${USER}-test-eks
echo ${CLUSTER_ARN}


rm -rf /tmp/${USER}-test-eks*

cd /tmp
AWS_K8S_TESTER_EKS_NAME=${USER}-test-eks \
AWS_K8S_TESTER_EKS_REGION=us-west-2 \
AWS_K8S_TESTER_EKS_S3_BUCKET_CREATE=true \
AWS_K8S_TESTER_EKS_REMOTE_ACCESS_KEY_CREATE=true \
AWS_K8S_TESTER_EKS_COMMAND_AFTER_CREATE_CLUSTER="aws eks describe-cluster --name ${USER}-test-eks" \
AWS_K8S_TESTER_EKS_COMMAND_AFTER_CREATE_ADD_ONS="aws eks describe-cluster --name ${USER}-test-eks" \
AWS_K8S_TESTER_EKS_PARAMETERS_ENCRYPTION_CMK_CREATE=true \
AWS_K8S_TESTER_EKS_PARAMETERS_ROLE_CREATE=true \
AWS_K8S_TESTER_EKS_PARAMETERS_VERSION=1.15 \
AWS_K8S_TESTER_EKS_PARAMETERS_VPC_CREATE=true \
AWS_K8S_TESTER_EKS_ADD_ON_NODE_GROUPS_ENABLE=true \
AWS_K8S_TESTER_EKS_ADD_ON_NODE_GROUPS_ROLE_CREATE=true \
AWS_K8S_TESTER_EKS_ADD_ON_NODE_GROUPS_ASGS={\"${USER}-test-eks-ng-al2-cpu\":{\"name\":\"${USER}-test-eks-ng-al2-cpu\",\"remote-access-user-name\":\"ec2-user\",\"ami-type\":\"AL2_x86_64\",\"image-id-ssm-parameter\":\"/aws/service/eks/optimized-ami/1.15/amazon-linux-2/recommended/image_id\",\"asg-min-size\":1,\"asg-max-size\":1,\"asg-desired-capacity\":1,\"instance-types\":[\"c5.xlarge\"],\"volume-size\":40},\"${USER}-test-eks-ng-bottlerocket\":{\"name\":\"${USER}-test-eks-ng-bottlerocket\",\"remote-access-user-name\":\"ec2-user\",\"ami-type\":\"BOTTLEROCKET_x86_64\",\"image-id-ssm-parameter\":\"/aws/service/bottlerocket/aws-k8s-1.15/x86_64/latest/image_id\",\"ssm-document-name\":\"${USER}InstallBottleRocket\",\"ssm-document-create\":true,\"ssm-document-commands\":\"enable-admin-container\",\"ssm-document-execution-timeout-seconds\":3600,\"asg-min-size\":1,\"asg-max-size\":1,\"asg-desired-capacity\":1,\"instance-types\":[\"c5.xlarge\"],\"volume-size\":40}} \
AWS_K8S_TESTER_EKS_ADD_ON_MANAGED_NODE_GROUPS_ENABLE=true \
AWS_K8S_TESTER_EKS_ADD_ON_MANAGED_NODE_GROUPS_ROLE_CREATE=true \
AWS_K8S_TESTER_EKS_ADD_ON_MANAGED_NODE_GROUPS_MNGS={\"${USER}-test-eks-mng-al2-cpu\":{\"name\":\"${USER}-test-eks-mng-al2-cpu\",\"remote-access-user-name\":\"ec2-user\",\"ami-type\":\"AL2_x86_64\",\"asg-min-size\":1,\"asg-max-size\":1,\"asg-desired-capacity\":1,\"instance-types\":[\"c5.xlarge\"],\"volume-size\":40}} \
AWS_K8S_TESTER_EKS_ADD_ON_NLB_HELLO_WORLD_ENABLE=true \
aws-k8s-tester eks create config -p /tmp/${USER}-test-eks.yaml && cat /tmp/${USER}-test-eks.yaml

<<COMMENT
# Or just run
aws-k8s-tester eks create config -p /tmp/${USER}-test-eks.yaml
# to write initial configuration with default values
COMMENT

<<COMMENT
# to assign a random cluster name, delete the following variable
# AWS_K8S_TESTER_EKS_NAME=${USER}-test-eks \

# to reuse an existing S3 bucket
AWS_K8S_TESTER_EKS_S3_BUCKET_CREATE=false \
AWS_K8S_TESTER_EKS_S3_BUCKET_NAME=${BUCKET_NAME} \

# to reuse an existing EC2 key-pair
AWS_K8S_TESTER_EKS_REMOTE_ACCESS_KEY_CREATE=false \
AWS_K8S_TESTER_EKS_REMOTE_ACCESS_KEY_NAME=${KEY_NAME} \
AWS_K8S_TESTER_EKS_REMOTE_ACCESS_PRIVATE_KEY_PATH=${KEY_PATH} \

# to reuse an existing role for "EKS cluster"
AWS_K8S_TESTER_EKS_PARAMETERS_ROLE_CREATE=false \
AWS_K8S_TESTER_EKS_PARAMETERS_ROLE_ARN=${CLUSTER_ROLE_ARN} \

# to reuse an existing VPC
AWS_K8S_TESTER_EKS_PARAMETERS_VPC_CREATE=false \
AWS_K8S_TESTER_EKS_PARAMETERS_VPC_ID=${VPC_ID} \

# to reuse an existing role for "Node Group"
AWS_K8S_TESTER_EKS_ADD_ON_NODE_GROUPS_ROLE_CREATE=false \
AWS_K8S_TESTER_EKS_ADD_ON_NODE_GROUPS_ROLE_ARN=${NG_ROLE_ARN} \

# to reuse an existing role for "Managed Node Group"
AWS_K8S_TESTER_EKS_ADD_ON_MANAGED_NODE_GROUPS_ROLE_CREATE=false \
AWS_K8S_TESTER_EKS_ADD_ON_MANAGED_NODE_GROUPS_ROLE_ARN=${MNG_ROLE_ARN} \
COMMENT



cd /tmp
aws-k8s-tester eks create cluster -p /tmp/${USER}-test-eks.yaml

cd /tmp
aws-k8s-tester eks delete cluster -p /tmp/${USER}-test-eks.yaml

This will create an EKS cluster with a worker node (takes about 20 minutes).

Once cluster is created, check cluster state using AWS CLI:

aws eks describe-cluster \
  --name ${USER}-test-eks \
  --query cluster.status

"ACTIVE"

Cluster states are persisted on disk and S3 bucket.

EKS tester uses this file to record status.

cat /tmp/config.yaml

# or
less +FG /tmp/config.yaml

Directories ¶

Path	Synopsis
client module
cmd
aws-k8s-tester aws-k8s-tester is a set of AWS test commands.	aws-k8s-tester is a set of AWS test commands.
aws-k8s-tester/ec2 Package ec2 implements EC2 related commands.	Package ec2 implements EC2 related commands.
aws-k8s-tester/eks Package eks implements EKS related commands.	Package eks implements EKS related commands.
aws-k8s-tester/version Package version implements version command.	Package version implements version command.
e2e
framework
framework/resource
framework/utils
resources
utils
tester Module
e2e2 module
ec2 Package ec2 implements testing utilities using EC2.	Package ec2 implements testing utilities using EC2.
ec2config Package ec2config defines EC2 configuration.	Package ec2config defines EC2 configuration.
gen gen generates ec2config documentation.	gen generates ec2config documentation.
eks Package eks implements EKS cluster operations.	Package eks implements EKS cluster operations.
alb Package alb implements ALB plugin that installs 2048.	Package alb implements ALB plugin that installs 2048.
appmesh Package appmesh implements App Mesh add-on.	Package appmesh implements App Mesh add-on.
configmaps Package configmaps implements tester for ConfigMap.	Package configmaps implements tester for ConfigMap.
cronjobs Package cronjobs creates CronJob objects in Kubernetes.	Package cronjobs creates CronJob objects in Kubernetes.
csrs Package csrs implements tester for CertificateSigningRequest.	Package csrs implements tester for CertificateSigningRequest.
fargate Package fargate implements tester for Fargate.	Package fargate implements tester for Fargate.
gpu Package gpu implements GPU plugin.	Package gpu implements GPU plugin.
irsa Package irsa implements tester for IAM Roles for Service Accounts (IRSA).	Package irsa implements tester for IAM Roles for Service Accounts (IRSA).
jobs-echo Package jobsecho creates Job objects in Kubernetes.	Package jobsecho creates Job objects in Kubernetes.
jobs-pi Package jobspi creates example Job objects in Kubernetes.	Package jobspi creates example Job objects in Kubernetes.
mng Package mng defines AWS EKS Managed Node Group configuration.	Package mng defines AWS EKS Managed Node Group configuration.
ng Package ng implements EKS worker nodes with a custom AMI.	Package ng implements EKS worker nodes with a custom AMI.
nlb Package nlb implements NLB plugin.	Package nlb implements NLB plugin.
secrets Package secrets implements Secrets plugin.	Package secrets implements Secrets plugin.
eksconfig Package eksconfig defines EKS test configuration.	Package eksconfig defines EKS test configuration.
gen gen generates eksconfig documentation.	gen generates eksconfig documentation.
k8s-tester module
aqua Module
armory Module
cloudwatch-agent Module
clusterloader Module
cmd/k8s-tester Module
cmd/readme-gen Module
cni Module
configmaps Module
conformance Module
csi-ebs Module
csi-efs Module
csrs Module
epsagon Module
falco Module
falcon Module
fluent-bit Module
helm Module
jobs-echo Module
jobs-pi Module
kubecost Module
kubernetes-dashboard Module
metrics-server Module
nlb-guestbook Module
nlb-hello-world Module
php-apache Module
secrets Module
splunk Module
stress Module
sysdig Module
tester Module
vault Module
wordpress Module
kubetest2 module
pkg
aws Package aws implements wrappers for AWS API calls.	Package aws implements wrappers for AWS API calls.
aws/cloudformation Package cloudformation implements common CloudFormation utilities.	Package cloudformation implements common CloudFormation utilities.
aws/ec2 Package ec2 implements various AWS EC2 operations.	Package ec2 implements various AWS EC2 operations.
aws/ec2/instance-types instance-types auto-generates EC2 instance types from AWS API.	instance-types auto-generates EC2 instance types from AWS API.
aws/ec2/metadata Package metadata queries the EC2 metadata.	Package metadata queries the EC2 metadata.
aws/elb Package elb implements ELB utilities.	Package elb implements ELB utilities.
aws/iam Package iam implements various IAM components.	Package iam implements various IAM components.
cloud
ctxhandler Package ctxhandler implements context handler.	Package ctxhandler implements context handler.
fileutil Package fileutil implements file utilities.	Package fileutil implements file utilities.
github Package github implements github utilities.	Package github implements github utilities.
httputil Package httputil implements various HTTP operations.	Package httputil implements various HTTP operations.
k8s-client Package k8sclient implements various k8s utils.	Package k8sclient implements various k8s utils.
logutil Package logutil implements various log utilities.	Package logutil implements various log utilities.
process
ssh Package ssh implements various SSH commands.	Package ssh implements various SSH commands.
utils module
version Package version defines aws-k8s-tester version.	Package version defines aws-k8s-tester version.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL