docker_deploy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c0a6af4b603facef00bb395c7598fbc4265605a
+  data.tar.gz: fc8a912ed44073f881859ae0934d9b59411daa52
+SHA512:
+  metadata.gz: 0eb9eb0c1975c9cdcb44a9e10507046593caa4298ccd683e5c2e2367d9ed9a6e58f6fe936b83108c246b881c3104e06565546ce3b74cbd7a6f29563658fe3d9e
+  data.tar.gz: 0555bb0bce47a2a169fa29c24e72d35af502a1c6535a0fae1b9269b6eabdad1efc73a2d57cc803be1c3725922eb6690a4f28a55b5f6e2c251ab79853101649d5

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in docker_deploy.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jonas Nicklas and Lisa Hammarström
+
+MIT License
+
+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/README.md

@@ -0,0 +1,83 @@
+# DockerDeploy
+
+Deploy docker containers via Rake. This is especially useful for dockerized
+Ruby applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'docker_deploy'
+```
+
+## Usage
+
+In your Rakefile define your deployment setup like this:
+
+``` ruby
+DockerDeploy.task do
+  image "elabs/projectpuzzle"
+
+  env "RAILS_ENV" => "production"
+
+  port 80 => 3000
+
+  stage :staging do
+    server "ubuntu@staging.projectpuzzle.com"
+
+    env "CANONICAL_HOST" => "staging.projectpuzzle.com"
+
+    host "http://staging.projectpuzzle.com"
+  end
+
+  stage :production do
+    server "ubuntu@app1.projectpuzzle.com"
+    server "ubuntu@app2.projectpuzzle.com"
+
+    env "CANONICAL_HOST" => "projectpuzzle.com"
+
+    host "http://projectpuzzle.com"
+  end
+end
+```
+
+If you're packaging a Rails application you might want to add this in
+`lib/tasks/docker.rake` instead.
+
+DockerDeploy has now generated a ton of rake tasks for you. You can inspect
+which ones are available by running:
+
+``` sh
+rake -T docker
+```
+
+To deploy your application to the server, the server must have docker installed
+and running and available without `sudo`. See the docker documentation on setting
+this up. Try running:
+
+```
+rake docker:staging:deploy
+```
+
+This should package your application, send it to the docker registry, pull it down
+on the remote server and finally run it as a docker container.
+
+## Adding a Dockerfile
+
+These instructions assume you already have a Dockerfile set up. If you want to
+package a Rails application, this might give you something to get you started:
+
+``` dockerfile
+FROM rails:onbuild
+RUN bundle exec rake assets:precompile
+```
+
+## Known issues
+
+* The `console` task is currently broken. We were unable to figure out how to
+create an interactive session via `sshkit`.
+
+## License
+
+[MIT](LICENSE.txt)

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/docker_deploy.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'docker_deploy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "docker_deploy"
+  spec.version       = DockerDeploy::VERSION
+  spec.authors       = ["Jonas Nicklas", "Lisa Hammarström"]
+  spec.email         = ["jonas.nicklas@gmail.com", "lisa@elabs.se"]
+  spec.summary       = %q{Deploy Docker containers via Rake}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sshkit", "~> 1.5"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/docker_deploy.rb

@@ -0,0 +1,33 @@
+require "sshkit"
+require "sshkit/dsl"
+require "shellwords"
+
+require "docker_deploy/version"
+require "docker_deploy/context"
+require "docker_deploy/stage"
+require "docker_deploy/task"
+
+# Improvement on the broken piece of crap text formatter in SSHKit.
+class PlainFormatter < SSHKit::Formatter::Abstract
+  def initialize(io = $stdout)
+    @io = io
+  end
+
+  def write(obj)
+    if obj.is_a?(SSHKit::Command)
+      @io.write(obj.stdout)
+    else
+      @io.write(obj.to_s)
+    end
+  end
+
+  alias_method :<<, :write
+end
+
+SSHKit.configure do |config|
+  config.output = PlainFormatter.new($stdout)
+  config.command_map["docker"] = "/usr/bin/env docker"
+  # config.output_verbosity = Logger::DEBUG
+end
+
+SSHKit::Backend::Netssh.config.pty = true

data/lib/docker_deploy/context.rb

@@ -0,0 +1,38 @@
+module DockerDeploy
+  class Context
+    attr_reader :stages, :variables, :ports
+
+    def initialize
+      @stages = []
+      @variables = {}
+      @ports = {}
+    end
+
+    def env(variables = {})
+      @variables.merge!(variables)
+    end
+
+    def port(ports = {})
+      @ports.merge!(ports)
+    end
+
+    def image(name = nil)
+      @image = name if name
+      @image
+    end
+
+    def container
+      @image.split("/").last
+    end
+
+    def revision
+      @revision ||= `git rev-parse HEAD`.chomp[0...8]
+    end
+
+    def stage(name, &block)
+      stage = Stage.new(self, name)
+      stage.instance_eval(&block)
+      @stages << stage
+    end
+  end
+end

data/lib/docker_deploy/stage.rb

@@ -0,0 +1,48 @@
+module DockerDeploy
+  class Stage
+    attr_reader :name, :servers, :variables
+
+    def initialize(context, name)
+      @context = context
+      @name = name
+      @servers = []
+      @variables = {}
+      @ports = {}
+      @deploy = ["docker:build", "docker:push", :pull, :restart]
+    end
+
+    def env(variables = {})
+      @variables.merge!(variables)
+    end
+
+    def port(ports = {})
+      @ports.merge!(ports)
+    end
+
+    def deploy(sequence = nil)
+      @deploy = sequence if sequence
+      @deploy
+    end
+
+    def host(name = nil)
+      @host = name if name
+      @host
+    end
+
+    def server(server)
+      @servers << SSHKit::Host.new(server)
+    end
+
+    def mappings
+      @context.ports.merge(@ports).each_with_object("") do |(from, to), s|
+        s << " -p %d:%d " % [from, to]
+      end
+    end
+
+    def options
+      @context.variables.merge(@variables).each_with_object("") do |(k, v), s|
+        s << " -e %s=%s " % [Shellwords.escape(k), Shellwords.escape(v)] if v.present?
+      end
+    end
+  end
+end

data/lib/docker_deploy/task.rb

@@ -0,0 +1,72 @@
+module DockerDeploy
+  def self.task(ns = :docker, &block)
+    main = TOPLEVEL_BINDING.eval("self")
+
+    context = Context.new
+    context.instance_eval(&block)
+
+    main.instance_eval do
+      namespace ns do
+
+        desc "Builds the application into a docker image"
+        task :build do
+          sh "docker build -t #{context.image}:#{context.revision} -t #{context.image}:latest ."
+        end
+
+        desc "Push the application's docker image to the docker registry"
+        task :push do
+          sh "docker push #{context.image}"
+        end
+
+        context.stages.each do |stage|
+          namespace stage.name do
+
+            desc "deploy the application"
+            task deploy: stage.deploy
+
+            desc "Pull down code from the docker registry"
+            task :pull do
+              on stage.servers do
+                execute :docker, "pull #{context.image}"
+              end
+            end
+
+            desc "Stop the application and remove its container"
+            task :stop do
+              on stage.servers do
+                execute :docker, "inspect #{context.container} 2>&1 > /dev/null && docker stop #{context.container} && docker rm #{context.container} || true"
+              end
+            end
+
+            desc "Start the application in a container using the latest image."
+            task :start do
+              on stage.servers do
+                execute :docker, "run -d #{stage.mappings} #{stage.options} --name #{context.container} #{context.image}:latest"
+
+                puts "\n\nStarted: #{stage.host}\n"
+              end
+            end
+
+            desc "Run migrations in the latest image."
+            task :migrate do
+              on stage.servers.first do
+                execute :docker, "run #{stage.options} -i -t --rm=true #{context.image}:latest bundle exec rake db:create db:migrate"
+              end
+            end
+
+            desc "Run a Rails console in the container"
+            task :console do
+              puts "Console is currently broken :("
+              puts "Run:\n"
+              puts "ssh #{stage.servers.first}"
+              puts "docker run #{stage.options} -i -t --rm=true #{context.image}:latest bundle exec rails console"
+            end
+
+            desc "Restart the running container."
+            task restart: [:stop, :start]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/docker_deploy/version.rb

@@ -0,0 +1,3 @@
+module DockerDeploy
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: docker_deploy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonas Nicklas
+- Lisa Hammarström
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- jonas.nicklas@gmail.com
+- lisa@elabs.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- docker_deploy.gemspec
+- lib/docker_deploy.rb
+- lib/docker_deploy/context.rb
+- lib/docker_deploy/stage.rb
+- lib/docker_deploy/task.rb
+- lib/docker_deploy/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Deploy Docker containers via Rake
+test_files: []