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.
The easiest way to get started with EKS Blueprints is to follow our Getting Started guide.
For complete project documentation, please see our official project documentation site.
To view a library of examples for how you can leverage the
eks-blueprints, please see our Blueprints Patterns Repository.
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:
You can also find a sample implementation that resides in this repository in
First, make sure you have the
aws-cli installed. To verify your installation, run the following:
# 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 firstname.lastname@example.org
Verify the installation.
# must output 2.91.0
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>
Run the following command to install the
eks-blueprints dependency in your project.
npm i @aws-quickstart/eks-blueprints
Replace the contents of
your-main-file by default is the name of the root project directory) with the following:
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> = [
const account = 'XXXXXXXXXXXXX';
const region = 'us-east-2';
const stack = blueprints.EksBlueprint.builder()
// do something with stack or drop this variable
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.
Deploy the stack using the following command
This will provision the following:
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.
Please see Internal Guidelines for details on contributions.
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.
This library is licensed under the Apache 2.0 License.
Generated using TypeDoc