dckerize 0.6.1 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb4d4f7ae8a8b8115230d78b29ca2d76700ed800
-  data.tar.gz: 872c007c9157dacb8ed329176932d96b6b39ae99
+  metadata.gz: 7d53b7321a208a9d47482884b1f44c7879c7ec11
+  data.tar.gz: 60868b0d8b361fbc8c48d7f2b21360c35ee821a9
 SHA512:
-  metadata.gz: c0286a2f0105092950d4287e9e2f2a915ac2cb5082500e2ca5b54646a82ff81b12aa5537cb7af42dae9afd8f22ba64904b58f984313ef20a4fe825991a976ba9
-  data.tar.gz: 278e45fbba7eb421a4cc1d2bd63284ce2dc2247b4ece1f1125cf7a5bfabe3d31b54b5dec925b43fd4befa86e6cc46bb8843355fdec4bece0a5ec3bd83817d766
+  metadata.gz: 679e303ff733a0d556e039833a002e09417fcf246b75cfb369203f53d226b626ee6d6921377970ead1bd9ae0d4e44dd6d0dd848ee6a518abda697f10559c0d0d
+  data.tar.gz: c4d0ca26181ddfba503af8dd19d6263f54808c24b4aa6ae91e1d2cf7413f0d83e5480773a66f0133a6f37366e16854ae3b134d14048c5884e0df55f4724d52ac

data/README.md

