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