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