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