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.23"
 172   end
 173
 174   python_package "PyICU" do
 175     python_virtualenv python_directory
 176     version "2.12"
 177   end
 178
 179   python_package "psycopg[binary]" do
 180     python_virtualenv python_directory
 181     version "3.1.13"
 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 "0.21.0"
 192   end
 193
 194   python_package "pygments" do
 195     python_virtualenv python_directory
 196     version "2.17.2"
 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.24.0.post1"
 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 #{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             :query_timeout => node[:nominatim][:api_query_timeout],
 314             :request_timeout => node[:nominatim][:api_request_timeout]
 315 end
 316
 317 remote_file "#{project_directory}/wikimedia-importance.sql.gz" do
 318   action :create_if_missing
 319   source "https://nominatim.org/data/wikimedia-importance.sql.gz"
 320   owner "nominatim"
 321   group "nominatim"
 322   mode "644"
 323 end
 324
 325 %w[gb_postcodes.csv.gz us_postcodes.csv.gz].each do |fname|
 326   remote_file "#{project_directory}/#{fname}" do
 327     action :create
 328     source "https://nominatim.org/data/#{fname}"
 329     owner "nominatim"
 330     group "nominatim"
 331     mode "644"
 332   end
 333 end
 334
 335 # Webserver + frontend
 336
 337 %w[user_agent referrer email generic].each do |name|
 338   file "#{cfg_directory}/nginx_blocked_#{name}.conf" do
 339     action :create_if_missing
 340     owner "nominatim"
 341     group "adm"
 342     mode "664"
 343   end
 344 end
 345
 346 if node[:nominatim][:api_flavour] == "php"
 347   node[:nominatim][:fpm_pools].each do |name, data|
 348     php_fpm name do
 349       port data[:port]
 350       pm data[:pm]
 351       pm_max_children data[:max_children]
 352       pm_start_servers 20
 353       pm_min_spare_servers 10
 354       pm_max_spare_servers 20
 355       pm_max_requests 10000
 356       prometheus_port data[:prometheus_port]
 357     end
 358   end
 359 elsif node[:nominatim][:api_flavour] == "python"
 360   systemd_service "nominatim" do
 361     description "Nominatim running as a gunicorn application"
 362     user "www-data"
 363     group "www-data"
 364     working_directory project_directory
 365     standard_output "append:#{node[:nominatim][:logdir]}/gunicorn.log"
 366     standard_error "inherit"
 367     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"
 368     exec_reload "/bin/kill -s HUP $MAINPID"
 369     environment :PYTHONPATH => "/usr/local/lib/nominatim/lib-python/"
 370     kill_mode "mixed"
 371     timeout_stop_sec 5
 372     private_tmp true
 373     requires "nominatim.socket"
 374     after "network.target"
 375   end
 376
 377   systemd_socket "nominatim" do
 378     description "Gunicorn socket for Nominatim"
 379     listen_stream "/run/gunicorn-nominatim.openstreetmap.org.sock"
 380     socket_user "www-data"
 381   end
 382 end
 383
 384 ssl_certificate node[:fqdn] do
 385   domains [node[:fqdn],
 386            "nominatim.openstreetmap.org",
 387            "nominatim.osm.org",
 388            "nominatim.openstreetmap.com",
 389            "nominatim.openstreetmap.net",
 390            "nominatim.openstreetmaps.org",
 391            "nominatim.openmaps.org",
 392            "nominatim.qgis.org"]
 393   notifies :reload, "service[nginx]"
 394 end
 395
 396 include_recipe "nginx"
 397
 398 nginx_site "default" do
 399   action [:delete]
 400 end
 401
 402 frontends = search(:node, "recipes:web\\:\\:frontend").sort_by(&:name)
 403
 404 nginx_site "nominatim" do
 405   template "nginx.erb"
 406   directory project_directory
 407   variables :pools => node[:nominatim][:fpm_pools],
 408             :frontends => frontends,
 409             :confdir => "#{basedir}/etc",
 410             :ui_directory => ui_directory
 411 end
 412
 413 template "/etc/logrotate.d/nginx" do
 414   source "logrotate.nginx.erb"
 415   owner "root"
 416   group "root"
 417   mode "644"
 418 end
 419
 420 # Updates
 421
 422 %w[nominatim-update
 423    nominatim-update-source
 424    nominatim-update-refresh-db
 425    nominatim-update-data
 426    nominatim-daily-maintenance].each do |fname|
 427   template "#{bin_directory}/#{fname}" do
 428     source "#{fname}.erb"
 429     owner "nominatim"
 430     group "nominatim"
 431     mode "554"
 432     variables :bindir => bin_directory,
 433               :srcdir => source_directory,
 434               :builddir => build_directory,
 435               :projectdir => project_directory,
 436               :qabindir => qa_bin_directory,
 437               :qadatadir => qa_data_directory
 438   end
 439 end
 440
 441 systemd_service "nominatim-update" do
 442   description "Update the Nominatim database"
 443   exec_start "#{bin_directory}/nominatim-update"
 444   restart "on-success"
 445   standard_output "append:#{node[:nominatim][:logdir]}/update.log"
 446   standard_error "inherit"
 447   working_directory project_directory
 448 end
 449
 450 systemd_service "nominatim-update-maintenance-trigger" do
 451   description "Trigger daily maintenance tasks for Nominatim DB"
 452   exec_start "ln -sf #{bin_directory}/nominatim-daily-maintenance #{bin_directory}/maintenance/"
 453   user "nominatim"
 454 end
 455
 456 systemd_timer "nominatim-update-maintenance-trigger" do
 457   action node[:nominatim][:state] != "off" ? :create : :delete
 458   description "Schedule daily maintenance tasks for Nominatim DB"
 459   on_calendar "*-*-* 02:03:00 UTC"
 460 end
 461
 462 service "nominatim-update-maintenance-trigger" do
 463   action node[:nominatim][:state] != "off" ? :enable : :disable
 464 end
 465
 466 # Nominatim UI
 467
 468 git ui_directory do
 469   action :sync
 470   repository node[:nominatim][:ui_repository]
 471   revision node[:nominatim][:ui_revision]
 472   user "nominatim"
 473   group "nominatim"
 474 end
 475
 476 template "#{ui_directory}/dist/theme/config.theme.js" do
 477   source "ui-config.js.erb"
 478   owner "nominatim"
 479   group "nominatim"
 480   mode "664"
 481 end
 482
 483 # Nominatim QA
 484
 485 if node[:nominatim][:enable_qa_tiles]
 486   package "python3-geojson"
 487
 488   git qa_bin_directory do
 489     repository node[:nominatim][:qa_repository]
 490     revision node[:nominatim][:qa_revision]
 491     enable_submodules true
 492     user "nominatim"
 493     group "nominatim"
 494     notifies :run, "execute[compile_qa]"
 495   end
 496
 497   execute "compile_qa" do
 498     action :nothing
 499     user "nominatim"
 500     cwd "#{qa_bin_directory}/clustering-vt"
 501     command "make"
 502   end
 503
 504   directory qa_data_directory do
 505     owner "nominatim"
 506     group "nominatim"
 507     mode "755"
 508     recursive true
 509   end
 510
 511   template "#{qa_bin_directory}/analyser/config/config.yaml" do
 512     source "qa_config.erb"
 513     owner "nominatim"
 514     group "nominatim"
 515     mode "755"
 516     variables :outputdir => "#{qa_data_directory}/new"
 517   end
 518
 519   ssl_certificate "qa-tile.nominatim.openstreetmap.org" do
 520     domains ["qa-tile.nominatim.openstreetmap.org"]
 521     notifies :reload, "service[nginx]"
 522   end
 523
 524   nginx_site "qa-tiles.nominatim" do
 525     template "nginx-qa-tiles.erb"
 526     directory build_directory
 527     variables :qa_data_directory => qa_data_directory
 528   end
 529
 530 end
 531
 532 # Replication
 533
 534 cron_d "nominatim-clean-db" do
 535   action node[:nominatim][:state] == "master" ? :create : :delete
 536   minute "5"
 537   hour "*/4"
 538   user "postgres"
 539   command "#{bin_directory}/clean-db-nominatim"
 540   mailto email_errors
 541 end
 542
 543 if node[:nominatim][:state] == "master"
 544   postgresql_user "replication" do
 545     cluster node[:nominatim][:dbcluster]
 546     password data_bag_item("nominatim", "passwords")["replication"]
 547     replication true
 548   end
 549
 550   directory node[:rsyncd][:modules][:archive][:path] do
 551     owner "postgres"
 552     group "postgres"
 553     mode "700"
 554   end
 555
 556   template "#{bin_directory}/clean-db-nominatim" do
 557     source "clean-db-nominatim.erb"
 558     owner "nominatim"
 559     group "nominatim"
 560     mode "755"
 561     variables :archive_dir => node[:rsyncd][:modules][:archive][:path],
 562               :update_stop_file => "#{basedir}/status/updates_disabled",
 563               :streaming_clients => search(:node, "nominatim_state:slave").map { |slave| slave[:fqdn] }.join(" ")
 564   end
 565 end
 566
 567 # Maintenance
 568
 569 cron_d "nominatim-backup" do
 570   action (node[:nominatim][:enable_backup] && node[:nominatim][:state] != "off") ? :create : :delete
 571   minute "0"
 572   hour "3"
 573   day "1"
 574   user "nominatim"
 575   command "#{bin_directory}/backup-nominatim"
 576   mailto email_errors
 577 end
 578
 579 cron_d "nominatim-vacuum-db" do
 580   action node[:nominatim][:state] != "off" ? :create : :delete
 581   minute "20"
 582   hour "0"
 583   user "postgres"
 584   command "#{bin_directory}/vacuum-db-nominatim"
 585   mailto email_errors
 586 end
 587
 588 %w[backup-nominatim vacuum-db-nominatim].each do |fname|
 589   template "#{bin_directory}/#{fname}" do
 590     source "#{fname}.erb"
 591     owner "nominatim"
 592     group "nominatim"
 593     mode "755"
 594     variables :db => node[:nominatim][:dbname]
 595   end
 596 end
 597
 598 # Logging
 599
 600 template "/etc/logrotate.d/nominatim" do
 601   source "logrotate.nominatim.erb"
 602   owner "root"
 603   group "root"
 604   mode "644"
 605 end
 606
 607 # Monitoring
 608 prometheus_exporter "nominatim" do
 609   port 8082
 610   user "www-data"
 611   restrict_address_families "AF_UNIX"
 612   options [
 613     "--nominatim.query-log=#{node[:nominatim][:logdir]}/query.log",
 614     "--nominatim.database-name=#{node[:nominatim][:dbname]}"
 615   ]
 616 end
 617
 618 include_recipe "fail2ban"
 619
 620 frontend_addresses = frontends.collect { |f| f.ipaddresses(:role => :external) }
 621
 622 fail2ban_jail "nominatim_limit_req" do
 623   filter "nginx-limit-req"
 624   logpath "#{node[:nominatim][:logdir]}/nominatim.openstreetmap.org-error.log"
 625   ports [80, 443]
 626   maxretry 20
 627   ignoreips frontend_addresses.flatten.sort
 628 end