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