sonoma-remote 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 87225981319ceaea4ec4f194245eb3676403b40d
+  data.tar.gz: c7fad6b2023e33a16525c0379e3c1aa7c5ae0ca3
+SHA512:
+  metadata.gz: 79549301b61850497f95822955eb568579bc3c9c7eba18fefe2d52a3ccb473e2d42fe15137b7cebe276c8cd67b68d6cd6a48ad5ce6bb26ba68a4827a497faaff
+  data.tar.gz: 247980a8b93d59c66d030bc96a01753854dd8e39ebe195ac1dc2222fbf40da04f8be08b75ab6d9a3b414fc5e43f679cd21dfdab7fa3cec91350727a35dd3c0be

data/.gitignore

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

data/.ruby-gemset

@@ -0,0 +1 @@
+sonoma-remote

data/.ruby-version

@@ -0,0 +1 @@
+2.2.0

data/Gemfile

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

data/README.md

@@ -0,0 +1,67 @@
+# Sonoma::Remote
+
+Manage Docker-based apps on remote servers.
+
+## Installation
+
+```ruby
+# gemfile
+gem "sonoma-remote"
+
+# Capfile
+load "sonoma/remote/tasks/all.rake" # or specific ones
+
+Sonoma::Deploy.configure!({
+  application: "your_app_name",
+  docker_registry: "host_of_registry",
+  docker_repository: "path_in_docker_registry",
+  user: "your_deploy_user"
+})
+
+# config/deploy.rb
+lock "{capistrano-version}"
+
+# config/uat.rb
+server("localhost", { roles: %W{app db worker}, user: fetch(:user), primary: true })
+```
+
+## Configuration
+
+```ruby
+load "sonoma/remote/tasks/all.rake" # or specific ones
+Sonoma::Deploy.required_config # see required config for loaded tasks
+Sonoma::Deploy.optional_config # see optional config for loaded tasks
+```
+
+## Sample
+
+```ruby
+load "sonoma/remote/tasks/all.rake"
+
+verify = ->(host) do
+  deployed_correct_version = false;
+  on(host) do
+    response = capture("curl", "localhost/status")
+    json_response = JSON.parse(response)
+    deployed_correct_version = (json_response["revision"] == fetch(:revision))
+  end
+  deployed_correct_version
+end
+
+docker_options =  -> {[
+  "-e HOSTS_IN_ENVIRONMENT=[#{roles(:app).collect(&:hostname).join(",")}]",
+  "-v /var/groupon/#{fetch(:application)}/log:/usr/src/app/log",
+  "-v /var/groupon/#{fetch(:application)}/config/local:/usr/src/app/config/local"
+]}
+
+Sonoma::Remote.configure!({
+  application: "gstream",
+  docker_options: docker_options,
+  docker_registry: "docker.groupondev.com",
+  docker_repository: "grpn_stream/gstream",
+  load_balancer_delay: 3,
+  server_boot_time: 3,
+  user: "gstream_deploy",
+  verify: verify
+})
+```

data/Rakefile

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

data/lib/sonoma-remote.rb

@@ -0,0 +1 @@
+require_relative "sonoma/remote"

data/lib/sonoma/remote.rb

@@ -0,0 +1,62 @@
+require "capistrano/setup"
+require "hipchat"
+
+module Sonoma
+  module Remote
+    @required_config = {}
+    @optional_config = {
+      hipchat_rooms: "Array of HipChat room ids, e.g. `[1,2]`",
+      hipchat_token: "Token to make requests against their API",
+      log_level: "Defaults to :info"
+    }
+
+    class << self
+      attr_accessor :required_config,
+        :optional_config
+
+      def add_required_config!(options)
+        self.required_config.merge!(symbolize(options))
+      end
+
+      def add_optional_config!(options)
+        self.optional_config.merge!(symbolize(options))
+      end
+
+      def configure!(config = {})
+        config = symbolize(config)
+
+        missing_values = required_config.dup.delete_if { |(key, value)| config.key?(key) }
+        fail_task("Missing required config: #{missing_values}") if missing_values.any?
+
+        set(:log_level, (config[:log_level] || ENV["LOG_LEVEL"] || :info))
+
+        config.each do |(key, value)|
+          set(key, value)
+        end
+      end
+
+      def notify(message, color = "green")
+        return unless fetch(:hipchat_token)
+        options = { api_version: "v2" }.merge(fetch(:hipchat_options, {}))
+        hipchat_client = HipChat::Client.new(fetch(:hipchat_token), options)
+        user = fetch(:user)[0...10]
+
+        fetch(:hipchat_rooms, []).each do |room|
+          hipchat_client[room].send(user, message, { color: color })
+        end
+      end
+
+      def fail_task(message)
+        run_locally { fatal(message) }
+        notify(message, "red")
+        fail
+      end
+
+      private
+
+      def symbolize(hash)
+        hash.each_with_object({}) { |(key, value), memo| memo[key.to_sym] = value }
+      end
+    end
+  end
+end

