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 :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 :piwik_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     ruby#{new_resource.ruby}
  91     ruby#{new_resource.ruby}-dev
  92     imagemagick
  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   gem_package "bundler#{new_resource.ruby}" do
 124     package_name "bundler"
 125     version "2.1.4"
 126     gem_binary "gem#{new_resource.ruby}"
 127     options "--format-executable"
 128   end
 129
 130   gem_package "bundler#{new_resource.ruby}" do
 131     package_name "pkg-config"
 132     gem_binary "gem#{new_resource.ruby}"
 133   end
 134
 135   declare_resource :directory, rails_directory do
 136     owner new_resource.user
 137     group new_resource.group
 138     mode "2775"
 139   end
 140
 141   git rails_directory do
 142     action :sync
 143     repository new_resource.repository
 144     revision new_resource.revision
 145     depth 1
 146     user new_resource.user
 147     group new_resource.group
 148   end
 149
 150   declare_resource :directory, "#{rails_directory}/tmp" do
 151     owner new_resource.user
 152     group new_resource.group
 153   end
 154
 155   file "#{rails_directory}/config/environment.rb" do
 156     owner new_resource.user
 157     group new_resource.group
 158   end
 159
 160   template "#{rails_directory}/config/database.yml" do
 161     cookbook "web"
 162     source "database.yml.erb"
 163     owner new_resource.user
 164     group new_resource.group
 165     mode "664"
 166     variables :host => new_resource.database_host,
 167               :port => new_resource.database_port,
 168               :name => new_resource.database_name,
 169               :username => new_resource.database_username,
 170               :password => new_resource.database_password
 171   end
 172
 173   application_yml = edit_file "#{rails_directory}/config/example.application.yml" do |line|
 174     line.gsub!(/^( *)server_protocol:.*$/, "\\1server_protocol: \"https\"")
 175     line.gsub!(/^( *)server_url:.*$/, "\\1server_url: \"#{new_resource.site}\"")
 176
 177     line.gsub!(/^( *)support_email:.*$/, "\\1support_email: \"support@openstreetmap.org\"")
 178
 179     if new_resource.email_from
 180       line.gsub!(/^( *)email_from:.*$/, "\\1email_from: \"#{new_resource.email_from}\"")
 181     end
 182
 183     line.gsub!(/^( *)email_return_path:.*$/, "\\1email_return_path: \"bounces@openstreetmap.org\"")
 184
 185     line.gsub!(/^( *)status:.*$/, "\\1status: :#{new_resource.status}")
 186
 187     if new_resource.messages_domain
 188       line.gsub!(/^( *)#messages_domain:.*$/, "\\1messages_domain: \"#{new_resource.messages_domain}\"")
 189     end
 190
 191     line.gsub!(/^( *)#geonames_username:.*$/, "\\1geonames_username: \"openstreetmap\"")
 192
 193     line.gsub!(/^( *)#maxmind_database:.*$/, "\\1maxmind_database: \"/usr/share/GeoIP/GeoLite2-Country.mmdb\"")
 194
 195     if new_resource.gpx_dir
 196       line.gsub!(/^( *)gpx_trace_dir:.*$/, "\\1gpx_trace_dir: \"#{new_resource.gpx_dir}/traces\"")
 197       line.gsub!(/^( *)gpx_image_dir:.*$/, "\\1gpx_image_dir: \"#{new_resource.gpx_dir}/images\"")
 198     end
 199
 200     if new_resource.attachments_dir
 201       line.gsub!(/^( *)attachments_dir:.*$/, "\\1attachments_dir: \"#{new_resource.attachments_dir}\"")
 202     end
 203
 204     if new_resource.log_path
 205       line.gsub!(/^( *)#log_path:.*$/, "\\1log_path: \"#{new_resource.log_path}\"")
 206     end
 207
 208     if new_resource.logstash_path
 209       line.gsub!(/^( *)#logstash_path:.*$/, "\\1logstash_path: \"#{new_resource.logstash_path}\"")
 210     end
 211
 212     if new_resource.memcache_servers
 213       line.gsub!(/^( *)#memcache_servers:.*$/, "\\1memcache_servers: [ \"#{new_resource.memcache_servers.join('", "')}\" ]")
 214     end
 215
 216     if new_resource.potlatch2_key
 217       line.gsub!(/^( *)#potlatch2_key:.*$/, "\\1potlatch2_key: \"#{new_resource.potlatch2_key}\"")
 218     end
 219
 220     if new_resource.id_key
 221       line.gsub!(/^( *)#id_key:.*$/, "\\1id_key: \"#{new_resource.id_key}\"")
 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.windowslive_auth_id
 252       line.gsub!(/^( *)#windowslive_auth_id:.*$/, "\\1windowslive_auth_id: \"#{new_resource.windowslive_auth_id}\"")
 253       line.gsub!(/^( *)#windowslive_auth_secret:.*$/, "\\1windowslive_auth_secret: \"#{new_resource.windowslive_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     "oauth_key",
 314     "oauth_application",
 315     "nominatim_url",
 316     "overpass_url",
 317     "google_auth_id",
 318     "google_auth_secret",
 319     "google_openid_realm",
 320     "facebook_auth_id",
 321     "facebook_auth_secret",
 322     "windowslive_auth_id",
 323     "windowslive_auth_secret",
 324     "github_auth_id",
 325     "github_auth_secret",
 326     "wikipedia_auth_id",
 327     "wikipedia_auth_secret",
 328     "thunderforest_key",
 329     "totp_key",
 330     "csp_enforce",
 331     "csp_report_url",
 332     "trace_use_job_queue",
 333     "diary_feed_delay",
 334     "storage_service",
 335     "storage_url",
 336     "avatar_storage",
 337     "trace_file_storage",
 338     "trace_image_storage",
 339     "trace_icon_storage",
 340     "avatar_storage_url",
 341     "trace_image_storage_url",
 342     "trace_icon_storage_url",
 343     "tile_cdn_url"
 344   ).compact.merge(
 345     "server_protocol" => "https",
 346     "server_url" => new_resource.site,
 347     "support_email" => "support@openstreetmap.org",
 348     "email_return_path" => "bounces@openstreetmap.org",
 349     "geonames_username" => "openstreetmap",
 350     "maxmind_database" => "/usr/share/GeoIP/GeoLite2-Country.mmdb",
 351     "max_request_area" => node[:web][:max_request_area],
 352     "max_number_of_nodes" => node[:web][:max_number_of_nodes],
 353     "max_number_of_way_nodes" => node[:web][:max_number_of_way_nodes],
 354     "max_number_of_relation_members" => node[:web][:max_number_of_relation_members]
 355   )
 356
 357   if new_resource.memcache_servers
 358     settings["memcache_servers"] = new_resource.memcache_servers.to_a
 359   end
 360
 361   if new_resource.gpx_dir
 362     settings["gpx_trace_dir"] = "#{new_resource.gpx_dir}/traces"
 363     settings["gpx_image_dir"] = "#{new_resource.gpx_dir}/images"
 364   end
 365
 366   file "#{rails_directory}/config/settings.local.yml" do
 367     owner new_resource.user
 368     group new_resource.group
 369     mode "664"
 370     content YAML.dump(settings)
 371     only_if { ::File.exist?("#{rails_directory}/config/settings.yml") }
 372   end
 373
 374   storage_configuration = new_resource.storage_configuration.merge(
 375     "local" => {
 376       "service" => "Disk",
 377       "root" => "#{rails_directory}/storage"
 378     }
 379   )
 380
 381   file "#{rails_directory}/config/storage.yml" do
 382     owner new_resource.user
 383     group new_resource.group
 384     mode "664"
 385     content YAML.dump(storage_configuration)
 386   end
 387
 388   if new_resource.piwik_configuration
 389     file "#{rails_directory}/config/piwik.yml" do
 390       owner new_resource.user
 391       group new_resource.group
 392       mode "664"
 393       content YAML.dump(new_resource.piwik_configuration)
 394     end
 395   else
 396     file "#{rails_directory}/config/piwik.yml" do
 397       action :delete
 398     end
 399   end
 400
 401   execute "#{rails_directory}/Gemfile" do
 402     action :nothing
 403     command "bundle#{new_resource.ruby} install"
 404     cwd rails_directory
 405     user "root"
 406     group "root"
 407     environment "NOKOGIRI_USE_SYSTEM_LIBRARIES" => "yes"
 408     subscribes :run, "gem_package[bundler#{new_resource.ruby}]"
 409     subscribes :run, "git[#{rails_directory}]"
 410   end
 411
 412   execute "#{rails_directory}/db/migrate" do
 413     action :nothing
 414     command "bundle#{new_resource.ruby} exec rake db:migrate"
 415     cwd rails_directory
 416     user new_resource.user
 417     group new_resource.group
 418     subscribes :run, "git[#{rails_directory}]"
 419     only_if { new_resource.run_migrations }
 420   end
 421
 422   package "yarnpkg" do
 423     only_if { new_resource.build_assets }
 424   end
 425
 426   execute "#{rails_directory}/package.json" do
 427     action :nothing
 428     command "bundle#{new_resource.ruby} exec rake yarn:install"
 429     environment "HOME" => rails_directory,
 430                 "RAILS_ENV" => "production"
 431     cwd rails_directory
 432     user new_resource.user
 433     group new_resource.group
 434     subscribes :run, "git[#{rails_directory}]"
 435     only_if { new_resource.build_assets }
 436   end
 437
 438   execute "#{rails_directory}/app/assets/javascripts/i18n" do
 439     action :nothing
 440     command "bundle#{new_resource.ruby} exec rake i18n:js:export"
 441     environment "HOME" => rails_directory,
 442                 "RAILS_ENV" => "production"
 443     cwd rails_directory
 444     user new_resource.user
 445     group new_resource.group
 446     subscribes :run, "git[#{rails_directory}]"
 447     only_if { new_resource.build_assets }
 448   end
 449
 450   execute "#{rails_directory}/public/assets" do
 451     action :nothing
 452     command "bundle#{new_resource.ruby} exec rake assets:precompile"
 453     environment "HOME" => rails_directory,
 454                 "RAILS_ENV" => "production"
 455     cwd rails_directory
 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, "file[#{rails_directory}/config/piwik.yml]"
 463     subscribes :run, "execute[#{rails_directory}/package.json]"
 464     subscribes :run, "execute[#{rails_directory}/app/assets/javascripts/i18n]"
 465     only_if { new_resource.build_assets }
 466   end
 467
 468   file "#{rails_directory}/public/export/embed.html" do
 469     action :nothing
 470     subscribes :delete, "git[#{rails_directory}]"
 471     subscribes :delete, "file[#{rails_directory}/config/settings.local.yml]"
 472   end
 473
 474   passenger_application rails_directory do
 475     action :nothing
 476     subscribes :restart, "git[#{rails_directory}]"
 477     subscribes :restart, "file[#{rails_directory}/config/database.yml]"
 478     subscribes :restart, "file[create:#{rails_directory}/config/application.yml]"
 479     subscribes :restart, "file[#{rails_directory}/config/settings.local.yml]"
 480     subscribes :restart, "file[#{rails_directory}/config/storage.yml]"
 481     subscribes :restart, "file[#{rails_directory}/config/piwik.yml]"
 482     subscribes :restart, "execute[#{rails_directory}/Gemfile]"
 483     subscribes :restart, "execute[#{rails_directory}/db/migrate]"
 484     subscribes :restart, "execute[#{rails_directory}/package.json]"
 485     subscribes :restart, "execute[#{rails_directory}/app/assets/javascripts/i18n]"
 486     subscribes :restart, "execute[#{rails_directory}/public/assets]"
 487     only_if { ::File.exist?("/usr/bin/passenger-config") }
 488   end
 489
 490   template "/etc/cron.daily/rails-#{new_resource.site.tr('.', '-')}" do
 491     cookbook "web"
 492     source "rails.cron.erb"
 493     owner "root"
 494     group "root"
 495     mode "755"
 496     variables :directory => rails_directory
 497   end
 498 end
 499
 500 action :restart do
 501   passenger_application rails_directory do
 502     action :restart
 503   end
 504 end
 505
 506 action_class do
 507   include Chef::Mixin::EditFile
 508
 509   def rails_directory
 510     new_resource.directory || "/srv/#{new_resource.site}"
 511   end
 512 end