Skip to content

Latest commit

 

History

History
86 lines (55 loc) · 2.71 KB

README.md

File metadata and controls

86 lines (55 loc) · 2.71 KB
Raw

Key-Value Store Demo Project

Prerequisites

  • go 1.10.x
  • dep Golang dependency manager
  • awscli

AWS Account Setup Steps

  1. Setup Consul artifact bucket
  2. Download Consul zip, extract consul binary, and upload to artifact bucket
  3. Setup pipeline source bucket, enable versioning
  4. Setup pipeline action bucket, enable versioning
  5. Create EC2 key pair
  6. Register Route53 domain
  7. Create SSL cert through AWS ACM for the registered domain in the last step
  • Resources must all be created in the same region
    • tested in us-east-1 & us-west-2

Build, Create Pipeline, Deploy Infrastructure, and Test

The setup_and_run_deployment_pipeline.sh script will do the following:

  1. Build the key-value CLI
  2. Package the cfn templates and key-value CLI into a deploy artifact
  3. Upload the artifact to the pipeline source S3 bucket
  4. Create a CodePipeline and Codebuild test job using the pipeline cfn template
  5. The Pipeline will then execute and create an infrastructure stack using the persistent-resources cfn template
  6. The Pipeline will then create a Consul cluster stack using the consul cfn template
  7. The Pipeline will then run the Codebuild job to test the key-value binary interaction with the Consul cluster using the key_value_test.sh script

Example Script Execution

./scripts/setup_and_run_deployment_pipeline.sh -s pipeline-source-bucket -a codepipeline-bucket -p my-profile -r us-east-1 -c
  • You will be prompted for the resource names from the account setup steps

CLI

A basic CLI for interacting with the Consul key-value store API

Build

build.sh

Mac OSX binary can be located at:

./cli/bin/darwin/key-value

Linux binary can be located at:

./cli/bin/linux/key-value

Integration Test Script

A basic integration test scipt is located at: scripts/key_value_test.sh

This script requires you to have the key-value binary in your current working directory and to set the env server_url with your server endpoint URL. It is the same script the Codebuild test job runs.

  • Example: export server_url="kvdemo.thehoff.xyz"

Teardown

Stacks must be torn down in the following order and each stack must be fully destroyed before deleting the following stack, otherwise you may receive resource dependency errors.

aws cloudformation delete-stack --stack-name kv-consul-cluster --profile my-profile --region us-east-1
aws cloudformation delete-stack --stack-name kv-persistent-resources --profile my-profile --region us-east-1
aws cloudformation delete-stack --stack-name kv-pipeline --profile my-profile --region us-east-1

TODO

  • Front Consul cluster with custom API
  • Automate teardown