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