data/lib/sonoma/remote/tasks/all.rake

@@ -0,0 +1,3 @@
+load "sonoma/remote/tasks/deploy.rake"
+load "sonoma/remote/tasks/info.rake"
+load "sonoma/remote/tasks/tasks.rake"

data/lib/sonoma/remote/tasks/deploy.rake

@@ -0,0 +1,79 @@
+namespace :deploy do
+  Sonoma::Remote.add_required_config!({
+    application: "e.g. `my_app`",
+    docker_registry: "e.g. `docker.groupondev.com`",
+    docker_repository: "e.g. `my-org/my-repo`"
+  })
+
+  Sonoma::Remote.add_optional_config!({
+    docker_options: "Can take an array or proc returning an array, e.g. `[\"-e FOO=BAR\"]`",
+    load_balancer_delay: "Wait time in seconds, e.g. `1`",
+    server_boot_time: "Wait time in seconds, e.g. `3`"
+  })
+
+  desc "Stop app"
+  task :stop, %w(hosts) do |_task, args|
+    hosts = args[:hosts]
+    hosts = env.filter(roles(:all)) unless hosts
+
+    on(hosts) do
+      execute(:sudo, "docker exec #{fetch(:application)} rm tmp/heartbeat.txt", { raise_on_non_zero_exit: false })
+      sleep(fetch(:load_balancer_delay).to_i)
+      execute(:sudo, "docker stop #{fetch(:application)}", { raise_on_non_zero_exit: false })
+      execute(:sudo, "docker rm #{fetch(:application)}", { raise_on_non_zero_exit: false })
+    end
+  end
+
+  desc "Start app"
+  task :start, %w(hosts) => %w(verify_revision) do |_task, args|
+    hosts = args[:hosts]
+    hosts = env.filter(roles(:all)) unless hosts
+
+    on(hosts) do
+      repo = "#{fetch(:docker_registry)}/#{fetch(:docker_repository)}:#{fetch(:revision)}"
+      default_options  = ["-e RACK_ENV=#{fetch(:stage)}", "--name #{fetch(:application)}"]
+      options = (default_options + fetch(:docker_options, [])).join(" ")
+
+      execute(:sudo, "docker run -d -p 80:9292 #{options} #{repo}")
+      execute(:sudo, "docker exec #{fetch(:application)} /bin/bash -c \"echo #{fetch(:revision)} > REVISION\"")
+      sleep(fetch(:server_boot_time).to_i)
+
+      %w(verify warmup).each do |check|
+        check_proc = fetch(check.to_sym, ->(host) { true })
+        Sonoma::Remote.fail_task("#{check} failed") if !check_proc.call(host)
+      end
+
+      execute(:sudo, "docker exec #{fetch(:application)} touch tmp/heartbeat.txt")
+    end
+  end
+
+  desc "Deploy to docker container"
+  task app: %w(verify_revision) do
+    on(roles(:app), { in: :sequence, wait: 1 }) do |host|
+      %w(deploy:stop deploy:start).each do |task_name|
+        task = Rake::Task[task_name]
+        task.invoke(host)
+        task.reenable
+      end
+    end
+  end
+
+  task(:notify_deploy_start) do
+    @start_time = Time.now
+    user = %x(whoami).chomp
+    deploy_ticket = ENV["DEPLOY_TICKET"]
+    regarding = deploy_ticket ? "regarding #{deploy_ticket}" : "manually"
+
+    message = "#{user} deploying #{fetch(:application)}@#{fetch(:revision)[0...10]} to #{fetch(:stage)}"
+    message += " (#{deploy_ticket})" if deploy_ticket
+    Sonoma::Remote.notify(message, :purple)
+  end
+
+  task(:notify_deploy_end) do
+    duration = (Time.now - @start_time)
+    Sonoma::Remote.notify("Deployed #{fetch(:application)}@#{fetch(:revision)[0...10]} to #{fetch(:stage)} in #{duration}")
+  end
+
+  before("deploy:app", :notify_deploy_start)
+  after("deploy:app", :notify_deploy_end)
+end

data/lib/sonoma/remote/tasks/info.rake

