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             :pool_size => node[:nominatim][:api_pool_size]
 263 end
 264
 265 remote_file "#{project_directory}/wikimedia-importance.sql.gz" do
 266   action :create_if_missing
 267   source "https://nominatim.org/data/wikimedia-importance.sql.gz"
 268   owner "nominatim"
 269   group "nominatim"
 270   mode "644"
 271 end
 272
 273 %w[gb_postcodes.csv.gz us_postcodes.csv.gz].each do |fname|
 274   remote_file "#{project_directory}/#{fname}" do
 275     action :create
 276     source "https://nominatim.org/data/#{fname}"
 277     owner "nominatim"
 278     group "nominatim"
 279     mode "644"
 280   end
 281 end
 282
 283 # Webserver + frontend
 284
 285 %w[user_agent referrer email generic].each do |name|
 286   file "#{cfg_directory}/nginx_blocked_#{name}.conf" do
 287     action :create_if_missing
 288     owner "nominatim"
 289     group "adm"
 290     mode "664"
 291   end
 292 end
 293
 294 if node[:nominatim][:api_flavour] == "php"
 295   node[:nominatim][:fpm_pools].each do |name, data|
 296     php_fpm name do
 297       port data[:port]
 298       pm data[:pm]
 299       pm_max_children data[:max_children]
 300       pm_start_servers 20
 301       pm_min_spare_servers 10
 302       pm_max_spare_servers 20
 303       pm_max_requests 10000
 304       prometheus_port data[:prometheus_port]
 305     end
 306   end
 307 elsif node[:nominatim][:api_flavour] == "python"
 308   systemd_service "nominatim" do
 309     description "Nominatim running as a gunicorn application"
 310     user "www-data"
 311     group "www-data"
 312     working_directory project_directory
 313     standard_output "append:#{node[:nominatim][:logdir]}/gunicorn.log"
 314     standard_error "inherit"
 315     exec_start "/usr/bin/gunicorn -b unix:/run/gunicorn-nominatim.openstreetmap.org.sock -w #{node[:nominatim][:api_workers]} -k uvicorn.workers.UvicornWorker nominatim.server.starlette.server:run_wsgi"
 316     exec_reload "/bin/kill -s HUP $MAINPID"
 317     environment :PYTHONPATH => "/usr/local/lib/nominatim/lib-python/"
 318     kill_mode "mixed"
 319     timeout_stop_sec 5
 320     private_tmp true
 321     requires "nominatim.socket"
 322     after "network.target"
 323   end
 324
 325   systemd_socket "nominatim" do
 326     description "Gunicorn socket for Nominatim"
 327     listen_stream "/run/gunicorn-nominatim.openstreetmap.org.sock"
 328     socket_user "www-data"
 329   end
 330 end
 331
 332 ssl_certificate node[:fqdn] do
 333   domains [node[:fqdn],
 334            "nominatim.openstreetmap.org",
 335            "nominatim.osm.org",
 336            "nominatim.openstreetmap.com",
 337            "nominatim.openstreetmap.net",
 338            "nominatim.openstreetmaps.org",
 339            "nominatim.openmaps.org",
 340            "nominatim.qgis.org"]
 341   notifies :reload, "service[nginx]"
 342 end
 343
 344 include_recipe "nginx"
 345
 346 nginx_site "default" do
 347   action [:delete]
 348 end
 349
 350 frontends = search(:node, "recipes:web\\:\\:frontend").sort_by(&:name)
 351
 352 nginx_site "nominatim" do
 353   template "nginx.erb"
 354   directory project_directory
 355   variables :pools => node[:nominatim][:fpm_pools],
 356             :frontends => frontends,
 357             :confdir => "#{basedir}/etc",
 358             :ui_directory => ui_directory
 359 end
 360
 361 template "/etc/logrotate.d/nginx" do
 362   source "logrotate.nginx.erb"
 363   owner "root"
 364   group "root"
 365   mode "644"
 366 end
 367
 368 # Updates
 369
 370 %w[nominatim-update
 371    nominatim-update-source
 372    nominatim-update-refresh-db
 373    nominatim-update-data
 374    nominatim-daily-maintenance].each do |fname|
 375   template "#{bin_directory}/#{fname}" do
 376     source "#{fname}.erb"
 377     owner "nominatim"
 378     group "nominatim"
 379     mode "554"
 380     variables :bindir => bin_directory,
 381               :srcdir => source_directory,
 382               :builddir => build_directory,
 383               :projectdir => project_directory,
 384               :qabindir => qa_bin_directory,
 385               :qadatadir => qa_data_directory
 386   end
 387 end
 388
 389 systemd_service "nominatim-update" do
 390   description "Update the Nominatim database"
 391   exec_start "#{bin_directory}/nominatim-update"
 392   restart "on-success"
 393   standard_output "append:#{node[:nominatim][:logdir]}/update.log"
 394   standard_error "inherit"
 395   working_directory project_directory
 396 end
 397
 398 systemd_service "nominatim-update-maintenance-trigger" do
 399   description "Trigger daily maintenance tasks for Nominatim DB"
 400   exec_start "ln -sf #{bin_directory}/nominatim-daily-maintenance #{bin_directory}/maintenance/"
 401   user "nominatim"
 402 end
 403
 404 systemd_timer "nominatim-update-maintenance-trigger" do
 405   action node[:nominatim][:state] != "off" ? :create : :delete
 406   description "Schedule daily maintenance tasks for Nominatim DB"
 407   on_calendar "*-*-* 02:03:00 UTC"
 408 end
 409
 410 service "nominatim-update-maintenance-trigger" do
 411   action node[:nominatim][:state] != "off" ? :enable : :disable
 412 end
 413
 414 # Nominatim UI
 415
 416 git ui_directory do
 417   action :sync
 418   repository node[:nominatim][:ui_repository]
 419   revision node[:nominatim][:ui_revision]
 420   user "nominatim"
 421   group "nominatim"
 422 end
 423
 424 template "#{ui_directory}/dist/theme/config.theme.js" do
 425   source "ui-config.js.erb"
 426   owner "nominatim"
 427   group "nominatim"
 428   mode "664"
 429 end
 430
 431 # Nominatim QA
 432
 433 if node[:nominatim][:enable_qa_tiles]
 434   package "python3-geojson"
 435
 436   git qa_bin_directory do
 437     repository node[:nominatim][:qa_repository]
 438     revision node[:nominatim][:qa_revision]
 439     enable_submodules true
 440     user "nominatim"
 441     group "nominatim"
 442     notifies :run, "execute[compile_qa]"
 443   end
 444
 445   execute "compile_qa" do
 446     action :nothing
 447     user "nominatim"
 448     cwd "#{qa_bin_directory}/clustering-vt"
 449     command "make"
 450   end
 451
 452   directory qa_data_directory do
 453     owner "nominatim"
 454     group "nominatim"
 455     mode "755"
 456     recursive true
 457   end
 458
 459   template "#{qa_bin_directory}/analyser/config/config.yaml" do
 460     source "qa_config.erb"
 461     owner "nominatim"
 462     group "nominatim"
 463     mode "755"
 464     variables :outputdir => "#{qa_data_directory}/new"
 465   end
 466
 467   ssl_certificate "qa-tile.nominatim.openstreetmap.org" do
 468     domains ["qa-tile.nominatim.openstreetmap.org"]
 469     notifies :reload, "service[nginx]"
 470   end
 471
 472   nginx_site "qa-tiles.nominatim" do
 473     template "nginx-qa-tiles.erb"
 474     directory build_directory
 475     variables :qa_data_directory => qa_data_directory
 476   end
 477
 478 end
 479
 480 # Replication
 481
 482 cron_d "nominatim-clean-db" do
 483   action node[:nominatim][:state] == "master" ? :create : :delete
 484   minute "5"
 485   hour "*/4"
 486   user "postgres"
 487   command "#{bin_directory}/clean-db-nominatim"
 488   mailto email_errors
 489 end
 490
 491 if node[:nominatim][:state] == "master"
 492   postgresql_user "replication" do
 493     cluster node[:nominatim][:dbcluster]
 494     password data_bag_item("nominatim", "passwords")["replication"]
 495     replication true
 496   end
 497
 498   directory node[:rsyncd][:modules][:archive][:path] do
 499     owner "postgres"
 500     group "postgres"
 501     mode "700"
 502   end
 503
 504   template "#{bin_directory}/clean-db-nominatim" do
 505     source "clean-db-nominatim.erb"
 506     owner "nominatim"
 507     group "nominatim"
 508     mode "755"
 509     variables :archive_dir => node[:rsyncd][:modules][:archive][:path],
 510               :update_stop_file => "#{basedir}/status/updates_disabled",
 511               :streaming_clients => search(:node, "nominatim_state:slave").map { |slave| slave[:fqdn] }.join(" ")
 512   end
 513 end
 514
 515 # Maintenance
 516
 517 cron_d "nominatim-backup" do
 518   action (node[:nominatim][:enable_backup] && node[:nominatim][:state] != "off") ? :create : :delete
 519   minute "0"
 520   hour "3"
 521   day "1"
 522   user "nominatim"
 523   command "#{bin_directory}/backup-nominatim"
 524   mailto email_errors
 525 end
 526
 527 cron_d "nominatim-vacuum-db" do
 528   action node[:nominatim][:state] != "off" ? :create : :delete
 529   minute "20"
 530   hour "0"
 531   user "postgres"
 532   command "#{bin_directory}/vacuum-db-nominatim"
 533   mailto email_errors
 534 end
 535
 536 %w[backup-nominatim vacuum-db-nominatim].each do |fname|
 537   template "#{bin_directory}/#{fname}" do
 538     source "#{fname}.erb"
 539     owner "nominatim"
 540     group "nominatim"
 541     mode "755"
 542     variables :db => node[:nominatim][:dbname]
 543   end
 544 end
 545
 546 # Logging
 547
 548 template "/etc/logrotate.d/nominatim" do
 549   source "logrotate.nominatim.erb"
 550   owner "root"
 551   group "root"
 552   mode "644"
 553 end
 554
 555 # Monitoring
 556
 557 munin_plugin_conf "nominatim" do
 558   template "munin.erb"
 559   variables :db => node[:nominatim][:dbname],
 560             :querylog => "#{node[:nominatim][:logdir]}/query.log"
 561 end
 562
 563 munin_plugin "nominatim_importlag" do
 564   target "#{source_directory}/munin/nominatim_importlag"
 565 end
 566
 567 munin_plugin "nominatim_query_speed" do
 568   target "#{source_directory}/munin/nominatim_query_speed_querylog"
 569 end
 570
 571 munin_plugin "nominatim_requests" do
 572   target "#{source_directory}/munin/nominatim_requests_querylog"
 573 end
 574
 575 prometheus_exporter "nominatim" do
 576   port 8082
 577   user "www-data"
 578   restrict_address_families "AF_UNIX"
 579   options [
 580     "--nominatim.query-log=#{node[:nominatim][:logdir]}/query.log",
 581     "--nominatim.database-name=#{node[:nominatim][:dbname]}"
 582   ]
 583 end
 584
 585 include_recipe "fail2ban"
 586
 587 frontend_addresses = frontends.collect { |f| f.ipaddresses(:role => :external) }
 588
 589 fail2ban_jail "nominatim_limit_req" do
 590   filter "nginx-limit-req"
 591   logpath "#{node[:nominatim][:logdir]}/nominatim.openstreetmap.org-error.log"
 592   ports [80, 443]
 593   maxretry 20
 594   ignoreips frontend_addresses.flatten.sort
 595 end