cookbooks/web/resources/rails_port.rb

   1 #
   2 # Cookbook:: web
   3 # Resource:: rails_port
   4 #
   5 # Copyright:: 2012, OpenStreetMap Foundation
   6 #
   7 # Licensed under the Apache License, Version 2.0 (the "License");
   8 # you may not use this file except in compliance with the License.
   9 # You may obtain a copy of the License at
  10 #
  11 #     https://www.apache.org/licenses/LICENSE-2.0
  12 #
  13 # Unless required by applicable law or agreed to in writing, software
  14 # distributed under the License is distributed on an "AS IS" BASIS,
  15 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16 # See the License for the specific language governing permissions and
  17 # limitations under the License.
  18 #
  19
  20 require "yaml"
  21
  22 resource_name :rails_port
  23 provides :rails_port
  24
  25 unified_mode true
  26
  27 default_action :create
  28
  29 property :site, String, :name_property => true
  30 property :directory, String
  31 property :user, String
  32 property :group, String
  33 property :repository, String, :default => "https://git.openstreetmap.org/public/rails.git"
  34 property :revision, String, :default => "live"
  35 property :run_migrations, [true, false], :default => false
  36 property :build_assets, [true, false], :default => true
  37 property :email_from, String, :default => "OpenStreetMap <support@openstreetmap.org>"
  38 property :status, String, :default => "online"
  39 property :database_host, String
  40 property :database_port, String
  41 property :database_name, String
  42 property :database_username, String
  43 property :database_password, String
  44 property :email_from, String
  45 property :messages_domain, String
  46 property :gpx_dir, String
  47 property :attachments_dir, String
  48 property :log_path, String
  49 property :logstash_path, String
  50 property :memcache_servers, Array
  51 property :potlatch2_key, String
  52 property :id_key, String
  53 property :id_application, String
  54 property :oauth_key, String
  55 property :oauth_application, String
  56 property :nominatim_url, String
  57 property :overpass_url, String
  58 property :overpass_credentials, [true, false], :default => false
  59 property :google_auth_id, String
  60 property :google_auth_secret, String
  61 property :google_openid_realm, String
  62 property :facebook_auth_id, String
  63 property :facebook_auth_secret, String
  64 property :microsoft_auth_id, String
  65 property :microsoft_auth_secret, String
  66 property :github_auth_id, String
  67 property :github_auth_secret, String
  68 property :wikipedia_auth_id, String
  69 property :wikipedia_auth_secret, String
  70 property :thunderforest_key, String
  71 property :tracestrack_key, String
  72 property :maptiler_key, String
  73 property :totp_key, String
  74 property :csp_enforce, [true, false], :default => false
  75 property :csp_report_url, String
  76 property :matomo_configuration, Hash
  77 property :storage_service, String, :default => "local"
  78 property :storage_url, String
  79 property :trace_use_job_queue, [true, false], :default => false
  80 property :diary_feed_delay, Integer
  81 property :storage_configuration, Hash, :default => {}
  82 property :avatar_storage, String
  83 property :trace_file_storage, String
  84 property :trace_image_storage, String
  85 property :trace_icon_storage, String
  86 property :avatar_storage_url, String
  87 property :trace_image_storage_url, String
  88 property :trace_icon_storage_url, String
  89 property :tile_cdn_url, String
  90 property :imagery_blacklist, Array
  91 property :signup_ip_per_day, Integer
  92 property :signup_ip_max_burst, Integer
  93 property :signup_email_per_day, Integer
  94 property :signup_email_max_burst, Integer
  95 property :doorkeeper_signing_key, String
  96 property :user_account_deletion_delay, Integer
  97
  98 action :create do
  99   package %w[
 100     imagemagick
 101     libvips42
 102     nodejs
 103     tzdata
 104   ]
 105
 106   package %w[
 107     g++
 108     make
 109     pkg-config
 110     libpq-dev
 111     libsasl2-dev
 112     libxml2-dev
 113     libxslt1-dev
 114     libmemcached-dev
 115     libffi-dev
 116     libgd-dev
 117     libarchive-dev
 118     libbz2-dev
 119     libyaml-dev
 120   ]
 121
 122   package %w[
 123     pngcrush
 124     advancecomp
 125     optipng
 126     pngquant
 127     jhead
 128     jpegoptim
 129     gifsicle
 130     libjpeg-turbo-progs
 131   ]
 132
 133   declare_resource :directory, rails_directory do
 134     owner new_resource.user
 135     group new_resource.group
 136     mode "2775"
 137   end
 138
 139   git rails_directory do
 140     action :sync
 141     repository new_resource.repository
 142     revision new_resource.revision
 143     depth 1
 144     user new_resource.user
 145     group new_resource.group
 146   end
 147
 148   declare_resource :directory, "#{rails_directory}/tmp" do
 149     owner new_resource.user
 150     group new_resource.group
 151   end
 152
 153   file "#{rails_directory}/config/environment.rb" do
 154     owner new_resource.user
 155     group new_resource.group
 156   end
 157
 158   template "#{rails_directory}/config/database.yml" do
 159     cookbook "web"
 160     source "database.yml.erb"
 161     owner new_resource.user
 162     group new_resource.group
 163     mode "664"
 164     variables :host => new_resource.database_host,
 165               :port => new_resource.database_port,
 166               :name => new_resource.database_name,
 167               :username => new_resource.database_username,
 168               :password => new_resource.database_password
 169   end
 170
 171   application_yml = edit_file "#{rails_directory}/config/example.application.yml" do |line|
 172     line.gsub!(/^( *)server_protocol:.*$/, "\\1server_protocol: \"https\"")
 173     line.gsub!(/^( *)server_url:.*$/, "\\1server_url: \"#{new_resource.site}\"")
 174
 175     line.gsub!(/^( *)support_email:.*$/, "\\1support_email: \"support@openstreetmap.org\"")
 176
 177     if new_resource.email_from
 178       line.gsub!(/^( *)email_from:.*$/, "\\1email_from: \"#{new_resource.email_from}\"")
 179     end
 180
 181     line.gsub!(/^( *)email_return_path:.*$/, "\\1email_return_path: \"bounces@openstreetmap.org\"")
 182
 183     line.gsub!(/^( *)status:.*$/, "\\1status: :#{new_resource.status}")
 184
 185     if new_resource.messages_domain
 186       line.gsub!(/^( *)#messages_domain:.*$/, "\\1messages_domain: \"#{new_resource.messages_domain}\"")
 187     end
 188
 189     line.gsub!(/^( *)#geonames_username:.*$/, "\\1geonames_username: \"openstreetmap\"")
 190
 191     line.gsub!(/^( *)#maxmind_database:.*$/, "\\1maxmind_database: \"#{node[:geoipupdate][:directory]}/GeoLite2-Country.mmdb\"")
 192
 193     if new_resource.gpx_dir
 194       line.gsub!(/^( *)gpx_trace_dir:.*$/, "\\1gpx_trace_dir: \"#{new_resource.gpx_dir}/traces\"")
 195       line.gsub!(/^( *)gpx_image_dir:.*$/, "\\1gpx_image_dir: \"#{new_resource.gpx_dir}/images\"")
 196     end
 197
 198     if new_resource.attachments_dir
 199       line.gsub!(/^( *)attachments_dir:.*$/, "\\1attachments_dir: \"#{new_resource.attachments_dir}\"")
 200     end
 201
 202     if new_resource.log_path
 203       line.gsub!(/^( *)#log_path:.*$/, "\\1log_path: \"#{new_resource.log_path}\"")
 204     end
 205
 206     if new_resource.logstash_path
 207       line.gsub!(/^( *)#logstash_path:.*$/, "\\1logstash_path: \"#{new_resource.logstash_path}\"")
 208     end
 209
 210     if new_resource.memcache_servers
 211       line.gsub!(/^( *)#memcache_servers:.*$/, "\\1memcache_servers: [ \"#{new_resource.memcache_servers.join('", "')}\" ]")
 212     end
 213
 214     if new_resource.potlatch2_key
 215       line.gsub!(/^( *)#potlatch2_key:.*$/, "\\1potlatch2_key: \"#{new_resource.potlatch2_key}\"")
 216     end
 217
 218     if new_resource.id_key
 219       line.gsub!(/^( *)#id_key:.*$/, "\\1id_key: \"#{new_resource.id_key}\"")
 220     end
 221
 222     if new_resource.id_application
 223       line.gsub!(/^( *)#id_application:.*$/, "\\1id_application: \"#{new_resource.id_application}\"")
 224     end
 225
 226     if new_resource.oauth_key
 227       line.gsub!(/^( *)#oauth_key:.*$/, "\\1oauth_key: \"#{new_resource.oauth_key}\"")
 228     end
 229
 230     if new_resource.oauth_application
 231       line.gsub!(/^( *)#oauth_application:.*$/, "\\1oauth_application: \"#{new_resource.oauth_application}\"")
 232     end
 233
 234     if new_resource.nominatim_url
 235       line.gsub!(/^( *)nominatim_url:.*$/, "\\1nominatim_url: \"#{new_resource.nominatim_url}\"")
 236     end
 237
 238     if new_resource.overpass_url
 239       line.gsub!(/^( *)overpass_url:.*$/, "\\1overpass_url: \"#{new_resource.overpass_url}\"")
 240     end
 241
 242     if new_resource.google_auth_id
 243       line.gsub!(/^( *)#google_auth_id:.*$/, "\\1google_auth_id: \"#{new_resource.google_auth_id}\"")
 244       line.gsub!(/^( *)#google_auth_secret:.*$/, "\\1google_auth_secret: \"#{new_resource.google_auth_secret}\"")
 245       line.gsub!(/^( *)#google_openid_realm:.*$/, "\\1google_openid_realm: \"#{new_resource.google_openid_realm}\"")
 246     end
 247
 248     if new_resource.facebook_auth_id
 249       line.gsub!(/^( *)#facebook_auth_id:.*$/, "\\1facebook_auth_id: \"#{new_resource.facebook_auth_id}\"")
 250       line.gsub!(/^( *)#facebook_auth_secret:.*$/, "\\1facebook_auth_secret: \"#{new_resource.facebook_auth_secret}\"")
 251     end
 252
 253     if new_resource.microsoft_auth_id
 254       line.gsub!(/^( *)#microsoft_auth_id:.*$/, "\\1microsoft_auth_id: \"#{new_resource.microsoft_auth_id}\"")
 255       line.gsub!(/^( *)#microsoft_auth_secret:.*$/, "\\1microsoft_auth_secret: \"#{new_resource.microsoft_auth_secret}\"")
 256     end
 257
 258     if new_resource.github_auth_id
 259       line.gsub!(/^( *)#github_auth_id:.*$/, "\\1github_auth_id: \"#{new_resource.github_auth_id}\"")
 260       line.gsub!(/^( *)#github_auth_secret:.*$/, "\\1github_auth_secret: \"#{new_resource.github_auth_secret}\"")
 261     end
 262
 263     if new_resource.wikipedia_auth_id
 264       line.gsub!(/^( *)#wikipedia_auth_id:.*$/, "\\1wikipedia_auth_id: \"#{new_resource.wikipedia_auth_id}\"")
 265       line.gsub!(/^( *)#wikipedia_auth_secret:.*$/, "\\1wikipedia_auth_secret: \"#{new_resource.wikipedia_auth_secret}\"")
 266     end
 267
 268     if new_resource.thunderforest_key
 269       line.gsub!(/^( *)#thunderforest_key:.*$/, "\\1thunderforest_key: \"#{new_resource.thunderforest_key}\"")
 270     end
 271
 272     if new_resource.totp_key
 273       line.gsub!(/^( *)#totp_key:.*$/, "\\1totp_key: \"#{new_resource.totp_key}\"")
 274     end
 275
 276     if new_resource.csp_enforce
 277       line.gsub!(/^( *)csp_enforce:.*$/, "\\1csp_enforce: \"#{new_resource.csp_enforce}\"")
 278     end
 279
 280     if new_resource.csp_report_url
 281       line.gsub!(/^( *)#csp_report_url:.*$/, "\\1csp_report_url: \"#{new_resource.csp_report_url}\"")
 282     end
 283
 284     line.gsub!(/^( *)require_terms_seen:.*$/, "\\1require_terms_seen: true")
 285     line.gsub!(/^( *)require_terms_agreed:.*$/, "\\1require_terms_agreed: true")
 286     line.gsub!(/^( *)trace_use_job_queue:.*$/, "\\1trace_use_job_queue: false")
 287
 288     line
 289   end
 290
 291   file "create:#{rails_directory}/config/application.yml" do
 292     path "#{rails_directory}/config/application.yml"
 293     owner new_resource.user
 294     group new_resource.group
 295     mode "664"
 296     content application_yml
 297     only_if { ::File.exist?("#{rails_directory}/config/example.application.yml") }
 298   end
 299
 300   file "delete:#{rails_directory}/config/application.yml" do
 301     path "#{rails_directory}/config/application.yml"
 302     action :delete
 303     not_if { ::File.exist?("#{rails_directory}/config/example.application.yml") }
 304   end
 305
 306   settings = new_resource.to_hash.transform_keys(&:to_s).slice(
 307     "email_from",
 308     "status",
 309     "messages_domain",
 310     "attachments_dir",
 311     "log_path",
 312     "logstash_path",
 313     "potlatch2_key",
 314     "id_key",
 315     "id_application",
 316     "oauth_key",
 317     "oauth_application",
 318     "nominatim_url",
 319     "overpass_url",
 320     "overpass_credentials",
 321     "google_auth_id",
 322     "google_auth_secret",
 323     "google_openid_realm",
 324     "facebook_auth_id",
 325     "facebook_auth_secret",
 326     "microsoft_auth_id",
 327     "microsoft_auth_secret",
 328     "github_auth_id",
 329     "github_auth_secret",
 330     "wikipedia_auth_id",
 331     "wikipedia_auth_secret",
 332     "thunderforest_key",
 333     "tracestrack_key",
 334     "maptiler_key",
 335     "totp_key",
 336     "csp_enforce",
 337     "csp_report_url",
 338     "trace_use_job_queue",
 339     "diary_feed_delay",
 340     "storage_service",
 341     "storage_url",
 342     "avatar_storage",
 343     "trace_file_storage",
 344     "trace_image_storage",
 345     "trace_icon_storage",
 346     "avatar_storage_url",
 347     "trace_image_storage_url",
 348     "trace_icon_storage_url",
 349     "tile_cdn_url",
 350     "imagery_blacklist",
 351     "signup_ip_per_day",
 352     "signup_ip_max_burst",
 353     "signup_email_per_day",
 354     "signup_email_max_burst",
 355     "doorkeeper_signing_key",
 356     "user_account_deletion_delay"
 357   ).compact.merge(
 358     "server_protocol" => "https",
 359     "server_url" => new_resource.site,
 360     "support_email" => "support@openstreetmap.org",
 361     "email_return_path" => "bounces@openstreetmap.org",
 362     "geonames_username" => "openstreetmap",
 363     "maxmind_database" => "#{node[:geoipupdate][:directory]}/GeoLite2-Country.mmdb",
 364     "max_request_area" => node[:web][:max_request_area],
 365     "max_number_of_nodes" => node[:web][:max_number_of_nodes],
 366     "max_number_of_way_nodes" => node[:web][:max_number_of_way_nodes],
 367     "max_number_of_relation_members" => node[:web][:max_number_of_relation_members],
 368     "oauth_10_support" => false,
 369     "oauth_10_registration" => false,
 370     "oauth_10a_support" => false,
 371     "basic_auth_support" => false
 372   )
 373
 374   if new_resource.memcache_servers
 375     settings["memcache_servers"] = new_resource.memcache_servers.to_a
 376   end
 377
 378   if new_resource.gpx_dir
 379     settings["gpx_trace_dir"] = "#{new_resource.gpx_dir}/traces"
 380     settings["gpx_image_dir"] = "#{new_resource.gpx_dir}/images"
 381   end
 382
 383   if new_resource.matomo_configuration
 384     settings["matomo"] = new_resource.matomo_configuration.to_h
 385   end
 386
 387   file "#{rails_directory}/config/settings.local.yml" do
 388     owner new_resource.user
 389     group new_resource.group
 390     mode "664"
 391     content YAML.dump(settings)
 392     only_if { ::File.exist?("#{rails_directory}/config/settings.yml") }
 393   end
 394
 395   storage_configuration = new_resource.storage_configuration.merge(
 396     "local" => {
 397       "service" => "Disk",
 398       "root" => "#{rails_directory}/storage"
 399     }
 400   )
 401
 402   file "#{rails_directory}/config/storage.yml" do
 403     owner new_resource.user
 404     group new_resource.group
 405     mode "664"
 406     content YAML.dump(storage_configuration)
 407   end
 408
 409   file "#{rails_directory}/config/piwik.yml" do
 410     action :delete
 411   end
 412
 413   directory "#{rails_directory}/vendor/bundle/ruby/#{node[:ruby][:version]}.0" do
 414     owner new_resource.user
 415     group new_resource.group
 416     mode "775"
 417     recursive true
 418   end
 419
 420   bundle_config rails_directory do
 421     user new_resource.user
 422     group new_resource.group
 423     settings "deployment" => "true",
 424              "build.nokogiri" => "--use-system-libraries"
 425   end
 426
 427   bundle_install rails_directory do
 428     action :nothing
 429     user new_resource.user
 430     group new_resource.group
 431     subscribes :run, "directory[#{rails_directory}/vendor/bundle/ruby/#{node[:ruby][:version]}.0]"
 432     subscribes :run, "git[#{rails_directory}]"
 433   end
 434
 435   bundle_exec "#{rails_directory}/db/migrate" do
 436     action :nothing
 437     directory rails_directory
 438     command "rails db:migrate"
 439     user new_resource.user
 440     group new_resource.group
 441     subscribes :run, "git[#{rails_directory}]"
 442     only_if { new_resource.run_migrations }
 443   end
 444
 445   bundle_exec "#{rails_directory}/package.json" do
 446     action :nothing
 447     directory rails_directory
 448     command "rails yarn:install"
 449     environment "HOME" => rails_directory,
 450                 "RAILS_ENV" => "production",
 451                 "SECRET_KEY_BASE_DUMMY" => "1"
 452     user new_resource.user
 453     group new_resource.group
 454     subscribes :run, "git[#{rails_directory}]"
 455     only_if { new_resource.build_assets }
 456   end
 457
 458   bundle_exec "#{rails_directory}/config/i18n-js.yml" do
 459     action :nothing
 460     directory rails_directory
 461     command "rails i18n:js:export"
 462     environment "HOME" => rails_directory,
 463                 "RAILS_ENV" => "production",
 464                 "SECRET_KEY_BASE_DUMMY" => "1"
 465     user new_resource.user
 466     group new_resource.group
 467     subscribes :run, "git[#{rails_directory}]"
 468     only_if { new_resource.build_assets && ::File.exist?("#{rails_directory}/config/i18n-js.yml") }
 469   end
 470
 471   bundle_exec "#{rails_directory}/config/i18n.yml" do
 472     action :nothing
 473     directory rails_directory
 474     command "i18n export"
 475     environment "HOME" => rails_directory
 476     user new_resource.user
 477     group new_resource.group
 478     subscribes :run, "git[#{rails_directory}]"
 479     only_if { new_resource.build_assets && ::File.exist?("#{rails_directory}/config/i18n.yml") }
 480   end
 481
 482   bundle_exec "#{rails_directory}/public/assets" do
 483     action :nothing
 484     directory rails_directory
 485     command "rails assets:precompile"
 486     environment "HOME" => rails_directory,
 487                 "RAILS_ENV" => "production",
 488                 "SECRET_KEY_BASE_DUMMY" => "1"
 489     user new_resource.user
 490     group new_resource.group
 491     subscribes :run, "git[#{rails_directory}]"
 492     subscribes :run, "file[create:#{rails_directory}/config/application.yml]"
 493     subscribes :run, "file[#{rails_directory}/config/settings.local.yml]"
 494     subscribes :run, "file[#{rails_directory}/config/storage.yml]"
 495     subscribes :run, "bundle_exec[#{rails_directory}/package.json]"
 496     subscribes :run, "bundle_exec[#{rails_directory}/config/i18n-js.yml]"
 497     subscribes :run, "bundle_exec[#{rails_directory}/config/i18n.yml]"
 498     only_if { new_resource.build_assets }
 499   end
 500
 501   file "#{rails_directory}/public/export/embed.html" do
 502     action :nothing
 503     subscribes :delete, "git[#{rails_directory}]"
 504     subscribes :delete, "file[#{rails_directory}/config/settings.local.yml]"
 505   end
 506
 507   passenger_application rails_directory do
 508     action :nothing
 509     subscribes :restart, "git[#{rails_directory}]"
 510     subscribes :restart, "file[#{rails_directory}/config/database.yml]"
 511     subscribes :restart, "file[create:#{rails_directory}/config/application.yml]"
 512     subscribes :restart, "file[#{rails_directory}/config/settings.local.yml]"
 513     subscribes :restart, "file[#{rails_directory}/config/storage.yml]"
 514     subscribes :restart, "bundle_installl[#{rails_directory}]"
 515     subscribes :restart, "bundle_exec[#{rails_directory}/db/migrate]"
 516     subscribes :restart, "bundle_exec[#{rails_directory}/package.json]"
 517     subscribes :restart, "bundle_exec[#{rails_directory}/app/assets/javascripts/i18n]"
 518     subscribes :restart, "bundle_exec[#{rails_directory}/public/assets]"
 519     only_if { ::File.exist?("/usr/bin/passenger-config") }
 520   end
 521
 522   template "/etc/cron.daily/rails-#{new_resource.site.tr('.', '-')}" do
 523     cookbook "web"
 524     source "rails.cron.erb"
 525     owner "root"
 526     group "root"
 527     mode "755"
 528     variables :directory => rails_directory
 529   end
 530 end
 531
 532 action :restart do
 533   passenger_application rails_directory do
 534     action :restart
 535   end
 536 end
 537
 538 action_class do
 539   include OpenStreetMap::Mixin::EditFile
 540
 541   def rails_directory
 542     new_resource.directory || "/srv/#{new_resource.site}"
 543   end
 544 end