TODO: init project by running the following from a Linux/MACOS host:
- copy template into new project
DEST_PATH=<PATH_TO_PLACE_PROJECT> make git-init && cd <PATH_TO_PLACE_PROJECT>
- add git remote
git remote add origin <GITHUB_CLONE_URI>
- init project
PROJECT_NAME="Company Product" QSID=qs-someid make init
- setup dev environment
make dev && pyenv shell eks-quickstart-dev
. For each new shell you use, you will need to re-runpyenv shell eks-quickstart-dev
. - deploy an eks cluster to use during development
CLUSTER_NAME=eks-dev AWS_REGION=us-west-2 AWS_PROFILE=my-aws-cli-profile make eks
- author deployment template
templates/eks-PRODUCT_NAME.template.yaml
- test deployment
- run lint tests
make lint
- add any additional required parameters to
parameters
section of.taskcat.yml
- launch the template
CLUSTER_NAME=eks-dev AWS_REGION=us-west-2 AWS_PROFILE=my-aws-cli-profile make test
- cleanup test stack
AWS_REGION=us-west-2 AWS_PROFILE=my-aws-cli-profile make clean-stack
- run lint tests
- remove eks cluster
CLUSTER_NAME=eks-dev AWS_REGION=us-west-2 AWS_PROFILE=my-aws-cli-profile make clean-eks
- create architecture diagram and replace sample
docs/images/architecture_diagram.png
. you can use the pptx template from here. - complete docs in
docs/partner_editable/
- get review from Quick Start team
- add permalinks to
docs/partner_editable/_settings.adoc
andREADME.md
- make repo public
- add parameter and submodule to the EKS marketplace Quick Start
- remove this checklist from
README.md
This Quick Start offers three deployment options:
Deploy into a new VPC and new EKS cluster
Deploy into a new VPC in an existing EKS cluster
Deploy into an existing EKS cluster
For architectural details, best practices, step-by-step instructions, and customization options, see the deployment guide.
To post feedback, submit feature ideas, or report bugs, use the Issues section of this GitHub repo. If you'd like to submit code for this Quick Start, please review the AWS Quick Start Contributor's Kit.