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