dckerize 0.7.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d53b7321a208a9d47482884b1f44c7879c7ec11
-  data.tar.gz: 60868b0d8b361fbc8c48d7f2b21360c35ee821a9
+  metadata.gz: 4b4da294caa9baac416d7e578b9b712e6b6df473
+  data.tar.gz: 6e3dd74200892ad7e97f05c681ecc1fe4dcaa3b1
 SHA512:
-  metadata.gz: 679e303ff733a0d556e039833a002e09417fcf246b75cfb369203f53d226b626ee6d6921377970ead1bd9ae0d4e44dd6d0dd848ee6a518abda697f10559c0d0d
-  data.tar.gz: c4d0ca26181ddfba503af8dd19d6263f54808c24b4aa6ae91e1d2cf7413f0d83e5480773a66f0133a6f37366e16854ae3b134d14048c5884e0df55f4724d52ac
+  metadata.gz: 9bbd9674d965becef33a74915f442a1d296a97801493954e81f64fa94e19a5af61db44ad5d260151a0a91604214ad8624acbf6490d42d91c182a959eda14200a
+  data.tar.gz: 2600a22c7515c1a2d2fe2a137c4455e0937fe86e0adfb0e19c6e72d0f1b2018f853bda6aca7d67fb87be7190a456d1d38f1af18b73a8268395fcfa0ac8c21270

data/README.md

@@ -10,15 +10,14 @@ This gem gives you a good starting point to containerize your Rails 5 applicatio
 
 You'll get
 
-- An nginx/passenger container environment for serving your application and all the necessary configurations.
-- A separate container running MySQL or PostgreSQL
+- An nginx/passenger container environment for your application and all the necessary configurations. It also mounts the application into the container so you can make development changes and not having to rebuild the image.
+- A separate container running PostgreSQL
 - A separate container for keeping your data using the data-only container pattern.
-- Extras (elasticsearch, redis and memcached for now)
 
 ## Requirements
 
-- Docker >= 1.12
-- Docker Compose >= 1.8
+- Docker >= 1.13
+- Docker Compose >= 1.13
 
 ## Installation
 
@@ -26,54 +25,30 @@ You'll get
 
 ## Usage
 
-You need to have a Rails 5 application already created. It can be useful if you
-create your app using the `--database` flag so you can have the driver already configured.
+### Quickstart
 
-General usage:
+    $ rails new myapp --database=postgresql
+    $ cd myapp
+    $ dckerize up myapp
 
-    $ dckerize up APP_NAME --database=<mysql|postgres> [--extras=elasticsearch,redis,memcached]
+Configure your database credentials (you can check these in your docker compose file):
 
-So for example in the root of your application run:
-
-    $ dckerize up APP_NAME --database=mysql
-
-Or
-
-    $ dckerize up APP_NAME --database=postgres
-
-Or
-
-    $ dckerize up APP_NAME --database=postgres --extras=elasticsearch,redis
-
-Where APP_NAME should be the same name of your application and you must specify the database
-that you want to use.
-
-## Database Configuration
-
-After running the `up` command you have to configure your database credentials
-in the following way:
-
-### MySQL
-In your config/database.yml add these lines to your configuration:
-
-    username: root
+    username: myapp
     password: mysecretpassword
-    host: mysql
-
-### Postgres
-In your config/database.yml add these lines to your configuration:
-
-    username: postgres
-    password: mysecretpassword
-    host: postgres
+    host: myapp-db
 
+Dckerize will use the name of your application to create the database host and user names.
+It also will create the development database by default (myapp_development in this case).
 
 Once you have your database configured, you can run:
 
 ```
-$ docker-compose up --build
+$ docker-compose build
+$ docker-compose up
 ```
 
