@aws-quickstart/eks-blueprints

Amazon EKS Blueprints for CDK

GitHub Build

Welcome to Amazon EKS Blueprints for CDK.

This repository contains the source code for the eks-blueprints NPM module. It can be used by AWS customers, partners, and internal AWS teams to configure and manage complete EKS clusters that are fully bootstrapped with the operational software that is needed to deploy and operate workloads.

DevContainer Setup

Users can choose this option, if you dont want to run this solution on a mac or ubuntu machine. Please use the dev container configuration in the .devcontainer folder with devpod or any other dev container environment to create a development environment with dependencies such as Node, NPM, aws-cli, aws-cdk, kubectl, helm dependencies for your local development with cdk-eks-blueprints solution.

Getting Started

The easiest way to get started with EKS Blueprints is to follow our Getting Started guide.

Documentation

For complete project documentation, please see our official project documentation site.

Examples

To view a library of examples for how you can leverage the eks-blueprints, please see our Blueprints Patterns Repository.

What can I do with this QuickStart?

Customers can use this QuickStart to easily architect and deploy a multi-team Blueprints built on EKS. Specifically, customers can leverage the eks-blueprints module to:

[x] Deploy Well-Architected EKS clusters across any number of accounts and regions.
[x] Manage cluster configuration, including addons that run in each cluster, from a single Git repository.
[x] Define teams, namespaces, and their associated access permissions for your clusters.
[x] Create Continuous Delivery(CD) pipelines that are responsible for deploying your infrastructure.
[x] Leverage GitOps-based workflows for onboarding and managing workloads for your teams.

You can also find a sample implementation that resides in this repository in bin/main.ts.

Getting Started

First, make sure you have the aws-cli installed. To verify your installation, run the following:

aws --version
# output aws-cli/2.2.3 Python/3.9.5 Darwin/20.3.0 source/x86_64 prompt/off

Install CDK matching the current version of the Blueprints QuickStart (which can be found in package.json).

npm install -g aws-cdk@2.162.1

Verify the installation.

cdk --version
# must output 2.162.1

Create a new CDK project. We use typescript for this example.

cdk init app --language typescript

Bootstrap your environment.

cdk bootstrap aws://<AWS_ACCOUNT_ID>/<AWS_REGION>

Usage for IPv4 cluster

Run the following command to install the eks-blueprints dependency in your project. By default, blueprints creates IPv4 cluster.

npm i @aws-quickstart/eks-blueprints

Replace the contents of bin/<your-main-file>.ts (where your-main-file by default is the name of the root project directory) with the following:

import 'source-map-support/register';
import * as cdk from 'aws-cdk-lib';
import * as blueprints from '@aws-quickstart/eks-blueprints';

const app = new cdk.App();

// AddOns for the cluster.
const addOns: Array<blueprints.ClusterAddOn> = [
    new blueprints.addons.ArgoCDAddOn,
    new blueprints.addons.CalicoOperatorAddOn,
    new blueprints.addons.MetricsServerAddOn,
    new blueprints.addons.ClusterAutoScalerAddOn,
    new blueprints.addons.ContainerInsightsAddOn,
    new blueprints.addons.AwsLoadBalancerControllerAddOn(),
    new blueprints.addons.VpcCniAddOn(),
    new blueprints.addons.CoreDnsAddOn(),
    new blueprints.addons.KubeProxyAddOn(),
    new blueprints.addons.XrayAddOn(),
    new blueprints.addons.IngressNginxAddOn()
];

const account = 'XXXXXXXXXXXXX';
const region = 'us-east-2';

const stack = blueprints.EksBlueprint.builder()
    .account(account)
    .region(region)
    .addOns(...addOns)
    .build(app, 'eks-blueprint-ipv4');
// do something with stack or drop this variable

Usage for IPv6 cluster

Run the following command to install the eks-blueprints dependency in your project. This example creates Ipv6 cluster.

Note: ipFamily has been introduced to support ipv6 cluster.

At time of creation, if VPC is not provided to EKS blueprints. It will automatically divide the provided VPC CIDR range, and create public and private subnets per Availability Zone. Network routing for the public subnets will be configured to allow outbound access directly via an Internet Gateway. Network routing for the private subnets will be configured to allow outbound access via a one NAT Gateway to reduce the cost. IPv6 does not require NAT for pod to pod communication. By default, we are creating one NAT for cluster communications outside endpoints if any.

