EKS Blueprints Workloads

Welcome to the EKS Blueprints Workloads repository.

This repository serves as a sample GitOps configuration repository that is meant to be used with the Amazon EKS Blueprints CDK Quick Start and Amazon EKS Blueprints for Terraform.

Documentation

Please refer to the Amazon EKS Blueprints Quick Start Getting Started guide for details on how to bootstrap an EKS cluster with the workload configuration contained in this repository.

Usage

Usage for Multi Repository example

Under the multi-repo folder you can find an example of bootstrapping ArgoCD App of Apps application that points to other applications that resides in other git repositories. This way a deployment of every application can be managed independently by the application team in the application's repository. The platform team on the other hand, own this repository (the ArgoCD app of apps configuration) and only need to onboards new applications to the cluster by adding them to the App of Apps chart

To bootstrap an EKS cluster with the configuration under the multi-repo folder, you first have to apply the ArgoCD Projects manifests resides in the argo-app-projects folder. These Projects are used by the ArgoCD Applicaitons defined in the argo-app-of-apps folder. The projects are used in order to restrict the deployment of an application to a specific target namespace. This way we ensure that even if the application team try to deploy their application to a different namespace (by adding explicit namespace definition to their Kubernetes manifests), ArgoCD will not apply the application manifests because of that restriction. Applying the manifests is done by:

kubectl apply -f multi-repo/argo-app-projects/

Now we can onboard the applications into our cluster:

argocd app create dev-apps \
    --dest-namespace argocd  \
    --dest-server https://kubernetes.default.svc  \
    --repo https://github.com/aws-samples/eks-blueprints-workloads.git \
    --path "multi-repo/argo-app-of-apps/dev"

To sync app configuration and deploy the workloads, run the following.

argocd app sync dev-apps 

Usage for Single Repository example

To bootstrap an EKS cluster with the configuration that is contained in this repository, create a new application in ArgoCD via the following.

argocd app create dev-apps \
    --dest-namespace argocd  \
    --dest-server https://kubernetes.default.svc  \
    --repo https://github.com/aws-samples/eks-blueprints-workloads.git \
    --path "envs/dev"

To sync app configuration and deploy the workloads, run the following.

argocd app sync dev-apps 

Repo Structure

The configuration in this repository is organized into two directories: envs and teams.

├── multirepo
    └── argo-app-of-apps
        └── dev
        └── test
        └── prod
    └── argo-app-projects
├── envs
└── teams

Environments

The configuration in the envs subdirectories represent configuration for a specific EKS environment. In the context of the Amazon EKS Blueprints Quick Start, an environment maps directly to a single EKS Cluster.

This repository has support for three different environments: dev, test, and prod. Each environment directory is a Helm chart which references the teams that run workloads in each cluster.

envs
├── dev
│   ├── Chart.yaml
│   ├── templates
│   │   ├── team-burnham.yaml
│   │   ├── team-carmen.yaml
│   │   ├── team-riker.yaml
│   └── values.yaml
├── prod
└── test

Teams

The configuration in the teams subdirectories represent the individual teams that are running workloads in our EKS clusters.

Each team subdirectory in turn has environment subdirectories. The configuration in those directories are Kubernetes manifests that represent the individual workload that is running for each team and in each environment.

NOTE Some team environment directories may contain additional yaml files such as an ingress.yaml

teams
├── team-burnham
│   ├── dev
│   │   ├── deployment.yaml
│   │   └── service.yaml
│   ├── prod
│   │   ├── deployment.yaml
│   │   └── service.yaml
│   └── test
│       ├── deployment.yaml
│       └── service.yaml
├── team-riker

Security

See CONTRIBUTING for more information.

License

This library is licensed under the MIT-0 License. See the LICENSE file.