+And that's it. Now you can go to localhost and see your dockerized Rails application.
+
 ## Contributing
 
 1. Fork it ( https://github.com/pacuna/dckerize/fork )

data/lib/dckerize/generator.rb

@@ -1,30 +1,8 @@
 module Dckerize
   class Generator
-    attr_accessor :name, :db, :extras
-    def initialize(name, db, extras = [])
-      if db == 'mysql'
-        @db              = 'mysql:5.7'
-        @db_password     = 'MYSQL_ROOT_PASSWORD=mysecretpassword'
-        @db_user         = 'MYSQL_USER=root'
-        @db_name         = "MYSQL_DATABASE=#{name}_development"
-        @data_volume_dir = '/var/lib/mysql'
-        @db_service_name = 'mysql'
-        @db_port = 3306
-      elsif db == 'postgres'
-        @db              = 'postgres:9.5.3'
-        @db_password     = 'POSTGRES_PASSWORD=mysecretpassword'
-        @db_user         = "POSTGRES_USER=#{name}"
-        @db_name         = "POSTGRES_DB=#{name}_development"
-        @data_volume_dir = '/var/lib/postgresql'
-        @db_service_name = 'postgres'
-        @db_port = 5432
-      end
+    attr_accessor :name
+    def initialize(name)
       @name = name
-
-      @extras = Array.new
-      extras.each do |extra|
-        @extras << Dckerize::Extra.new(extra)
-      end
     end
 
     def get_binding
@@ -42,7 +20,7 @@ module Dckerize
 
       create_from_template('Dockerfile.erb', 'Dockerfile.development')
       create_from_template('webapp.conf.erb', "webapp.conf")
-      create_from_template('setup.sh.erb', "setup.sh")
+      create_from_template('wait-for-postgres.sh.erb', "wait-for-postgres.sh")
       create_from_template('rails-env.conf.erb', "rails-env.conf")
       create_from_template('docker-compose.yml.erb', "docker-compose.yml")
     end
@@ -54,7 +32,7 @@ module Dckerize
       File.open("#{output_file}", 'w') { |file| file.write(result) }
 
       # add execution permissions for setup.sh
-      system "chmod +x #{output_file}" if output_file == 'setup.sh'
+      system "chmod +x #{output_file}" if output_file == 'wait-for-postgres.sh'
     end
 
   end

data/lib/dckerize/runner.rb

@@ -1,53 +1,22 @@
 module Dckerize
   class Runner
 
-    VALID_DBS             = ['mysql', 'postgres', 'mongo']
-    VALID_EXTRAS          = ['elasticsearch', 'redis', 'memcached']
-    ERROR_MESSAGE         = 'USAGE: dckerize up APP_NAME --database=<mysql|postgres|mongo> [--extras=elasticsearch,redis,memcached]'
-    VAGRANT_FOLDER_EXISTS = 'ERROR: vagrant folder already exists.'
+    ERROR_MESSAGE         = 'USAGE: dckerize up APP_NAME'
     CONF_FOLDER_EXISTS    = 'ERROR: conf folder already exists.'
-    DOCKERFILE_EXISTS     = 'ERROR: Dockerfile already exists.'
+    DOCKERFILE_EXISTS     = 'ERROR: Dockerfile.development already exists.'
     DOCKERCOMPOSE_EXISTS  = 'ERROR: docker-compose already exists.'
     def initialize(options)
       @options = options
     end
 
     def execute
-      extras = []
-      db = ''
       raise ERROR_MESSAGE unless valid?
-      @options[2..-1].each do |option|
-        splitted_option = option.split('=')
-        if splitted_option[0] == '--database'
-          db = splitted_option[1]
-        elsif splitted_option[0] == '--extras'
-          extras << splitted_option[1].split(',')
-        else
-          raise_error ERROR_MESSAGE
-        end
-      end
-      Dckerize::Generator.new(@options[1], db, extras.flatten).up
+      Dckerize::Generator.new(@options[1]).up
     end
 
     def valid?
       # first option should always be up
       return false if @options[0] != 'up'
-      # db is mandatory
-      return false unless @options.grep(/--database=/).any?
-
-      # only valid options allowed
-      # for dbs and extras
-      @options[2..-1].each do |option|
-        if option.split('=')[0] == '--database'
-          return false unless VALID_DBS.include?(option.split('=')[1])
-        elsif option.split('=')[0] == '--extras'
-          (option.split('=')[1]).split(',').each do |extra|
-            return false unless VALID_EXTRAS.include?(extra)
-          end
-        else
-          return false
-        end
-      end
       true
     end
   end

data/lib/dckerize/version.rb

@@ -1,3 +1,3 @@
 module Dckerize
-  VERSION = "0.7.1"
+  VERSION = "0.8.2"
 end

data/lib/dckerize.rb

@@ -1,5 +1,4 @@
 require "dckerize/version"
-require "dckerize/extra"
 require "dckerize/generator"
 require "dckerize/runner"
 require 'erb'

data/templates/Dockerfile.erb

@@ -1,4 +1,4 @@
-FROM phusion/passenger-ruby23:0.9.19
+FROM phusion/passenger-ruby24:0.9.21
 
 # Set correct environment variables.
 ENV HOME /root
@@ -6,23 +6,12 @@ ENV HOME /root
 # Use baseimage-docker's init process.
 CMD ["/sbin/my_init"]
 
-# Additional packages: we are adding the netcat package so we can
-# make pings to the database service
-RUN apt-get update && apt-get install -y -o Dpkg::Options::="--force-confold" netcat
+# Additional packages
+RUN apt-get update && apt-get install -y -o Dpkg::Options::="--force-confold" postgresql-client
 
 # Enable Nginx and Passenger
 RUN rm -f /etc/service/nginx/down
 
-# Add virtual host entry for the application. Make sure
-# the file is in the correct path
-RUN rm /etc/nginx/sites-enabled/default
-ADD webapp.conf /etc/nginx/sites-enabled/webapp.conf
-
-# In case we need some environmental variables in Nginx. Make sure
-# the file is in the correct path
-ADD rails-env.conf /etc/nginx/main.d/rails-env.conf
-
-
 ENV LANG en_US.UTF-8
 ENV LANGUAGE en_US.UTF-8
 ENV LC_ALL en_US.UTF-8
@@ -32,7 +21,14 @@ ENV LC_ALL en_US.UTF-8
 WORKDIR /tmp
 ADD Gemfile /tmp/
 ADD Gemfile.lock /tmp/
-RUN bundle install -j4
+RUN bundle install --jobs 4 --retry 3
+
+# Add virtual host entry for the application
+RUN rm /etc/nginx/sites-enabled/default
+ADD webapp.conf /etc/nginx/sites-enabled/webapp.conf
+
+# In case we need some environmental variables in Nginx
+ADD rails-env.conf /etc/nginx/main.d/rails-env.conf
 
 # Copy application into the container and use right permissions: passenger
 # uses the app user for running the application
@@ -42,6 +38,5 @@ RUN usermod -u 1000 app
 RUN chown -R app:app /home/app/webapp
 WORKDIR /home/app/webapp
 
-
 # Clean up APT when done.
 RUN apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*

data/templates/docker-compose.yml.erb

@@ -1,44 +1,38 @@
 version: '2'
 services:
-  webapp_setup:
+  <%= @name %>-db:
+    image: postgres:9.5.3
+    environment:
+      - POSTGRES_PASSWORD=mysecretpassword
+      - POSTGRES_USER=<%= @name %>
+      - POSTGRES_DB=<%= @name %>_development
+    volumes_from:
+      - <%= @name %>-data
+  <%= @name %>-data:
+    image: postgres:9.5.3
+    volumes:
+      - /var/lib/postgresql
+    command: "true"
+  <%= @name %>-migrate:
     build:
       context: .
       dockerfile: Dockerfile.development
     depends_on:
-      - <%= @db_service_name %>
+      - <%= @name %>-db
     environment:
       - PASSENGER_APP_ENV=development
-    entrypoint: ./setup.sh
-  webapp:
-    container_name: <%= @name %>
+    command: ["./wait-for-postgres.sh", "<%= @name %>-db", "bin/rails", "db:migrate"]
+  <%= @name %>:
     build:
       context: .
       dockerfile: Dockerfile.development
     depends_on:
-      - <%= @db_service_name %>
-      - webapp_setup
+      - <%= @name %>-db
+      - <%= @name %>-migrate
     ports:
       - "80:80"
     environment:
       - PASSENGER_APP_ENV=development
+      - RAILS_LOG_TO_STDOUT=true
     volumes:
       - .:/home/app/webapp
-  <%= @db_service_name %>:
-    image: <%= @db %>
-    <%- if @db_password -%>
-    environment:
-      - <%= @db_password %>
-      - <%= @db_user %>
-      - <%= @db_name %>
-    <%- end -%>
-    volumes_from:
-      - data
-  data:
-    image: <%= @db %>
-    volumes:
-      - <%= @data_volume_dir %>
-    command: "true"
-  <%- @extras.each do |extra| -%>
-  <%= extra.service_name %>:
-    image: <%= extra.image %>
-  <%- end -%>

data/templates/rails-env.conf.erb

@@ -1,4 +1,2 @@
 # example variables
-env SECRET_KEY_BASE;
-env DATABASE_URL;
-env DATABASE_PASSWORD;
+env RAILS_LOG_TO_STDOUT;

data/templates/wait-for-postgres.sh.erb

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+set -e
+
+host="$1"
+shift
+cmd="$@"
+
+until PGPASSWORD=mysecretpassword psql -h "$host" -U "<%= @name %>" -d "<%= @name %>_development" -c '\l'; do
+  >&2 echo "Postgres is unavailable - sleeping"
+  sleep 1
+done
+
+>&2 echo "Postgres is up - executing command"
+exec $cmd
+

data/templates/webapp.conf.erb

@@ -6,5 +6,5 @@ server {
     passenger_enabled on;
     passenger_user app;
 
-    passenger_ruby /usr/bin/ruby2.3;
+    passenger_ruby /usr/bin/ruby2.4;
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dckerize
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Pablo Acuña
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-17 00:00:00.000000000 Z
+date: 2017-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,13 @@ files:
 - dckerize.gemspec
 - exe/dckerize
 - lib/dckerize.rb
-- lib/dckerize/extra.rb
 - lib/dckerize/generator.rb
 - lib/dckerize/runner.rb
 - lib/dckerize/version.rb
 - templates/Dockerfile.erb
 - templates/docker-compose.yml.erb
 - templates/rails-env.conf.erb
-- templates/setup.sh.erb
+- templates/wait-for-postgres.sh.erb
 - templates/webapp.conf.erb
 homepage: https://github.com/pacuna/dckerize
 licenses:
@@ -102,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Supercharged Rails development using Docker containers.

data/lib/dckerize/extra.rb

@@ -1,49 +0,0 @@
-module Dckerize
-  class Extra
-    attr_accessor :name
-    def initialize(name)
-      @name = name
-    end
-
-    def image
-      if name == 'elasticsearch'
-        'elasticsearch'
-      elsif name == 'redis'
-        'redis'
-      elsif name == 'memcached'
-        'memcached'
-      end
-    end
-
-    def service_name
-      if name == 'elasticsearch'
-        'elasticsearch'
-      elsif name == 'redis'
-        'redis'
-      elsif name == 'memcached'
-        'memcached'
-      end
-    end
-
-    def alias
-      if name == 'elasticsearch'
-        'elasticsearch'
-      elsif name == 'redis'
-        'redis'
-      elsif name == 'memcached'
-        'memcached'
-      end
-    end
-
-    def env_variables
-      if name == 'elasticsearch'
-        ['ELASTICSEARCH_PORT_9200_TCP_ADDR', 'ELASTICSEARCH_URL']
-      elsif name == 'redis'
-        ['REDIS_PORT_6379_TCP_ADDR']
-      elsif name == 'memcached'
-        ['MEMCACHED_PORT_11211_TCP_ADDR']
-      end
-    end
-  end
-
-end

data/templates/setup.sh.erb

@@ -1,11 +0,0 @@
-#!/bin/sh
-
-echo "Waiting <%= @db_service_name %> to start..."
-
-while ! nc -z <%= @db_service_name %> <%= @db_port %>; do
-  sleep 0.1
-done
-
-echo "<%= @db_service_name %> started"
-
-bin/rails db:migrate