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