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