dockerfile-rails 1.4.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9cd11ebc9f7480d2cd29942b3dbb771ddd98377291a93aa27c70317bab0114e
-  data.tar.gz: 95611b26453984a5e51d2606321c3fdef93cf41b42a23b39f515a1e21ff97e5f
+  metadata.gz: 4478af556f6059702ab4b1fce65ab4735a024299796bdebce3014730f3d86220
+  data.tar.gz: 941e1e7a2fd88238d3ee9dd7fe16ffb2e290e10568fd1ca2ed3e0001d5aceed8
 SHA512:
-  metadata.gz: 76d6de186f304dc03e775de367c0b9b17e53b8eaf2b74738fa4cc8f6323fb84e3cc235a357f8c4d0bc2c3957b8e07411e96523d6052c12a58ab8aa89963f781f
-  data.tar.gz: addd1bd0774d6ec14f92811d8ba0ff5616c089c73e72a7d06a9e5fdd2b0a68dfca490fff760d973fd7ff3c6c80e4dd755deed439165a4f43d91cbb336ec3f420
+  metadata.gz: ed8adae939c867d565049530df18915c49f0cbd775cc9b909733960ea8b3075b9185132eaf1454e501f7ea211a3f903dca44ce394f20fe356168154d8c2165dd
+  data.tar.gz: a289a97a457eedd708e9449172b5191685d5f120de3b04df18d6e35950131f681972bf009953967120e32d949b4aede461ac0fb675e14fff8858ccf38de7d522

data/README.md

