jack-eb 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 308bf22aa5cec82466834fe6c043a894553bd139
-  data.tar.gz: c0925b0a49597d7eb880f826f318d1a5be9e682d
+  metadata.gz: 35033b3491aacbbc133d70a83cb0347e3a61518e
+  data.tar.gz: 224f5f929c0d055d62dff3a3e58b14ff68bd6d2d
 SHA512:
-  metadata.gz: 39d8faa02284e9066d0fc0073a88deb8e4451f3264e515d9ea76a6882f2f44baba8be4026e861dd7c00fc16103b7dae34f66d821bef2e61eefd5d29691410989
-  data.tar.gz: 3704c8303f3403b96e4d2e2cf2573a5b72707cd2f8241b0cd4050d143030e4025e18e2d5fa66948451f500c07801ca3a200d303cff81f180a49f96cd19590445
+  metadata.gz: aa180a5634c0862e3068f6692e065b1f102fb0948a51c800a1e1183682c96a83658dcfd15f0b9296b1b4b4e4a5e56d2d6dde9c4abaace5a4e8ccb79b2621bd32
+  data.tar.gz: b2cca38a575b4837cdfbd8d7eafaa9029fc1ab9a9f78bf98fe1682c253d6cea9cf789f5647006b7f7c54f6108e191e4efb18850baab65a73e9a3816ee1b6196f

data/CHANGELOG.md

@@ -3,6 +3,9 @@
 All notable changes to this project will be documented in this file.
 This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [1.3.0]
+- flatten cli interface: jack config apply -> jack apply
+
 ## [1.2.1]
 - fix EB_OPTIONS and early trap for friendly exit
 

data/README.md

