dockerize-stack 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87574780f266391e269351522bcb8014e0ede375bdee86b340dc1bc43e1ac405
-  data.tar.gz: 8b206957467b456ffacc59612c7a15845cac8fca5e8234a673c016601ad96146
+  metadata.gz: 463c73cd30ce0f03ffbdeeffa99db4a7eedda9ac3611bd5c9e7ac8d477cc3d97
+  data.tar.gz: 7ec780a8f81ba600fc3e29a10456c8412c0cdaf8784dd99cb6476c3f86a7db5c
 SHA512:
-  metadata.gz: e6cd4e4e84de9ef3e8042f016af769246d3926ce17657a7d77c9c9bf79a42f6dc6fd1d451118d8a4a843208f8f42f8e8d03a282edb145c31d924bd17461c8777
-  data.tar.gz: 26c5b75ea1dca073fc4683ce4923779a503e4050cb6ab683ac9b75de3563803ce5ca3dc7f4341021eee45979305ec543f71fac0916df7945df4af0a075fd82be
+  metadata.gz: 5927bd9855ff172132ae13ded16c2b0a77ab46f7d8e5b81cee01fc0e81ca558ad2685ff6691e1b11246b4db8f4d6934bd2113384dd20b7d5137f80c9466489c1
+  data.tar.gz: 7572551ff734743ba341b0b0ea7408018571bacaf502b7e92c2cb341130535e8c58bb36623b446a15c24efd1d8c67103307a657135e3a6f7b75c1628979ff5e7

data/README.md

@@ -1,12 +1,16 @@
-# Dockerize Stack for development
+# Dockerize Stack
 
-This it's a generator for generate Dockerfile and docker-compose for your application for development
+This it's a generator for generate Dockerfile and docker-compose for your application for development and production
 
 ## Why?
 
-For build a quick stack for your development enviroment docker is the best tool you can use, but you need to configure the Dockerfile docker-compose, persisted database data, set the entrypoint...
+- Help to configure multiple applications using the same templates.
 
-This generator help you to have a basic template for your stack; focusing on develepment enviroment.
+- For build a quick stack for your development enviroment docker is the best tool you can use, but you need to configure the Dockerfile docker-compose, persisted database data, set the entrypoint...
+
+- For deploy to kubernetes you need first Dockerfile for your application, this templates help to build optimize docker image for productions enviroments.
+
+- Using templates is more easy customize docker build process (Dockerfile, docker-compose).
 
 ## Install
 
@@ -32,31 +36,29 @@ or use docker image
 docker run --user $(id -u) -it -v $(pwd):/usr/src devmasx/dockerize-stack rails
 ```
 
-This script ask you:
+## Rails Templates
+
+[rails example](./examples/rails)
+
+By default the Dockerfile config is for production enviroment; using docker multistage feature and ARG (Build arguments) at the build time this Dockerfile is the same for development and production.
 
-- Ruby version
-- Database type
+See all options:
+
+```
+dockerize-stack help rails
+```
 
-example files generate:
+Build a docker image for development enviroment:
 
 ```
