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