@@ -0,0 +1,39 @@
+namespace :info do
+  DEFAULT_STATUS_ENDPOINT = "http://localhost/status"
+  Sonoma::Remote.add_optional_config!({
+    status_endpoint: "Defaults to #{DEFAULT_STATUS_ENDPOINT}"
+  })
+
+  task(:run, [:command]) do |_task, args|
+    command = args[:command]
+    on roles(:all), in: :sequence do |host|
+      execute(*command) # fails unless ok
+      info(capture(*command))
+    end
+  end
+
+  desc "Show docker version"
+  task(:docker) do
+    command = "sudo docker version"
+    Rake::Task["info:run"].invoke(command)
+  end
+
+  desc "Show docker processes"
+  task(:docker_ps) do
+    command = "sudo docker ps"
+    Rake::Task["info:run"].invoke(command)
+  end
+
+  desc "Show roller stats"
+  task(:roller) do
+    roller_endpoint = "http://localhost:1875/host/rollinfo"
+    Rake::Task["info:run"].invoke("curl -s #{roller_endpoint}")
+  end
+
+  desc "Show host status"
+  task(:status) do
+    status_endpoint = fetch(:status_endpoint, DEFAULT_STATUS_ENDPOINT)
+    Rake::Task["info:run"].invoke("curl -sv #{status_endpoint}")
+  end
+end
+

data/lib/sonoma/remote/tasks/tasks.rake

@@ -0,0 +1,45 @@
+Sonoma::Remote.add_required_config!({
+  docker_registry: "e.g. `docker.groupondev.com`",
+  docker_repository: "e.g. `my-org/my-repo`"
+})
+
+Sonoma::Remote.add_optional_config!({
+  console_command: "e.g. `bin/console`"
+})
+
+desc "Verifies that REVISION is set and it is available in the docker registry"
+task(:verify_revision) do
+  environmental_ref = (ENV["REVISION"] || ENV["VERSION"] || ENV["BRANCH"] || ENV["TAG"] || ENV["REF"] || ENV["SHA"])
+  revision = `git rev-parse #{environmental_ref || "HEAD"}`.chomp
+  run_locally { info("REVISION set to #{revision}") }
+
+  set(:revision, revision)
+
+  on(roles(:app, { primary: true })) do
+    uri = URI("http://#{fetch(:docker_registry)}/v1/repositories/#{fetch(:docker_repository)}/tags/#{fetch(:revision)}")
+    if (Net::HTTP.get_response(uri).code != "200")
+      Sonoma::Remote.fail_task("#{fetch(:revision)} not present in registry.")
+    end
+  end
+end
+
+desc "Load console in env"
+task :console do
+  on(roles(:utility, { primary: true })) do |host|
+    command = "sudo docker exec -it #{fetch(:application)} #{fetch(:console_command, "bin/console")}"
+    exec(%Q(ssh #{fetch(:user)}@#{host.hostname} -t '#{command}'))
+  end
+end
+
+desc "Run rake task from a docker container (`RAKE_TASK=db:migrate cap uat rake`)"
+task :rake, %w(as_dba) => %w(verify_revision) do |_task, args|
+  docker_repo = "#{fetch(:docker_registry)}/#{fetch(:docker_repository)}:#{fetch(:revision)}"
+
+  options = ["-e RACK_ENV=#{fetch(:stage)}"]
+  options << "-e AS_DBA=#{args["as_dba"]}" if args["as_dba"]
+  options.concat(fetch(:docker_options, []))
+
+  on(roles(:worker, { primary: true })) do
+    puts capture("sudo docker run --rm #{options.join(" ")} --name rake_task #{docker_repo} bin/rake #{ENV["RAKE_TASK"]}")
+  end
+end

data/lib/sonoma/remote/version.rb

@@ -0,0 +1,5 @@
+module Sonoma
+  module Remote
+    VERSION = "0.0.1"
+  end
+end

data/sonoma-remote.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sonoma/remote/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sonoma-remote"
+  spec.version       = Sonoma::Remote::VERSION
+  spec.authors       = ["Sonoma"]
+  spec.email         = ["goods-cim-orders-dev@groupon.com"]
+  spec.summary       = %q{Deploy/Manage/Monitor Remote Servers Running Docker}
+  spec.description   = %q{}
+  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 "capistrano", ">= 3.4.0"
+  spec.add_dependency "hipchat"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: sonoma-remote
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sonoma
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: hipchat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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:
+- goods-cim-orders-dev@groupon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- README.md
+- Rakefile
+- lib/sonoma-remote.rb
+- lib/sonoma/remote.rb
+- lib/sonoma/remote/tasks/all.rake
+- lib/sonoma/remote/tasks/deploy.rake
+- lib/sonoma/remote/tasks/info.rake
+- lib/sonoma/remote/tasks/tasks.rake
+- lib/sonoma/remote/version.rb
+- sonoma-remote.gemspec
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Deploy/Manage/Monitor Remote Servers Running Docker
+test_files: []