import 'source-map-support/register';
import * as cdk from 'aws-cdk-lib';
import * as blueprints from '@aws-quickstart/eks-blueprints';

const app = new cdk.App();

// AddOns for the cluster. For ipv6 cluster, we haven't tested with all the addons except for the below addons.
const addOns: Array<blueprints.ClusterAddOn> = [
    new blueprints.addons.VpcCniAddOn(),
    new blueprints.addons.KarpenterAddOn(),
    new blueprints.addons.SecretsStoreAddOn()
];

const account = 'XXXXXXXXXXXXX';
const region = 'us-east-2';
const ipFamily = IpFamily.IP_V6; //IpFamily.IP_V6 isquavelent to "ipv6"

const stack = blueprints.EksBlueprint.builder()
    .account(account)
    .region(region)
    .ipFamily(ipFamily)
    .addOns(...addOns)
    .build(app, 'eks-blueprint-ipv6');

Note: if the account/region combination used in the code example above is different from the initial combination used with cdk bootstrap, you will need to perform cdk bootstrap again to avoid error.

Please reference CDK usage doc for detail.

List the stacks using the following command

cdk list

Example output for cdk list:

eks-blueprint-ipv4
eks-blueprint-ipv6

Deploy the stack using the following command

cdk deploy <stack-name>

Example to deploy IPv6 cluster:

cdk deploy eks-blueprint-ipv6

This will provision the following:

[x] A new Well-Architected VPC with both Public and Private subnets.
[x] A new Well-Architected EKS cluster in the region and account you specify.
[x] Nginx into your cluster to serve as a reverse proxy for your workloads.
[x] ArgoCD into your cluster to support GitOps deployments.
[x] Calico into your cluster to support Network policies.
[x] Metrics Server into your cluster to support metrics collection.
[x] AWS and Kubernetes resources needed to support Cluster Autoscaler.
[x] AWS and Kubernetes resources needed to forward logs and metrics to Container Insights.
[x] AWS and Kubernetes resources needed to support AWS Load Balancer Controller.
[x] Amazon VPC CNI add-on (VpcCni) into your cluster to support native VPC networking for Amazon EKS.
[x] CoreDNS Amazon EKS add-on (CoreDns) into your cluster. CoreDns is a flexible, extensible DNS server that can serve as the Kubernetes cluster DNS
[x] kube-proxy Amazon EKS add-on (KubeProxy) into your cluster to maintains network rules on each Amazon EC2 node
[x] AWS and Kubernetes resources needed to support AWS X-Ray.

Why should I use this QuickStart?

The ecosystem of tools that have developed around Kubernetes and the Cloud Native Computing Foundation (CNCF) provides cloud engineers with a wealth of choice when it comes to architecting their infrastructure. Determining the right mix of tools and services however, in addition to how they integrate, can be a challenge. As your Kubernetes estate grows, managing configuration for your clusters can also become a challenge.

AWS customers are building internal platforms to tame this complexity, automate the management of their Kubernetes environments, and make it easy for developers to onboard their workloads. However, these platforms require investment of time and engineering resources to build. The goal of this QuickStart is to provide customers with a tool chain that can help them deploy a Well-Architected platform on top of EKS with ease. The eks-blueprints framework provides logical abstractions and prescriptive guidance for building a platform. Ultimately, we want to help EKS customers accelerate time to market for their own platform initiatives.

Contributing

Please see Internal Guidelines for details on contributions.

Feedback

For architectural details, step-by-step instructions, and customization options, see our official documentation site.

To post feedback, submit feature ideas, or report bugs, use the Issues section of this GitHub repo.

To submit code for this Quick Start, see the AWS Quick Start Contributor's Kit.

License

This library is licensed under the Apache 2.0 License.

@aws-quickstart/eks-blueprints

Amazon EKS Blueprints for CDK

DevContainer Setup

Getting Started

Documentation

Examples

What can I do with this QuickStart?

Getting Started

Usage for IPv4 cluster

Usage for IPv6 cluster

Note: ipFamily has been introduced to support ipv6 cluster.

Why should I use this QuickStart?

Contributing

Feedback

License

Settings

On This Page