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