bigrig 0.0.0 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac82a5ac9205c016b1210a6aeaecfa1ea4ef5b3d
-  data.tar.gz: 4432ef121babf48862b9d4befb15c1a077280ede
+  metadata.gz: 99b5f00bb1d9aaed030eb08d2fb4bc79e7dcdc3b
+  data.tar.gz: 988da417c88855fe554b87c35df7356baeda0165
 SHA512:
-  metadata.gz: df0ee8a7881784b97c7e983c11e52f9c2453488113c87864e45209739a246b180d841f88c2826fa755c2c1da6f67c0a58887689de72e9d2e4166b62dfc4b6ecc
-  data.tar.gz: d8d9ce2f48ece6aa483249b6b1120a711678659288821eb36b46d818cc3d63710b5d940b0207e4936c2aaed18378a161d8d45691bae1bc92d7dcff0a2abf8ef0
+  metadata.gz: 4fe24f80563124bb78aa7e3480a22ba901598ceef6b56567b601ed5ca8f1f4d62115cbf70381614decdf84237ce62987537399d56caba171f57cee7cd8bbb90f
+  data.tar.gz: 8ea9d97e635b3efd6ab682184afe7b82692de5abf5398070eed4dc0a7b64102069d36085c35113d7f6b1ea89550816f2f477b19f5acdc5a430a64954515c952b

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format doc

data/.rubocop.yml

@@ -0,0 +1,20 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-01-08 10:47:58 -0800 using RuboCop version 0.27.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+#
+AllCops:
+  Exclude:
+    - 'lib/bigrig/docker_api.rb'
+    - 'vendor/**/*'
+
+Metrics/LineLength:
+  Max: 100
+
+Style/Documentation:
+  Enabled: false
+
+Style/DotPosition:
+  Enabled: true
+  EnforcedStyle: trailing

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.2

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+0.0.2
+=====
+* Profiles can add new containers
+
+0.0.3
+=====
+* `bigrig ship` takes credentials
+
+0.0.4
+=====
+Bump read timeout to one hour
+
+0.0.5
+=====
+Add -c flag to cleanup after ship
+
+0.0.7
+=====
+Add profiles to most commands

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,84 @@
+PATH
+  remote: .
+  specs:
+    bigrig (0.0.7)
+      colorize (= 0.7.5)
+      docker-api (= 1.20.0)
+      gli (= 2.12.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    Platform (0.4.0)
+    addressable (2.3.6)
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
+    coderay (1.1.0)
+    colorize (0.7.5)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    docker-api (1.20.0)
+      excon (>= 0.38.0)
+      json
+    excon (0.44.4)
+    gli (2.12.2)
+    json (1.8.2)
+    method_source (0.8.2)
+    open4 (1.3.4)
+    parser (2.2.0.pre.8)
+      ast (>= 1.1, < 3.0)
+      slop (~> 3.4, >= 3.4.5)
+    popen4 (0.1.2)
+      Platform (>= 0.4.0)
+      open4 (>= 0.4.0)
+    powerpack (0.0.9)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rainbow (2.0.0)
+    rake (10.4.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-its (1.0.1)
+      rspec-core (>= 2.99.0.beta1)
+      rspec-expectations (>= 2.99.0.beta1)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    rubocop (0.27.1)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.0.pre.7, < 3.0)
+      powerpack (~> 0.0.6)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.0)
+    safe_yaml (1.0.4)
+    slop (3.6.0)
+    vcr (2.9.3)
+    webmock (1.20.4)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bigrig!
+  popen4
+  pry
+  rake
+  rspec
+  rspec-its
+  rubocop
+  vcr (~> 2.9.3)
+  webmock (~> 1.20.4)

data/LICENSE

@@ -0,0 +1,28 @@
+Copyright (c) 2015, Constant Contact
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of bigrig nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/README.md

