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 :totp_key, String
  73 property :csp_enforce, [true, false], :default => false
  74 property :csp_report_url, String
  75 property :matomo_configuration, Hash
  76 property :storage_service, String, :default => "local"
  77 property :storage_url, String
  78 property :trace_use_job_queue, [true, false], :default => false
  79 property :diary_feed_delay, Integer
  80 property :storage_configuration, Hash, :default => {}
  81 property :avatar_storage, String
  82 property :trace_file_storage, String
  83 property :trace_image_storage, String
  84 property :trace_icon_storage, String
  85 property :avatar_storage_url, String
  86 property :trace_image_storage_url, String
  87 property :trace_icon_storage_url, String
  88 property :tile_cdn_url, String
  89 property :imagery_blacklist, Array
  90 property :signup_ip_per_day, Integer
  91 property :signup_ip_max_burst, Integer
  92 property :signup_email_per_day, Integer
  93 property :signup_email_max_burst, Integer
  94
  95 action :create do
  96   package %W[
  97     imagemagick
  98     libvips42
  99     nodejs
 100     tzdata
 101   ]
 102
 103   package %w[
 104     g++
 105     make
 106     pkg-config
 107     libpq-dev
 108     libsasl2-dev
 109     libxml2-dev
 110     libxslt1-dev
 111     libmemcached-dev
 112     libffi-dev
 113     libgd-dev
 114     libarchive-dev
 115     libbz2-dev
 116   ]
 117
 118   package %w[
 119     pngcrush
 120     advancecomp
 121     optipng
 122     pngquant
 123     jhead
 124     jpegoptim
 125     gifsicle
 126     libjpeg-turbo-progs
 127   ]
 128
 129   declare_resource :directory, rails_directory do
 130     owner new_resource.user
 131     group new_resource.group
 132     mode "2775"
 133   end
 134
 135   git rails_directory do
 136     action :sync
 137     repository new_resource.repository
 138     revision new_resource.revision
 139     depth 1
 140     user new_resource.user
 141     group new_resource.group
 142   end
 143
 144   declare_resource :directory, "#{rails_directory}/tmp" do
 145     owner new_resource.user
 146     group new_resource.group
 147   end
 148
 149   file "#{rails_directory}/config/environment.rb" do
 150     owner new_resource.user
 151     group new_resource.group
 152   end
 153
 154   template "#{rails_directory}/config/database.yml" do
 155     cookbook "web"
 156     source "database.yml.erb"
 157     owner new_resource.user
 158     group new_resource.group
 159     mode "664"
 160     variables :host => new_resource.database_host,
 161               :port => new_resource.database_port,
 162               :name => new_resource.database_name,
 163               :username => new_resource.database_username,
 164               :password => new_resource.database_password
 165   end
 166
 167   application_yml = edit_file "#{rails_directory}/config/example.application.yml" do |line|
 168     line.gsub!(/^( *)server_protocol:.*$/, "\\1server_protocol: \"https\"")
 169     line.gsub!(/^( *)server_url:.*$/, "\\1server_url: \"#{new_resource.site}\"")
 170
 171     line.gsub!(/^( *)support_email:.*$/, "\\1support_email: \"support@openstreetmap.org\"")
 172
 173     if new_resource.email_from
 174       line.gsub!(/^( *)email_from:.*$/, "\\1email_from: \"#{new_resource.email_from}\"")
 175     end
 176
 177     line.gsub!(/^( *)email_return_path:.*$/, "\\1email_return_path: \"bounces@openstreetmap.org\"")
 178
 179     line.gsub!(/^( *)status:.*$/, "\\1status: :#{new_resource.status}")
 180
 181     if new_resource.messages_domain
 182       line.gsub!(/^( *)#messages_domain:.*$/, "\\1messages_domain: \"#{new_resource.messages_domain}\"")
 183     end
 184
 185     line.gsub!(/^( *)#geonames_username:.*$/, "\\1geonames_username: \"openstreetmap\"")
 186
 187     line.gsub!(/^( *)#maxmind_database:.*$/, "\\1maxmind_database: \"#{node[:geoipupdate][:directory]}/GeoLite2-Country.mmdb\"")
 188
 189     if new_resource.gpx_dir
 190       line.gsub!(/^( *)gpx_trace_dir:.*$/, "\\1gpx_trace_dir: \"#{new_resource.gpx_dir}/traces\"")
 191       line.gsub!(/^( *)gpx_image_dir:.*$/, "\\1gpx_image_dir: \"#{new_resource.gpx_dir}/images\"")
 192     end
 193
 194     if new_resource.attachments_dir
 195       line.gsub!(/^( *)attachments_dir:.*$/, "\\1attachments_dir: \"#{new_resource.attachments_dir}\"")
 196     end
 197
 198     if new_resource.log_path
 199       line.gsub!(/^( *)#log_path:.*$/, "\\1log_path: \"#{new_resource.log_path}\"")
 200     end
 201
 202     if new_resource.logstash_path
 203       line.gsub!(/^( *)#logstash_path:.*$/, "\\1logstash_path: \"#{new_resource.logstash_path}\"")
 204     end
 205
 206     if new_resource.memcache_servers
 207       line.gsub!(/^( *)#memcache_servers:.*$/, "\\1memcache_servers: [ \"#{new_resource.memcache_servers.join('", "')}\" ]")
 208     end
 209
 210     if new_resource.potlatch2_key
 211       line.gsub!(/^( *)#potlatch2_key:.*$/, "\\1potlatch2_key: \"#{new_resource.potlatch2_key}\"")
 212     end
 213
 214     if new_resource.id_key
 215       line.gsub!(/^( *)#id_key:.*$/, "\\1id_key: \"#{new_resource.id_key}\"")
 216     end
 217
 218     if new_resource.id_application
 219       line.gsub!(/^( *)#id_application:.*$/, "\\1id_application: \"#{new_resource.id_application}\"")
 220     end
 221
 222     if new_resource.oauth_key
 223       line.gsub!(/^( *)#oauth_key:.*$/, "\\1oauth_key: \"#{new_resource.oauth_key}\"")
 224     end
 225
 226     if new_resource.oauth_application
 227       line.gsub!(/^( *)#oauth_application:.*$/, "\\1oauth_application: \"#{new_resource.oauth_application}\"")
 228     end
 229
 230     if new_resource.nominatim_url
 231       line.gsub!(/^( *)nominatim_url:.*$/, "\\1nominatim_url: \"#{new_resource.nominatim_url}\"")
 232     end
 233
 234     if new_resource.overpass_url
 235       line.gsub!(/^( *)overpass_url:.*$/, "\\1overpass_url: \"#{new_resource.overpass_url}\"")
 236     end
 237
 238     if new_resource.google_auth_id
 239       line.gsub!(/^( *)#google_auth_id:.*$/, "\\1google_auth_id: \"#{new_resource.google_auth_id}\"")
 240       line.gsub!(/^( *)#google_auth_secret:.*$/, "\\1google_auth_secret: \"#{new_resource.google_auth_secret}\"")
 241       line.gsub!(/^( *)#google_openid_realm:.*$/, "\\1google_openid_realm: \"#{new_resource.google_openid_realm}\"")
 242     end
 243
 244     if new_resource.facebook_auth_id
 245       line.gsub!(/^( *)#facebook_auth_id:.*$/, "\\1facebook_auth_id: \"#{new_resource.facebook_auth_id}\"")
 246       line.gsub!(/^( *)#facebook_auth_secret:.*$/, "\\1facebook_auth_secret: \"#{new_resource.facebook_auth_secret}\"")
 247     end
 248
 249     if new_resource.microsoft_auth_id
 250       line.gsub!(/^( *)#microsoft_auth_id:.*$/, "\\1microsoft_auth_id: \"#{new_resource.microsoft_auth_id}\"")
 251       line.gsub!(/^( *)#microsoft_auth_secret:.*$/, "\\1microsoft_auth_secret: \"#{new_resource.microsoft_auth_secret}\"")
 252     end
 253
 254     if new_resource.github_auth_id
 255       line.gsub!(/^( *)#github_auth_id:.*$/, "\\1github_auth_id: \"#{new_resource.github_auth_id}\"")
 256       line.gsub!(/^( *)#github_auth_secret:.*$/, "\\1github_auth_secret: \"#{new_resource.github_auth_secret}\"")
 257     end
 258
 259     if new_resource.wikipedia_auth_id
 260       line.gsub!(/^( *)#wikipedia_auth_id:.*$/, "\\1wikipedia_auth_id: \"#{new_resource.wikipedia_auth_id}\"")
 261       line.gsub!(/^( *)#wikipedia_auth_secret:.*$/, "\\1wikipedia_auth_secret: \"#{new_resource.wikipedia_auth_secret}\"")
 262     end
 263
 264     if new_resource.thunderforest_key
 265       line.gsub!(/^( *)#thunderforest_key:.*$/, "\\1thunderforest_key: \"#{new_resource.thunderforest_key}\"")
 266     end
 267
 268     if new_resource.totp_key
 269       line.gsub!(/^( *)#totp_key:.*$/, "\\1totp_key: \"#{new_resource.totp_key}\"")
 270     end
 271
 272     if new_resource.csp_enforce
 273       line.gsub!(/^( *)csp_enforce:.*$/, "\\1csp_enforce: \"#{new_resource.csp_enforce}\"")
 274     end
 275
 276     if new_resource.csp_report_url
 277       line.gsub!(/^( *)#csp_report_url:.*$/, "\\1csp_report_url: \"#{new_resource.csp_report_url}\"")
 278     end
 279
 280     line.gsub!(/^( *)require_terms_seen:.*$/, "\\1require_terms_seen: true")
 281     line.gsub!(/^( *)require_terms_agreed:.*$/, "\\1require_terms_agreed: true")
 282     line.gsub!(/^( *)trace_use_job_queue:.*$/, "\\1trace_use_job_queue: false")
 283
 284     line
 285   end
 286
 287   file "create:#{rails_directory}/config/application.yml" do
 288     path "#{rails_directory}/config/application.yml"
 289     owner new_resource.user
 290     group new_resource.group
 291     mode "664"
 292     content application_yml
 293     only_if { ::File.exist?("#{rails_directory}/config/example.application.yml") }
 294   end
 295
 296   file "delete:#{rails_directory}/config/application.yml" do
 297     path "#{rails_directory}/config/application.yml"
 298     action :delete
 299     not_if { ::File.exist?("#{rails_directory}/config/example.application.yml") }
 300   end
 301
 302   settings = new_resource.to_hash.transform_keys(&:to_s).slice(
 303     "email_from",
 304     "status",
 305     "messages_domain",
 306     "attachments_dir",
 307     "log_path",
 308     "logstash_path",
 309     "potlatch2_key",
 310     "id_key",
 311     "id_application",
 312     "oauth_key",
 313     "oauth_application",
 314     "nominatim_url",
 315     "overpass_url",
 316     "overpass_credentials",
 317     "google_auth_id",
 318     "google_auth_secret",
 319     "google_openid_realm",
 320     "facebook_auth_id",
 321     "facebook_auth_secret",
 322     "microsoft_auth_id",
 323     "microsoft_auth_secret",
 324     "github_auth_id",
 325     "github_auth_secret",
 326     "wikipedia_auth_id",
 327     "wikipedia_auth_secret",
 328     "thunderforest_key",
 329     "tracestrack_key",
 330     "totp_key",
 331     "csp_enforce",
 332     "csp_report_url",
 333     "trace_use_job_queue",
 334     "diary_feed_delay",
 335     "storage_service",
 336     "storage_url",
 337     "avatar_storage",
 338     "trace_file_storage",
 339     "trace_image_storage",
 340     "trace_icon_storage",
 341     "avatar_storage_url",
 342     "trace_image_storage_url",
 343     "trace_icon_storage_url",
 344     "tile_cdn_url",
 345     "imagery_blacklist",
 346     "signup_ip_per_day",
 347     "signup_ip_max_burst",
 348     "signup_email_per_day",
 349     "signup_email_max_burst"
 350   ).compact.merge(
 351     "server_protocol" => "https",
 352     "server_url" => new_resource.site,
 353     "support_email" => "support@openstreetmap.org",
 354     "email_return_path" => "bounces@openstreetmap.org",
 355     "geonames_username" => "openstreetmap",
 356     "maxmind_database" => "#{node[:geoipupdate][:directory]}/GeoLite2-Country.mmdb",
 357     "max_request_area" => node[:web][:max_request_area],
 358     "max_number_of_nodes" => node[:web][:max_number_of_nodes],
 359     "max_number_of_way_nodes" => node[:web][:max_number_of_way_nodes],
 360     "max_number_of_relation_members" => node[:web][:max_number_of_relation_members]
 361   )
 362
 363   if new_resource.memcache_servers
 364     settings["memcache_servers"] = new_resource.memcache_servers.to_a
 365   end
 366
 367   if new_resource.gpx_dir
 368     settings["gpx_trace_dir"] = "#{new_resource.gpx_dir}/traces"
 369     settings["gpx_image_dir"] = "#{new_resource.gpx_dir}/images"
 370   end
 371
 372   if new_resource.matomo_configuration
 373     settings["matomo"] = new_resource.matomo_configuration.to_h
 374   end
 375
 376   file "#{rails_directory}/config/settings.local.yml" do
 377     owner new_resource.user
 378     group new_resource.group
 379     mode "664"
 380     content YAML.dump(settings)
 381     only_if { ::File.exist?("#{rails_directory}/config/settings.yml") }
 382   end
 383
 384   storage_configuration = new_resource.storage_configuration.merge(
 385     "local" => {
 386       "service" => "Disk",
 387       "root" => "#{rails_directory}/storage"
 388     }
 389   )
 390
 391   file "#{rails_directory}/config/storage.yml" do
 392     owner new_resource.user
 393     group new_resource.group
 394     mode "664"
 395     content YAML.dump(storage_configuration)
 396   end
 397
 398   file "#{rails_directory}/config/piwik.yml" do
 399     action :delete
 400   end
 401
 402   bundle_install "#{rails_directory}" do
 403     action :nothing
 404     user "root"
 405     group "root"
 406     environment "NOKOGIRI_USE_SYSTEM_LIBRARIES" => "yes"
 407     subscribes :run, "git[#{rails_directory}]"
 408   end
 409
 410   bundle_exec "#{rails_directory}/db/migrate" do
 411     action :nothing
 412     directory rails_directory
 413     command "rails db:migrate"
 414     user new_resource.user
 415     group new_resource.group
 416     subscribes :run, "git[#{rails_directory}]"
 417     only_if { new_resource.run_migrations }
 418   end
 419
 420   bundle_exec "#{rails_directory}/package.json" do
 421     action :nothing
 422     directory rails_directory
 423     command "rails yarn:install"
 424     environment "HOME" => rails_directory,
 425                 "RAILS_ENV" => "production"
 426     user new_resource.user
 427     group new_resource.group
 428     subscribes :run, "git[#{rails_directory}]"
 429     only_if { new_resource.build_assets }
 430   end
 431
 432   bundle_exec "#{rails_directory}/app/assets/javascripts/i18n" do
 433     action :nothing
 434     directory rails_directory
 435     command "rails i18n:js:export"
 436     environment "HOME" => rails_directory,
 437                 "RAILS_ENV" => "production"
 438     user new_resource.user
 439     group new_resource.group
 440     subscribes :run, "git[#{rails_directory}]"
 441     only_if { new_resource.build_assets }
 442   end
 443
 444   bundle_exec "#{rails_directory}/public/assets" do
 445     action :nothing
 446     directory rails_directory
 447     command "rails assets:precompile"
 448     environment "HOME" => rails_directory,
 449                 "RAILS_ENV" => "production"
 450     user new_resource.user
 451     group new_resource.group
 452     subscribes :run, "git[#{rails_directory}]"
 453     subscribes :run, "file[create:#{rails_directory}/config/application.yml]"
 454     subscribes :run, "file[#{rails_directory}/config/settings.local.yml]"
 455     subscribes :run, "file[#{rails_directory}/config/storage.yml]"
 456     subscribes :run, "bundle_exec[#{rails_directory}/package.json]"
 457     subscribes :run, "bundle_exec[#{rails_directory}/app/assets/javascripts/i18n]"
 458     only_if { new_resource.build_assets }
 459   end
 460
 461   file "#{rails_directory}/public/export/embed.html" do
 462     action :nothing
 463     subscribes :delete, "git[#{rails_directory}]"
 464     subscribes :delete, "file[#{rails_directory}/config/settings.local.yml]"
 465   end
 466
 467   passenger_application rails_directory do
 468     action :nothing
 469     subscribes :restart, "git[#{rails_directory}]"
 470     subscribes :restart, "file[#{rails_directory}/config/database.yml]"
 471     subscribes :restart, "file[create:#{rails_directory}/config/application.yml]"
 472     subscribes :restart, "file[#{rails_directory}/config/settings.local.yml]"
 473     subscribes :restart, "file[#{rails_directory}/config/storage.yml]"
 474     subscribes :restart, "bundle_installl[#{rails_directory}]"
 475     subscribes :restart, "bundle_exec[#{rails_directory}/db/migrate]"
 476     subscribes :restart, "bundle_exec[#{rails_directory}/package.json]"
 477     subscribes :restart, "bundle_exec[#{rails_directory}/app/assets/javascripts/i18n]"
 478     subscribes :restart, "bundle_exec[#{rails_directory}/public/assets]"
 479     only_if { ::File.exist?("/usr/bin/passenger-config") }
 480   end
 481
 482   template "/etc/cron.daily/rails-#{new_resource.site.tr('.', '-')}" do
 483     cookbook "web"
 484     source "rails.cron.erb"
 485     owner "root"
 486     group "root"
 487     mode "755"
 488     variables :directory => rails_directory
 489   end
 490 end
 491
 492 action :restart do
 493   passenger_application rails_directory do
 494     action :restart
 495   end
 496 end
 497
 498 action_class do
 499   include OpenStreetMap::Mixin::EditFile
 500
 501   def rails_directory
 502     new_resource.directory || "/srv/#{new_resource.site}"
 503   end
 504 end