@@ -2,25 +2,23 @@
 [![Gem Version](https://badge.fury.io/rb/dckerize.svg)](http://badge.fury.io/rb/dckerize)
 [![Build Status](https://travis-ci.org/pacuna/dckerize.svg?branch=master)](https://travis-ci.org/pacuna/dckerize)
 
-Supercharged Rails development using Docker and Vagrant 
+Supercharged Rails development using Docker
 
 ## Description
 
-This gem gives you a good starting point for developing your Rails application using containers managed by Docker
-inside of a VM managed by Vagrant (video demo at the end of the readme).
+This gem gives you a good starting point to containerize your Rails 5 applications using Docker.
 
 You'll get
 
-- An ubuntu trusty image already provisioned with Docker and Docker Compose.
 - An nginx/passenger container environment for serving your application and all the necessary configurations.
-- A separate container running MySQL/postgres/Mongo for your DB.
+- A separate container running MySQL or PostgreSQL
 - A separate container for keeping your data using the data-only container pattern.
 - Extras (elasticsearch, redis and memcached for now)
 
 ## Requirements
 
-- Ruby and Bundler
-- Vagrant >= 1.6
+- Docker >= 1.12
+- Docker Compose >= 1.8
 
 ## Installation
 
@@ -28,11 +26,12 @@ You'll get
 
 ## Usage
 
-You need to have a Rails application already created.
+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.
 
 General usage:
 
-    $ dckerize up APP_NAME --database=<mysql|postgres|mongo> [--extras=elasticsearch,redis,memcached]
+    $ dckerize up APP_NAME --database=<mysql|postgres> [--extras=elasticsearch,redis,memcached]
 
 So for example in the root of your application run:
 
@@ -44,131 +43,37 @@ Or
 
 Or
 
-    $ dckerize up APP_NAME --database=postgres --extras=elasticsearch
-
-Or
-
-    $ dckerize up APP_NAME --database=mongo --extras=elasticsearch,redis
-
+    $ 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.
 
-### Generated Structure
-
-Dckerize will generate:
-
-- A Vagrant folder, which contains a Vagrantfile and a docker-compose-installer bash script for provisioning.
-- A conf folder containing an nginx configuration file for your site and an environment definition file for passing
-the necessary environment variables to passenger. Any extra environment variables passed to your Rails application
-should be declared in this file.
-- A Dockerfile for building your application.
-- A docker-compose.yml file for starting your entire enviroment inside the VM.
+## Database Configuration
 
-### Environment Variables Configuration
+After running the `up` command you have to configure your database credentials
+in the following way:
 
-## MySQL
+### MySQL
 In your config/database.yml add these lines to your configuration:
 
     username: root
-    password: <%= ENV['MYSQL_ENV_MYSQL_ROOT_PASSWORD'] %>
+    password: mysecretpassword
     host: mysql
 
-## Postgres
+### Postgres
 In your config/database.yml add these lines to your configuration:
 
-    user: postgres
-    password: <%= ENV['POSTGRES_ENV_POSTGRES_PASSWORD'] %> 
+    username: postgres
+    password: mysecretpassword
     host: postgres
 
-## Mongo
-
-Host for Mongo
-
-    ENV['MONGO_PORT_27017_TCP_ADDR']
-
-
-## Elasticsearch
-
-Host for elasticsearch
-
-    ENV['ELASTICSEARCH_PORT_9200_TCP_ADDR']
-
-## Redis
-
-Host for redis
-
-    ENV['REDIS_PORT_6379_TCP_ADDR']
-
-## Memcached
-
-Host for memcached
-
-    ENV['MEMCACHED_PORT_11211_TCP_ADDR']
-
-### Developing
-
-Go inside the generated vagrant folder and run
-
-    $ vagrant up
 
-Vagrant will pull the ubuntu trusty image, the necessary docker images and set the shared folder for
-development.
-
-Once finished, run
-
-    $ vagrant ssh
-    $ cd /APP_NAME
-    $ sudo docker-compose up -d
-
-Since the folder is being shared with the virtual machine, you can run docker-compose using the docker-compose.yml file.
-This will build the container for your application, the db and the links between the containers.
-
-The application folder will also be mounted inside the container, so you can work as you normally do locally and see the changes
-reflected immediately inside the container.
-
-Now you can go inside the container and run the typical Rails commands for interacting with your application.
-
-To get the app container's name run:
-
-    $ docker ps
-
-This will show you all the running containers. Choose the one that's running your app and go inside by executing:
-
-    $ docker exec -it CONTAINER_NAME bash
-
-Now you can interact with your application
-
-    $ rake db:create
-    $ rake db:migrate
-    $ rails c
-
-And etc.
-
-The nginx container is mapping its port 80 with the port 80 of the guest host, and since we're declaring a private network in our Vagranfile
-you can access your application by visiting http://192.168.50.4.
-
-### Mounting extra files to running containers
-
-Useful for adding sql dumps to your db container (not the data one). In this case you should have the file in your shared folder and send it from your host in vagrant to your running container. There are several ways to accomplish this, but the simplest way is described [here](http://stackoverflow.com/a/24805696).
-The fastest way for a running container:
+Once you have your database configured, you can run:
 
 ```
-docker exec -i <container_id> bash -c 'cat > /path/to/container/file' < /path/to/host/file/
+$ docker-compose up --build
 ```
 
-## TODO
-
-- [x] Support for more services (redis, elasticsearch)
-- Support for other ruby/rails versions
-- More workflow examples
-
-
-
-## Video demo
-
-[![Dckerize](http://img.youtube.com/vi/X8IVAoBUtbs/0.jpg)](http://www.youtube.com/watch?v=X8IVAoBUtbs)
-
 ## Contributing
 
 1. Fork it ( https://github.com/pacuna/dckerize/fork )

data/lib/dckerize/generator.rb

@@ -4,23 +4,20 @@ module Dckerize
     def initialize(name, db, extras = [])
       if db == 'mysql'
         @db              = 'mysql:5.7'
-        @db_password     = 'MYSQL_ROOT_PASSWORD'
-        @db_password_env = 'MYSQL_ENV_MYSQL_ROOT_PASSWORD'
-        @db_host_env     = 'MYSQL_PORT_3306_TCP_ADDR'
+        @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'
-        @db_password     = 'POSTGRES_PASSWORD'
-        @db_password_env = 'POSTGRES_ENV_POSTGRES_PASSWORD'
-        @db_host_env     = 'POSTGRES_PORT_5432_TCP_ADDR'
+        @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'
-      elsif db == 'mongo'
-        @db              = 'mongo'
-        @db_host_env     = 'MONGO_PORT_27017_TCP_ADDR'
-        @data_volume_dir = '/data/db'
-        @db_service_name = 'mongo'
+        @db_port = 5432
       end
       @name = name
 
@@ -40,20 +37,14 @@ module Dckerize
 
     def up
 
-      # create vagrant and conf folders only if don't exist
-      raise Dckerize::Runner::VAGRANT_FOLDER_EXISTS if File.exists?('vagrant') 
-      raise Dckerize::Runner::CONF_FOLDER_EXISTS if File.exists?('conf')
-      raise Dckerize::Runner::DOCKERFILE_EXISTS if File.exists?('Dockerfile')
+      raise Dckerize::Runner::DOCKERFILE_EXISTS if File.exists?('Dockerfile.development')
       raise Dckerize::Runner::DOCKERCOMPOSE_EXISTS if File.exists?('docker-compose.yml')
-      FileUtils.mkdir_p('vagrant')
-      FileUtils.mkdir_p('conf')
 
-      create_from_template('Vagrantfile.erb', 'vagrant/Vagrantfile')
-      create_from_template('Dockerfile.erb', 'Dockerfile')
-      create_from_template('site.conf.erb', "conf/#{@name}.conf")
-      create_from_template('env.conf.erb', "conf/env.conf")
+      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('rails-env.conf.erb', "rails-env.conf")
       create_from_template('docker-compose.yml.erb', "docker-compose.yml")
-      create_from_template('docker-compose-installer.sh.erb', "vagrant/docker-compose-installer.sh")
     end
 
     private
@@ -61,6 +52,9 @@ module Dckerize
       template = ERB.new(File.read("#{templates}/#{template_name}"), nil, '-')
       result = template.result(binding)
       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'
     end
 
   end

data/lib/dckerize/version.rb

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

data/templates/Dockerfile.erb

@@ -1,4 +1,4 @@
-FROM phusion/passenger-ruby22:0.9.15
+FROM phusion/passenger-ruby23:0.9.19
 
 # Set correct environment variables.
 ENV HOME /root
@@ -6,30 +6,42 @@ 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
 
-# Clean up APT when done.
-RUN apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
-
-# Active nginx
+# Enable Nginx and Passenger
 RUN rm -f /etc/service/nginx/down
 
-# Copy the nginx template for configuration and preserve environment variables
+# Add virtual host entry for the application. Make sure
+# the file is in the correct path
 RUN rm /etc/nginx/sites-enabled/default
-ADD conf/<%= @name %>.conf /etc/nginx/sites-enabled/<%= @name %>.conf
-ADD conf/env.conf /etc/nginx/main.d/env.conf
+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
 
-# Create the folder for the project and set the workdir
-RUN mkdir /home/app/<%= @name %>
-WORKDIR /home/app/<%= @name %>
 
-# Copy the project inside the container and run bundle install
-COPY Gemfile /home/app/<%= @name %>/
-COPY Gemfile.lock /home/app/<%= @name %>/
-RUN bundle install
-COPY . /home/app/<%= @name %>
+ENV LANG en_US.UTF-8
+ENV LANGUAGE en_US.UTF-8
+ENV LC_ALL en_US.UTF-8
 
-# Set permissions for the passenger user for this app
-RUN chown -R app:app /home/app/<%= @name %>
+# Install gems: it's better to build an independent layer for the gems
+# so they are cached during builds unless Gemfile changes
+WORKDIR /tmp
+ADD Gemfile /tmp/
+ADD Gemfile.lock /tmp/
+RUN bundle install -j4
 
-# Expose the port
-EXPOSE 80
+# Copy application into the container and use right permissions: passenger
+# uses the app user for running the application
+RUN mkdir /home/app/webapp
+COPY . /home/app/webapp
+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,38 +1,44 @@
-data:
-  image: <%= @db %>
-  name: <%= @name %>-data
-  <%- if @db_password -%>
-  environment:
-    - <%= @db_password %>=secretpassword
-  <%- end -%>
-  volumes:
-    - <%= @data_volume_dir %>
-  command: "true"
-<%= @db_service_name %>:
-  image: <%= @db %>
-  name: <%= @name %>-db
-  <%- if @db_password -%>
-  environment:
-    - <%= @db_password %>=secretpassword
-  <%- end -%>
-  volumes_from:
-    - data
-webapp:
-  build: .
-  name: <%= @name %>
-  ports:
-    - "80:80"
-  environment:
-    - PASSENGER_APP_ENV=development
-  links:
-    - <%= @db_service_name %>:<%= @db_service_name %>
-    <%- @extras.each do |extra| -%>
-    - <%= extra.service_name %>:<%= extra.alias %>
+version: '2'
+services:
+  webapp_setup:
+    build:
+      context: .
+      dockerfile: Dockerfile.development
+    depends_on:
+      - <%= @db_service_name %>
+    environment:
+      - PASSENGER_APP_ENV=development
+    entrypoint: ./setup.sh
+  webapp:
+    container_name: <%= @name %>
+    build:
+      context: .
+      dockerfile: Dockerfile.development
+    depends_on:
+      - <%= @db_service_name %>
+      - webapp_setup
+    ports:
+      - "80:80"
+    environment:
+      - PASSENGER_APP_ENV=development
+    volumes:
+      - .:/home/app/webapp
+  <%= @db_service_name %>:
+    image: <%= @db %>
+    <%- if @db_password -%>
+    environment:
+      - <%= @db_password %>
+      - <%= @db_user %>
+      - <%= @db_name %>
     <%- end -%>
-  volumes:
-    - /<%= @name %>:/home/app/<%= @name %>
-<%- @extras.each do |extra| -%>
-<%= extra.service_name %>:
-  image: <%= extra.image %>
-  name: <%= @name %>-<%= extra.service_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

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

data/templates/setup.sh.erb

@@ -0,0 +1,11 @@
+#!/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

data/templates/webapp.conf.erb

@@ -0,0 +1,10 @@
+server {
+    listen 80;
+    server_name _;
+    root /home/app/webapp/public;
+
+    passenger_enabled on;
+    passenger_user app;
+
+    passenger_ruby /usr/bin/ruby2.3;
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dckerize
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.1
 platform: ruby
 authors:
 - Pablo Acuña
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-24 00:00:00.000000000 Z
+date: 2016-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -77,11 +77,10 @@ files:
 - lib/dckerize/runner.rb
 - lib/dckerize/version.rb
 - templates/Dockerfile.erb
-- templates/Vagrantfile.erb
-- templates/docker-compose-installer.sh.erb
 - templates/docker-compose.yml.erb
-- templates/env.conf.erb
-- templates/site.conf.erb
+- templates/rails-env.conf.erb
+- templates/setup.sh.erb
+- templates/webapp.conf.erb
 homepage: https://github.com/pacuna/dckerize
 licenses:
 - MIT
@@ -103,9 +102,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Supercharged Rails development using Docker containers.
 test_files: []
-has_rdoc: 

data/templates/Vagrantfile.erb

@@ -1,28 +0,0 @@
-VAGRANTFILE_API_VERSION = "2"
-
-Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
-
-  config.vm.box     = "trusty"
-  config.vm.box_url = "https://cloud-images.ubuntu.com/vagrant/trusty/current/trusty-server-cloudimg-amd64-vagrant-disk1.box"
-
-  config.vm.provider :virtualbox do |vb|
-    vb.customize ["modifyvm", :id, "--memory", "2048"]
-  end
-  
-  config.vm.synced_folder "../", "/<%= @name %>", :mount_options => ["uid=9999,gid=9999"]
-
-  config.vm.network :private_network, ip: "192.168.50.4"
-
-  config.vm.provision :shell, :inline => 'apt-get update'
-  config.vm.provision :shell, path: "docker-compose-installer.sh"
-
-  config.vm.provision "docker" do |d|
-    d.pull_images "<%= @db %>"
-    d.pull_images "phusion/passenger-ruby22:0.9.15"
-    <%- @extras.each do |extra| -%>
-    d.pull_images "<%= extra.image %>"
-    <%- end -%>
-  end
-
-
-end

data/templates/docker-compose-installer.sh.erb

@@ -1,10 +0,0 @@
-#!/bin/bash
-if which docker-compose >/dev/null; then
-   echo docker-compose already installed
-else
-   echo Installing docker-compose...
-   sudo -i
-   curl -L https://github.com/docker/compose/releases/download/1.3.1/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose
-   chmod +x /usr/local/bin/docker-compose
-   exit
-fi

data/templates/env.conf.erb

@@ -1,9 +0,0 @@
-<%- if @db_password_env -%>
-env <%= @db_password_env %>;
-<%- end -%>
-env <%= @db_host_env %>;
-<% @extras.each do |extra| -%>
-<% extra.env_variables.each do |env_variable| -%>
-env <%= env_variable %>;
-<% end -%>
-<% end -%>

data/templates/site.conf.erb

@@ -1,10 +0,0 @@
-server {
-    listen 80;
-    server_name www.<%= @name %>.com;
-    root /home/app/<%= @name %>/public;
-
-    passenger_enabled on;
-    passenger_user app;
-
-    passenger_ruby /usr/bin/ruby2.2;
-}