Skip to content
This repository has been archived by the owner on Aug 12, 2024. It is now read-only.

Garden AWS Quickstart solution for production-like development clusters on AWS.

License

Notifications You must be signed in to change notification settings

garden-io/garden-aws-quickstart

Repository files navigation

Garden Development Cluster Solution for AWS

Features

  • Remote development: Use an Amazon EKS cluster as a remote development environment for your engineering team, as well as for CI and QA environments.
  • Fast builds: Save precious engineering time wasted waiting for container builds by using the in-cluster-building and build caching features. Your container images will be stored in AWS ECR repositories.
  • Autoscaling: Control the minimum and maximum number of nodes in the cluster, to support your Engineering team size and workload requirements
  • Access management: Easily grant access to your development teams, so they can use remote production-like dev environments and see changes reflected instantly with Garden sync mode. This will make the remote development environment feel like running your set of services locally.
  • Batteries included: Also takes care of Load Balancing, Ingress controller, SSL certificates and Route53 supporting any number of development environments right away. The EKS cluster comes already with all necessary IAM permissions preconfigured that Garden needs to function.

High-level architecture overview

plot

Quick start

After completing the following steps, you will have deployed your dev environment for the Garden quick-start example to your Garden Development Cluster on AWS.

1. DNS Setup

To make your development environments accessible for your engineering and QA teams you need to choose a domain name that we will use for the Quickstart cluster. You need to be the owner of that domain and be able to create DNS records.

When using gardendev.example.com, your development and QA environments would be reachable on any of the subdomains (*.gardendev.example.com) once you completed the quick start steps.

If this DNS name is not already hosted on AWS Route 53, you need to create a hosted zone for it first, and also complete step 8 of that guide to make AWS Route 53 DNS servers authoritative for the chosen DNS name.

2. Deploy the solution

Now you can deploy the solution using AWS CloudFormation.

Follow the link to the Quick install template (View Template Source).

Parameters

Please refer to the parameters reference for a description of all parameters.

The following parameters will need to be configured to launch the quickstart guide. You can keep the default value for all other parameters.

IAMEKSFullAccessPrincipals

List of ARN principals, like IAM users or roles, that should be allowed to assume the role to get access to the EKS cluster. Mutually exclusive with the IAMEKSFullAccessRole parameter. You must either supply an IAMEKSFullAccessRole parameter, or IAMEKSFullAccessPrincipals, but not both.

Example: arn:aws:iam::001122334455:user/anna,arn:aws:iam::001122334455:user/steffen,arn:aws:iam::001122334455:user/srihas

IAMEKSFullAccessRole

The ARN of the IAM role that gets access to the EKS cluster. Everyone who can assume this role will have full access to the EKS cluster created in this stack. You are responsible for managing the trust policy of this role and allow users to assume it. Mutually exclusive with IAMEKSFullAccessPrincipals parameter. You must either supply an IAMEKSFullAccessRole parameter, or IAMEKSFullAccessPrincipals, but not both.

In case you are using AWS Single Sign On (also known as AWS Identity Center) you will want to specify the AWSReservedSSO role that your development teams can assume in IAMEKSFullAccessRole.

Example: arn:aws:iam::001122334455:role/AWSReservedSSO_DeveloperAccess_xxxxxxxx

IngressRoute53HostedZoneId

The ID of the Route53 hosted zone with the domain that can be used for ingress to the development environments

Use the drop down to choose the hosted zone ID that hosts the domain chosen in step 1 (DNS Setup).

IngressRoute53HostedZoneId

The subdomain that can be used for ingress to the development environments. Needs to be a hosted domain in Route53RecordTarget, for example: garden.mycompany.com.

Enter the domain chosen in step 1 (DNS Setup).

3. Deploy the quickstart-example

  1. git clone https://github.com/garden-io/quickstart-example.git
  2. cd quickstart-example
  3. Update the Kubernetes provider configuration in project.garden.yml
  4. garden dev
  5. > deploy --sync

Telemetry

When launching, updating or deleting the CloudFormation Stack we collect anonymized telemetry and send it to Segment.io. It helps us understand how our users use Garden and aids our decision process when prioritizing new features, bug fixing, etc.

We put great effort in making sure we only collect completely anonymized data by hashing sensitive information using SHA-512. See also the implementation at src/functions/tracking.ts.

About

Garden AWS Quickstart solution for production-like development clusters on AWS.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •