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 "prometheus"
  23
  24 if node[:nominatim][:api_flavour] == "php"
  25   include_recipe "php::fpm"
  26 end
  27
  28 basedir = data_bag_item("accounts", "nominatim")["home"]
  29 email_errors = data_bag_item("accounts", "lonvia")["email"]
  30
  31 directory basedir do
  32   owner "nominatim"
  33   group "nominatim"
  34   mode "755"
  35   recursive true
  36 end
  37
  38 ## Log directory setup
  39
  40 directory node[:nominatim][:logdir] do
  41   owner "nominatim"
  42   group "nominatim"
  43   mode "755"
  44   recursive true
  45 end
  46
  47 file "#{node[:nominatim][:logdir]}/query.log" do
  48   action :create_if_missing
  49   owner "www-data"
  50   group "adm"
  51   mode "664"
  52 end
  53
  54 file "#{node[:nominatim][:logdir]}/update.log" do
  55   action :create_if_missing
  56   owner "nominatim"
  57   group "adm"
  58   mode "664"
  59 end
  60
  61 ## Postgresql
  62
  63 include_recipe "postgresql"
  64
  65 postgresql_version = node[:nominatim][:dbcluster].split("/").first
  66 postgis_version = node[:nominatim][:postgis]
  67
  68 package "postgresql-#{postgresql_version}-postgis-#{postgis_version}"
  69
  70 node[:nominatim][:dbadmins].each do |user|
  71   postgresql_user user do
  72     cluster node[:nominatim][:dbcluster]
  73     superuser true
  74     only_if { node[:nominatim][:state] != "slave" }
  75   end
  76 end
  77
  78 postgresql_user "nominatim" do
  79   cluster node[:nominatim][:dbcluster]
  80   superuser true
  81   only_if { node[:nominatim][:state] != "slave" }
  82 end
  83
  84 postgresql_user "www-data" do
  85   cluster node[:nominatim][:dbcluster]
  86   only_if { node[:nominatim][:state] != "slave" }
  87 end
  88
  89 postgresql_munin "nominatim" do
  90   cluster node[:nominatim][:dbcluster]
  91   database node[:nominatim][:dbname]
  92 end
  93
  94 directory "#{basedir}/tablespaces" do
  95   owner "postgres"
  96   group "postgres"
  97   mode "700"
  98 end
  99
 100 # NOTE: tablespaces must be exactly in the same location on each
 101 #       Nominatim instance when replication is in use. Therefore
 102 #       use symlinks to canonical directory locations.
 103 node[:nominatim][:tablespaces].each do |name, location|
 104   directory location do
 105     owner "postgres"
 106     group "postgres"
 107     mode "700"
 108     recursive true
 109   end
 110
 111   link "#{basedir}/tablespaces/#{name}" do
 112     to location
 113   end
 114
 115   postgresql_tablespace name do
 116     cluster node[:nominatim][:dbcluster]
 117     location "#{basedir}/tablespaces/#{name}"
 118   end
 119 end
 120
 121 ## Nominatim backend
 122
 123 include_recipe "git"
 124
 125 package %w[
 126   build-essential
 127   cmake
 128   g++
 129   libboost-dev
 130   libboost-system-dev
 131   libboost-filesystem-dev
 132   libexpat1-dev
 133   zlib1g-dev
 134   libbz2-dev
 135   libpq-dev
 136   libproj-dev
 137   liblua5.3-dev
 138   libluajit-5.1-dev
 139   lua5.3
 140   python3-pyosmium
 141   python3-psycopg2
 142   python3-dotenv
 143   python3-psutil
 144   python3-jinja2
 145   python3-icu
 146   python3-datrie
 147   python3-yaml
 148   python3-sqlalchemy-ext
 149   python3-geoalchemy2
 150   python3-asyncpg
 151   ruby
 152   ruby-file-tail
 153   ruby-pg
 154   ruby-webrick
 155 ]
 156
 157 if node[:nominatim][:api_flavour] == "php"
 158   package %w[
 159     php-pgsql
 160     php-intl
 161   ]
 162 elsif node[:nominatim][:api_flavour] == "python"
 163   package %w[
 164     gunicorn
 165     uvicorn
 166     python3-starlette
 167   ]
 168 end
 169
 170 source_directory = "#{basedir}/src/nominatim"
 171 build_directory = "#{basedir}/src/build"
 172 project_directory = "#{basedir}/planet-project"
 173 bin_directory = "#{basedir}/bin"
 174 cfg_directory = "#{basedir}/etc"
 175 ui_directory = "#{basedir}/ui"
 176 qa_bin_directory = "#{basedir}/src/Nominatim-Data-Analyser"
 177 qa_data_directory = "#{basedir}/qa-data"
 178
 179 [basedir, "#{basedir}/src", cfg_directory, bin_directory, build_directory, project_directory].each do |path|
 180   directory path do
 181     owner "nominatim"
 182     group "nominatim"
 183     mode "755"
 184     recursive true
 185   end
 186 end
 187
 188 directory "#{bin_directory}/maintenance" do
 189   owner "nominatim"
 190   group "nominatim"
 191   mode "775"
 192 end
 193
 194 if node[:nominatim][:flatnode_file]
 195   directory File.dirname(node[:nominatim][:flatnode_file]) do
 196     recursive true
 197   end
 198 end
 199
 200 remote_directory "#{project_directory}/static-website" do
 201   source "website"
 202   owner "nominatim"
 203   group "nominatim"
 204   mode "755"
 205   files_owner "nominatim"
 206   files_group "nominatim"
 207   files_mode "644"
 208   purge false
 209 end
 210
 211 # Normally syncing via chef is a bad idea because syncing might involve
 212 # an update of database functions which should not be done while an update
 213 # is ongoing. Therefore we sync in between update cycles. There is an
 214 # exception for slaves: they get DB function updates from the master, so
 215 # only the source code needs to be updated, which chef may do.
 216 git source_directory do
 217   action node[:nominatim][:state] == "slave" ? :sync : :checkout
 218   repository node[:nominatim][:repository]
 219   revision node[:nominatim][:revision]
 220   enable_submodules true
 221   user "nominatim"
 222   group "nominatim"
 223   not_if { node[:nominatim][:state] != "slave" && File.exist?("#{source_directory}/README.md") }
 224   notifies :run, "execute[compile_nominatim]"
 225 end
 226
 227 remote_file "#{source_directory}/data/country_osm_grid.sql.gz" do
 228   action :create_if_missing
 229   source "https://nominatim.org/data/country_grid.sql.gz"
 230   owner "nominatim"
 231   group "nominatim"
 232   mode "644"
 233 end
 234
 235 execute "compile_nominatim" do
 236   action :nothing
 237   user "nominatim"
 238   cwd build_directory
 239   command "cmake -D WITH_LUAJIT=ON #{source_directory} && make"
 240   notifies :run, "execute[install_nominatim]"
 241 end
 242
 243 execute "install_nominatim" do
 244   action :nothing
 245   cwd build_directory
 246   command "make install"
 247 end
 248
 249 # Project directory
 250
 251 template "#{project_directory}/.env" do
 252   source "nominatim.env.erb"
 253   owner "nominatim"
 254   group "nominatim"
 255   mode "664"
 256   variables :base_url => node[:nominatim][:state] == "off" ? node[:fqdn] : "nominatim.openstreetmap.org",
 257             :dbname => node[:nominatim][:dbname],
 258             :flatnode_file => node[:nominatim][:flatnode_file],
 259             :log_file => "#{node[:nominatim][:logdir]}/query.log",
 260             :tokenizer => node[:nominatim][:config][:tokenizer],
 261             :forward_dependencies => node[:nominatim][:config][:forward_dependencies]
 262 end
 263
 264 remote_file "#{project_directory}/wikimedia-importance.sql.gz" do
 265   action :create_if_missing
 266   source "https://nominatim.org/data/wikimedia-importance.sql.gz"
 267   owner "nominatim"
 268   group "nominatim"
 269   mode "644"
 270 end
 271
 272 %w[gb_postcodes.csv.gz us_postcodes.csv.gz].each do |fname|
 273   remote_file "#{project_directory}/#{fname}" do
 274     action :create
 275     source "https://nominatim.org/data/#{fname}"
 276     owner "nominatim"
 277     group "nominatim"
 278     mode "644"
 279   end
 280 end
 281
 282 # Webserver + frontend
 283
 284 %w[user_agent referrer email generic].each do |name|
 285   file "#{cfg_directory}/nginx_blocked_#{name}.conf" do
 286     action :create_if_missing
 287     owner "nominatim"
 288     group "adm"
 289     mode "664"
 290   end
 291 end
 292
 293 if node[:nominatim][:api_flavour] == "php"
 294   node[:nominatim][:fpm_pools].each do |name, data|
 295     php_fpm name do
 296       port data[:port]
 297       pm data[:pm]
 298       pm_max_children data[:max_children]
 299       pm_start_servers 20
 300       pm_min_spare_servers 10
 301       pm_max_spare_servers 20
 302       pm_max_requests 10000
 303       prometheus_port data[:prometheus_port]
 304     end
 305   end
 306 elsif node[:nominatim][:api_flavour] == "python"
 307   systemd_service "nominatim" do
 308     description "Nominatim running as a gunicorn application"
 309     user "www-data"
 310     group "www-data"
 311     working_directory project_directory
 312     standard_output "append:#{node[:nominatim][:logdir]}/gunicorn.log"
 313     standard_error "inherit"
 314     exec_start "/usr/bin/gunicorn -b unix:/run/gunicorn-nominatim.openstreetmap.org.sock -w 10 -k uvicorn.workers.UvicornWorker nominatim.server.starlette.server:run_wsgi"
 315     exec_reload "/bin/kill -s HUP $MAINPID"
 316     environment :PYTHONPATH => "/usr/local/lib/nominatim/lib-python/"
 317     kill_mode "mixed"
 318     timeout_stop_sec 5
 319     private_tmp true
 320     requires "nominatim.socket"
 321     after "network.target"
 322   end
 323
 324   systemd_socket "nominatim" do
 325     description "Gunicorn socket for Nominatim"
 326     listen_stream "/run/gunicorn-nominatim.openstreetmap.org.sock"
 327     socket_user "www-data"
 328   end
 329 end
 330
 331 ssl_certificate node[:fqdn] do
 332   domains [node[:fqdn],
 333            "nominatim.openstreetmap.org",
 334            "nominatim.osm.org",
 335            "nominatim.openstreetmap.com",
 336            "nominatim.openstreetmap.net",
 337            "nominatim.openstreetmaps.org",
 338            "nominatim.openmaps.org",
 339            "nominatim.qgis.org"]
 340   notifies :reload, "service[nginx]"
 341 end
 342
 343 include_recipe "nginx"
 344
 345 nginx_site "default" do
 346   action [:delete]
 347 end
 348
 349 frontends = search(:node, "recipes:web\\:\\:frontend").sort_by(&:name)
 350
 351 nginx_site "nominatim" do
 352   template "nginx.erb"
 353   directory project_directory
 354   variables :pools => node[:nominatim][:fpm_pools],
 355             :frontends => frontends,
 356             :confdir => "#{basedir}/etc",
 357             :ui_directory => ui_directory
 358 end
 359
 360 template "/etc/logrotate.d/nginx" do
 361   source "logrotate.nginx.erb"
 362   owner "root"
 363   group "root"
 364   mode "644"
 365 end
 366
 367 # Updates
 368
 369 %w[nominatim-update
 370    nominatim-update-source
 371    nominatim-update-refresh-db
 372    nominatim-update-data
 373    nominatim-daily-maintenance].each do |fname|
 374   template "#{bin_directory}/#{fname}" do
 375     source "#{fname}.erb"
 376     owner "nominatim"
 377     group "nominatim"
 378     mode "554"
 379     variables :bindir => bin_directory,
 380               :srcdir => source_directory,
 381               :builddir => build_directory,
 382               :projectdir => project_directory,
 383               :qabindir => qa_bin_directory,
 384               :qadatadir => qa_data_directory
 385   end
 386 end
 387
 388 systemd_service "nominatim-update" do
 389   description "Update the Nominatim database"
 390   exec_start "#{bin_directory}/nominatim-update"
 391   restart "on-success"
 392   standard_output "append:#{node[:nominatim][:logdir]}/update.log"
 393   standard_error "inherit"
 394   working_directory project_directory
 395 end
 396
 397 systemd_service "nominatim-update-maintenance-trigger" do
 398   description "Trigger daily maintenance tasks for Nominatim DB"
 399   exec_start "ln -sf #{bin_directory}/nominatim-daily-maintenance #{bin_directory}/maintenance/"
 400   user "nominatim"
 401 end
 402
 403 systemd_timer "nominatim-update-maintenance-trigger" do
 404   action node[:nominatim][:state] != "off" ? :create : :delete
 405   description "Schedule daily maintenance tasks for Nominatim DB"
 406   on_calendar "*-*-* 02:03:00 UTC"
 407 end
 408
 409 service "nominatim-update-maintenance-trigger" do
 410   action node[:nominatim][:state] != "off" ? :enable : :disable
 411 end
 412
 413 # Nominatim UI
 414
 415 git ui_directory do
 416   action :sync
 417   repository node[:nominatim][:ui_repository]
 418   revision node[:nominatim][:ui_revision]
 419   user "nominatim"
 420   group "nominatim"
 421 end
 422
 423 template "#{ui_directory}/dist/theme/config.theme.js" do
 424   source "ui-config.js.erb"
 425   owner "nominatim"
 426   group "nominatim"
 427   mode "664"
 428 end
 429
 430 # Nominatim QA
 431
 432 if node[:nominatim][:enable_qa_tiles]
 433   package "python3-geojson"
 434
 435   git qa_bin_directory do
 436     repository node[:nominatim][:qa_repository]
 437     revision node[:nominatim][:qa_revision]
 438     enable_submodules true
 439     user "nominatim"
 440     group "nominatim"
 441     notifies :run, "execute[compile_qa]"
 442   end
 443
 444   execute "compile_qa" do
 445     action :nothing
 446     user "nominatim"
 447     cwd "#{qa_bin_directory}/clustering-vt"
 448     command "make"
 449   end
 450
 451   directory qa_data_directory do
 452     owner "nominatim"
 453     group "nominatim"
 454     mode "755"
 455     recursive true
 456   end
 457
 458   template "#{qa_bin_directory}/analyser/config/config.yaml" do
 459     source "qa_config.erb"
 460     owner "nominatim"
 461     group "nominatim"
 462     mode "755"
 463     variables :outputdir => "#{qa_data_directory}/new"
 464   end
 465
 466   ssl_certificate "qa-tile.nominatim.openstreetmap.org" do
 467     domains ["qa-tile.nominatim.openstreetmap.org"]
 468     notifies :reload, "service[nginx]"
 469   end
 470
 471   nginx_site "qa-tiles.nominatim" do
 472     template "nginx-qa-tiles.erb"
 473     directory build_directory
 474     variables :qa_data_directory => qa_data_directory
 475   end
 476
 477 end
 478
 479 # Replication
 480
 481 cron_d "nominatim-clean-db" do
 482   action node[:nominatim][:state] == "master" ? :create : :delete
 483   minute "5"
 484   hour "*/4"
 485   user "postgres"
 486   command "#{bin_directory}/clean-db-nominatim"
 487   mailto email_errors
 488 end
 489
 490 if node[:nominatim][:state] == "master"
 491   postgresql_user "replication" do
 492     cluster node[:nominatim][:dbcluster]
 493     password data_bag_item("nominatim", "passwords")["replication"]
 494     replication true
 495   end
 496
 497   directory node[:rsyncd][:modules][:archive][:path] do
 498     owner "postgres"
 499     group "postgres"
 500     mode "700"
 501   end
 502
 503   template "#{bin_directory}/clean-db-nominatim" do
 504     source "clean-db-nominatim.erb"
 505     owner "nominatim"
 506     group "nominatim"
 507     mode "755"
 508     variables :archive_dir => node[:rsyncd][:modules][:archive][:path],
 509               :update_stop_file => "#{basedir}/status/updates_disabled",
 510               :streaming_clients => search(:node, "nominatim_state:slave").map { |slave| slave[:fqdn] }.join(" ")
 511   end
 512 end
 513
 514 # Maintenance
 515
 516 cron_d "nominatim-backup" do
 517   action (node[:nominatim][:enable_backup] && node[:nominatim][:state] != "off") ? :create : :delete
 518   minute "0"
 519   hour "3"
 520   day "1"
 521   user "nominatim"
 522   command "#{bin_directory}/backup-nominatim"
 523   mailto email_errors
 524 end
 525
 526 cron_d "nominatim-vacuum-db" do
 527   action node[:nominatim][:state] != "off" ? :create : :delete
 528   minute "20"
 529   hour "0"
 530   user "postgres"
 531   command "#{bin_directory}/vacuum-db-nominatim"
 532   mailto email_errors
 533 end
 534
 535 %w[backup-nominatim vacuum-db-nominatim].each do |fname|
 536   template "#{bin_directory}/#{fname}" do
 537     source "#{fname}.erb"
 538     owner "nominatim"
 539     group "nominatim"
 540     mode "755"
 541     variables :db => node[:nominatim][:dbname]
 542   end
 543 end
 544
 545 # Logging
 546
 547 template "/etc/logrotate.d/nominatim" do
 548   source "logrotate.nominatim.erb"
 549   owner "root"
 550   group "root"
 551   mode "644"
 552 end
 553
 554 # Monitoring
 555
 556 munin_plugin_conf "nominatim" do
 557   template "munin.erb"
 558   variables :db => node[:nominatim][:dbname],
 559             :querylog => "#{node[:nominatim][:logdir]}/query.log"
 560 end
 561
 562 munin_plugin "nominatim_importlag" do
 563   target "#{source_directory}/munin/nominatim_importlag"
 564 end
 565
 566 munin_plugin "nominatim_query_speed" do
 567   target "#{source_directory}/munin/nominatim_query_speed_querylog"
 568 end
 569
 570 munin_plugin "nominatim_requests" do
 571   target "#{source_directory}/munin/nominatim_requests_querylog"
 572 end
 573
 574 prometheus_exporter "nominatim" do
 575   port 8082
 576   user "www-data"
 577   restrict_address_families "AF_UNIX"
 578   options [
 579     "--nominatim.query-log=#{node[:nominatim][:logdir]}/query.log",
 580     "--nominatim.database-name=#{node[:nominatim][:dbname]}"
 581   ]
 582 end
 583
 584 include_recipe "fail2ban"
 585
 586 frontend_addresses = frontends.collect { |f| f.ipaddresses(:role => :external) }
 587
 588 fail2ban_jail "nominatim_limit_req" do
 589   filter "nginx-limit-req"
 590   logpath "#{node[:nominatim][:logdir]}/nominatim.openstreetmap.org-error.log"
 591   ports [80, 443]
 592   maxretry 20
 593   ignoreips frontend_addresses.flatten.sort
 594 end