Wrapper tool to manage AWS Elastic Beanstalk environments
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
docs
lib
spec
.gitignore
.rspec
CHANGELOG.md
CONTRIBUTING.md
Gemfile
Guardfile
LICENSE.txt
README.md
Rakefile
circle.yml
jack.gemspec

README.md

Jack and the Elastic Beanstalk

CircleCI Code Climate Join the chat at https://gitter.im/tongueroo/jack Support

Jack allows you to easily manage your AWS Elastic Beanstalk Jack environments.

Jack provides a jack apply command to update the Elastic Beanstalk environment. Before uploading the new configuration Elastic Beanstalk jack first downloads the current configuration and then does a diff on the changes that are about to be applied. This gives a preview of exactly what will be changed. This is particularly helpful when changes are made through the EB GUI and are out of sync with what is stored in the downloaded jack/cfg files.

See jack-eb.com for full documentation.

This blog post also provides a good introduction and shows off useful examples of what you can do with the jack tool: Jack and the Elastic Beanstalk — Tool to Manage AWS Elastic Beanstalk Environments.

Use Cases

  • Allows codification of the infrastructure by downloading the configuration. You can save the downloaded configs into version control.
  • Safely upload new configs by previewing the changes before actually uploading and applying the configuration to the infrastructure.
  • Moving EB enviroments from one EB application to another EB application. EB provides a way to clone environments within an application but is unable to move the enivornment to an entirely new application. This is useful if you want to "rename" the EB application.

Installation

Install jack with RubyGems:

gem install jack-eb

Note that the gem is called jack-eb but the actual command that is installed is called jack. If you are installing jack with RubyGems you will need to handle installing the additional dependencies yourself.

More installation instructions are on the Installation docs.

Conventions

Before using the tool, it is good to know that jack follows a convention for the environment and application name. This is done in order to keep the jack commands simple and short. The convention is:

environment_name: [app]-[role]-[env]
application_name: [app]

A concrete example is helpful:

environment_name: hi-web-prod
application_name: hi

The example above means the EB application name will be hi and the environment name will be hi-web-prod. By convention, the first word, separated by a '-', of the environment name is the application name. This convention can be overridden easily via by configuring the settings. It is also possible to override the application name convention from the cli with the --app flag.

Quick Usage

Here's a quick overview of how to use jack:

brew cask install boltopslabs/software/bolts
git clone https://github.com/tongueroo/hi # demo sinatra app
cd hi
jack create hi-web-stag # creates a EB App named hi and EB Environment named hi-web-stag
jack download hi-web-stag
# ... make adjustments to jack/cfg/hi-web-stag.yml ...
jack upload hi-web-stag

See jack-eb.com for full documentation.

Contributing

Everyone can contribute to make jack better. Please fork the project and open a pull request! We love your pull requests. Contributions are encouraged and welcomed!

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request