-/docker
---development
-----Dockerfile
-----entrypoint.sh
---production
-----rails
-------Dockerfile
-------entrypoint.sh
-----nginx
-------Dockerfile
-------entrypoint.sh
-/.dockerignore
-/docker-compose.yml
-/config/database-docker.yml
+docker build -t rails-example \
+ --build-arg=BUNDLE_DEPLOYMENT="false" \
+ --build-arg=BUNDLE_WITHOUT="" \
+ --build-arg=NODE_ENV="" \
+ .
 ```
 
 ## TODO
 
 - [ ] Add integrations with all database types rails new supported ([mysql/postgresql/sqlite3/oracle/frontbase/ibm_db/sqlserver/jdbcmysql/jdbcsqlite3/jdbcpostgresql/jdbc])
-- [x] Integrate Build with private repositorys
+- [x] Integrate Build with private repositories

data/lib/config.yml

@@ -0,0 +1,28 @@
+rails:
+  defaults:
+    ruby_version: "2.5.6"
+    nodejs_version: "10.16.3"
+    yarn_version: "1.17.3"
+    javascrit_package_manager:
+      - asset_pipeline
+      - yarn
+      - npm
+    database:
+      - postgresql
+      - mysql
+    rails_worker: true
+    github_private: false
+    kubernetes: false
+  questions:
+    ruby_version: "Ruby Version (default 2.5.6):"
+    javascrit_package_manager: What is your Javascript package manager?
+    database: What is your Database?
+    rails_worker: You need workers with sidekiq? y/n, (default y)
+    github_private: You need github token for private gems? y/n (default no)
+    kubernetes: You want generate docker-stack for kubernetes? y/n (default no)'
+
+react:
+  defaults:
+    nodejs_version: "10.16.3"
+  questions:
+    nodejs_version: "Nodejs version (default 10.16.3):"

data/lib/dockerize_stack.rb

@@ -6,17 +6,57 @@ require_relative './dockerize_stack/rails.rb'
 module DockerizeStack
   class Command < Thor
     include Thor::Actions
+    include ThorActionsExtend
+    RAILS_CONFIG_DEFAULTS = CONFIG.dig(:rails, :defaults)
+
+    option :template_folder,
+           aliases: 't',
+           desc: 'Template folder path'
+    option :output_folder,
+           default: '.',
+           aliases: 'o',
+           desc: 'Output folder'
+    option :ruby_version,
+           banner: RAILS_CONFIG_DEFAULTS[:ruby_version],
+           desc: 'Ruby version'
+    option :javascrit_package_manager,
+           banner: 'npm',
+           enum: RAILS_CONFIG_DEFAULTS[:javascrit_package_manager]
+    option :nodejs_version,
+           banner: RAILS_CONFIG_DEFAULTS[:nodejs_version],
+           desc: 'Nodejs version'
+    option :yarn_version,
+           banner: RAILS_CONFIG_DEFAULTS[:yarn_version],
+           desc: 'Yarn version'
+    option :database,
+           banner: 'postgresql',
+           enum: RAILS_CONFIG_DEFAULTS[:database],
+           desc: 'Database type'
+    option :rails_worker,
+           type: :boolean,
+           banner: RAILS_CONFIG_DEFAULTS[:rails_worker],
+           desc: 'Rails sidekiq examples in docker-compose.yml'
+    option :github_private,
+           type: :boolean,
+           banner: RAILS_CONFIG_DEFAULTS[:github_private],
+           desc: 'Set GITHUB_USERNAME and GITHUB_TOKEN in dockerfile bundle config'
+    option :kubernetes,
+           type: :boolean,
+           banner: RAILS_CONFIG_DEFAULTS[:kubernetes],
+           desc: 'Basic examples for kubernetes config (minikube)'
 
-    option :path
     desc 'rails', 'generate docker files for rails application'
     def rails
-      DockerizeStack::Rails.new.generate_files(path: options[:path])
+      DockerizeStack::Rails.new.run(options)
     end
 
-    option :path
+    option :template_folder, aliases: 't', desc: 'Template folder path'
+    option :output_folder, default: '.', aliases: 'o', desc: 'Output folder'
+    option :nodejs_version, banner: '10.16.3', dec: 'Nodejs version'
+
     desc 'react', 'generate docker files for create react app'
     def react
-      DockerizeStack::React.new.generate_files(path: options[:path])
+      DockerizeStack::React.new.run(options)
     end
   end
 end

data/lib/dockerize_stack/rails.rb

@@ -4,27 +4,30 @@ module DockerizeStack
     include Thor::Actions
     include ThorActionsExtend
 
-    attr_accessor :ruby_version, :nodejs_version, :yarn_version,
-      :database, :github_private, :kubernetes, :workdir
-
-    def self.source_root
-      "#{File.dirname(__FILE__)}/../../templates/rails"
-    end
+    attr_accessor :ruby_version, :javascrit_package_manager, :nodejs_version,
+                  :yarn_version, :database, :github_private, :kubernetes, :output_folder
 
     no_commands do
-      def generate_files(path:)
-        @workdir = path || '.'
-        @nodejs_version = '10.16.3'
-        @yarn_version = '1.17.3'
-
-        @ruby_version = ask_with_default('Ruby Version (default 2.5.6):', '2.5.6')
-        @database = ask('What is your Database?', limited_to: ['postgresql', 'mysql'])
-        @rails_worker = ask_with_default('You need worker service (sidekiq example) (default yes):', 'yes')
-        @github_private = ask_with_default('You need github token for private gems? (default no):', 'no')
-        @kubernetes = ask_with_default('You want generate docker-stack for kubernetes? y/n', 'n')
-
-        render_templates
-        render_kubernetes_templates unless ['n', 'no', ''].include?(@kubernetes)
+      def template_type
+        :rails
+      end
+
+      def run(options)
+        super(options)
+        render_kubernetes_templates if @kubernetes
+      end
+
+      def fetch_template_variables
+        @output_folder             = with_default(:output_folder)
+        @nodejs_version            = with_default(:nodejs_version)
+        @yarn_version              = with_default(:yarn_version)
+
+        @ruby_version              = ask_with_default(:ruby_version)
+        @javascrit_package_manager = ask_with_options(:javascrit_package_manager)
+        @database                  = ask_with_options(:database)
+        @rails_worker              = ask_with_default_boolean(:rails_worker)
+        @github_private            = ask_with_default_boolean(:github_private)
+        @kubernetes                = ask_with_default_boolean(:kubernetes)
       end
 
       def render_templates
@@ -38,7 +41,7 @@ module DockerizeStack
       end
 
       def render_kubernetes_templates
-        directory 'kubernetes', "#{@workdir}/kubernetes"
+        directory 'kubernetes', "#{@output_folder}/kubernetes"
       end
     end
   end

data/lib/dockerize_stack/react.rb

@@ -6,25 +6,23 @@ module DockerizeStack
     include Thor::Actions
     include ThorActionsExtend
 
-    attr_accessor :nodejs_version, :workdir
-
-    def self.source_root
-      "#{File.dirname(__FILE__)}/../../templates/react"
-    end
+    attr_accessor :nodejs_version, :output_folder
 
     no_commands do
-      def generate_files(path: '.')
-        @workdir = path
-        @nodejs_version = ask_with_default('Nodejs Version (default 10):', '10')
+      def template_type
+        :react
+      end
 
-        render_templates
+      def fetch_template_variables
+        @output_folder = with_default(:output_folder)
+        @nodejs_version = ask_with_default(:nodejs_version)
       end
 
       def render_templates
         render_template 'Dockerfile.erb'
-        render_template '.dockerignore.erb'
+        render_template 'dockerignore.erb', '.dockerignore'
 
-        directory 'nginx', "#{@workdir}/nginx"
+        directory 'nginx', "#{@output_folder}/nginx"
       end
     end
   end

data/lib/thor_extend.rb

@@ -1,14 +1,63 @@
+require 'yaml'
+require 'json'
+
 module ThorActionsExtend
   include Thor::Actions
 
+  CONFIG = JSON.parse(
+      JSON.dump(YAML.load_file("#{File.dirname(__FILE__)}/config.yml")),
+      symbolize_names: true
+    )
+  def run(options)
+    @template_type = template_type
+    @options = options
+    @config = CONFIG[@template_type]
+    self.class.source_root(template_folder(@template_type.to_s))
+
+    fetch_template_variables
+    render_templates
+  end
+
   private
+
+  def template_folder(template_type)
+    @options[:template_folder] || "#{File.dirname(__FILE__)}/../templates/#{template_type}"
+  end
+
   def render_template(path, target_path = path)
-    template path, "#{@workdir}/#{target_path.gsub('.erb', '')}"
+    template path, "#{@output_folder}/#{target_path.gsub('.erb', '')}"
+  end
+
+  def with_default(option)
+    return @config[:defaults][option] if @options[option].nil?
+
+    @options[option]
   end
 
-  def ask_with_default(question = '', default = '')
-    result = ask(question)
-    result != '' ? result : default
+  def ask_with_default(option, default = nil)
+    return @options[option] unless @options[option].nil?
+
+    default = @config[:defaults][option] if default.nil?
+    result = ask(@config[:questions][option])
+
+    result == '' ? default : result
+  end
+
+  def ask_with_options(option, limited_to = nil)
+    return @options[option] if @options[option]
+
+    limited_to = @config[:defaults][option] if limited_to.nil?
+    ask(@config[:questions][option], limited_to: limited_to)
+  end
+
+  def ask_with_default_boolean(option)
+    return @options[option] unless @options[option].nil?
+
+    result = ask(@config[:questions][option])
+    default = @config[:defaults][option] if default.nil?
+    return default if result == ''
+
+    %w[yes y true].include?(result) ? true : false
   end
 
   def append_or_create(file_path, file_content)

data/lib/version.rb

@@ -1,3 +1,3 @@
 module DockerizeStack
-  VERSION = "0.5.2"
+  VERSION = '0.6.0'
 end

data/templates/rails/Dockerfile.erb

@@ -1,9 +1,9 @@
 # ****************************
 # ******Build base stage******
 # ****************************
-
+<% if javascrit_package_manager != "asset_pipeline" %>
 FROM node:<%= nodejs_version %>-slim as nodejs
-
+<% end %>
 FROM ruby:<%= ruby_version %>-slim as builder
 
 # Install common libs
@@ -16,12 +16,18 @@ RUN apt-get install -y mysql-client libmysqlclient-dev
 # Install Postgresql
 RUN apt-get install -y postgresql-client libpq-dev
 <% end %>
-# Install Nodejs and Yarn
+# Install Nodejs<% if javascrit_package_manager == "asset_pipeline" %>
+RUN apt-get install -y nodejs npm
+<% elsif javascrit_package_manager == "yarn" %>
 ENV NODE_VERSION=<%= nodejs_version %> YARN_VERSION=<%= yarn_version %>
 COPY --from=nodejs /usr/local/bin/ /usr/local/bin/
 COPY --from=nodejs /usr/local/lib/ /usr/local/lib/
 COPY --from=nodejs /opt/yarn-v<%= yarn_version %>/ /opt/yarn-v<%= yarn_version %>/
-
+<% elsif javascrit_package_manager == "npm" %>
+ENV NODE_VERSION=<%= nodejs_version %>
+COPY --from=nodejs /usr/local/bin/ /usr/local/bin/
+COPY --from=nodejs /usr/local/lib/ /usr/local/lib/
+<% end %>
 WORKDIR /app
 <% if @github_private == 'yes' %>
 # Private repository
@@ -29,7 +35,6 @@ ARG GITHUB_TOKEN
 ARG GITHUB_USERNAME
 RUN bundle config github.com ${GITHUB_USERNAME}:${GITHUB_TOKEN}
 <% end %>
-
 # Production config
 ARG BUNDLE_DEPLOYMENT=true
 ARG BUNDLE_WITHOUT="development test staging"
@@ -41,11 +46,16 @@ ENV NODE_ENV=$NODE_ENV
 # Gems cache layer
 COPY Gemfile Gemfile.lock /app/
 RUN bundle install -j 4
-
+<% if javascrit_package_manager == "yarn" %>
 # Node modules cache layer
 COPY package.json yarn.lock /app/
 RUN yarn install --pure-lockfile
-
+<% elsif javascrit_package_manager == "npm" %>
+# Node modules cache layer
+COPY package.json package-lock.json /app/
+RUN npm ci
+<% elsif javascrit_package_manager == "asset_pipeline" %>
+<% end %>
 COPY . .
 CMD "./entrypoint.sh"
 
@@ -57,8 +67,9 @@ FROM builder as production-builder
 
 # Build production assets
 RUN bundle exec rails assets:precompile
+<% if javascrit_package_manager != "asset_pipeline" %>
 RUN rm -r node_modules
-
+<% end %>
 # **********************************
 # ******Final production Stage******
 # **********************************
@@ -68,11 +79,18 @@ FROM ruby:<%= ruby_version %>-slim
 ENV NODE_ENV=production RAILS_ENV=production RAILS_LOG_TO_STDOUT=true
 
 # Install system dependencies
+<% if javascrit_package_manager != "asset_pipeline" %>
 COPY --from=nodejs /usr/local/ /usr/local/
+<% end %><% if javascrit_package_manager == "asset_pipeline" %>
 RUN apt-get update -qq && apt-get install -y \
   libpq-dev \
+  nodejs \
   && apt-get clean && rm -rf /var/lib/apt/lists/*
-
+<% else %>
+RUN apt-get update -qq && apt-get install -y \
+  libpq-dev \
+  && apt-get clean && rm -rf /var/lib/apt/lists/*
+<% end %>
 WORKDIR /app
 
 RUN groupadd -r deploy && useradd -r -g deploy deploy

data/templates/rails/entrypoint.sh.erb

@@ -1,5 +1,7 @@
 bundle check || bundle install
 rake db:create db:migrate
 rm -f tmp/pids/server.pid
+<% if javascrit_package_manager == "asset_pipeline" %>
 rm -rf public/packs/* || true && bin/webpack-dev-server &
+<% end %>
 bundle exec rails server -p 3000 -b 0.0.0.0

data/templates/react/dockerignore.erb

@@ -0,0 +1,27 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+# echo .git > .dockerignore && cat .gitignore >> .dockerignore
+
+.git
+Dockerfile
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dockerize-stack
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Miguel Savignano
@@ -34,6 +34,7 @@ files:
 - LICENSE
 - README.md
 - bin/dockerize-stack
+- lib/config.yml
 - lib/dockerize_stack.rb
 - lib/dockerize_stack/rails.rb
 - lib/dockerize_stack/react.rb
@@ -60,6 +61,7 @@ files:
 - templates/rails/nginx/etc/nginx/conf.d/default.conf
 - templates/rails/nginx/etc/nginx/nginx.conf
 - templates/react/Dockerfile.erb
+- templates/react/dockerignore.erb
 - templates/react/nginx/conf.d/default.conf.template
 homepage: https://github.com/MiguelSavignano/dockerize-stack
 licenses:
@@ -80,8 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.9
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: DockerizeStack