capistrano-container 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b651e108dd83aaa200aad9f5576445e75cfeccb
+  data.tar.gz: 2a036295642ac2ea8a09fbe82549d394fa4c28e3
+SHA512:
+  metadata.gz: e4be7aa7fc3703d844cc898ad5775d9a436dfcf061010f81de94519ac41bffdf22946413fe5a973e4f8a0e7e6f15e042fd39dae2cb0c788887728e23aa27bac2
+  data.tar.gz: 98ce9c8497aa0bfe6613da4c768cb9c8a605365c345314d52457389380e9d6fe4d8dbff195c2629e1e3c095d8d1c587750aaa1ab94f18e1b8fcf5b75b2a7cd31

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 creative-workflow
+
+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,158 @@
+# Capistrano::Container [![Gem Version](https://badge.fury.io/rb/capistrano-container.svg)](http://badge.fury.io/rb/capistrano-container)
+
+Helps managing [docker]() container and files inside docker container for Capistrano 3.x.
+
+This project is in an early stage but helps me alot dealing with my container deployments and keeps my code clean. It is not only ment for docker, but at the moment there only supports docker, feel free to ditribute =)
+
+This gem does not handle Dockerfiles or such things, for that there are enough capistrano modules available.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano', '>= 3.0.0'
+gem 'capistrano-container'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-container
+
+Dont forget to require the module in your Capfile:
+
+```ruby
+require 'capistrano/container'
+```  
+
+## Usage
+### definition
+To define and register a container do the following in you stage config or deploy.rb:
+
+```ruby
+...
+
+server('www.example.com', user: 'root', roles: %w{web})
+
+container 'db',  roles: %w{db},
+                 container_id: 'website_company_beta_db',
+                 server: ['www.example.com']
+
+container 'php', roles: %w{php},
+                 container_id: 'website_company_beta_php',
+                 server: ['www.example.com']
+
+...
+```
+
+This registers two container (db, php) for the server www.example.com. The roles can later be used to filter container like the way you filter server in capistrano.
+
+The container id is optional. If not set the ontainer id is equal to the name you give the container as first argument. The container id will later be used to run docker commands.
+
+If you define a container, the given hosts get the role `:container_host` behind the scenes, so you can filter hosts that running container. Also a container specific role will be added, fo container named php `:container_php`.
+
+
+### commandline tasks
+There are general tasks you can run, if needed you will be asked on which container_id the command should run.
+
+```ruby
+cap container:all                  # show all docker containers
+cap container:delete               # delete a docker container
+cap container:diff                 # show FS diffs of docker container
+cap container:events               # show events of docker container
+cap container:inspect              # show info of docker container
+cap container:logs                 # show logs of docker container
+cap container:pause                # pause a docker container
+cap container:ports                # show shows public facing port of docker container
+cap container:ressources           # show resource usage statistics of docker container
+cap container:restart              # restart a docker container
+cap container:running              # show running docker containers
+cap container:stop                 # stop a docker container
+cap container:top                  # show running processes of docker container
+cap container:unpause              # unpause a docker container
+cap container:update_docker        # update docker
+```
+
+For every registered container also specific tasks will be registered. For a container named php the following tasks will be available. (With `cap -T` you will the container specific tasks only see if you register your container in the deploy.rb)
+
+```ruby
+cap container:php:delete           # delete a docker container
+cap container:php:diff             # show FS diffs of docker container
+cap container:php:events           # show events of docker container
+cap container:php:inspect          # show info of docker container
+cap container:php:logs             # show logs of docker container
+cap container:php:pause            # pause a docker container
+cap container:php:ports            # show shows public facing port of docker container
+cap container:php:ressources       # show resource usage statistics of docker container
+cap container:php:restart          # restart a docker container
+cap container:php:stop             # stop a docker container
+cap container:php:top              # show running processes of docker container
+cap container:php:unpause          # unpause a docker container
+```
+
+### ruby tasks
+You can access the defined container like this:
+
+```ruby
+after :deploy, :updated do
+  on roles :web do
+    # do your application restarts
+  end
+
+  on_container_roles :php do |container, host|
+    container.invoke 'restart'
+  end
+end
+```
+This filter container with the role `:php` and invokes the task `container:#{container.name}:restart`.
+
+Or inside other tasks
+```ruby
+  container = container_by_name :db
+  container = container_by_roles :php
+  container = container_by_id 'website_company_beta_db'
+```
+
+A container instance has the following methods:
+```ruby
+  # tests if the container has a specific role
+  def has_role?(role)
+
+  # the docker container id if configured, the container name instead
+  def container_id
+
+  # the container specific role, for a container named php `:container_php`
+  def container_role
+
+  # uploads a local file to a temp file on host /tmp, then copies the file into the container with docker cp
+  def upload!(src, target)
+
+  # doenloads a container file to host /tmp and then to a local file
+  def download!(src, target)
+
+  # executes a command on the docker container with docker exec
+  def execute(command)
+
+  # invokes a container specific task
+  def invoke(task_name)
+```
+
+## TODO
+  * Implement provider pattern for other container manager.
+  * Write tests.
+
+## Changes
+### Version 0.0.2
+  * Initial release
+
+## Contributing
+
+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

data/README0.md

@@ -0,0 +1,74 @@
+# Capistrano::pm2 [![Gem Version](https://badge.fury.io/rb/capistrano-pm2.svg)](http://badge.fury.io/rb/capistrano-pm2)
+
+nodejs [pm2](https://github.com/Unitech/pm2) support for Capistrano 3.x
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano', '~> 3.1.0'
+gem 'capistrano-pm2'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-pm2
+
+## Usage
+
+Require in `Capfile` to use the default task:
+
+```ruby
+require 'capistrano/pm2'
+```
+
+The task will run before `deploy:restart` as part of Capistrano's default deploy,
+or can be run in isolation with `cap production pm2:restart`. You can also invoke it in your `deploy.rb`:
+```ruby
+namespace :deploy do
+  desc 'Restart application'
+  task :restart do
+    # invoke 'npm:install'
+    invoke 'pm2:restart'
+  end
+
+  after :publishing, :restart
+end
+```
+
+
+Available Tasks
+```ruby
+cap pm2:delete                     # Delete pm2 application
+cap pm2:list                       # Show pm2 application info
+cap pm2:logs                       # Watch pm2 logs
+cap pm2:restart                    # Restart app gracefully
+cap pm2:setup                      # Install pm2 via npm on the remote host
+cap pm2:start                      # Start pm2 application
+cap pm2:status                     # List all pm2 applications
+cap pm2:stop                       # Stop pm2 application
+cap pm2:save                       # Save pm2 state so it can be loaded after restart
+```
+
+Configurable options:
+```ruby
+set :pm2_app_command, 'main.js'                   # default, runs main.js
+set :pm2_app_name, nil                            # app name for pm2, default cap :application
+set :pm2_target_path, -> { release_path.join('subdir') } # default not set
+set :pm2_roles, :all                              # default, cap roles to run on
+set :pm2_env_variables, {}                        # default, env vars for pm2
+set :pm2_start_params, ''                         # default, pm2 start params see http://pm2.keymetrics.io/docs/usage/quick-start/#cheat-sheet
+```
+
+## Contributing
+
+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

data/Rakefile

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

data/capistrano-container.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name        = 'capistrano-container'
+  spec.version     = '0.0.2'
+  spec.date        = '2016-06-08'
+  spec.summary     = 'Helps managing docker container and files inside docker container for Capistrano 3.x'
+  spec.description = spec.summary
+  spec.authors     = ['Tom Hanoldt']
+  spec.email       = ['tom@creative-workflow.berlin']
+  spec.files       = ['lib/hola.rb']
+  spec.homepage    = 'https://gihub.com/creative-workflow/capistrano-container'
+  spec.license     = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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.0.0.pre'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.1'
+end

data/lib/capistrano-container.rb

@@ -0,0 +1 @@
+require_relative 'capistrano/container.rb'

data/lib/capistrano/container.rb

@@ -0,0 +1,85 @@
+require_relative 'tasks/container.rb'
+
+module Capistrano
+  module Container
+    require_relative 'container/instance.rb'
+    require_relative 'container/manager.rb'
+    require_relative 'container/mixins.rb'
+  end
+end
+
+$container_manager = Manager.new
+
+module Capistrano
+  module DSL
+    def container(name, config = {})
+      # self gives access to capistrano dsl inside a container instance
+      $container_manager.add(name, config)
+    end
+
+    def on_container_roles(container_roles, &block)
+      container_by_roles(container_roles).each do |container|
+        on roles(container.container_role) do |host|
+          container.dsl = self
+          block.call container, host
+        end
+      end
+    end
+
+    def on_container(container, &block)
+      on roles(container.container_role) do |host|
+        container.dsl = self
+        block.call container, host
+      end
+    end
+
+    def container_by_roles(roles)
+      $container_manager.by_roles(roles).map do |container|
+        container.dsl = self
+        container
+      end
+    end
+
+    def container_by_name(name)
+      tmp = $container_manager.by_name(name)
+      tmp.dsl = self
+      tmp
+    end
+
+    def container_by_id(id)
+      tmp = $container_manager.by_id(id)
+      tmp.dsl = self
+      tmp
+    end
+
+    def run_container_command(command, container = nil)
+      if command.include?('{container_id}')
+        if container.nil?
+          container_id = ask_for_container_id
+          container    = container_by_id container_id
+        end
+
+        command.gsub!('{container_id}', container.container_id)
+
+        on roles(container.container_role) do |host|
+          container.dsl = self
+
+          puts capture("docker #{command}")
+        end
+
+      else
+        on roles(:container_host) do
+            puts capture("docker #{command}")
+        end
+      end
+    end
+
+    def ask_for_container_id()
+      invoke 'container:all'
+
+      ask(:container_id, "container id?")
+
+      fetch(:container_id)
+    end
+  end
+end

data/lib/capistrano/container/instance.rb

@@ -0,0 +1,67 @@
+require 'securerandom'
+
+class Instance
+  attr_reader :name
+  attr_reader :config
+  attr_writer :dsl
+
+  def initialize(name, config)
+    @dsl    = nil
+    @name   = name
+    @config = {shared_on_host: '/tmp'}.merge(config)
+  end
+
+  def has_role?(role)
+    return false unless @config.key? :roles
+
+    role = role.to_s if role.is_a? Symbol
+
+    @config[:roles].include? role
+  end
+
+  def container_id
+    return @name unless @config.key? :container_id
+
+    @config[:container_id]
+  end
+
+  def container_role
+    "container_#{@name}".to_sym
+  end
+
+  def upload!(src, target)
+    tmp = "#{@config[:shared_on_host]}/capistrano-docker.#{SecureRandom.uuid}.tmp"
+
+    @dsl.upload!(src, tmp)
+
+    self.cp(tmp, "#{container_id}:#{target}")
+
+    @dsl.execute("rm -rf #{tmp}")
+  end
+
+  def download!(src, target)
+    tmp = "#{@config[:shared_on_host]}/capistrano-docker.#{SecureRandom.uuid}.tmp"
+
+    self.cp("#{container_id}:#{src}", tmp)
+
+    @dsl.download!(tmp, target)
+
+    @dsl.execute("rm -rf #{tmp}")
+  end
+
+  def execute(command)
+    command = "docker exec -i #{container_id} bash -c '#{command.gsub("'", "\'")}'"
+
+    @dsl.execute(command)
+  end
+
+  def cp(src, target)
+    command = "docker cp #{src} #{target}"
+
+    @dsl.execute(command)
+  end
+
+  def invoke(task_name)
+    @dsl.invoke "container:#{@name}:#{task_name}"
+  end
+end

data/lib/capistrano/container/manager.rb

@@ -0,0 +1,55 @@
+require 'rake/dsl_definition'
+
+class Manager
+  include Rake::DSL
+
+  def initialize()
+    @container = {}
+  end
+
+  def add(name, config)
+    @container[name.to_sym] = container = Instance.new(name, config)
+
+    config[:server].map!{ |ip| server(ip) }
+
+    config[:server].each do |server|
+      server.add_roles [:container_host, container.container_role]
+    end
+
+    self.create_container_tasks(container)
+
+    container
+  end
+
+  def by_name(name)
+    @container[name.to_sym]
+  end
+
+  def by_id(id)
+    @container.each do |name, instance|
+      return instance if instance.container_id == id
+    end
+  end
+
+  def by_roles(roles)
+    roles = Array(roles)
+
+    return @container.values if roles.include? :all
+
+    tmp = {}
+    roles.each do |role|
+      @container.each do |name, instance|
+        tmp[name] = instance if instance.has_role? role
+      end
+    end
+    tmp.values
+  end
+
+  def create_container_tasks(container)
+    namespace :container do
+      namespace container.name do
+        Mixins.define_tasks(container)
+      end
+    end
+  end
+end

data/lib/capistrano/container/mixins.rb

@@ -0,0 +1,67 @@
+require 'rake/dsl_definition'
+
+module Mixins
+  extend Rake::DSL
+
+  def self.define_tasks(container = nil)
+    desc "pause a docker container"
+    task :pause do
+      run_container_command("pause {container_id}", container)
+    end
+
+    desc "unpause a docker container"
+    task :unpause do
+      run_container_command("unpause {container_id}", container)
+    end
+
+    desc "restart a docker container"
+    task :restart do
+      run_container_command("restart {container_id}", container)
+    end
+
+    desc "delete a docker container"
+    task :delete do
+      run_container_command("rm {container_id}", container)
+    end
+
+    desc "stop a docker container"
+    task :stop do
+      run_container_command("stop {container_id}", container)
+    end
+
+    desc "show info of docker container"
+    task :inspect do
+      run_container_command("inspect {container_id}", container)
+    end
+
+    desc "show logs of docker container"
+    task :logs do
+      run_container_command("logs {container_id}", container)
+    end
+
+    desc "show FS diffs of docker container"
+    task :diff do
+      run_container_command("diff {container_id}", container)
+    end
+
+    desc "show resource usage statistics of docker container"
+    task :ressources do
+      run_container_command("statt {container_id}", container)
+    end
+
+    desc "show running processes of docker container"
+    task :top do
+      run_container_command("top {container_id}", container)
+    end
+
+    desc "show events of docker container"
+    task :events do
+      run_container_command("events {container_id}", container)
+    end
+
+    desc "show shows public facing port of docker container"
+    task :ports do
+      run_container_command("port {container_id}", container)
+    end
+  end
+end

data/lib/capistrano/tasks/container.rb

@@ -0,0 +1,20 @@
+require_relative '../container/mixins.rb'
+
+namespace :container do
+  desc "update docker"
+  task :update_docker do
+    run_container_command("wget -qO- https://get.docker.com/ | sh")
+  end
+
+  desc "show all docker containers"
+  task :all do
+    run_container_command('ps -a')
+  end
+
+  desc "show running docker containers"
+  task :running do
+    run_container_command('ps')
+  end
+
+  Mixins.define_tasks
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-container
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Tom Hanoldt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0.pre
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0.pre
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+description: Helps managing docker container and files inside docker container for
+  Capistrano 3.x
+email:
+- tom@creative-workflow.berlin
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- README0.md
+- Rakefile
+- capistrano-container.gemspec
+- lib/capistrano-container.rb
+- lib/capistrano/container.rb
+- lib/capistrano/container/instance.rb
+- lib/capistrano/container/manager.rb
+- lib/capistrano/container/mixins.rb
+- lib/capistrano/tasks/container.rb
+homepage: https://gihub.com/creative-workflow/capistrano-container
+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.6
+signing_key: 
+specification_version: 4
+summary: Helps managing docker container and files inside docker container for Capistrano
+  3.x
+test_files: []