dromedary 🐪

Sample app to demonstrate a working pipeline using AWS Code Services

Infrastructure as Code

Dromedary was featured by Paul Duvall, Stelligent's Chief Technology Officer, during the ARC307: Infrastructure as Code breakout session at 2015 AWS re:Invent.

You can view the recording of that breakout session at https://www.youtube.com/watch?v=WL2xSMVXy5w.

The Demo App 🐪

The Dromedary demo app is a simple nodejs application that displays a pie chart to users. The data that describes the pie chart (i.e. the colors and their values) is served by the application.

If a user clicks on a particular color segment in the chart, the frontend will send a request to the backend to increment the value for that color and update the chart with the new value.

The frontend will also poll the backend for changes to values of the colors of the pie chart and update the chart appropriately. If it detects that a new version of the app has been deployed, it will reload the page.

Directions are provided to run this demo in AWS and locally.

Feature Backlog 🐪

We plan to add additional features in the coming months. Check the issues and Feature Backlog for more information.

Running in AWS 🐪

DISCLAIMER: Executing the following will create billable AWS resources in your account. Be sure to clean up Dromedary resources after you are done to minimize charges

PLEASE NOTE: This demo is an exercise in Infrastructure as Code, and is meant to demonstrate neither best practices in highly available nor highly secure deployments in AWS.

CloudFormation Bootstrapping (e.g. for AWS Test Drive)

You'll need the AWS CLI tools installed and configured to start.

You'll also need to create a hosted zone in Route53. This hosted zone does not necessarily need to be publicly available and a registered domain.

You can either use the AWS CLI or the AWS web console to launch a new CloudFormation stack. To launch from the console, click the button below (you'll need to login to your AWS account if you have not already done so).

To launch from the CLI, see this example:

aws cloudformation create-stack \
--stack-name DromedaryStack  \ 
--template-body https://raw.githubusercontent.com/stelligent/dromedary/master/pipeline/cfn/dromedary-master.json \ 
--region us-east-1 \
--disable-rollback --capabilities="CAPABILITY_IAM" \
--parameters ParameterKey=KeyName,ParameterValue=YOURKEYPAIR \
	ParameterKey=Branch,ParameterValue=master \
	ParameterKey=BaseTemplateURL,ParameterValue=https://s3.amazonaws.com/stelligent-training-public/master/ \
	ParameterKey=GitHubUser,ParameterValue=YOURGITHUBUSER \
	ParameterKey=GitHubToken,ParameterValue=YOURGITHUBTOKEN \ 
	ParameterKey=DDBTableName,ParameterValue=YOURUNIQUEDDBTABLENAME \
	ParameterKey=ProdHostedZone,ParameterValue=.YOURHOSTEDZONE

In the above example, you'll need to set the YOURHOSTEDZONE value to your Route53 hosted zone. You'll need to configure your own GitHub token by going to https://github.com/settings/tokens.

Parameters	Description
KeyName	The EC2 keypair name to use for ssh access to the bootstrapping instance.
GitHubUser	GitHub UserName. This username must have access to the GitHubToken.
GitHubToken	Secret. OAuthToken with access to Repo. Go to https://github.com/settings/tokens.
BaseTemplateURL	S3 Base URL of all the CloudFormation templated used in Dromedary (without the file names)
DDBTableName	Unique TableName for the Dromedary DynamoDB database.
ProdHostedZone	Route53 Hosted Zone. You must precede `YOURHOSTEDZONE` with a `.`.

As part of the bootstrapping process, it will automatically launch the Dromedary application stack via CodePipeline.

IMPORTANT: You will need to manually delete the CloudFormation stack once you've completed usage. You will be charged for AWS resource usage.

Bootstrapping Tests View the outputs in CloudFormation for links to test reports uploaded to your Dromedary S3 bucket.

Post-bootstrap steps

Upon completion of a successful pipeline execution, Dromedary will be available by going to the Outputs tab on the master CloudFormation stack and clicking on the value for the DromedaryAppURL Output. If that hosted zone is not a publicly registered domain, you can access Dromedary via IP address. The IP address can be queried by viewing the EIP output of the ENI CloudFormation stack.

Every time changes are pushed to Github, CodePipeline will build, test, deploy and release those changes.

Configure Jenkins Security

IMPORTANT: It's very important that you enable Jenkins security.

From CodePipeline, click on any of the Actions to launch Jenkins. From Jenkins, perform the following steps to configure security:

Manage Jenkins > Configure Global Security
Check Enable Security
Click Jenkins’ own user database
Check Allow users to sign up
Check Logged in users can do anything
Click the Save button
Click Sign Up in the top right to create an account
Save and login as that user
Manage Jenkins > Configure Global Security
Check Matrix Based Security
Add a line for the user you just created
Check the Administer box
Click the Save button

Manual Cleanup

For manually bootstrapped builds, to delete (nearly) all Dromedary resources, execute the delete script:

./bin/delete-all.sh

The only resources that remain and require manual deletion is the Dromedary S3 bucket.

Builds made using the AWS Test Drive CloudFormation stack will self terminate all resources after the AliveDuration timeout. You will need to manually delete the CloudFormation stack.

Running Locally 🐪

Install Prerequisites

Ensure nodejs and npm are installed

On Mac OS X, this can be done via Homebrew: brew install node
On Amazon Linux, packages are available via the EPEL yum repo: yum install -y nodejs npm --enablerepo=epel

Java must be installed so that DynamoDB Local can run
Install dependencies: npm install

NOTE: Dromedary relies on gulp for local development and build tasks. You may need to install gulp globally: npm install -g gulp

If gulp is not globally installed, ensure ./node_modules/.bin/ is in your PATH.

Local Server

The default task will start dynamodb-local on port 8079 and a node server listening on port 8080:

Run gulp - this downloads and starts DynamoDB Local and starts Node
Point your webbrowser to http://localhost:8080

Executing Unit Tests

Unit tests located in test/ were written using Mocha and Chai, and can be executed using the test task:

Run gulp test

Executing Acceptance Tests

Acceptance tests located in tests-functional/ require Dromedary to be running (eg: gulp), and can be executed using the test-functional task:

Run gulp test-functional

These tests (which, at this time are closer to integration tests than functional tests) exercise the API endpoints defined in app.js.

Building a Distributable Archive

The dist task copies relevant files to dist/ and installs only dependencies required to run the standalone app:

Run gulp dist

dist/archive.tar.gz will be created if this task run successfully.

dmbettinger / dromedary