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