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