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