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