@@ -0,0 +1,191 @@
+[![Build Status](https://travis-ci.org/constantcontact/bigrig.svg?branch=master)](https://travis-ci.org/constantcontact/bigrig)
+# Bigrig
+
+Bigrig manages and coordinates the lifecycle of multiple Docker containers
+in a composite deployment strategy so you don't have to.
+
+In its simplest form, docker looks super-easy to use.  Whip up a Dockerfile,
+fire that badboy up, and you're all done, right?  Well, unfortunately
+in reality it's rarely that straightforward.
+
+# Scope
+
+We want to make three things easier:
+* Development
+* Environemnt-specific configuration
+* Separation of Operational Concerns
+
+## Environment-specific configuration
+
+Unless your ecosystem consists of the simplest possible deployment strategy,
+you're likely going to need to be able to deploy your application to different
+environments and you'll need the ability to configure the application in an
+environment-specific way.
+
+Bigrig lets you specify environment-specific configuration for all your
+environments in one place.  Having a single source-of-record for all
+environment details means it's easier to configure a new environment and it's
+easier to see the differences between environments.
+
+## Separation of Operational Concerns
+
+There's this thing called **Separation of operational concerns** and it's one
+of the core principles that makes Docker attractive in the first place.  I
+don't care about the operating system beyond what's immediately
+required to make my app go, and in many cases this might be all you need.
+
+That being said, when the scope of your app grows beyond a single process
+you've got two choices:
+* Add more processes to your Docker-ized application
+* Spin up more than one container and each one with a distinct job
+
+There are those that might argue you shouldn't run more than one process
+per container and if you count yourself among them Bigrig might be for you.
+
+## bigrig.json
+
+The below Bigrig metadata would be part of the project
+`hawknewton/my-awesome-app`, sitting next to a Dockerfile that knows how to
+generate a docker image.
+
+```json
+{
+  "containers": {
+    "my-awesome-app": {
+      "ports": ["80:80"],
+      "repo": "hawknewton/my-awesome-app",
+      "path": ".",
+      "env": {
+        "USE_SSL": true,
+        "CACHE_TIMEOUT": "3600"
+      }
+    },
+
+    "logger": {
+      "repo": "hawknewton/logger",
+      "tag": "1.2.3",
+      "volumes-from": ["my-awesome-app"]
+    }
+  },
+
+  "profiles": {
+    "qa": {
+      "my-awesome-app": {
+        "CACHE_TIMEOUT": "10"
+      }
+    },
+
+    "qa-1": {
+      "my-awesome-app": {
+        "hosts": [ "qa-1-database.company.com:database" ]
+      }
+    },
+
+    "qa-2": {
+      "my-awesome-app": {
+        "hosts": [ "qa-2-database.company.com:database" ]
+      }
+    },
+
+    "production": {
+      "my-awesome-app": {
+        "hosts": [ "proddb12.company.com:database" ]
+      }
+    },
+
+    "dev": {
+      "web": {
+        "env": {
+          "USE_SSL": false,
+          "CACHE_TIMEOUT": "1"
+        },
+        "links": [ "awesome-app-db:database" ]
+      },
+
+      "awesome-app-db": {
+        "tag": "mysql:5.5",
+        "env": {
+          "MYSQL_ROOT_PASSWORD": "rootpasswordhere",
+          "MYSQL_USER": "awesomeuser",
+          "MYSQL_PASSWORD": "awesomespassword",
+          "MYSQL_DATABASE": "awesome_db"
+        }
+      }
+    }
+  }
+}
+```
+
+A few things:
+* You can start Bigrig with more than one active profile. In the example
+  above, you'd probably start the individual QA environments with a
+  specific profile (`qa-1`, for example) and the broader **environment class**
+  `qa`.
+* I've included the hostname `database` for illustrative purposes, but I'd
+  advocate using something more sophisticated like a service registry to avoid
+  needing environment-specific profile entries for anything but the simplest
+  deployments.
+* If two profiles override the same value the profile declared later in
+  `bigrig.json` wins.
+
+## Development
+
+We strive to bring the developer's environment as close to production as
+possible (as well as the other way around).  The developer uses
+`bigrig.json` to develop their code and production uses `bigrig.json`
+to start the application.
+
+## QA/Production
+
+When building your application bigrig will create an **immutable** version of
+your `bigrig.json` that will always have the same **deterministic** behavior when
+run. Additionally, it'll build, tag, and push all containers that contain a
+`path` entry.
+
+For example given a bigrig.json that looks like this:
+
+```json
+{
+  "containers": {
+    "my-awesome-app": {
+      "ports": ["80:80"],
+      "repo": "hawknewton/my-awesome-app",
+      "path": ".",
+      "env": {
+        "USE_SSL": true,
+        "CACHE_TIMEOUT": "3600"
+      }
+    }
+  }
+}
+```
+
+Running `bigrig ship 1.2.3` builds the Dockerfile in the current directory,
+tags the resulting image, pushes that image, and creates `bigrig-1.2.3.json`
+that looks like this:
+
+```json
+{
+  "containers": {
+    "hawknewton/my-awesome-app": {
+      "ports": ["80:80"],
+      "repo": "hawknewton/my-awesome-app",
+      "tag": "1.2.3",
+      "env": {
+        "USE_SSL": true,
+        "CACHE_TIMEOUT": "3600"
+      }
+    }
+  }
+}
+```
+
+TODO
+====
+* Error handling is pretty bad
+* Add model validation
+
+See Also
+========
+* The docker guys look to be renaming `fig` to `compose`.  If they added
+  profile support this project would become largely redundant.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'rake/clean'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: [:spec, :rubocop]

data/bigrig.gemspec

@@ -0,0 +1,29 @@
+# Ensure we require the local version and not one we might have installed already
+require File.join([File.dirname(__FILE__), 'lib', 'bigrig', 'version.rb'])
+Gem::Specification.new do |s|
+  s.name = 'bigrig'
+  s.version = Bigrig::VERSION
+  s.author = 'Your Name Here'
+  s.email = 'your@email.address.com'
+  s.homepage = 'http://your.website.com'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'A description of your project'
+  s.files = `git ls-files`.split('
+')
+  s.require_paths << 'lib'
+  s.has_rdoc = true
+  s.bindir = 'bin'
+  s.executables << 'bigrig'
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('rspec-its')
+  s.add_development_dependency('rubocop')
+  s.add_development_dependency('pry')
+  s.add_development_dependency('vcr', '~> 2.9.3')
+  s.add_development_dependency('webmock', '~> 1.20.4')
+  s.add_development_dependency('popen4')
+
+  s.add_runtime_dependency('gli', '2.12.2')
+  s.add_runtime_dependency('colorize', '0.7.5')
+  s.add_runtime_dependency('docker-api', '1.20.0')
+end

data/bin/bigrig

@@ -0,0 +1,113 @@
+#!/usr/bin/env ruby
+require 'gli'
+require 'bigrig'
+
+STDOUT.sync = true
+
+include GLI::App
+
+program_desc 'Describe your application here'
+
+version Bigrig::VERSION
+
+subcommand_option_handling :normal
+arguments :strict
+
+# desc 'Describe some switch here'
+# switch [:s, :switch]
+
+# desc 'Describe some flag here'
+# default_value 'the default'
+# arg_name 'The name of the argument'
+# flag [:f, :flagname]
+#
+desc 'bigrig file'
+default_value 'bigrig.json'
+flag [:f, :file]
+
+desc 'Start the applicaiton in dev mode'
+command :dev do |c|
+  c.desc 'profiles to activate'
+  c.default_value 'dev'
+  c.flag [:p, :profiles]
+
+  c.action do |global_options, _options, _args|
+    Bigrig::DevAction.new(global_options[:active_containers]).perform
+  end
+end
+
+desc 'Prints logs from the application'
+command :logs do |c|
+  c.desc 'profiles to activate'
+  c.flag [:p, :profiles]
+
+  c.action do |global_options, _options, _args|
+    Bigrig::LogAction.new(global_options[:active_containers]).perform
+  end
+end
+
+desc 'Spin up a bigrig application'
+command :run do |c|
+  c.desc 'profiles to activate'
+  c.flag [:p, :profiles]
+
+  c.action do |global_options, _options, _args|
+    Bigrig::RunAction.new(global_options[:active_containers]).perform
+  end
+end
+
+desc 'Stop and destroy a bigrig application'
+command :destroy do |c|
+  c.desc 'profiles to activate'
+  c.flag [:p, :profiles]
+
+  c.action do |global_options, _options, _args|
+    Bigrig::DestroyAction.new(global_options[:active_containers]).perform
+  end
+end
+
+desc 'Build, push, and tag docker images'
+arg_name 'version'
+command :ship do |c|
+  c.desc 'username'
+  c.flag [:u, :username]
+
+  c.desc 'password'
+  c.flag [:p, :password]
+
+  c.desc 'email address'
+  c.flag [:e, :email]
+
+  c.desc 'remove the image after pushing'
+  c.switch [:c, :clean]
+
+  c.action do |global_options, options, args|
+    args[0] || fail('version is required')
+    creds = [:username, :password, :email].each_with_object({}) { |e, o| o[e] = options[e] }
+
+    Bigrig::ShipAction.new(global_options[:file], args[0], options[:clean], creds).perform
+  end
+end
+
+pre do |global_options, _command, options, _args|
+  profiles = options[:profiles] && options[:profiles].split(',') || []
+  active_containers = Bigrig::Descriptor.read(global_options[:file], profiles)
+  global_options[:active_containers] = active_containers.as_json
+  true
+end
+
+post do |_global, _command, _options, _args|
+  # Post logic here
+  # Use skips_post before a command to skip this
+  # block on that command only
+end
+
+on_error do |e|
+  # Error logic here
+  # return false to skip default error handling
+  puts e
+  puts e.backtrace
+  true
+end
+
+exit run(ARGV)

data/lib/bigrig/actions/destroy_action.rb

@@ -0,0 +1,21 @@
+module Bigrig
+  class DestroyAction
+    def initialize(active_containers)
+      @application = Application.from_json active_containers
+    end
+
+    def perform
+      @application.containers.each do |container|
+        if DockerAdapter.running? container.name
+          puts "Killing container #{container.name}"
+          DockerAdapter.kill container.name
+        end
+
+        if DockerAdapter.container_exists? container.name
+          puts "Removing container #{container.name}"
+          DockerAdapter.remove_container container.name
+        end
+      end
+    end
+  end
+end

data/lib/bigrig/actions/dev_action.rb

@@ -0,0 +1,19 @@
+module Bigrig
+  class DevAction
+    def initialize(active_containers)
+      @active_containers = active_containers
+    end
+
+    def perform
+      RunAction.new(@active_containers).perform
+      [:SIGTERM, :SIGINT].each { |s| Signal.trap(s) { destroy } }
+      LogAction.new(@active_containers).perform
+    end
+
+    private
+
+    def destroy
+      DestroyAction.new(@active_containers).perform
+    end
+  end
+end

data/lib/bigrig/actions/log_action.rb

@@ -0,0 +1,45 @@
+require 'colorize'
+
+module Bigrig
+  class LogAction
+    COLORS = [:green,
+              :yellow,
+              :light_blue,
+              :magenta,
+              :light_white]
+
+    def initialize(active_containers)
+      @application = Application.from_json active_containers
+    end
+
+    def perform
+      threads = @application.containers.map do |container|
+        color = next_color
+        Thread.new do
+          DockerAdapter.logs container.name, &print_block(container.name.send color)
+        end
+      end
+
+      threads.each(&:join)
+    end
+
+    private
+
+    def print_block(name)
+      proc do |stream, chunk|
+        if stream == :stderr
+          print "#{name}: #{chunk.light_red}"
+        else
+          puts "#{name}: #{chunk}"
+        end
+        $stdout.flush
+      end
+    end
+
+    def next_color
+      @color ||= 0
+      @color += 1
+      COLORS[(@color - 1) % 5]
+    end
+  end
+end

data/lib/bigrig/actions/run_action.rb

@@ -0,0 +1,14 @@
+module Bigrig
+  class RunAction
+    attr_accessor :application
+
+    def initialize(active_containers)
+      application = Application.from_json active_containers
+      @runner = Runner.new application
+    end
+
+    def perform
+      @runner.run
+    end
+  end
+end

data/lib/bigrig/actions/ship_action.rb

@@ -0,0 +1,51 @@
+module Bigrig
+  class ShipAction
+    def initialize(file, version, clean, credentials)
+      @file = file
+      @version = version
+      @clean = clean
+      @credentials = credentials
+    end
+
+    def perform
+      containers.each do |_name, container|
+        container['path'] && build_and_push!(container)
+      end
+
+      File.write outfile, JSON.dump(json)
+    end
+
+    private
+
+    def build_and_push!(container)
+      path = container.delete 'path'
+      repo_and_tag = "#{container['repo']}:#{@version}"
+      container['tag'] = @version
+      image = DockerAdapter.build path, &OutputParser.parser_proc
+      DockerAdapter.tag image, repo_and_tag
+      DockerAdapter.push repo_and_tag, credentials, &OutputParser.parser_proc
+      @clean && DockerAdapter.remove_image(image)
+    end
+
+    def containers
+      json['containers']
+    end
+
+    def credentials
+      @credentials && {
+        'username' => @credentials[:username],
+        'password' => @credentials[:password],
+        'email' => @credentials[:email],
+        'serveraddress' => 'https://index.docker.io/v1'
+      }
+    end
+
+    def json
+      @json ||= JSON.parse File.read @file
+    end
+
+    def outfile
+      "#{@file.split('.').first}-#{@version}.json"
+    end
+  end
+end

data/lib/bigrig/actions.rb

@@ -0,0 +1,5 @@
+require 'bigrig/actions/destroy_action'
+require 'bigrig/actions/log_action'
+require 'bigrig/actions/run_action'
+require 'bigrig/actions/dev_action'
+require 'bigrig/actions/ship_action'