@@ -5,9 +5,13 @@
 [![Code Climate](https://codeclimate.com/github/tongueroo/jack/badges/gpa.svg)](https://codeclimate.com/github/tongueroo/jack)
 [![Test Coverage](https://codeclimate.com/github/tongueroo/jack/badges/coverage.svg)](https://codeclimate.com/github/tongueroo/jack)
 
+The documentation for this tool is at [jackandtheelasticbeanstalk.com](http://jackandtheelasticbeanstalk.com).
+
 Jack is a wrapper tool around the [aws eb cli3](http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/eb-cli3.html) tool use for managing AWS Elastic Beanstalk, EB, environments.  It allows you to create environments using the  saved template configuration file generated by `eb config save`.  Jack moves the config file to the jack/cfg folder of your project and manages the the config files from there.
 
-Jack provides a `jack config apply` command to update the EB environment.   Before uploading the new configuration to EB jack first downloads the current configuration and then does a diff on the changes that are about to be applied.  This gives a very helpful preview of exactly what you are intending to change.  This particularly helpful when changes are made through the EB GUI and are out of sync with what is stored in the `jack/cfg` files.  The demo video is available [here](https://www.youtube.com/watch?v=t7EcAOf8h1o).
+Jack provides a `jack config apply` command to update the EB environment.   Before uploading the new configuration to EB jack first downloads the current configuration and then does a diff on the changes that are about to be applied.  This gives a very helpful preview of exactly what you are intending to change.  This particularly helpful when changes are made through the EB GUI and are out of sync with what is stored in the `jack/cfg` files.
+
+
 
 This blog post also provides a good introduction and shows some useful examples of what you can do with the jack tool: [Jack and the Elastic Beanstalk — Tool to Manage AWS Elastic Beanstalk Environments](https://medium.com/@tongueroo/jack-and-the-elastic-beanstalk-easily-manage-aws-environments-3ab496f08ad2#.o7w3x0yd9).
 

data/docs/.gitignore

@@ -0,0 +1,4 @@
+_site
+.sass-cache
+.jekyll-metadata
+Gemfile.lock

data/docs/CNAME

@@ -0,0 +1 @@
+jackandtheelasticbeanstalk.com

data/docs/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "jekyll"

data/docs/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 BoltOps
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/docs/README.md

@@ -0,0 +1,21 @@
+# Jack Documentation
+
+This project powers the jack documementation website: [jackandtheelasticbeanstalk.com](http://jackandtheelasticbeanstalk.com).  It is a static website generated by [Jekyll](https://jekyllrb.com/).
+
+## Contributing
+
+For minor changes like typos, you can click **Suggest an edit to this page**, located at the bottom of each article. This will take you to the source file on GitHub, where you can submit a pull request for your change through the UI.
+
+## Local Setup
+
+For larger fixes, you can run the site locally with the following:
+
+```
+git clone https://github.com/tongueroo/jack.git
+cd jack/docs
+bundle
+jekyll clean
+jekyll serve
+```
+
+You'll be able to view the site on [http://localhost:4000](http://localhost:4000).

data/docs/_config.yml

@@ -0,0 +1,69 @@
+# Site settings
+title: Jack
+email: tongueroo@gmail.com
+url: https://jackandtheelasticbeanstalk.com
+description: "Manage your AWS Elastic Beanstalk Jack environments easily with Jack."
+keywords: "Jack, AWS Elastic Beanstalk, DevOps, Infrastructure, BoltOps, Tools, Producitivity, Documentation"
+skills: ""
+meta_author: Tung Nguyen
+
+# Google webmaster tools
+google_verify:
+
+# https://ssl.bing.com/webmaster/configure/verify/ownership Option 2 content= goes here
+bing_verify:
+
+# Contact form:
+# - static : pass through formspree.io to validate email sending
+# - disqus : replace contact form by disqus thread
+# - comment the line below if you want to stick with the default PHP contact form
+contact: static
+
+# If you use disqus you need disqus shortname
+# https://help.disqus.com/customer/portal/articles/466208
+disqus_shortname:
+
+# Color settings (hex-codes without the leading hash-tag)
+color:
+  primary: 3972c7
+  primary-rgb: "24,288,156" #"128,179,255"
+  secondary: 2c3e50 #FD6E8A
+  secondary-dark: 233140 #A2122F
+  links: a3c8ff
+
+# Footer settings
+footer:
+  copyright: BoltOps, LLC
+  location: San Francisco, CA
+  social: BoltOps
+  credits:
+  contact: contact@boltops.com
+  phone:
+
+# Social networks usernames (many more available: google-plus, flickr, dribbble, pinterest, instagram, tumblr, linkedin, etc.)
+social:
+  - title: twitter
+    url: http://twitter.com/boltopslabs
+  - title: github
+    url: http://github.com/boltopslabs
+
+# Credits content
+credits: 'BoltOps, LLC'
+
+# Build settings
+markdown: kramdown
+permalink: pretty
+
+gh_url: "https://github.com/tongueroo/jack"
+
+collections:
+  docs:
+    name: "Documentation"
+    output: true
+
+defaults:
+  - values:
+      layout: default
+
+plugins_dir:
+ - jekyll-coffeescript

data/docs/_docs/install.md

@@ -0,0 +1,48 @@
+---
+title: Installation
+---
+
+### Install with Bolts Toolbelt
+
+If you want to quickly install jack without having to worry about jack's dependency you can simply install the Bolts Toolbelt which has jack included.
+
+```sh
+brew cask install boltopslabs/software/bolts
+```
+
+For more information about the Bolts Toolbelt or to get an installer for another operating system visit: [https://boltops.com/toolbelt](https://boltops.com/toolbelt)
+
+### Install with RubyGems
+
+If you prefer to install jack via RubyGems follow the instructions:
+
+```sh
+gem install jack-eb # the name is called jack-eb not jack
+```
+
+Or you can add jack to your Gemfile in your project if you are working with a ruby project.  It is not required for your project to be a ruby project to use jack.
+
+{% highlight ruby %}
+gem "jack-eb"
+{% endhighlight %}
+
+You also need to install jack's additional dependencies: the aws cli and the aws eb cli.
+
+On a Mac OS system, you can use homebrew:
+
+```sh
+brew install awscli # follow the post install instructions
+brew install awsebcli
+```
+
+Make sure you follow the homebrew post install instructions to set up  `~/.aws/config` and `~/.aws/credentials`.
+
+On other operating systems, follow Amazon Web Services' official installation guides:
+
+* [Installing the AWS Command Line Interface
+](http://docs.aws.amazon.com/cli/latest/userguide/installing.html)
+* [Install the Elastic Beanstalk Command Line Interface (EB CLI)](http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/eb-cli3-install.html)
+
+
+<a class="btn btn-basic" href="/quick-start/">Back</a>
+<a class="btn btn-primary" href="{% link _docs/structure.md %}">Next Step</a>

data/docs/_docs/jack-apply.md

@@ -0,0 +1,54 @@
+---
+title: jack apply
+---
+
+#### Applying Changes
+
+Now let's make some changes to the Elastic Beanstalk environment. Let's change the AutoScaling RollingUpdateEnabled from `true` to `false`.  Here is the line for that setting:
+
+```yaml
+    RollingUpdateEnabled: true
+```
+
+
+And then update it with the following command:
+
+```sh
+jack apply hi-web-stag
+```
+
+You should see similiar output:
+
+<img src="/img/tutorials/jack-apply.png" class="doc-photo" />
+
+#### Syncing Changes
+
+Let's demonstrate one of the good reasons for using jack to manage your Elastic Beanstalk configurations. Let's say someone on the team updates one of the environment variables using the AWS Elastic Beanstalk Console.
+
+<img src="/img/tutorials/eb-console-update.png" class="doc-photo" />
+
+Now we decide to re-enable RollingUpdateEnabled to `true`.  We'll apply this change again:
+
+```sh
+jack apply hi-web-stag
+```
+
+Notice that this time when jack compares the configuration you see the changes that your other team member has made.
+
+<img src="/img/tutorials/jack-apply-no.png" class="doc-photo" />
+
+By allowing you to preview the changes and prompting for your confirmation, jack prevents you from accidentally overriding their change.  This saves later headaches and confusion when changes "suddenly" disappear.
+
+
+You can now download the updated configuration first and then re-add your changes.
+
+```
+jack download get hi-web-stag
+# add back in your changes to `jack/cfg/hi-web-stag.cfg.yml
+jack upload apply hi-web-stag
+```
+
+You are now set! Jack allows you codify the infrastructure code and then enables you to apply those changes safely.
+
+<a class="btn btn-basic" href="{% link _docs/jack-get.md %}">Back</a>
+<a class="btn btn-primary" href="{% link _docs/jack-diff.md %}">Next Step</a>

data/docs/_docs/jack-create.md

@@ -0,0 +1,20 @@
+---
+title: jack create
+---
+
+Run the following command to create an Elastic Beanstalk Environment:
+
+```sh
+jack create hi-web-prod
+```
+
+The above command will automatically create an Elastic Beanstalk application called **hi** and an environment called **hi-web-prod**.  Jack follows a naming convention scheme: `[app]-[role]-[env]`.  Jack automatically separates the words by dashes and takes the first word using that as the app name.  This is how jack knows how to create an Elastic Beanstalk application named **hi** without you having to tell it that.  The naming convention can be easily [overridden]({% link _docs/conventions.md %}). The naming conventions helps provide guidance for best practices and dramatically simplies the tools usage.  Things just work.
+
+After a few minutes you should see an environment fully spun up in Elastic Beanstalk's Console:
+
+<img src="/img/tutorials/aws-eb-dashboard.png" class="doc-photo" />
+
+In the next step, you'll download the configuration from the newly created environment.
+
+<a class="btn btn-basic" href="{% link _docs/tutorial.md %}">Back</a>
+<a class="btn btn-primary" href="{% link _docs/jack-get.md %}">Next Step</a>

data/docs/_docs/jack-deploy.md

@@ -0,0 +1,31 @@
+---
+title: jack deploy
+---
+
+So far we have been using an empty folder as our project to mainly demonstrate jack's abiliy to download and managed configuration files.  Jack can also deploy applications to the Elastic Beanstalk environments.  For this next step, we will deploy a small test sinatra app available on GitHub at [tongueroo/sinatra](https://github.com/tongueroo/sinatra).
+
+Clone the project and cd into it:
+
+```sh
+git clone https://github.com/tongueroo/sinatra.git
+cd sinatra
+```
+
+Now we can use the `jack deploy` command to deploy the app:
+
+```sh
+jack deploy hi-web-stag
+```
+
+You should see similiar output below:
+
+<img src="/img/tutorials/jack-deploy.png" class="doc-photo" />
+
+The jack deploy command simply is a wrapper command to the `eb deploy` command.  If you need to pass `eb deploy` options down through to the underlying command you can use the `EB_OPTIONS` environment variable.  Here's an example:
+
+```sh
+EB_OPTION='--nohang' jack deploy hi-web-stag
+```
+
+<a class="btn btn-basic" href="{% link _docs/jack-diff.md %}">Back</a>
+<a class="btn btn-primary" href="{% link _docs/jack-terminate.md %}">Next Step</a>

data/docs/_docs/jack-diff.md

@@ -0,0 +1,24 @@
+---
+title: jack diff
+---
+
+#### Preview Changes
+
+You can preview the changes without applying the changes with `jack diff`.
+
+```sh
+jack diff hi-web-stag
+```
+
+You should see something similar to this:
+
+<img src="/img/tutorials/jack-diff.png" class="doc-photo" />
+
+By default, `jack diff` cleans up after itself and removes the originally downloaded `.elasticbeanstalk/saved_configs`.  If you would like to keep that file around for further inspection, use the `--dirty` flag.
+
+```sh
+jack diff hi-web-stag --dirty
+```
+
+<a class="btn btn-basic" href="{% link _docs/jack-apply.md %}">Back</a>
+<a class="btn btn-primary" href="{% link _docs/jack-deploy.md %}">Next Step</a>

data/docs/_docs/jack-get.md

@@ -0,0 +1,51 @@
+---
+title: jack get
+---
+
+Run the following command to download the configuration from the Elastic Beanstalk environment:
+
+```sh
+jack get hi-web-stag
+```
+
+You should something similar to this:
+
+<img src="/img/tutorials/jack-get.png" class="doc-photo" />
+
+Let's take a look the contents of the downloaded file:
+
+```yaml
+AWSConfigurationTemplateVersion: 1.1.0.0
+EnvironmentConfigurationMetadata:
+  Description: Configuration created from the EB CLI using "eb config save".
+EnvironmentTier:
+  Name: WebServer
+  Type: Standard
+OptionSettings:
+  aws:autoscaling:launchconfiguration:
+    EC2KeyName: default
+    IamInstanceProfile: aws-elasticbeanstalk-ec2-role
+    InstanceType: t2.micro
+  aws:autoscaling:updatepolicy:rollingupdate:
+    RollingUpdateEnabled: true
+    RollingUpdateType: Health
+  aws:elasticbeanstalk:command:
+    BatchSize: '30'
+    BatchSizeType: Percentage
+  aws:elasticbeanstalk:environment:
+    ServiceRole: aws-elasticbeanstalk-service-role
+  aws:elasticbeanstalk:healthreporting:system:
+    SystemType: enhanced
+  aws:elb:loadbalancer:
+    CrossZone: true
+  aws:elb:policies:
+    ConnectionDrainingEnabled: true
+Platform:
+  PlatformArn: arn:aws:elasticbeanstalk:us-west-2::platform/Docker running on 64bit
+    Amazon Linux/2.1.0
+```
+
+As you can see this file contains everything there is to know about the Elastic Beanstalk environment.  With this file you can completely rebuild the environment and even "clone" it across Elastic Beanstalk applications.
+
+<a class="btn btn-basic" href="{% link _docs/jack-create.md %}">Back</a>
+<a class="btn btn-primary" href="{% link _docs/jack-apply.md %}">Next Step</a>

data/docs/_docs/jack-terminate.md

@@ -0,0 +1,20 @@
+---
+title: jack terminate
+---
+
+Let's clean up after ourselves and delete the environment.  You can delete your Elastic Beanstalk environment with the following command:
+
+```sh
+jack terminate hi-web-stag
+```
+
+Jack prompts you for confirmation.  If you want to bypass the prompt use the `--sure` flag.
+
+```
+jack terminate hi-web-stag --sure
+```
+
+Congratulations! 🍾 You have created Elastic Beanstalk environments, downloaded and applied configuration changes, deployed new code to the environment and cleaned up after youself by terminating the environment. You have successfully used jack to manage an Elastic Beanstalk environment.
+
+<a class="btn btn-basic" href="{% link _docs/jack-deploy.md %}">Back</a>
+<a class="btn btn-primary" href="{% link _docs/next-steps.md %}">Next Step</a>

data/docs/_docs/next-steps.md

@@ -0,0 +1,16 @@
+---
+title: Next Steps
+---
+
+This concludes the tutorial guide for jack. Hopefully you are now more comfortable with jack's basic usage, concepts, and have a feel for the workflow.
+
+From here, there are a few resources that can help you continue along:
+
+* Check out the [jack](https://github.com/tongueroo/jack) repo on GitHub
+* Submit an issue
+* Write a blog post describing how you are using jack, or an interesting problem jack has allowed you to solve
+
+Everyone can contribute to make jack better, including the documentation. These docs are are of the same jack repo in the [docs folder](https://github.com/tongueroo/jack/tree/master/docs). Please fork the project and open a pull request!  We love your pull requests. Contributions are encouraged and welcomed!
+
+<a class="btn btn-basic" href="{% link _docs/jack-terminate.md %}">Back</a>
+<a class="btn btn-primary" href="{% link articles.md %}">Next Step</a>