cookbooks/nominatim/recipes/default.rb

   1 #
   2 # Cookbook:: nominatim
   3 # Recipe:: base
   4 #
   5 # Copyright:: 2015, 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 include_recipe "accounts"
  21 include_recipe "munin"
  22 include_recipe "php::fpm"
  23
  24 basedir = data_bag_item("accounts", "nominatim")["home"]
  25 email_errors = data_bag_item("accounts", "lonvia")["email"]
  26
  27 directory basedir do
  28   owner "nominatim"
  29   group "nominatim"
  30   mode "755"
  31   recursive true
  32 end
  33
  34 directory node[:nominatim][:logdir] do
  35   owner "nominatim"
  36   group "nominatim"
  37   mode "755"
  38   recursive true
  39 end
  40
  41 file "#{node[:nominatim][:logdir]}/query.log" do
  42   action :create_if_missing
  43   owner "www-data"
  44   group "adm"
  45   mode "664"
  46 end
  47
  48 file "#{node[:nominatim][:logdir]}/update.log" do
  49   action :create_if_missing
  50   owner "nominatim"
  51   group "adm"
  52   mode "664"
  53 end
  54
  55 # exception granted for a limited time so that they can set up their own server
  56 firewall_rule "increase-limits-gnome-proxy" do
  57   action :accept
  58   family "inet"
  59   source "net:8.43.85.23"
  60   dest "fw"
  61   proto "tcp:syn"
  62   dest_ports "https"
  63   rate_limit "s:10/sec:30"
  64 end
  65
  66 ## Postgresql
  67
  68 include_recipe "postgresql"
  69
  70 postgresql_version = node[:nominatim][:dbcluster].split("/").first
  71 postgis_version = node[:nominatim][:postgis]
  72
  73 package "postgresql-#{postgresql_version}-postgis-#{postgis_version}"
  74
  75 node[:nominatim][:dbadmins].each do |user|
  76   postgresql_user user do
  77     cluster node[:nominatim][:dbcluster]
  78     superuser true
  79     only_if { node[:nominatim][:state] != "slave" }
  80   end
  81 end
  82
  83 postgresql_user "nominatim" do
  84   cluster node[:nominatim][:dbcluster]
  85   superuser true
  86   only_if { node[:nominatim][:state] != "slave" }
  87 end
  88
  89 postgresql_user "www-data" do
  90   cluster node[:nominatim][:dbcluster]
  91   only_if { node[:nominatim][:state] != "slave" }
  92 end
  93
  94 postgresql_munin "nominatim" do
  95   cluster node[:nominatim][:dbcluster]
  96   database node[:nominatim][:dbname]
  97 end
  98
  99 directory "#{basedir}/tablespaces" do
 100   owner "postgres"
 101   group "postgres"
 102   mode "700"
 103 end
 104
 105 # NOTE: tablespaces must be exactly in the same location on each
 106 #       Nominatim instance when replication is in use. Therefore
 107 #       use symlinks to canonical directory locations.
 108 node[:nominatim][:tablespaces].each do |name, location|
 109   directory location do
 110     owner "postgres"
 111     group "postgres"
 112     mode "700"
 113     recursive true
 114   end
 115
 116   link "#{basedir}/tablespaces/#{name}" do
 117     to location
 118   end
 119
 120   postgresql_tablespace name do
 121     cluster node[:nominatim][:dbcluster]
 122     location "#{basedir}/tablespaces/#{name}"
 123   end
 124 end
 125
 126 if node[:nominatim][:state] == "master"
 127   postgresql_user "replication" do
 128     cluster node[:nominatim][:dbcluster]
 129     password data_bag_item("nominatim", "passwords")["replication"]
 130     replication true
 131   end
 132
 133   directory node[:rsyncd][:modules][:archive][:path] do
 134     owner "postgres"
 135     group "postgres"
 136     mode "700"
 137   end
 138
 139   template "/usr/local/bin/clean-db-nominatim" do
 140     source "clean-db-nominatim.erb"
 141     owner "root"
 142     group "root"
 143     mode "755"
 144     variables :archive_dir => node[:rsyncd][:modules][:archive][:path],
 145               :update_stop_file => "#{basedir}/status/updates_disabled",
 146               :streaming_clients => search(:node, "nominatim_state:slave").map { |slave| slave[:fqdn] }.join(" ")
 147   end
 148 end
 149
 150 ## Nominatim backend
 151
 152 include_recipe "git"
 153
 154 package %w[
 155   build-essential
 156   cmake
 157   g++
 158   libboost-dev
 159   libboost-system-dev
 160   libboost-filesystem-dev
 161   libexpat1-dev
 162   zlib1g-dev
 163   libxml2-dev
 164   libbz2-dev
 165   libpq-dev
 166   libgeos++-dev
 167   libproj-dev
 168   python3-pyosmium
 169   pyosmium
 170   python3-psycopg2
 171   python3-dotenv
 172   python3-psutil
 173   python3-jinja2
 174   python3-icu
 175   php-pgsql
 176   php-intl
 177   php-symfony-dotenv
 178 ]
 179
 180 source_directory = "#{basedir}/nominatim"
 181 build_directory = "#{basedir}/bin"
 182 ui_directory = "#{basedir}/ui"
 183 qa_bin_directory = "#{basedir}/Nominatim-Data-Analyser"
 184 qa_data_directory = "#{basedir}/qa-data"
 185
 186 directory build_directory do
 187   owner "nominatim"
 188   group "nominatim"
 189   mode "755"
 190   recursive true
 191 end
 192
 193 # Normally syncing via chef is a bad idea because syncing might involve
 194 # an update of database functions which should not be done while an update
 195 # is ongoing. Therefore we sync in between update cycles. There is an
 196 # exception for slaves: they get DB function updates from the master, so
 197 # only the source code needs to be updated, which chef may do.
 198 git source_directory do
 199   action node[:nominatim][:state] == "slave" ? :sync : :checkout
 200   repository node[:nominatim][:repository]
 201   revision node[:nominatim][:revision]
 202   enable_submodules true
 203   user "nominatim"
 204   group "nominatim"
 205   not_if { node[:nominatim][:state] != "slave" && File.exist?("#{source_directory}/README.md") }
 206   notifies :run, "execute[compile_nominatim]"
 207 end
 208
 209 remote_file "#{source_directory}/data/country_osm_grid.sql.gz" do
 210   action :create_if_missing
 211   source "https://www.nominatim.org/data/country_grid.sql.gz"
 212   owner "nominatim"
 213   group "nominatim"
 214   mode "644"
 215 end
 216
 217 execute "compile_nominatim" do
 218   action :nothing
 219   user "nominatim"
 220   cwd build_directory
 221   command "cmake #{source_directory} && make"
 222 end
 223
 224 template "#{source_directory}/.git/hooks/post-merge" do
 225   source "git-post-merge-hook.erb"
 226   owner "nominatim"
 227   group "nominatim"
 228   mode "755"
 229   variables :srcdir => source_directory,
 230             :builddir => build_directory,
 231             :dbname => node[:nominatim][:dbname]
 232 end
 233
 234 template "#{build_directory}/.env" do
 235   source "nominatim.env.erb"
 236   owner "nominatim"
 237   group "nominatim"
 238   mode "664"
 239   variables :base_url => node[:nominatim][:state] == "off" ? node[:fqdn] : "nominatim.openstreetmap.org",
 240             :dbname => node[:nominatim][:dbname],
 241             :flatnode_file => node[:nominatim][:flatnode_file],
 242             :log_file => "#{node[:nominatim][:logdir]}/query.log",
 243             :tokenizer => node[:nominatim][:config][:tokenizer]
 244 end
 245
 246 git ui_directory do
 247   action :sync
 248   repository node[:nominatim][:ui_repository]
 249   revision node[:nominatim][:ui_revision]
 250   user "nominatim"
 251   group "nominatim"
 252 end
 253
 254 template "#{ui_directory}/dist/theme/config.theme.js" do
 255   source "ui-config.js.erb"
 256   owner "nominatim"
 257   group "nominatim"
 258   mode "664"
 259 end
 260
 261 if node[:nominatim][:flatnode_file]
 262   directory File.dirname(node[:nominatim][:flatnode_file]) do
 263     recursive true
 264   end
 265 end
 266
 267 template "/etc/logrotate.d/nominatim" do
 268   source "logrotate.nominatim.erb"
 269   owner "root"
 270   group "root"
 271   mode "644"
 272 end
 273
 274 external_data = [
 275   "wikimedia-importance.sql.gz",
 276   "gb_postcodes.csv.gz",
 277   "us_postcodes.csv.gz"
 278 ]
 279
 280 external_data.each do |fname|
 281   remote_file "#{build_directory}/#{fname}" do
 282     action :create_if_missing
 283     source "https://www.nominatim.org/data/#{fname}"
 284     owner "nominatim"
 285     group "nominatim"
 286     mode "644"
 287   end
 288 end
 289
 290 if node[:nominatim][:state] == "off"
 291   cron_d "nominatim-backup" do
 292     action :delete
 293   end
 294
 295   cron_d "nominatim-vacuum-db" do
 296     action :delete
 297   end
 298
 299   cron_d "nominatim-clean-db" do
 300     action :delete
 301   end
 302
 303   cron_d "nominatim-update-maintenance-trigger" do
 304     action :delete
 305   end
 306 else
 307   cron_d "nominatim-backup" do
 308     action node[:nominatim][:enable_backup] ? :create : :delete
 309     minute "0"
 310     hour "3"
 311     day "1"
 312     user "nominatim"
 313     command "/usr/local/bin/backup-nominatim"
 314     mailto email_errors
 315   end
 316
 317   cron_d "nominatim-vacuum-db" do
 318     minute "20"
 319     hour "0"
 320     user "postgres"
 321     command "/usr/local/bin/vacuum-db-nominatim"
 322     mailto email_errors
 323   end
 324
 325   cron_d "nominatim-clean-db" do
 326     action node[:nominatim][:state] == "master" ? :create : :delete
 327     minute "5"
 328     hour "*/4"
 329     user "postgres"
 330     command "/usr/local/bin/clean-db-nominatim"
 331     mailto email_errors
 332   end
 333
 334   cron_d "nominatim-update-maintenance-trigger" do
 335     minute "18"
 336     hour "1"
 337     user "nominatim"
 338     command "touch #{basedir}/status/update_maintenance"
 339     mailto email_errors
 340   end
 341 end
 342
 343 template "#{source_directory}/utils/nominatim-update" do
 344   source "updater.erb"
 345   user "nominatim"
 346   group "nominatim"
 347   mode "755"
 348   variables :bindir => build_directory,
 349             :srcdir => source_directory,
 350             :logfile => "#{node[:nominatim][:logdir]}/update.log",
 351             :branch => node[:nominatim][:revision],
 352             :update_stop_file => "#{basedir}/status/updates_disabled",
 353             :update_maintenance_trigger => "#{basedir}/status/update_maintenance",
 354             :qabindir => qa_bin_directory,
 355             :qadatadir => qa_data_directory
 356 end
 357
 358 template "/etc/init.d/nominatim-update" do
 359   source "updater.init.erb"
 360   user "nominatim"
 361   group "nominatim"
 362   mode "755"
 363   variables :source_directory => source_directory
 364 end
 365
 366 %w[backup-nominatim vacuum-db-nominatim].each do |fname|
 367   template "/usr/local/bin/#{fname}" do
 368     source "#{fname}.erb"
 369     owner "root"
 370     group "root"
 371     mode "755"
 372     variables :db => node[:nominatim][:dbname]
 373   end
 374 end
 375
 376 ## webserver frontend
 377
 378 directory "#{basedir}/etc" do
 379   owner "nominatim"
 380   group "adm"
 381   mode "775"
 382 end
 383
 384 %w[user_agent referrer email generic].each do |name|
 385   file "#{basedir}/etc/nginx_blocked_#{name}.conf" do
 386     action :create_if_missing
 387     owner "nominatim"
 388     group "adm"
 389     mode "664"
 390   end
 391 end
 392
 393 node[:nominatim][:fpm_pools].each do |name, data|
 394   php_fpm name do
 395     port data[:port]
 396     pm data[:pm]
 397     pm_max_children data[:max_children]
 398     pm_start_servers 20
 399     pm_min_spare_servers 10
 400     pm_max_spare_servers 20
 401     pm_max_requests 10000
 402     prometheus_port data[:prometheus_port]
 403   end
 404 end
 405
 406 ssl_certificate node[:fqdn] do
 407   domains [node[:fqdn],
 408            "nominatim.openstreetmap.org",
 409            "nominatim.osm.org",
 410            "nominatim.openstreetmap.com",
 411            "nominatim.openstreetmap.net",
 412            "nominatim.openstreetmaps.org",
 413            "nominatim.openmaps.org",
 414            "nominatim.qgis.org"]
 415   notifies :reload, "service[nginx]"
 416 end
 417
 418 package "apache2" do
 419   action :remove
 420 end
 421
 422 include_recipe "nginx"
 423
 424 nginx_site "default" do
 425   action [:delete]
 426 end
 427
 428 frontends = search(:node, "recipes:web\\:\\:frontend").sort_by(&:name)
 429
 430 nginx_site "nominatim" do
 431   template "nginx.erb"
 432   directory build_directory
 433   variables :pools => node[:nominatim][:fpm_pools],
 434             :frontends => frontends,
 435             :confdir => "#{basedir}/etc",
 436             :ui_directory => ui_directory
 437 end
 438
 439 template "/etc/logrotate.d/nginx" do
 440   source "logrotate.nginx.erb"
 441   owner "root"
 442   group "root"
 443   mode "644"
 444 end
 445
 446 munin_plugin_conf "nominatim" do
 447   template "munin.erb"
 448   variables :db => node[:nominatim][:dbname],
 449             :querylog => "#{node[:nominatim][:logdir]}/query.log"
 450 end
 451
 452 munin_plugin "nominatim_importlag" do
 453   target "#{source_directory}/munin/nominatim_importlag"
 454 end
 455
 456 munin_plugin "nominatim_query_speed" do
 457   target "#{source_directory}/munin/nominatim_query_speed_querylog"
 458 end
 459
 460 munin_plugin "nominatim_requests" do
 461   target "#{source_directory}/munin/nominatim_requests_querylog"
 462 end
 463
 464 directory "#{basedir}/status" do
 465   owner "nominatim"
 466   group "postgres"
 467   mode "775"
 468 end
 469
 470 include_recipe "fail2ban"
 471
 472 frontend_addresses = frontends.collect { |f| f.ipaddresses(:role => :external) }
 473
 474 fail2ban_jail "nominatim_limit_req" do
 475   filter "nginx-limit-req"
 476   logpath "#{node[:nominatim][:logdir]}/nominatim.openstreetmap.org-error.log"
 477   ports [80, 443]
 478   maxretry 20
 479   ignoreips frontend_addresses.flatten.sort
 480 end
 481
 482 ### QA tile generation
 483
 484 if node[:nominatim][:enable_qa_tiles]
 485   git qa_bin_directory do
 486     repository node[:nominatim][:qa_repository]
 487     revision node[:nominatim][:qa_revision]
 488     enable_submodules true
 489     user "nominatim"
 490     group "nominatim"
 491     notifies :run, "execute[compile_qa]"
 492   end
 493
 494   execute "compile_qa" do
 495     action :nothing
 496     user "nominatim"
 497     cwd "#{qa_bin_directory}/clustering-vt"
 498     command "make"
 499   end
 500
 501   directory qa_data_directory do
 502     owner "nominatim"
 503     group "nominatim"
 504     mode "755"
 505     recursive true
 506   end
 507
 508   template "#{qa_bin_directory}/analyser/config/config.yaml" do
 509     source "qa_config.erb"
 510     owner "nominatim"
 511     group "nominatim"
 512     mode "755"
 513     variables :outputdir => "#{qa_data_directory}/new"
 514   end
 515
 516   link "#{build_directory}/website/qa-data" do
 517     to "#{qa_data_directory}/current"
 518     owner "nominatim"
 519     group "nominatim"
 520   end
 521 end