Gantree

Build Status Test Coverage Code Climate Gem Version

Why Gantree?

The name is derived from the word gantry which is a large crane used in ports to pick up shipping containers and load them on a ship. Gantry was already taken so I spelled it "tree" because the primary use is for elastic beanstalk and I guess a beanstalk is a form of tree?

Description

This tool is intended to help you setup a Dockerrun.aws.json which allows you to deploy a prebuilt image of your application to Elastic Beanstalk. This also allows you to do versioned deploys to your Elastic Beanstalk application and create an archive of every versioned Dockerrun.aws.json in amazons s3 bucket service.

Installation

You need to have your AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables set in order to use the tool as well as the proper aws permissions for Elastic Beanstalk, and S3 access.

For the time being you also need to configure your github repo to auto build an image inside of Dockerhub (private or open). In order to do this you need to have a dockerhub account already, login, and select your profile/orginization to add a Automated Build to. Select the branch you want to build, location of the docker file and the tag to reference the image that will be built (this will hopefully be automated in the future via dockerhub api).

Once you have your docker image created you will also need to install docker (if you haven't already)

Install docker for MAC OSX https://docs.docker.com/installation/mac/

Generate your login credentials token:

docker

Install the gem

gem install gantree

Initialize

What this does is create a new Dockerrun.aws.json inside your repository and uploads your docker login credentials to s3 (for private repo access) so you can do deploys. We need the -u to specify a username to rename your .dockercfg and reference it in the Dockerrun.aws.json

For a public repo

gantree init -p 3000 bleacher/cauldron:master

For a private repo

gantree init -u frodriguez -p 3000 bleacher/cauldron:master

Deploy

This command renames your Dockerrun.aws.json temporarily to NAME_OF_ENV-GITHUB_HASH-Dockerrun.aws.json, uploads it to a NAME_OF_APP-versions bucket, creates a new elastic beanstalk version, and asks the specified elastic beanstalk environment to update to that new version.

gantree deploy stag-cauldron-app-s1

By default this will check for the environment cauldron-stag-s1 and deploy to the app stag-cauldron-app. You can also specify an environment name directly using -e.

gantree deploy -e cauldron-stag-s1 stag-cauldron-app-s1

You can also specify a new image tag to use for the deploy

gantree deploy -t latest stag-cauldon-app-s1

Create Stacks

Gantree allows you to leverage the power of aws cloud formation to create your entire elastic beanstalk stack, rds, caching layer etc all while maintaining a set naming convention. This does the following:

  • uses the ruby-cloudformation-dsl to generate nested cloud formation templates inside a cfn folder in your repo
  • uploads them to an s3 bucket
  • uses aws-sdk to communicate with cfn and initiate the stack creation

To generate a basic staging cluster for linguist we would do:

gantree create stag-linguist-app-s1

In the elastic beanstalk console you will now see an application called linguist-stag-s1 with an environment called stag-linguist-app-s1

You can modify the name of the environment if this does not fit your naming convention:

gantre create your_app_name -e your_env_name

.gantreecfg

Allow defaults for commands to be set in a json file 

{
  "ebextensions" : "configs/.ebextensions",
  "default_instance_size" : "m3.medium"
}

.ebextension Support

Elastic Beanstalk cli allows you to create a .ebextension folder that you can package with your deploy to control the host/environment of your application. Deploying only a docker container image referenced in Dockerrun.aws.json has the unfortunate side effect of losing this extreamly powerful feature. To allow this feature to be included in gantree and make it even better you can select either to package a local .ebextension folder with your deploy, package a remote .ebextension folder hosted in github (with branch support) or even create a .gantreecfg file to make either of these type of deploys a default.

gantree deploy -x "git:br/ebextensions:master" stag-cauldron-app-s1

By default your application will be created on a t1.micro unless you specify otherwise:

gantree ceate your_app_name -i m3.medium

What if you need a database? Here enters the beauty of RDS

PostgreSQL: gantree create your_app_name --rds pg

Mysql: gantree create your_app_name --rds msql

TODO:

What if you want a cdn behind each of your generated applications

Fastly: gantree create your_app_name --cdn fastly

CloudFront: gantree create yoour_app_name --cdn cloudfront

Redis & Memcached

Elasticache gantree create your_app_name --cache redis or gantree create your_app_name --cache memcache

Autogenerated Release Notes

I would like have built in integration with opbeat configurable thorugh the .gantreecfg located in the applications repository.

Notes:

Also if the cloud formation template that is generated doesn't match your needs (which it might now) you can edit the .rb files in the repo's cfn folder, build your own gem and use it how you like.