@@ -75,11 +75,27 @@ Not all of your needs can be determined by scanning your application.  For examp
 [autocrlf](https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration#_core_autocrlf) enabled or may not be able to set bin stubs as executable.
 * `--label=name:value` - specify docker label.  Can be used multiple times.  See [LABEL](https://docs.docker.com/engine/reference/builder/#label) for detail
 * `--no-prepare` - omit `db:prepare`.  Useful for cloud platforms with [release](https://devcenter.heroku.com/articles/release-phase) phases
+* `--passenger` - use [Phusion Passenger](https://www.phusionpassenger.com/) under [nginx](https://www.nginx.com/)
 * `--platform=s` - specify target platform.  See [FROM](https://docs.docker.com/engine/reference/builder/#from) for details
+* `--variant=s` - dockerhub ruby variant, defaults to `slim`.  See [docker official images](https://hub.docker.com/_/ruby) for list.
 * `--precompile=defer` - may be needed when your configuration requires access to secrets that are not available at build time.  Results in larger images and slower deployments.
 * `--root` - run application as root
 * `--windows` - make Dockerfile work for Windows users that may have set `git config --global core.autocrlf true`
 
+### Advanced Customization:
+
+There may be times where feature detection plus flags just aren't enough.  As an example, you may wish to configure and run multiple processes.  
+
+* `--instructions=path` - a dockerfile fragment to be inserted into the final document. 
+* `--migration=cmd` - a replacement (generally a script) for `db:prepare`/`db:migrate`.
+* `--procfile=path` - a [Procfile](https://github.com/ddollar/foreman#foreman) to use in place of launching Rails directly.
+
+Like with environment variables, packages, and build args, `--instructions` can be tailored to a specific build phase by adding `-base`, `-build`, or `-deploy` after the flag name, with the default being `-deploy`.
+
+Additionaly, if the instructions start with a [shebang](https://en.wikipedia.org/wiki/Shebang_(Unix)) instead the file being treated as a Dockerfile fragment, the file is treated as a script and a `RUN` statement is added to your Dockerfile instead.
+
+---
+
 Options are saved between runs into `config/dockerfile.yml`.  To invert a boolean options, add or remove a `no-` prefix from the option name.
 
 ## Testing

data/lib/generators/dockerfile_generator.rb

@@ -19,6 +19,7 @@ class DockerfileGenerator < Rails::Generators::Base
     "litefs" => false,
     "lock" => true,
     "max-idle" => nil,
+    "migrate" => "",
     "mysql" => false,
     "nginx" => false,
     "parallel" => false,
@@ -27,11 +28,14 @@ class DockerfileGenerator < Rails::Generators::Base
     "postgresql" => false,
     "precompile" => nil,
     "prepare" => true,
+    "procfile" => "",
     "redis" => false,
+    "registry" => "",
     "root" => false,
     "sqlite3" => false,
     "sudo" => false,
     "swap" => nil,
+    "variant" => "slim",
     "windows" => false,
     "yjit" => false,
   }.then { |hash| Struct.new(*hash.keys.map(&:to_sym)).new(*hash.values) }
@@ -42,6 +46,7 @@ class DockerfileGenerator < Rails::Generators::Base
   @@packages = { "base" => [], "build" => [], "deploy" => [] }
   @@vars = { "base" => {}, "build" => {}, "deploy" => {} }
   @@args = { "base" => {}, "build" => {}, "deploy" => {} }
+  @@instructions = { "base" => nil, "build" => nil, "deploy" => nil }
 
   # load defaults from config file
   if File.exist? "config/dockerfile.yml"
@@ -70,6 +75,12 @@ class DockerfileGenerator < Rails::Generators::Base
         end
       end
 
+      if options[:instructions]
+        options[:instructions].each do |stage, value|
+          @@instructions[stage.to_s] = value
+        end
+      end
+
       @@labels = options[:label].stringify_keys if options.include? :label
     end
   end
@@ -125,6 +136,12 @@ class DockerfileGenerator < Rails::Generators::Base
   class_option :platform, type: :string, default: OPTION_DEFAULTS.platform,
     desc: "image platform (example: linux/arm64)"
 
+  class_option :registry, type: :string, default: OPTION_DEFAULTS.registry,
+    desc: "docker registry to use (example: registry.docker.com/library/)"
+
+  class_option :variant, type: :string, default: OPTION_DEFAULTS.variant,
+    desc: "dockerhub image variant (example: slim-bullseye)"
+
   class_option :jemalloc, type: :boolean, default: OPTION_DEFAULTS.jemalloc,
     desc: "use jemalloc alternative malloc implementation"
 
@@ -152,6 +169,13 @@ class DockerfileGenerator < Rails::Generators::Base
   class_option :sudo, type: :boolean, default: OPTION_DEFAULTS.sudo,
     desc: "Install and configure sudo to enable running as rails with full environment"
 
+  class_option "migrate", type: :string, default: OPTION_DEFAULTS.migrate,
+    desc: "custom migration/db:prepare script"
+
+  class_option "procfile", type: :string, default: OPTION_DEFAULTS.procfile,
+    desc: "custom procfile to start services"
+
+
   class_option "add-base", type: :array, default: [],
     desc: "additional packages to install for both build and deploy"
 
@@ -191,6 +215,16 @@ class DockerfileGenerator < Rails::Generators::Base
     desc: "additional build arguments to set for deployment"
 
 
+  class_option "instructions-base", type: :string, default: "",
+    desc: "additional instructions to add to the base stage"
+
+  class_option "instructions-build", type: :string, default: "",
+    desc: "additional instructions to add to the build stage"
+
+  class_option "instructions-deploy", aliases: "--instructions", type: :string, default: "",
+    desc: "additional instructions to add to the final stage"
+
+
   def generate_app
     source_paths.push File.expand_path("./templates", __dir__)
 
@@ -216,11 +250,15 @@ class DockerfileGenerator < Rails::Generators::Base
       @@args[phase].merge! options["arg-#{phase}"]
       @@args[phase].delete_if { |key, value| value.blank? }
       @@args.delete phase if @@args[phase].empty?
+
+      @@instructions[phase] ||= options["instructions-#{phase}"]
+      @@instructions.delete phase if @@instructions[phase].empty?
     end
 
     @dockerfile_config["packages"] = @@packages
     @dockerfile_config["envs"] = @@vars
     @dockerfile_config["args"] = @@args
+    @dockerfile_config["instructions"] = @@instructions
 
     scan_rails_app
 
@@ -267,7 +305,7 @@ class DockerfileGenerator < Rails::Generators::Base
     end
 
     @dockerfile_config = (@dockerfile_config.to_a - BASE_DEFAULTS.to_h.stringify_keys.to_a).to_h
-    %w(packages envs args).each do |key|
+    %w(packages envs args instructions).each do |key|
       @dockerfile_config.delete key if @dockerfile_config[key].empty?
     end
 
@@ -451,6 +489,9 @@ private
       packages += %w(libjpeg-dev libpng-dev libtiff-dev libwebp-dev)
     end
 
+    # Passenger
+    packages << "passenger" if using_passenger?
+
     packages.sort.uniq
   end
 
@@ -516,10 +557,12 @@ private
     packages += @@packages["deploy"] if @@packages["deploy"]
 
     # start with databases: sqlite3, postgres, mysql
-    packages << "libsqlite3-0" if options.sqlite3? || @sqlite3
     packages << "postgresql-client" if options.postgresql? || @postgresql
     packages << "default-mysql-client" if options.mysql? || @mysql
     packages << "libjemalloc2" if options.jemalloc? && !options.fullstaq?
+    if options.sqlite3? || @sqlite3
+      packages << "libsqlite3-0" unless packages.include? "sqlite3"
+    end
 
     # litefs
     packages += ["ca-certificates", "fuse3", "sudo"] if options.litefs?
@@ -542,7 +585,7 @@ private
     end
 
     # Passenger
-    packages += %w(passenger libnginx-mod-http-passenger) if using_passenger?
+    packages << "libnginx-mod-http-passenger" if using_passenger?
 
     # nginx
     packages << "nginx" if options.nginx? || using_passenger?
@@ -550,28 +593,49 @@ private
     # sudo
     packages << "sudo" if options.sudo?
 
+    if !options.procfile.blank? || (procfile.size > 1)
+      packages << "ruby-foreman"
+    end
+
     packages.sort
   end
 
-  def deploy_repos
+  def base_repos
     repos = []
     packages = []
 
-    if using_puppeteer? && deploy_packages.include?("google-chrome-stable")
+    if using_passenger?
       packages += %w(gnupg curl)
       repos += [
        "curl https://oss-binaries.phusionpassenger.com/auto-software-signing-gpg-key.txt |",
-       "  gpg --dearmor > /etc/apt/trusted.gpg.d/google-archive.gpg &&",
-       'echo "deb http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list'
+       "  gpg --dearmor > /etc/apt/trusted.gpg.d/phusion.gpg &&",
+       "bash -c 'echo deb https://oss-binaries.phusionpassenger.com/apt/passenger $(source /etc/os-release; echo $VERSION_CODENAME) main > /etc/apt/sources.list.d/passenger.list'"
       ]
     end
 
-    if using_passenger?
+    if repos.empty?
+      ""
+    else
+      packages.sort!.uniq!
+      unless packages.empty?
+        repos.unshift "apt-get update -qq &&",
+          "apt-get install --no-install-recommends -y #{packages.join(" ")} &&"
+      end
+
+      repos.join(" \\\n    ") + " && \\\n    "
+    end
+  end
+
+  def deploy_repos
+    repos = []
+    packages = []
+
+    if using_puppeteer? && deploy_packages.include?("google-chrome-stable")
       packages += %w(gnupg curl)
       repos += [
-       "curl https://oss-binaries.phusionpassenger.com/auto-software-signing-gpg-key.txt |",
-       "  gpg --dearmor > /etc/apt/trusted.gpg.d/phusion.gpg &&",
-       "bash -c 'echo deb https://oss-binaries.phusionpassenger.com/apt/passenger $(source /etc/os-release; echo $VERSION_CODENAME) main > /etc/apt/sources.list.d/passenger.list'"
+       "curl https://dl-ssl.google.com/linux/linux_signing_key.pub |",
+       "  gpg --dearmor > /etc/apt/trusted.gpg.d/google-archive.gpg &&",
+       'echo "deb http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list'
       ]
     end
 
@@ -674,7 +738,7 @@ private
       env.merge! @@args["deploy"].to_h { |key, value| [key, "$#{key}"] }
     end
 
-    env.merge! @@vars["base"] if @@vars["base"]
+    env.merge! @@vars["deploy"] if @@vars["deploy"]
 
     env.map { |key, value| "#{key}=#{value.inspect}" }.sort
   end
@@ -718,6 +782,42 @@ private
     args
   end
 
+  def base_instructions
+    return nil unless @@instructions["base"]
+
+    instructions = IO.read @@instructions["base"]
+
+    if instructions.start_with? "#!"
+      instructions = "# custom instructions\nRUN #{@instructions["base"].strip}"
+    end
+
+    instructions.html_safe
+  end
+
+  def build_instructions
+    return nil unless @@instructions["build"]
+
+    instructions = IO.read @@instructions["build"]
+
+    if instructions.start_with? "#!"
+      instructions = "# custom build instructions\nRUN #{@instructions["build"].strip}"
+    end
+
+    instructions.html_safe
+  end
+
+  def deploy_instructions
+    return nil unless @@instructions["deploy"]
+
+    instructions = IO.read @@instructions["deploy"]
+
+    if instructions.start_with? "#!"
+      instructions = "# custom deploy instructions\nRUN #{@instructions["deploy"].strip}"
+    end
+
+    instructions.html_safe
+  end
+
   def binfile_fixups
     # binfiles may have OS specific paths to ruby.  Normalize them.
     shebangs = Dir["bin/*"].map { |file| IO.read(file).lines.first }.join
@@ -838,10 +938,12 @@ private
   end
 
   def dbprep_command
-    if Rails::VERSION::MAJOR >= 6
-      "db:prepare"
+    if !options.migrate.blank?
+      options.migrate
+    elsif Rails::VERSION::MAJOR >= 6
+      "./bin/rails db:prepare"
     else
-      "db:migrate"
+      "./bin/rails db:migrate"
     end
   end
 

data/lib/generators/templates/Dockerfile.erb

@@ -8,9 +8,9 @@ ARG RUBY_VERSION=<%= RUBY_VERSION %>
 
 <% end -%>
 <% if options.fullstaq -%>
-FROM <%= platform %>quay.io/evl.ms/fullstaq-ruby:${RUBY_VERSION}-<%= options.jemalloc ? 'jemalloc-' : '' %>slim<% unless options.precompile == "defer" %> as base<% end %>
+FROM <%= platform %>quay.io/evl.ms/fullstaq-ruby:${RUBY_VERSION}-<%= options.jemalloc ? 'jemalloc-' : '' %><%= options.variant %><% unless options.precompile == "defer" %> as base<% end %>
 <% else -%>
-FROM <%= platform %>registry.docker.com/library/ruby:$RUBY_VERSION-slim<% unless options.precompile == "defer" %> as base<% end %>
+FROM <%= platform %><%= options.registry %>ruby:$RUBY_VERSION-<%= options.variant %><% unless options.precompile == "defer" %> as base<% end %>
 <% end -%>
 
 <% unless options.label.empty? -%>
@@ -36,12 +36,16 @@ RUN gem update --system --no-document && \
 
 <% unless base_requirements.empty? -%>
 # Install packages needed to install <%= base_requirements %>
-<%= render partial: 'apt_install', locals: {packages: base_packages, clean: true, repos: ''} %>
+<%= render partial: 'apt_install', locals: {packages: base_packages, clean: true, repos: base_repos} %>
 
 <% end -%>
 <% if using_execjs? -%>
 <%= render partial: 'install_node', locals: {yarn_version: nil} %>
 
+<% end -%>
+<% if base_instructions -%>
+<%= base_instructions %>
+
 <% end -%>
 <% unless options.precompile == "defer" -%>
 
@@ -98,10 +102,17 @@ RUN bundle install<% if depend_on_bootsnap? -%> && \
     bundle exec bootsnap precompile --gemfile<% end %> && \
     rm -rf ~/.bundle/ $BUNDLE_PATH/ruby/*/cache $BUNDLE_PATH/ruby/*/bundler/gems/*/.git
 
+<% end -%>
+<% if using_passenger? -%>
+# Compile passenger native support
+RUN passenger-config build-native-support
+
 <% end -%>
 <% if parallel? -%>
 # Copy node modules
 COPY --from=node /rails/node_modules /rails/node_modules
+COPY --from=node /usr/local/node /usr/local/node
+ENV PATH=/usr/local/node/bin:$PATH
 
 <% elsif using_node? -%>
 <%= render partial: 'npm_install', locals: {sources: Dir[*%w(package.json package-lock.json yarn.lock)]} %>
@@ -110,6 +121,10 @@ COPY --from=node /rails/node_modules /rails/node_modules
 # Copy application code
 COPY<% if options.link? %> --link<% end %> . .
 
+<% if build_instructions -%>
+<%= build_instructions %>
+
+<% end -%>
 <% if depend_on_bootsnap? -%>
 # Precompile bootsnap code for faster boot times
 RUN bundle exec bootsnap precompile app/ lib/
@@ -165,6 +180,11 @@ RUN gem install foreman
 # Copy built artifacts: gems, application
 COPY --from=build /usr/local/bundle /usr/local/bundle
 COPY --from=build /rails /rails
+<% if using_passenger? -%>
+
+# Copy passenger native support
+COPY --from=build /root/.passenger/native_support /root/.passenger/native_support
+<% end -%>
 <% if api_client_dir -%>
 
 # Copy built client
@@ -202,6 +222,10 @@ RUN useradd rails --create-home --shell /bin/bash && \
 USER rails:rails
 <% end -%>
 
+<% end -%>
+<% if deploy_instructions -%>
+<%= deploy_instructions.strip %>
+
 <% end -%>
 <% if using_litefs? and !run_as_root? -%>
 # Authorize rails user to launch litefs
@@ -237,7 +261,9 @@ EXPOSE 3000
 VOLUME /data
 <% end -%>
 <% unless fly_processes -%>
-<% if procfile.size > 1 -%>
+<% if !options.procfile.blank? -%>
+CMD ["foreman", "start", "--procfile=<%= options.procfile %>"]
+<% elsif procfile.size > 1 -%>
 CMD ["foreman", "start", "--procfile=Procfile.prod"]
 <% else -%>
 CMD <%= procfile.values.first.split(" ").inspect %>

data/lib/generators/templates/_passenger.erb

@@ -25,4 +25,5 @@ RUN echo "daemon off;" >> /etc/nginx/nginx.conf && \
 <% if options['max-idle'] -%>
     chmod +sx /etc/nginx/sites-enabled/hook_detached_process && \
 <% end -%>
+    sed -i 's/user www-data/user rails/' /etc/nginx/nginx.conf && \
     mkdir /var/run/passenger-instreg

data/lib/generators/templates/docker-entrypoint.erb

@@ -31,7 +31,9 @@ fi
 
 <% end -%>
 <% if options.prepare -%>
-<% if procfile.size > 1 -%>
+<% if !options.procfile.blank? -%>
+if [ "${*}" == "foreman start --procfile=<%= options.procfile %>" ]; then
+<% elsif procfile.size > 1 -%>
 # If running the production procfile then create or migrate existing database
 if [ "${*}" == "foreman start --procfile=Procfile.prod" ]; then
 <% else -%>
@@ -41,7 +43,7 @@ if [ "${*}" == <%= procfile.values.first.inspect %> <% if using_litefs? %>-a "$F
 <% if options.precompile == "defer" -%>
   ./bin/rails assets:precompile
 <% end -%>
-  ./bin/rails <%= dbprep_command %>
+  <%= dbprep_command %>
 fi
 
 <% elsif !options.swap -%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dockerfile-rails
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.5.0
 platform: ruby
 authors:
 - Sam Ruby
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-08 00:00:00.000000000 Z
+date: 2023-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails