docker-rails 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29eddb9dd688e2781429ec0fa43faa2eb5797a60
-  data.tar.gz: fbcb78c9a799b9a7bae895a5727904d344f7a9a1
+  metadata.gz: 5ee7498a73d43a8cc24e329c9bdf688e5bde379f
+  data.tar.gz: 817e09489010ddcc26b6783335ee5d88281e016d
 SHA512:
-  metadata.gz: ee49cf865269e985ba43848ec8cfe3ceeac29fc58802d4b44b0631ac5065e1f22d26767aff4abaf6619f5a804a0f7baeb1437711d85860c75ab31b7c54e28837
-  data.tar.gz: 44911f7657c234530b003e41f46435862a832ba024553cf8e19bb4869e19ddd2c33a9c159cc7c163a8937fd76b6d134c4f9c8ce3e845d9e91221274747f75bc8
+  metadata.gz: 753d087b003e69125829c8f3f7ebfd88e4b36b838b3041078c6f8c7a6b68d59054a02c7e57c71f797ff93654786c535b44576a17dc2ab2da38a0029f598d2d84
+  data.tar.gz: b7cf55c4a143394e20f1a80ed918cdb60d014f9368e549de8bcf6368963bfb5515c1790fdebd5e30e3e75b36c34bc6fca3ac1209d1ab166cfbe3a08213eeba56

data/README.md

@@ -13,6 +13,7 @@ A simplified pattern to execute rails applications within Docker (with a CI buil
 - Interpolates variables `docker-compose.yml` making CI builds much easier
 - DB check CLI function provided for docker-compose `command` to check if db is ready
 - Configurable exit_code for `ci` - determine which container's exit code will be the result of the process (useful for CI tests)
+- Declarative ssh key sharing via SSH Agent Forwarding, including making `known_hosts` available to targeted containers.
 
 ## Usage
 
@@ -28,10 +29,11 @@ CI, the reason this is built. Do it all, do it consistently, do it concurrently,
 
 1. `before_command` - run anything on the host prior to building the docker image e.g. `rm -Rf target`
 2. `compose` - create the resolved `docker-compose.yml`
-3. `gemset_volume` - find or create the shared global gems volume for this ruby version
-4. `build` - `docker-compose build` the configuration
-5. `up` - `docker-compose up` the configuration
-6. `cleanup`
+3. `gemset_volume create` - find or create the shared global gems volume for this ruby version
+4. `ssh_agent forward` - forward any declared keys and copy in `known_hosts`
+5. `build` - `docker-compose build` the configuration
+6. `up` - `docker-compose up` the configuration
+7. `cleanup`
     1. `stop` - stop all containers for this configuration (including one-off sessions)
     2. `extract` - extract any defined files from any container
     3. `rm_volumes` - `docker-compose rm -v --force` to cleanup any container volumes (excluding the gems volume)
@@ -72,21 +74,22 @@ Almost all of the commands below are in support of the `ci` command, so why not
 
 ```bash
 Commands:
-  docker-rails bash_connect <target> <service_name>    # Open a bash shell to a running container (with automatic cleanup) e.g. bundle exec docker-rails bash --build=222 development db
-  docker-rails build <target>                          # Build for the given build/target e.g. bundle exec docker-rails build --build=222 development
-  docker-rails ci <target>                             # Execute the works, everything with cleanup included e.g. bundle exec docker-rails ci --build=222 test
-  docker-rails cleanup <target>                        # Runs container cleanup functions stop, rm_volumes, rm_compose, rm_dangling, ps_all e.g. bundle exec docker-rails cleanup --build=222 development
-  docker-rails compose <target>                        # Writes a resolved docker-compose.yml file e.g. bundle exec docker-rails compose --build=222 test
+  docker-rails bash_connect <target> <service_name>    # Open a bash shell to a running container (with automatic cleanup) e.g. docker-rails bash --build=222 development db
+  docker-rails build <target>                          # Build for the given build/target e.g. docker-rails build --build=222 development
+  docker-rails ci <target>                             # Execute the works, everything with cleanup included e.g. docker-rails ci --build=222 test
+  docker-rails cleanup <target>                        # Runs container cleanup functions stop, rm_volumes, rm_compose, rm_dangling, ps_all e.g. docker-rails cleanup --build=222 development
+  docker-rails compose <target>                        # Writes a resolved docker-compose.yml file e.g. docker-rails compose --build=222 test
   docker-rails db_check <db>                           # Runs db_check e.g. bundle exec docker-rails db_check mysql
-  docker-rails exec <target> <service_name> <command>  # Run an arbitrary command on a given service container e.g. bundle exec docker-rails exec --build=222 development db bash
-  docker-rails gemset_volume <command>                   # Gems volume management e.g. bundle exec docker-rails gemset_volume create
+  docker-rails exec <target> <service_name> <command>  # Run an arbitrary command on a given service container e.g. docker-rails exec --build=222 development db bash
+  docker-rails gemset_volume <command>                 # Gemset volume management e.g. docker-rails gemset_volume create
   docker-rails help [COMMAND]                          # Describe available commands or one specific command
-  docker-rails ps <target>                             # List containers for the target compose configuration e.g. bundle exec docker-rails ps --build=222 development
-  docker-rails ps_all                                  # List all remaining containers regardless of state e.g. bundle exec docker-rails ps_all
-  docker-rails rm_dangling                             # Remove danging images e.g. bundle exec docker-rails rm_dangling
-  docker-rails rm_volumes <target>                     # Stop all running containers and remove corresponding volumes for the given build/target e.g. bundle exec docker-rails rm_volumes --build=222 development
-  docker-rails stop <target>                           # Stop all running containers for the given build/target e.g. bundle exec docker-rails stop --build=222 development
-  docker-rails up <target>                             # Up the docker-compose configuration for the given build/target. Use -d for detached mode. e.g. bundle exec docker-rails up -d --build=222 test
+  docker-rails ps <target>                             # List containers for the target compose configuration e.g. docker-rails ps --build=222 development
+  docker-rails ps_all                                  # List all remaining containers regardless of state e.g. docker-rails ps_all
+  docker-rails rm_dangling                             # Remove danging images e.g. docker-rails rm_dangling
+  docker-rails rm_volumes <target>                     # Stop all running containers and remove corresponding volumes for the given build/target e.g. docker-rails rm_volumes --build=222 development
+  docker-rails ssh_agent <command>                     # SSH Agent Forwarding e.g. docker-rails ssh_agent forward
+  docker-rails stop <target>                           # Stop all running containers for the given build/target e.g. docker-rails stop --build=222 development
+  docker-rails up <target>                             # Up the docker-compose configuration for the given build/target. Use -d for detached mode. e.g. docker-rails up -d --build=222 test
 
 Options:
   -b, [--build=BUILD]  # Build name e.g. 123.  Can also be specified as environment variable DOCKER_RAILS_BUILD
@@ -141,13 +144,14 @@ COPY . /project
 ### 2. Add a docker-rails.yml
 
 Environment variables will be interpolated, so feel free to use them. 
-The _rails engine_ example below shows an example with all of the environments `development | test | parallel_tests | staging` to show reuse of the primary `compose` configuration. 
+The _rails engine_ example below shows an example with all of the environments `ssh_test | development | test | parallel_tests | staging` to show reuse of the primary `compose` configuration. 
 
 ```yaml
 verbose: true
 exit_code: web
 before_command: bash -c "rm -Rf target && rm -Rf spec/dummy/log"
 
+# ---
 # create a global gemset to be shared amongst all ruby 2.2.2 containers.
 gemset:
   name: 2.2.2
@@ -155,6 +159,18 @@ gemset:
   containers:
     - web
 
+# ---
+# Make the host user's id_rsa key available to the web container e.g. for cloning from github
+#   If you see "Host key verification failed", make sure the same command runs on the host first 
+#   which will add to the known_hosts file. The known_hosts is copied from the host to the ssh-agent automatically.
+ssh-agent:
+  containers:
+    - web
+  keys:
+    - id_rsa
+
+# ---
+# Declare a reusable extract set
 extractions: &extractions
   web:
     extract:
@@ -165,12 +181,42 @@ extractions: &extractions
       - '/project/tmp/parallel_runtime_rspec.log:./tmp'
 
       
-# local environments need elasticsearch, staging/production connects to existing running instance.
+# ---
+# Declare a reusable elasticsearch container, staging/production connects to existing running instance.
 elasticsearch: &elasticsearch
   elasticsearch:
     image: library/elasticsearch:1.7
     ports:
       - "9200"
+      
+# ---
+# Base docker-compose configuration for all environments.  Anything under the `compose` element must be standard docker-compose syntax.
+compose:
+  web:
+    build: .
+    working_dir: /project/spec/dummy
+    ports:
+      - "3000"
+
+    links:
+      - db
+
+  db:
+    # https://github.com/docker-library/docs/tree/master/mysql
+    image: library/mysql:5.7.6
+    ports:
+      - "3306"
+
+    # https://github.com/docker-library/docs/tree/master/mysql#environment-variables
+    environment:
+      - MYSQL_ALLOW_EMPTY_PASSWORD=true      
+
+# ---
+# Overrides based on the named targets ssh_test | development | test | parallel_tests | staging       
+ssh_test:
+  compose:
+    web:
+      command: bash -c "ssh -T git@bitbucket.org"      
 
 development:
   compose:
@@ -290,27 +336,6 @@ staging:
         && gem install foreman
         && foreman start
         "
-
-# base docker-compose configuration for all environments
-compose:
-  web:
-    build: .
-    working_dir: /project/spec/dummy
-    ports:
-      - "3000"
-
-    links:
-      - db
-
-  db:
-    # https://github.com/docker-library/docs/tree/master/mysql
-    image: library/mysql:5.7.6
-    ports:
-      - "3306"
-
-    # https://github.com/docker-library/docs/tree/master/mysql#environment-variables
-    environment:
-      - MYSQL_ALLOW_EMPTY_PASSWORD=true
 ```
 
 ## CI setup

data/lib/docker/rails.rb

@@ -18,5 +18,6 @@ require 'docker/rails/app'
 
 require 'docker/rails/cli/db_check'
 require 'docker/rails/cli/gemset_volume'
+require 'docker/rails/cli/ssh_agent'
 
 require 'docker/rails/cli/main'

data/lib/docker/rails/app.rb

@@ -5,12 +5,6 @@ module Docker
       include Singleton
       attr_reader :config,
                   :compose_config,
-                  :ruby_version,
-                  :build, # given build, usually a number
-                  :project_name, # resolved compose project name
-                  :target,
-                  :gemset_volume_path,
-                  :gemset_volume_name,
                   :compose_filename,
                   :exit_code
 
@@ -30,35 +24,22 @@ module Docker
       end
 
       def configure(options)
-        @target = options[:target]
-
         # Allow CLI option `build` to fallback to an env variable DOCKER_RAILS_BUILD.  Note that CLI provides a default build value of 1, so check against the default and existence of the env var.
         build = options[:build]
         build = ENV['DOCKER_RAILS_BUILD'] if build.to_i == 1 && !ENV['DOCKER_RAILS_BUILD'].nil?
-        ENV['DOCKER_RAILS_BUILD'] = @build = build
-
-        # determine project_name
-        dir_name = Dir.pwd.split('/').last
-        @project_name = "#{dir_name}_#{target}_#{build}"
-
-        # FIXME: temporarily sanitize project_name until they loosen restrictions see https://github.com/docker/compose/issues/2119
-        @project_name = @project_name.gsub(/[^a-z0-9]/, '')
+        ENV['DOCKER_RAILS_BUILD'] = build
 
+        target = options[:target]
 
         # load the docker-rails.yml
-        @config = Docker::Rails::Config.new
-        @config.load!(@target)
-
-        # these are generated/resolved in the config#load, grab them for convenience
-        @gemset_volume_path = ENV['DOCKER_RAILS_GEMSET_VOLUME_PATH']
-        @gemset_volume_name = ENV['DOCKER_RAILS_GEMSET_VOLUME_NAME']
-
+        @config = Docker::Rails::Config.new({build: build, target: target})
+        @config.load!(target)
         @is_configured = true
       end
 
       def compose
         # Write a docker-compose.yml with interpolated variables
-        @compose_filename = compose_filename_from @project_name
+        @compose_filename = compose_filename_from project_name
 
         rm_compose
 
@@ -79,7 +60,7 @@ module Docker
         @is_configured || false
       end
 
-      def extract
+      def extract_all
 
         # For each container, process extractions
         #  Containers are defined in compose, extractions are defined at root under container name e.g.:
@@ -106,22 +87,26 @@ module Docker
             next
           end
 
-          extractions.each do |extraction|
-            if extraction =~ /:/
-              tokens = extraction.split(':')
-              from = tokens[0]
-              to = tokens[1]
-            else
-              from = extraction
-              to = '.'
-            end
+          extract(container, service_name, extractions)
+        end
+      end
 
-            puts "\nExtracting #{service_name} #{from} to #{to}"
-            begin
-              extract_files(container, from, to)
-            rescue => e
-              puts e.message
-            end
+      def extract(container, service_name, extractions)
+        extractions.each do |extraction|
+          if extraction =~ /:/
+            tokens = extraction.split(':')
+            from = tokens[0]
+            to = tokens[1]
+          else
+            from = extraction
+            to = '.'
+          end
+
+          puts "\nExtracting #{service_name} #{from} to #{to}"
+          begin
+            extract_files(container, from, to)
+          rescue => e
+            puts e.message
           end
         end
       end
@@ -157,66 +142,13 @@ module Docker
         exec 'docker ps -a'
       end
 
-      def stop
+      def stop_all
         puts "\n\n\n\nStopping containers..."
         puts '-----------------------------'
         containers = Docker::Container.all(all: true)
         containers.each do |container|
           if is_project_container?(container)
-            printf "#{container.name}.."
-
-            # Stop it
-            container.stop
-            60.times do |i|
-              printf '.'
-              if container.down?
-                printf "done.\n"
-                break
-              end
-              sleep 1
-            end
-
-            # Kill it #1 - if still up, kill it softly?  # http://tldp.org/LDP/Bash-Beginners-Guide/html/sect_12_01.html
-            if container.up?
-              printf 'killing(-1)'
-              container.kill(signal: 'SIGHUP')
-              10.times do |i|
-                printf '.'
-                if container.down?
-                  printf "done.\n"
-                  break
-                end
-                sleep 1
-              end
-            end
-
-            # Kill it #2 - if still up, kill it with a vengeance?  # http://tldp.org/LDP/Bash-Beginners-Guide/html/sect_12_01.html
-            if container.up?
-              printf 'killing(-9)'
-              container.kill(signal: 'SIGKILL')
-              10.times do |i|
-                printf '.'
-                if container.down?
-                  printf "done.\n"
-                  break
-                end
-                sleep 1
-              end
-            end
-
-            # Kill it #3 - if still up, kill it with a chuck norris?  # http://tldp.org/LDP/Bash-Beginners-Guide/html/sect_12_01.html
-            if container.up?
-              printf 'killing(Chuck Norris)'
-              container.kill(signal: 'SIGSTOP')
-              10.times do |i|
-                printf '.'
-                if container.down?
-                  printf "done.\n"
-                  break
-                end
-                sleep 1
-              end
-            end
+            stop(container)
 
             service_name = container.compose.service
             if @config['exit_code'].eql?(service_name)
@@ -229,6 +161,7 @@ module Docker
             end
           end
         end
+        rm_ssh_agent
         puts 'Done.'
       end
 
@@ -241,7 +174,7 @@ module Docker
         containers.each do |container|
           if is_project_container?(container)
             puts container.name
-            container.remove(v: true, force: true)
+            rm_v(container)
           end
         end
         puts 'Done.'
@@ -268,7 +201,7 @@ module Docker
         # docker exec -it 2ed97d0bb938 bash
         container = get_container(service_name)
         if container.nil?
-          puts "#{service_name} does not appear to be running for build #{@build}"
+          puts "#{service_name} does not appear to be running for build #{build}"
           return
         end
 
@@ -276,16 +209,43 @@ module Docker
         container
       end
 
+      def run_ssh_agent
+        return if @config[:'ssh-agent'].nil?
+        run_ssh_agent_daemon
+        ssh_add_keys
+        ssh_add_known_hosts
+      end
+
+      def rm_ssh_agent
+        ssh_agent_name = @config.ssh_agent_name
+        begin
+          container = Docker::Container.get(ssh_agent_name)
+          stop(container)
+          rm_v(container)
+        rescue Docker::Error::NotFoundError => e
+          puts "SSH Agent forwarding container #{ssh_agent_name} does not exist."
+        end
+      end
+
       # Create global gems data volume to cache gems for this version of ruby
       #     https://docs.docker.com/userguide/dockervolumes/
-      def create_gems_volume
+      def create_gemset_volume
         begin
-          Docker::Container.get(@gemset_volume_name)
-          puts "Gem data volume container #{@gemset_volume_name} already exists."
+          Docker::Container.get(gemset_volume_name)
+          puts "Gem data volume container #{gemset_volume_name} already exists."
         rescue Docker::Error::NotFoundError => e
 
-          exec "docker create -v #{@gemset_volume_path} --name #{@gemset_volume_name} busybox"
-          puts "Gem data volume container #{@gemset_volume_name} created."
+          exec "docker create -v #{gemset_volume_path} --name #{gemset_volume_name} busybox"
+          puts "Gem data volume container #{gemset_volume_name} created."
+        end
+      end
+
+      def rm_gemset_volume
+        begin
+          container = Docker::Container.get(gemset_volume_name)
+          rm_v(container)
+        rescue Docker::Error::NotFoundError => e
+          puts "Gem data volume container #{gemset_volume_name} does not exist."
         end
       end
 
@@ -308,7 +268,7 @@ module Docker
         # in the case of running a bash session, this file may dissappear, just make sure it is there.
         compose unless File.exists?(@compose_filename)
 
-        exec("docker-compose -f #{@compose_filename} -p #{@project_name} #{cmd} #{options}", capture, ignore_errors)
+        exec("docker-compose -f #{@compose_filename} -p #{project_name} #{cmd} #{options}", capture, ignore_errors)
       end
 
       def get_container(service_name)
@@ -327,7 +287,7 @@ module Docker
         # build = labels['com.docker.compose.project']
 
         return false if container.compose.nil?
-        return true if @project_name.eql? container.compose.project
+        return true if project_name.eql? container.compose.project
         false
       end
 
@@ -363,6 +323,101 @@ module Docker
           end
         }
       end
+
+      def stop(container)
+        printf "#{container.name}.."
+
+        # Stop it
+        container.stop
+        60.times do |i|
+          printf '.'
+          if container.down?
+            printf "done.\n"
+            break
+          end
+          sleep 1
+        end
+
+        # kill it if necessary
+        kill(container)
+      end
+
+      # kill container, progressively more forceful from -1, -9, then full Chuck Norris.
+      def kill(container)
+        %w(SIGHUP SIGKILL SIGSTOP).each do |signal|
+          if container.up?
+            printf "killing(#{signal})"
+            container.kill(signal: signal)
+            10.times do |i|
+              printf '.'
+              if container.down?
+                printf "done.\n"
+                break
+              end
+              sleep 1
+            end
+          end
+        end
+      end
+
+      def ssh_agent_image
+        # 'whilp/ssh-agent:latest'
+        'rosskevin/ssh-agent:latest'
+      end
+
+      def ssh_base_cmd
+        ssh_agent_name = @config.ssh_agent_name
+        "docker run --rm --volumes-from=#{ssh_agent_name} -v ~/.ssh:/ssh #{ssh_agent_image}"
+      end
+
+      def ssh_add_known_hosts
+        exec "#{ssh_base_cmd} cp /ssh/known_hosts /root/.ssh/known_hosts"
+      end
+
+      def ssh_add_keys
+        ssh_keys = @config[:'ssh-agent'][:keys]
+        puts "Forwarding SSH key(s): #{ssh_keys.join(',')} into container(s): #{@config[:'ssh-agent'][:containers].join(',')}"
+        ssh_keys.each do |key_file_name|
+          local_key_file = "#{ENV['HOME']}/.ssh/#{key_file_name}"
+          raise "Local key file #{local_key_file} doesn't exist." unless File.exists? local_key_file
+          exec "#{ssh_base_cmd} ssh-add /ssh/#{key_file_name}"
+        end
+      end
+
+      def run_ssh_agent_daemon
+        ssh_agent_name = @config.ssh_agent_name
+        begin
+          Docker::Container.get(ssh_agent_name)
+          puts "Gem data volume container #{ssh_agent_name} already exists."
+        rescue Docker::Error::NotFoundError => e
+          exec "docker run -d --name=#{ssh_agent_name} #{ssh_agent_image}"
+          puts "SSH Agent forwarding container #{ssh_agent_name} running."
+        end
+      end
+
+      def rm_v(container)
+        container.remove(v: true, force: true)
+      end
+
+      def gemset_volume_name
+        @config[:gemset][:volume][:name]
+      end
+
+      def gemset_volume_path
+        @config[:gemset][:volume][:path]
+      end
+
+      def project_name
+        @config[:project_name]
+      end
+
+      def build
+        @config[:build]
+      end
+
+      def target
+        @config[:target]
+      end
     end
   end
 end

data/lib/docker/rails/cli/gemset_volume.rb

@@ -2,16 +2,15 @@ module Docker
   module Rails
     module CLI
       class GemsetVolume < Thor
-
-        default_task :help
-
-        desc 'create', 'Create a gem volume'
+        desc 'create', 'Create a gemset volume'
         def create(target = nil)
-          App.configured(target, options).create_gems_volume
+          App.configured(target, options).create_gemset_volume
         end
 
-
-        # TODO: add destroy volume
+        desc 'rm', 'Remove a gemset volume'
+        def rm(target = nil)
+          App.configured(target, options).rm_gemset_volume
+        end
       end
     end
   end

data/lib/docker/rails/cli/main.rb

@@ -12,6 +12,9 @@ module Docker
         desc 'gemset_volume <command>', 'Gemset volume management e.g. docker-rails gemset_volume create'
         subcommand 'gemset_volume', Docker::Rails::CLI::GemsetVolume
 
+        desc 'ssh_agent <command>', 'SSH Agent Forwarding e.g. docker-rails ssh_agent forward'
+        subcommand 'ssh_agent', Docker::Rails::CLI::SshAgent
+
         desc 'ci <target>', 'Execute the works, everything with cleanup included e.g. docker-rails ci --build=222 test'
         long_desc <<-D
 
@@ -27,6 +30,7 @@ module Docker
           invoke :before, [target], []
           invoke :compose, [target], []
           invoke CLI::GemsetVolume, :create, [target], options
+          invoke CLI::SshAgent, :forward, [target], options
           begin
             invoke :build # on CI - always build to ensure dockerfile hasn't been altered - small price to pay for consistent CI.
             invoke :up
@@ -42,7 +46,7 @@ module Docker
         def extract(target)
           app = App.configured(target, options)
           invoke :compose, [target], []
-          app.extract
+          app.extract_all
         end
 
         desc 'cleanup <target>', 'Runs container cleanup functions stop, rm_volumes, rm_compose, rm_dangling, ps_all e.g. docker-rails cleanup --build=222 development'
@@ -67,6 +71,7 @@ module Docker
 
           invoke :before, [target], base_options
           invoke CLI::GemsetVolume, :create, [target], base_options
+          invoke CLI::SshAgent, :forward, [target], base_options
 
           compose_options = ''
           compose_options = '-d' if options[:detached]
@@ -99,7 +104,7 @@ module Docker
 
         def stop(target)
           invoke :compose
-          App.configured(target, options).stop
+          App.configured(target, options).stop_all
         end
 
         desc 'rm_volumes <target>', 'Stop all running containers and remove corresponding volumes for the given build/target e.g. docker-rails rm_volumes --build=222 development'
@@ -157,6 +162,8 @@ module Docker
           app = App.configured(target, options)
 
           invoke :compose, [target], []
+          invoke CLI::GemsetVolume, :create, [target], []
+          invoke CLI::SshAgent, :forward, [target], []
 
           app.run_service_command(service_name, command)
         end

data/lib/docker/rails/cli/ssh_agent.rb

@@ -0,0 +1,17 @@
+module Docker
+  module Rails
+    module CLI
+      class SshAgent < Thor
+        desc 'forward', 'Run SSH Agent Forwarding'
+        def forward(target = nil)
+          App.configured(target, options).run_ssh_agent
+        end
+
+        desc 'rm', 'Stop and remove SSH Agent Forwarding'
+        def rm(target = nil)
+          App.configured(target, options).rm_ssh_agent
+        end
+      end
+    end
+  end
+end

data/lib/docker/rails/config.rb

@@ -3,29 +3,46 @@ module Docker
     require 'dry/config'
     class Config < Dry::Config::Base
 
-      # environment:
-      #   # make ssh keys available via ssh forwarding (see volume entry)
-      #   - SSH_AUTH_SOCK=/ssh-agent/socket
-      #
-      # volumes_from:
-      #   # Use configured whilp/ssh-agent long running container for keys
-      #   - ssh-agent
-      SSH_AGENT_DEFAULT_CONFIG = {
-          environment: ['SSH_AUTH_SOCK=/ssh-agent/socket'],
-          volumes_from: ['ssh-agent']
-      }
+      def initialize(options = {})
+        raise 'build unspecified' if options[:build].nil?
+        build = options[:build]
 
+        raise 'target unspecified' if options[:target].nil?
+        target = options[:target]
+
+        # determine project_name
+        dir_name = Dir.pwd.split('/').last
+        project_name = "#{dir_name}_#{target}_#{build}"
+
+        # FIXME: temporarily sanitize project_name until they loosen restrictions see https://github.com/docker/compose/issues/2119
+        project_name = project_name.gsub(/[^a-z0-9]/, '')
 
-      def initialize(options = {})
         super({
                   default_configuration: {
+                      build: build,
+                      target: target,
+                      project_name: project_name,
                       verbose: false
-
                   },
                   prune: [:development, :test, :parallel_tests, :staging, :production]
               }.merge(options))
       end
 
+
+      def ssh_agent_name
+        "#{self[:project_name]}_ssh_agent"
+      end
+
+      def write_docker_compose_file(output_filename = 'docker-compose.yml')
+        write_yaml_file(output_filename, self[:'compose'])
+      end
+
+      def to_yaml(config = @configuration)
+        yaml = super(config)
+        yaml = yaml.gsub(/command: .$/, 'command: >')
+        yaml
+      end
+
       def load!(environment, *filenames)
 
         # reject nil target environments
@@ -38,8 +55,8 @@ module Docker
         end
 
         # reject unknown target environments
-        config = load_unpruned(environment, *filenames)
-        raise "Unknown target environment '#{environment.to_sym}'" if config[environment.to_sym].nil?
+        unpruned_config = load_unpruned(environment, *filenames)
+        raise "Unknown target environment '#{environment.to_sym}'" if unpruned_config[environment.to_sym].nil?
 
 
         # -----------------------------------------------------
@@ -49,54 +66,76 @@ module Docker
 
         # ----
         # ssh-agent
-        ssh_agent = config[:'ssh-agent']
-        if !ssh_agent.nil?
-          ssh_agent[:containers].each do |container|
-            raise "Unknown container #{container}" if config[:compose][container.to_sym].nil?
-            compose[container.to_sym] ||= {}
-            compose[container.to_sym].deeper_merge! ({}.merge SSH_AGENT_DEFAULT_CONFIG)
-          end
-        end
+        generate_ssh_agent(compose, unpruned_config)
 
         # ----
         # gemset volume
-        gemset = config[:gemset]
+        generate_gemset(compose, unpruned_config, generated_defaults, filenames)
+
+        # now add the generated to the seeded default configuration
+        @default_configuration.merge!(generated_defaults)
+
+        # reset the base @configuration by loading the new default configuration
+        clear
+
+        # finally, load the config as internal state
+        super(environment, *filenames)
+      end
+
+      protected
+
+      def generate_gemset(compose, unpruned_config, generated_defaults, filenames)
+        gemset = unpruned_config[:gemset]
         raise "Expected to find 'gemset:' in #{filenames}" if gemset.nil?
 
         gemset_name = gemset[:name]
         raise "Expected to find 'gemset: name' in #{filenames}" if gemset_name.nil?
 
-        ENV['DOCKER_RAILS_GEMSET_VOLUME_PATH'] = gemset_volume_path = "/gemset/#{gemset_name}"
-        ENV['DOCKER_RAILS_GEMSET_VOLUME_NAME'] = gemset_volume_name = "gemset-#{gemset_name}"
+        # add the generated gemset name/path to the generated defaults
+        gemset_volume_path = "/gemset/#{gemset_name}"
+        gemset_volume_name = "gemset-#{gemset_name}"
+
+        generated_defaults.deeper_merge!(gemset: gemset)
+        generated_defaults[:gemset].deeper_merge!({
+                                                      volume: {
+                                                          name: gemset_volume_name,
+                                                          path: gemset_volume_path
+                                                      }
+
+                                                  })
 
         raise "Expected to find 'gemset: containers' with at least one entry" if gemset[:containers].nil? || gemset[:containers].length < 1
         gemset[:containers].each do |container|
-          raise "Unknown container #{container}" if config[:compose][container.to_sym].nil?
+          raise "Unknown container #{container}" if unpruned_config[:compose][container.to_sym].nil?
           compose[container.to_sym] ||= {}
           compose[container.to_sym].deeper_merge! ({
                                                       environment: ["GEM_HOME=#{gemset_volume_path}"],
                                                       volumes_from: [gemset_volume_name]
                                                   })
         end
-
-        # now add the generated to the seeded default configuration
-        @default_configuration.merge!(generated_defaults)
-
-        # reset the base @configuration by loading the new default configuration
-        clear
-
-        # finally, load the config as internal state
-        super(environment, *filenames)
       end
 
-      def write_docker_compose_file(output_filename = 'docker-compose.yml')
-        write_yaml_file(output_filename, self[:'compose'])
-      end
+      def generate_ssh_agent(compose, unpruned_config)
+        ssh_agent = unpruned_config[:'ssh-agent']
+        if !ssh_agent.nil?
 
-      def to_yaml(config = @configuration)
-        yaml = super(config)
-        yaml = yaml.gsub(/command: .$/, 'command: >')
-        yaml
+          raise "Expected to find 'ssh-agent: keys' with at least one entry" if ssh_agent[:keys].nil? || ssh_agent[:keys].length < 1
+          ssh_agent[:containers].each do |container|
+            raise "Unknown container #{container}" if unpruned_config[:compose][container.to_sym].nil?
+            # environment:
+            #   # make ssh keys available via ssh forwarding (see volume entry)
+            #   - SSH_AUTH_SOCK=/ssh-agent/socket
+            #
+            # volumes_from:
+            #   # Use configured whilp/ssh-agent long running container for keys
+            #   - <project_name>-ssh-agent
+            compose[container.to_sym] ||= {}
+            compose[container.to_sym].deeper_merge! ({
+                                                        environment: ['SSH_AUTH_SOCK=/root/.ssh/socket'],
+                                                        volumes_from: [ssh_agent_name]
+                                                    })
+          end
+        end
       end
     end
   end

data/lib/docker/rails/ext/container.rb

@@ -3,7 +3,7 @@ class Docker::Container
   #FIXME: remove this method when pull #321 is accepted
   # Update the @info hash, which is the only mutable state in this object.
   def refresh!
-     other = Docker::Container.all({all: true}, connection).find { |c|
+    other = Docker::Container.all({all: true}, connection).find { |c|
       c.id.start_with?(self.id) || self.id.start_with?(c.id)
     }
 
@@ -20,7 +20,15 @@ class Docker::Container
   end
 
   def name
-    info['Names'][0].gsub(/^\//, '')
+    name = info['Names'][0] unless info['Names'].nil?
+    name = info['Name'] if name.nil? # straight docker containers appear to just use 'Name'
+
+    # puts "Name: #{info['Name']}"
+    # puts "Names: #{info['Names']}"
+    # puts "Names.nil?: #{info['Names'].nil?}"
+    # puts "Names.length: #{info['Names'].length}"
+
+    name.gsub(/^\//, '')
   end
 
   def up?

data/lib/docker/rails/version.rb

@@ -1,5 +1,5 @@
 module Docker
   module Rails
-    VERSION = '0.6.0'
+    VERSION = '0.7.0'
   end
 end

data/spec/docker/rails/config_spec.rb

@@ -3,7 +3,11 @@ require 'spec_helper'
 describe Docker::Rails::Config do
 
   subject(:options) { {} }
-  subject(:config) { Docker::Rails::Config.new }
+  let(:target) { :foo }
+  let(:build) { 111 }
+  let(:dir_name) { 'rails' }
+  let(:project_name) { "#{dir_name}#{target}#{build}" }
+  subject(:config) { Docker::Rails::Config.new(build: build, target: target) }
 
   it 'should not raise error when key is not found' do
     config.clear
@@ -39,11 +43,11 @@ describe Docker::Rails::Config do
 
 
   context ':development' do
-    let(:target_env){ :development}
+    let(:target) { :development }
     before(:each) {
       Dir.chdir(File.dirname(__FILE__)) do
         config.clear
-        config.load!(target_env)
+        config.load!(target)
       end
     }
 
@@ -78,8 +82,8 @@ describe Docker::Rails::Config do
       }
 
       it 'web should have ssh-agent' do
-        expect(compose_config[:web][:environment]).to include('SSH_AUTH_SOCK=/ssh-agent/socket')
-        expect(compose_config[:web][:volumes_from]).to include('ssh-agent')
+        expect(compose_config[:web][:environment]).to include('SSH_AUTH_SOCK=/root/.ssh/socket')
+        expect(compose_config[:web][:volumes_from]).to include("#{project_name}_ssh_agent")
       end
       it 'web should have gemset' do
         expect(compose_config[:web][:environment]).to include('GEM_HOME=/gemset/2.2.2')

data/spec/docker/rails/docker-rails.yml

@@ -40,6 +40,7 @@ ssh-agent:
 #      - ssh-agent
 
 
+# shared extractions
 extractions: &extractions
   web:
     extract:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docker-rails
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Kevin Ross
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-02 00:00:00.000000000 Z
+date: 2015-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -160,6 +160,7 @@ files:
 - lib/docker/rails/cli/db_check.rb
 - lib/docker/rails/cli/gemset_volume.rb
 - lib/docker/rails/cli/main.rb
+- lib/docker/rails/cli/ssh_agent.rb
 - lib/docker/rails/compose_config.rb
 - lib/docker/rails/config.rb
 - lib/docker/rails/ext/container.rb