forked from fly-apps/dockerfile-rails
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdockerfile_generator.rb
1356 lines (1060 loc) · 38.8 KB
/
dockerfile_generator.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# frozen_string_literal: true
require "erb"
require "json"
require_relative "../dockerfile-rails/scanner.rb"
class DockerfileGenerator < Rails::Generators::Base
include DockerfileRails::Scanner
BASE_DEFAULTS = {
"alpine" => false,
"bin-cd" => false,
"cache" => false,
"ci" => false,
"compose" => false,
"fullstaq" => false,
"gemfile-updates" => true,
"jemalloc" => false,
"label" => {},
"link" => true,
"litefs" => false,
"lock" => true,
"max-idle" => nil,
"migrate" => "",
"mysql" => false,
"nginx" => false,
"parallel" => false,
"passenger" => false,
"platform" => nil,
"postgresql" => false,
"precompile" => nil,
"prepare" => true,
"private-gemserver-domain" => nil,
"procfile" => "",
"redis" => false,
"registry" => "",
"rollbar" => false,
"root" => false,
"sqlite3" => false,
"sqlserver" => false,
"sentry" => false,
"sudo" => false,
"swap" => nil,
"thruster" => false,
"variant" => nil,
"windows" => false,
"yjit" => false,
}.yield_self { |hash| Struct.new(*hash.keys.map(&:to_sym)).new(*hash.values) }
OPTION_DEFAULTS = BASE_DEFAULTS.dup
@@labels = {}
@@packages = { "base" => [], "build" => [], "deploy" => [] }
@@vars = { "base" => {}, "build" => {}, "deploy" => {} }
@@args = { "base" => {}, "build" => {}, "deploy" => {} }
@@instructions = { "base" => nil, "build" => nil, "deploy" => nil }
ALPINE_MAPPINGS = {
"build-essential" => "build-base",
"chromium-sandbox" => "chromium-chromedriver",
"default-libmysqlclient-dev" => "mysql-client",
"default-mysqlclient" => "mysql-client",
"freedts-bin" => "freedts",
"libicu-dev" => "icu-dev",
"libjemalloc" => "jemalloc-dev",
"libjpeg-dev" => "jpeg-dev",
"libmagickwand-dev" => "imagemagick-libs",
"libsqlite3-0" => "sqlite-dev",
"libtiff-dev" => "tiff-dev",
"libjemalloc2" => "jemalloc",
"libvips" => "vips-dev",
"node-gyp" => "gyp",
"pkg-config" => "pkgconfig",
"python" => "python3",
"python-is-python3" => "python3"
}
# load defaults from config file
if File.exist? "config/dockerfile.yml"
options = YAML.safe_load(IO.read("config/dockerfile.yml"), symbolize_names: true)[:options]
if options
OPTION_DEFAULTS.to_h.each do |option, value|
OPTION_DEFAULTS[option] = options[option] if options.include? option
end
if options[:packages]
options[:packages].each do |stage, list|
@@packages[stage.to_s] = list
end
end
if options[:envs]
options[:envs].each do |stage, vars|
@@vars[stage.to_s] = vars.stringify_keys
end
end
if options[:args]
options[:args].each do |stage, vars|
@@args[stage.to_s] = vars.stringify_keys
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
class_option :ci, type: :boolean, default: OPTION_DEFAULTS.ci,
desc: "include test gems in bundle"
class_option :link, type: :boolean, default: OPTION_DEFAULTS.lock,
desc: "use COPY --link whenever possible"
class_option :lock, type: :boolean, default: OPTION_DEFAULTS.lock,
desc: "lock Gemfile/package.json"
class_option :precompile, type: :string, default: OPTION_DEFAULTS.precompile,
desc: 'if set to "defer", assets:precompile will be done at deploy time'
class_option "bin-cd", type: :boolean, default: OPTION_DEFAULTS["bin-cd"],
desc: "modify binstubs to set working directory"
class_option "windows", type: :boolean, default: OPTION_DEFAULTS["windows"],
desc: "fixup CRLF in binstubs and make each executable"
class_option :cache, type: :boolean, default: OPTION_DEFAULTS.cache,
desc: "use build cache to speed up installs"
class_option :prepare, type: :boolean, default: OPTION_DEFAULTS.prepare,
desc: "include db:prepare step"
class_option :parallel, type: :boolean, default: OPTION_DEFAULTS.parallel,
desc: "use build stages to install gems and node modules in parallel"
class_option :swap, type: :string, default: OPTION_DEFAULTS.swap,
desc: "allocate swapspace"
class_option :compose, type: :boolean, default: OPTION_DEFAULTS.compose,
desc: "generate a docker-compose.yml file"
class_option :redis, type: :boolean, default: OPTION_DEFAULTS.redis,
desc: "include redis libraries"
class_option :sqlite3, aliases: "--sqlite", type: :boolean, default: OPTION_DEFAULTS.sqlite3,
desc: "include sqlite3 libraries"
class_option :sqlserver, aliases: "--sqlserver", type: :boolean, default: OPTION_DEFAULTS.sqlserver,
desc: "include SQL server libraries"
class_option :litefs, type: :boolean, default: OPTION_DEFAULTS.litefs,
desc: "replicate sqlite3 databases using litefs"
class_option :postgresql, aliases: "--postgres", type: :boolean, default: OPTION_DEFAULTS.postgresql,
desc: "include postgresql libraries"
class_option :mysql, type: :boolean, default: OPTION_DEFAULTS.mysql,
desc: "include mysql libraries"
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 :alpine, type: :boolean, default: OPTION_DEFAULTS.alpine,
descr: "use alpine image"
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"
class_option :fullstaq, type: :boolean, default: OPTION_DEFAULTS.fullstaq,
descr: "use Fullstaq Ruby image from Quay.io"
class_option :yjit, type: :boolean, default: OPTION_DEFAULTS.yjit,
desc: "enable YJIT optimizing compiler"
class_option :label, type: :hash, default: {},
desc: "Add Docker label(s)"
class_option :thruster, type: :boolean, default: OPTION_DEFAULTS.thruster,
desc: "use Thruster HTTP/2 proxy"
class_option :nginx, type: :boolean, default: OPTION_DEFAULTS.nginx,
desc: "Serve static files with nginx"
class_option :passenger, type: :boolean, default: OPTION_DEFAULTS.passenger,
desc: "Serve Rails application with Phusion Passsenger"
class_option "max-idle", type: :string, default: OPTION_DEFAULTS["max-idle"],
desc: "Exit server after application has been idle for n seconds."
class_option :root, type: :boolean, default: OPTION_DEFAULTS.root,
desc: "Run application as root user"
class_option :sudo, type: :boolean, default: OPTION_DEFAULTS.sudo,
desc: "Install and configure sudo to enable running as rails with full environment"
class_option :sentry, type: :boolean, default: OPTION_DEFAULTS.sentry,
desc: "Install gems and a default initializer for Sentry"
class_option :rollbar, type: :boolean, default: OPTION_DEFAULTS.rollbar,
desc: "Install gem and a default initializer for Rollbar"
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 "private-gemserver-domain", type: :string, default: OPTION_DEFAULTS["private-gemserver-domain"],
desc: "domain name of a private gemserver used when installing application gems"
class_option "gemfile-updates", type: :boolean, default: OPTION_DEFAULTS["gemfile-updates"],
desc: "include gemfile updates"
class_option "add-base", type: :array, default: [],
desc: "additional packages to install for both build and deploy"
class_option "add-build", type: :array, default: [],
desc: "additional packages to install for use during build"
class_option "add-deploy", aliases: "--add", type: :array, default: [],
desc: "additional packages to install for deployment"
class_option "remove-base", type: :array, default: [],
desc: "remove from list of base packages"
class_option "remove-build", type: :array, default: [],
desc: "remove from list of build packages"
class_option "remove-deploy", aliases: "--remove", type: :array, default: [],
desc: "remove from list of deploy packages"
class_option "env-base", type: :hash, default: {},
desc: "additional environment variables for both build and deploy"
class_option "env-build", type: :hash, default: {},
desc: "additional environment variables to set during build"
class_option "env-deploy", aliases: "--env", type: :hash, default: {},
desc: "additional environment variables to set for deployment"
class_option "arg-base", aliases: "--arg", type: :hash, default: {},
desc: "additional build arguments for both build and deploy"
class_option "arg-build", type: :hash, default: {},
desc: "additional build arguments to set during build"
class_option "arg-deploy", type: :hash, default: {},
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__)
# merge options
options.label.replace(@@labels.merge(options.label).select { |key, value| value != "" })
# gather up options for config file
@dockerfile_config = OPTION_DEFAULTS.dup.to_h.stringify_keys
options.to_h.each do |option, value|
@dockerfile_config[option] = value if @dockerfile_config.include? option
end
%w(base build deploy).each do |phase|
@@packages[phase] += options["add-#{phase}"]
@@packages[phase] -= options["remove-#{phase}"]
@@packages[phase].uniq!
@@packages.delete phase if @@packages[phase].empty?
@@vars[phase].merge! options["env-#{phase}"]
@@vars[phase].delete_if { |key, value| value.blank? }
@@vars.delete phase if @@vars[phase].empty?
@@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
Bundler.with_original_env { install_gems }
template "Dockerfile.erb", "Dockerfile"
template "dockerignore.erb", ".dockerignore"
if using_node? && node_version =~ (/\A\d+\.\d+\.\d+\z/)
template "node-version.erb", ".node-version"
end
template "docker-entrypoint.erb", "bin/docker-entrypoint"
chmod "bin/docker-entrypoint", 0755 & ~File.umask, verbose: false
template "docker-compose.yml.erb", "docker-compose.yml" if options.compose
if using_litefs?
template "litefs.yml.erb", "config/litefs.yml"
fly_attach_consul
end
if File.exist?("fly.toml") && (fly_processes || !options.prepare || options.swap || deploy_database == "sqlite3")
if File.stat("fly.toml").size > 0
template "fly.toml.erb", "fly.toml"
else
toml = fly_make_toml
File.write "fly.toml", toml if toml != ""
end
end
if options.sentry? && (not File.exist?("config/initializers/sentry.rb"))
template "sentry.rb.erb", "config/initializers/sentry.rb"
end
if options.rollbar? && (not File.exist?("config/initializers/rollbar.rb"))
template "rollbar.rb.erb", "config/initializers/rollbar.rb"
end
if @gemfile.include?("vite_ruby")
package = JSON.load_file("package.json")
unless package.dig("scripts", "build")
package["scripts"] ||= {}
package["scripts"]["build"] = "vite build --outDir public"
say_status :update, "package.json"
IO.write("package.json", JSON.pretty_generate(package))
end
end
@dockerfile_config = (@dockerfile_config.to_a - BASE_DEFAULTS.to_h.stringify_keys.to_a).to_h
%w(packages envs args instructions).each do |key|
@dockerfile_config.delete key if @dockerfile_config[key].empty?
end
if !@dockerfile_config.empty?
template "dockerfile.yml.erb", "config/dockerfile.yml", force: true
elsif File.exist? "config/dockerfile.yml"
remove_file "config/dockerfile.yml"
end
# check Dockerfile for common errors: missing packages, mismatched Ruby version
if options.skip? && File.exist?("Dockerfile")
message = nil
shell = Thor::Base.shell.new
dockerfile = IO.read("Dockerfile")
missing = Set.new(base_packages + build_packages) -
Set.new(dockerfile.scan(/[-\w]+/))
unless missing.empty?
message = "The following packages are missing from the Dockerfile: #{missing.to_a.join(", ")}"
STDERR.puts "\n" + shell.set_color(message, Thor::Shell::Color::RED, Thor::Shell::Color::BOLD)
end
ruby_version = dockerfile.match(/ARG RUBY_VERSION=(\d+\.\d+\.\d+)/)[1]
if ruby_version && ruby_version != RUBY_VERSION
message = "The Ruby version in the Dockerfile (#{ruby_version}) does not match the Ruby version of the Rails app (#{RUBY_VERSION})"
STDERR.puts "\n" + shell.set_color(message, Thor::Shell::Color::RED, Thor::Shell::Color::BOLD)
end
exit 42 if message
end
end
private
def render(options)
scope = (Class.new do
def initialize(obj, locals)
@_obj = obj
@_locals = locals.yield_self do |hash|
return nil if hash.empty?
Struct.new(*hash.keys.map(&:to_sym)).new(*hash.values)
end
end
def method_missing(method, *args, &block)
if @_locals&.respond_to? method
@_locals.send method, *args, &block
else
@_obj.send method, *args, &block
end
end
def get_binding
binding
end
end).new(self, options[:locals] || {})
template = IO.read(File.join(source_paths.last, "_#{options[:partial]}.erb"))
ERB.new(template, trim_mode: "-").result(scope.get_binding).strip
end
def platform
if options.platform
"--platform=#{options.platform} "
else
""
end
end
def variant
options.variant || (options.alpine ? "alpine" : "slim")
end
def run_as_root?
options.root?
end
def using_litefs?
options.litefs?
end
def using_litestack?
@gemfile.include?("litestack")
end
def using_node?
return @using_node if @using_node != nil
return if using_bun?
@using_node = File.exist?("package.json")
end
def using_bun?
return @using_bun if @using_bun != nil
@using_bun = File.exist?("bun.config.js") || File.exist?("bun.lockb")
end
def references_ruby_version_file?
@references_ruby_version_file ||= IO.read("Gemfile").include?(".ruby-version")
end
def using_redis?
# Note: If you have redis installed on your computer, 'rails new` will
# automatically add redis to your Gemfile, so having it in your Gemfile is
# not a reliable indicator of whether or not your application actually uses
# redis.
# using_redis? is currently used for two things: actually adding the redis
# gem if it is going to be needed in production, and adding a redis
# container to docker-compose.yml. Neither of these actions should be done
# unless there is an indication that redis is actually being used and not
# merely included in the Gemfile.
options.redis? or @redis or @gemfile.include?("sidekiq")
end
def using_execjs?
@gemfile.include?("execjs") or @gemfile.include?("grover")
end
def using_puppeteer?
@gemfile.include?("grover") or @gemfile.include?("puppeteer-ruby")
end
def using_passenger?
options.passenger? or options["max-idle"]
end
def using_sidekiq?
@gemfile.include?("sidekiq")
end
def using_solidq?
@gemfile.include?("solid_queue")
end
def parallel?
(using_node? || using_bun?) && options.parallel
end
def has_mysql_gem?
@gemfile.include? "mysql2" or using_trilogy?
end
def using_trilogy?
@gemfile.include?("trilogy") || @gemfile.include?("activerecord-trilogy-adapter")
end
def keeps?
return @keeps if @keeps != nil
@keeps = !!Dir["**/.keep"]
end
def install_gems
return unless options["gemfile-updates"]
ENV["BUNDLE_IGNORE_MESSAGES"] = "1"
gemfile = IO.read("Gemfile")
unless /^\s*source\s/.match?(gemfile)
gemfile = %{source "https://rubygems.org"\n} + gemfile
end
if options.postgresql? || @postgresql
system "bundle add pg --skip-install" unless @gemfile.include? "pg"
end
if options.mysql? || @mysql
system "bundle add mysql2 --skip-install" unless has_mysql_gem?
end
if options.redis? || using_redis?
system "bundle add redis --skip-install" unless @gemfile.include? "redis"
end
if options.sentry?
system "bundle add sentry-ruby --skip-install" unless @gemfile.include? "sentry-ruby"
system "bundle add sentry-rails --skip-install" unless @gemfile.include? "sentry-rails"
end
if options.thruster?
system "bundle add thruster --skip-install" unless @gemfile.include? "thruster"
end
if options.rollbar?
system "bundle add rollbar --skip-install" unless @gemfile.include? "rollbar"
end
# https://stackoverflow.com/questions/70500220/rails-7-ruby-3-1-loaderror-cannot-load-such-file-net-smtp/70500221#70500221
if @gemfile.include? "mail"
%w(net-smtp net-imap net-pop).each do |gem|
system "bundle add #{gem} --skip-install --require false" unless @gemfile.include? gem
end
end
unless gemfile == IO.read("Gemfile")
system "bundle install --quiet"
end
if options.lock?
# ensure linux platform is in the bundle lock
current_platforms = `bundle platform`
add_platforms = []
if !current_platforms.include?("x86_64-linux")
add_platforms += ["--add-platform=x86_64-linux"]
end
if !current_platforms.include?("aarch64-linux") && RUBY_PLATFORM.start_with?("arm64")
add_platforms += ["--add-platform=aarch64-linux"]
end
unless add_platforms.empty?
system "bundle lock #{add_platforms.join(" ")}"
end
end
end
def base_gems
gems = ["bundler"]
if options.ci? && options.lock? && @gemfile.include?("debug")
# https://github.com/rails/rails/pull/47515
# https://github.com/rubygems/rubygems/issues/6082#issuecomment-1329756343
gems += %w(irb reline) - @gemfile unless Gem.ruby_version >= Gem::Version.new("3.2.2")
end
gems.sort
end
def alpinize(packages)
packages.map { |package| ALPINE_MAPPINGS[package] || package }.sort.uniq
end
def base_packages
packages = []
packages += @@packages["base"] if @@packages["base"]
if using_execjs?
if node_version == "lts"
packages += %w(nodejs npm)
else
packages += %w(curl)
end
end
if using_puppeteer?
packages += %w(curl gnupg)
end
# charlock_holmes. Placed here as the library itself is
# libicu63 in buster, libicu67 in bullseye, libiclu72 in bookworm...
packages << "libicu-dev" if @gemfile.include? "charlock_holmes"
if @gemfile.include? "webp-ffi"
# https://github.com/le0pard/webp-ffi#requirements
packages += %w(libjpeg-dev libpng-dev libtiff-dev libwebp-dev)
end
# Passenger
packages << "passenger" if using_passenger?
if options.alpine?
packages << "tzdata"
alpinize(packages)
else
packages.sort.uniq
end
end
def base_requirements
requirements = []
requirements << "nodejs" if using_execjs?
requirements << "chrome" if using_puppeteer?
requirements << "charlock_holmes" if @gemfile.include? "charlock_holmes"
requirements.join(" and ")
end
def build_packages
# start with the essentials
packages = %w(build-essential)
packages += @@packages["build"] if @@packages["build"]
packages += %w(nodejs npm) if (node_version == "lts") && (not using_execjs?)
packages << "libyaml-dev" if options.fullstaq?
# add databases: sqlite3, postgres, mysql
packages << "pkg-config" if options.sqlite3? || @sqlite3
packages << "libpq-dev" if options.postgresql? || @postgresql
packages << "freetds-dev" if options.sqlserver? || @sqlserver
if (options.mysql? || @mysql) && !using_trilogy?
packages << "default-libmysqlclient-dev"
end
# add git if needed to install gems
packages << "git" if @git
# ActiveStorage preview support
packages << "libvips" if @gemfile.include? "ruby-vips"
# Rmagick gem
packages += %w[pkg-config libmagickwand-dev] if @gemfile.include? "rmagick"
# node support, including support for building native modules
if using_node?
packages += %w(node-gyp pkg-config)
unless using_execjs? || using_puppeteer?
packages << "curl"
end
# module build process depends on Python, and debian changed
# how python is installed with the bullseye release. Below
# is based on debian release included with the Ruby images on
# Dockerhub.
case RUBY_VERSION
when /^2\.7/
bullseye = RUBY_VERSION >= "2.7.4"
when /^3\.0/
bullseye = RUBY_VERSION >= "3.0.2"
when /^2\./
bullseye = false
else
bullseye = true
end
if bullseye
packages << "python-is-python3"
else
packages << "python"
end
end
if using_bun?
packages += %w(curl unzip)
end
if options.alpine?
alpinize(packages)
else
packages.sort.uniq
end
end
def deploy_packages
packages = %w(curl) # work with the default healthcheck strategy in MRSK
packages += @@packages["deploy"] if @@packages["deploy"]
# start with databases: sqlite3, postgres, mysql
packages << "postgresql-client" if options.postgresql? || @postgresql
packages << "default-mysql-client" if options.mysql? || @mysql
packages << "freetds-bin" if options.sqlserver? || @sqlserver
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?
# ActiveStorage preview support
packages << "libvips" if @gemfile.include? "ruby-vips"
# Rmagick gem
if @gemfile.include?("rmagick") || @gemfile.include?("mini_magick")
packages << "imagemagick"
end
# Puppeteer
if using_puppeteer?
if options.platform&.include? "amd"
packages << "google-chrome-stable"
else
packages += %w(chromium chromium-sandbox)
end
end
# Passenger
packages << "libnginx-mod-http-passenger" if using_passenger?
# nginx
packages << "nginx" if options.nginx? || using_passenger?
# sudo
packages << "sudo" if options.sudo?
if !options.procfile.blank? || (procfile.size > 1)
packages << "ruby-foreman"
end
if options.alpine?
packages << "sqlite-libs" if @gemfile.include? "sqlite3"
packages << "libpq" if @gemfile.include? "pg"
alpinize(packages)
else
packages.sort.uniq
end
end
def pkg_update
if options.alpine?
"apk update"
else
"apt-get update -qq"
end
end
def pkg_install
if options.alpine?
"apk add"
else
"apt-get install --no-install-recommends -y"
end
end
def pkg_cache
if options.alpine?
{ "dev-apk-cache" => "/var/cache/apk" }
else
{ "dev-apt-cache" => "/var/cache/apt", "dev-apt-lib" => "/var/lib/apt" }
end
end
def pkg_cleanup
if options.alpine?
"/var/cache/apk/*"
else
"/var/lib/apt/lists /var/cache/apt/archives"
end
end
def base_repos
repos = []
packages = []
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/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 repos.empty?
""
else
packages.sort!.uniq!
unless packages.empty?
repos.unshift "#{pkg_update} &&",
"#{pkg_install} #{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://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-chrome.list'
]
end
if repos.empty?
""
else
packages.sort!.uniq!
unless packages.empty?
repos.unshift "#{pkg_update} &&",
"#{pkg_install} --no-install-recommends -y #{packages.join(" ")} &&"
end
repos.join(" \\\n ") + " && \\\n "
end
end
def base_env
env = {
"RAILS_ENV" => "production",
"BUNDLE_PATH" => "/usr/local/bundle",
"BUNDLE_WITHOUT" => options.ci? ? "development" : "development:test"
}
if options.lock?
env["BUNDLE_DEPLOYMENT"] = "1"
end
if using_litestack?
env["LITESTACK_DATA_PATH"] = "/data"
end
if @@args["base"]
env.merge! @@args["base"].to_h { |key, value| [key, "$#{key}"] }
end
env.merge! @@vars["base"] if @@vars["base"]
env.map { |key, value| "#{key}=#{value.inspect}" }.sort
end
def build_env
env = {}
if using_execjs? && (node_version != "lts")
env["PATH"] = "/usr/local/node/bin:$PATH"
end
if using_puppeteer?
env["PUPPETEER_SKIP_CHROMIUM_DOWNLOAD"] = "true"
end
if @@args["build"]
env.merge! @@args["build"].to_h { |key, value| [key, "$#{key}"] }
end
env.merge! @@vars["build"] if @@vars["build"]
env.map { |key, value| "#{key}=#{value.inspect}" }
end
def deploy_env
env = {}
env["PORT"] = "3001" if (options.nginx? && !using_passenger?) || using_litefs?
if Rails::VERSION::MAJOR < 7 || Rails::VERSION::STRING.start_with?("7.0")
env["RAILS_LOG_TO_STDOUT"] = "1"
env["RAILS_SERVE_STATIC_FILES"] = "true" unless options.nginx?
end
if deploy_database == "sqlite3"
if using_litefs?
env["DATABASE_URL"] = "sqlite3:///litefs/production.sqlite3"
else
env["DATABASE_URL"] = "sqlite3:///data/production.sqlite3"
end
end
if options.yjit?
env["RUBY_YJIT_ENABLE"] = "1"
end
if options.jemalloc? && !options.fullstaq?
env["LD_PRELOAD"] = "libjemalloc.so.2"
env["MALLOC_CONF"] = "dirty_decay_ms:1000,narenas:2,background_thread:true"
end
if using_puppeteer?
env["GROVER_NO_SANDBOX"] = "true" if @gemfile.include? "grover"
env["PUPPETEER_RUBY_NO_SANDBOX"] = "1" if @gemfile.include? "puppeteer-ruby"
if options.platform&.include? "amd"
env["PUPPETEER_EXECUTABLE_PATH"] = "/usr/bin/google-chrome"
else
env["PUPPETEER_EXECUTABLE_PATH"] = "/usr/bin/chromium"
end
end
if @@args["deploy"]
env.merge! @@args["deploy"].to_h { |key, value| [key, "$#{key}"] }
end
env.merge! @@vars["deploy"] if @@vars["deploy"]
env.map { |key, value| "#{key}=#{value.inspect}" }.sort
end
def base_args
args = {}
args.merge! @@args["base"] if @@args["base"]
args
end
def build_args
args = {}
args.merge! @@args["build"] if @@args["build"]
args
end
def deploy_args
args = {}
args.merge! @@args["deploy"] if @@args["deploy"]
args
end
def all_args
args = {}
unless options.root?
args[:UID] = "${UID:-1000}".html_safe
args[:GID] = "${GID:-${UID:-1000}}".html_safe
end
args.merge! base_args
args.merge! build_args
args.merge! deploy_args
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