barnacle 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0c8dbe0e035531f309a0b26e950d85a2d4862732
+  data.tar.gz: 4c25e3cb78e1a8448b7ea4d9bccdc118c2eca1be
+SHA512:
+  metadata.gz: cc6589d60772aade2b54dd631473be42693a2f37297b69f6e16485c421e898418f0742e6ac07654e767e1ffc3495c063bc9beb2ef3a74719b54802de031e39e2
+  data.tar.gz: 28fe6c9065bf0db1087fcb7bbd49834f4dd895641a4a6cd8cd41068c42c59ec897a724fb2b4692b042ebf9ec07c087a3e31616fc92ac98e77ea132676b55f873

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 kswope
+
+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,151 @@
+# Barnacle
+
+
+All I want from Docker is convenience and the ability to run isolate services.
+I don't want to push to registries, tag images, manage containers, etc.  I
+created this simple gem to hide these complexities.
+
+There are only four ways to run barnacle, and you can probably guess what they do.
+
+```
+barnacle up
+```
+
+```
+barnacle down
+```
+
+```
+barnacle status
+```
+
+```
+barnacle enter
+```
+
+## Requires
+
+docker version >= 1.5.0
+
+some reasonable version of ruby
+
+## Install
+
+This is a ruby script packaged in a ruby gem.
+
+```
+shell> gem install barnacle
+```
+
+or Gemfile:
+
+```
+gem 'barnacle'
+```
+
+## Setup
+
+Place your Dockerfile and an optional file named config.yml in your services
+root directory.  barnacle will look for these files in a directory named
+barnacle.  The Dockerfile will probably contain an ADD statement to include
+some or all of the directory tree - but that's up to you.  Your Dockerfile will
+definitely need a CMD because there's no way to pass arguments to barnacle - a
+design decision for simplicy, the objective of barnacle.
+
+
+    my_service/
+    ├── app
+    ├── barnacle
+    │   ├── config.yml
+    │   └── Dockerfile
+    ├── bin
+    └── lib
+
+## Execution and Defaults
+
+##### Defaults:
+
+* detach = true
+* [name]     = current directory name
+* [hostname] = current directory name
+
+If you want to override any defaults put them in the barnacle/config.yml file described in the next section.
+
+##### barnacle up (runs)
+
+```
+docker build -f barnacle/Dockerfile -t [name]
+docker rm -f [name]
+docker run --detach=true --name=[name] --hostname=[hostname] [config.yml switches] [name] 
+```
+
+##### barnacle down (runs)
+
+```
+docker stop NAME
+```
+
+
+##### barnacle status (just highlights line with [name] in the name column)
+
+```
+docker ps -a
+```
+
+
+##### docker enter (executes)
+
+```
+docker exec -ti NAME bash
+
+```
+
+## config.yml
+
+This file is made up only of command line switches passed to docker commands.
+
+Example config.yml:
+
+    docker:
+      privileged: true
+      v: 
+        - /sys/fs/cgroup:/sys/fs/cgroup:ro
+        - /var/log/relay:/var/log
+
+The above config.yml results in these __additional__ command line switches
+for $>docker up
+
+    --priviledged=true -v /sys/fs/cgroup:/sys/fs/cgroup:ro -v /var/log/relay:/var/log
+
+
+## Workflow
+
+Just a suggestion for production deployment.
+
+1. Get changes up to production server (git push/pull, rsync, floppy, whatever)
+
+2. Log into remote host... cd to service's directory
+
+4. barnacle up
+
+If you are more sophisticated you might combine all these steps in a single
+command - like a rake task utilizing ssh -c for the remote commands, or even
+something like Ansible.
+
+No image repository is needed except for the base image on the first run.  If
+you keep your images up on the production server, and are smart about your
+Dockerfile, this should be a very quick deployment.
+
+Note: if you are deploying rails don't forget to put 'bundle install', compile
+assets, and tell the web server of the changes  in your Dockerfile.  (research
+into caching as much 'bundle install' as possible) 
+
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/barnacle/fork )
+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 a new Pull Request

data/Rakefile

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

data/barnacle.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'barnacle/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "barnacle"
+  spec.version       = Barnacle::VERSION
+  spec.authors       = ["kswope"]
+  spec.email         = ["github-kevdev@snkmail.com"]
+
+  if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com' to prevent pushes to rubygems.org, or delete to allow pushes to any server."
+  end
+
+  spec.summary       = %q{Manage your Dockerized service with four simple commands}
+  spec.description   = %q{Manage your Dockerized service with four simple commands}
+  spec.homepage      = "https://github.com/kswope/barnacle"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency 'rainbow'
+
+
+end

data/exe/barnacle

@@ -0,0 +1,214 @@
+#!/usr/bin/env ruby
+
+require 'rainbow'
+require 'yaml'
+  
+yml_filename = 'barnacle/config.yml'
+
+
+#-------------------------------------------------------------------------------
+# requires >1.5 (because of "build -f") (delete this -f is in distros)
+#-------------------------------------------------------------------------------
+version = `docker -v`[/[\d\.]+/]
+raise "Requires docker version >= 1.5.0" unless version >= "1.5.0"
+
+
+#-------------------------------------------------------------------------------
+# colorized puts
+#-------------------------------------------------------------------------------
+def cputs(str)
+  puts Rainbow(str).yellow
+end
+
+
+#-------------------------------------------------------------------------------
+# Default options
+#-------------------------------------------------------------------------------
+options = { # default options
+  'name'     => File.basename(Dir.pwd),
+  'hostname' => File.basename(Dir.pwd),
+  'detach'   => true
+}
+
+
+#-------------------------------------------------------------------------------
+# Process command line arg
+#-------------------------------------------------------------------------------
+switch = ARGV[0]
+unless (ARGV.size == 1) && ["up", "down", "status", "enter"].include?(switch)
+  puts "usage: #{File.basename($0)} up|down|status|enter" 
+  exit(1)
+end
+
+
+#-------------------------------------------------------------------------------
+# merge in options from optional barnacle/switches.yml
+#-------------------------------------------------------------------------------
+if File.exists?(yml_filename)
+  if docker_yml = YAML.load_file(yml_filename)['docker']
+    p docker_yml
+    options.merge!(docker_yml) if docker_yml
+  else
+    cputs "Warning: #{yml_filename} found but didn't contain 'docker' node, not using"
+  end
+else
+  cputs "Warning: no config file found, using only defaults"
+end
+
+
+#-------------------------------------------------------------------------------
+# method that tried to run commands or blows up with error
+#-------------------------------------------------------------------------------
+def run_command(command)
+  cputs "Kernel#system> #{command}"
+  unless system(command)
+    cputs "*** ERROR: Failure running command"
+    cputs "*** #{$?}"
+    exit(1)
+  end
+end
+
+
+#-------------------------------------------------------------------------------
+# down
+#-------------------------------------------------------------------------------
+if switch == 'down'
+  run_command("docker stop #{options['name']}")
+  exit(0)
+end
+
+
+#-------------------------------------------------------------------------------
+# up
+#-------------------------------------------------------------------------------
+if switch == 'up'
+
+  # Build the docker image
+  run_command("docker build -f barnacle/Dockerfile -t #{options['name']} .")
+
+  # Delete current container, use -f in case its already running.  ";true" kludge
+  # is because running "docker rm" on a non-existant container causes "docker rm"
+  # to return a false status, rather than just quietly fail and there is
+  # currently no "fail silently" option like many unix commands.
+  run_command("docker rm -f #{options['name']}; true") 
+
+  # Build up a docker run command with arguments supplied by our default options
+  # and options overriding those from the yaml config file.
+  command = "docker run"
+  options.each do |option|
+
+    switch = option[0]
+    args = [option[1]].flatten
+
+    if switch.length > 1 # --key=value 
+      args.each do |arg|
+        command << " --#{switch}=#{arg}"
+      end
+    else # -k value
+      args.each do |arg| 
+        command << " -#{switch} #{arg}"
+      end
+    end
+
+  end
+
+  command << " #{options['name']}"
+
+  # execute our docker run command
+  run_command(command)
+
+end # if up
+
+
+#-------------------------------------------------------------------------------
+# enter
+#-------------------------------------------------------------------------------
+if switch == 'enter'
+
+  cmd = "docker exec -ti #{options['name']} bash" 
+  cputs "Kernel#exec> #{cmd}"
+  exec cmd
+
+end
+
+
+#-------------------------------------------------------------------------------
+# Clean up the docker ps formatting mess - calculate the max size needed for
+# each column with the power of ruby.
+#-------------------------------------------------------------------------------
+def calc_column_max_sizes(lines)
+
+  max_widths = Hash.new(0)
+  lines.each do |line|
+
+    line.each.with_index do |column, i|
+      
+      # reassign max_widths[i] if new value is greater 
+      max_widths[i] = (max_widths[i] < column.size) ? column.size : max_widths[i]
+
+    end
+
+  end
+
+  max_widths
+
+end
+
+
+#-------------------------------------------------------------------------------
+# figure out header column positions
+#-------------------------------------------------------------------------------
+def header_indexes(header)
+
+  ['CONTAINER ID','IMAGE','COMMAND','CREATED','STATUS','PORTS','NAMES'].inject([]) do |a,t|
+      a << header.index(t) 
+  end
+
+end
+
+
+#-------------------------------------------------------------------------------
+# status - basically colorizes docker ps output laboriously; best we can do
+# with the current docker cli (most of the effort is just to clean up the ugly
+# fixed column widths that docker ps puts out, it made barnacle look bad.
+#-------------------------------------------------------------------------------
+if switch == 'status'
+
+  cputs %{Searching for container named "#{options["name"]}"} 
+
+  lines = `docker ps -a`.split("\n")
+
+  column_indexes = header_indexes( lines[0] )
+
+  # convert lines to [line][column] array (scary code.. look away)
+  columns = lines.inject([]) do |columns, line|
+     line = column_indexes.reverse.each.with_index.inject([]) do |columns, (position, i)|
+       columns[i] = line[position..-1].strip # pluck out last column in this row
+       line = line[0..position - 1] # truncate part of line we just plucked
+       columns
+     end
+     columns << line.reverse # reverse because we gobbled up the line from the end
+  end
+
+  max_widths = calc_column_max_sizes(columns)
+
+  columns.each do |line|
+
+    # build output string with columns
+    str = line.each_with_index.inject('') do |accum, (part,i)|
+      accum << part.ljust(max_widths[i]+ 2) # pad column data to max width plus a little extra
+      accum
+    end
+
+    # what all this was about, coloring line
+    if line[6].eql?(options['name'])
+      cputs str #<--- cputs
+    else
+      puts str  #<--- puts
+    end
+
+  end
+
+end
+
+

data/lib/barnacle/version.rb

@@ -0,0 +1,3 @@
+module Barnacle
+  VERSION = "0.1.1"
+end

data/lib/barnacle.rb

@@ -0,0 +1,5 @@
+require "barnacle/version"
+
+module Barnacle
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: barnacle
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- kswope
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  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'
+description: Manage your Dockerized service with four simple commands
+email:
+- github-kevdev@snkmail.com
+executables:
+- barnacle
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- barnacle.gemspec
+- exe/barnacle
+- lib/barnacle.rb
+- lib/barnacle/version.rb
+homepage: https://github.com/kswope/barnacle
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Manage your Dockerized service with four simple commands
+test_files: []