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 "php::fpm"
  23 include_recipe "prometheus"
  24
  25 basedir = data_bag_item("accounts", "nominatim")["home"]
  26 email_errors = data_bag_item("accounts", "lonvia")["email"]
  27
  28 directory basedir do
  29   owner "nominatim"
  30   group "nominatim"
  31   mode "755"
  32   recursive true
  33 end
  34
  35 ## Log directory setup
  36
  37 directory node[:nominatim][:logdir] do
  38   owner "nominatim"
  39   group "nominatim"
  40   mode "755"
  41   recursive true
  42 end
  43
  44 file "#{node[:nominatim][:logdir]}/query.log" do
  45   action :create_if_missing
  46   owner "www-data"
  47   group "adm"
  48   mode "664"
  49 end
  50
  51 file "#{node[:nominatim][:logdir]}/update.log" do
  52   action :create_if_missing
  53   owner "nominatim"
  54   group "adm"
  55   mode "664"
  56 end
  57
  58 ## Postgresql
  59
  60 include_recipe "postgresql"
  61
  62 postgresql_version = node[:nominatim][:dbcluster].split("/").first
  63 postgis_version = node[:nominatim][:postgis]
  64
  65 package "postgresql-#{postgresql_version}-postgis-#{postgis_version}"
  66
  67 node[:nominatim][:dbadmins].each do |user|
  68   postgresql_user user do
  69     cluster node[:nominatim][:dbcluster]
  70     superuser true
  71     only_if { node[:nominatim][:state] != "slave" }
  72   end
  73 end
  74
  75 postgresql_user "nominatim" do
  76   cluster node[:nominatim][:dbcluster]
  77   superuser true
  78   only_if { node[:nominatim][:state] != "slave" }
  79 end
  80
  81 postgresql_user "www-data" do
  82   cluster node[:nominatim][:dbcluster]
  83   only_if { node[:nominatim][:state] != "slave" }
  84 end
  85
  86 postgresql_munin "nominatim" do
  87   cluster node[:nominatim][:dbcluster]
  88   database node[:nominatim][:dbname]
  89 end
  90
  91 directory "#{basedir}/tablespaces" do
  92   owner "postgres"
  93   group "postgres"
  94   mode "700"
  95 end
  96
  97 # NOTE: tablespaces must be exactly in the same location on each
  98 #       Nominatim instance when replication is in use. Therefore
  99 #       use symlinks to canonical directory locations.
 100 node[:nominatim][:tablespaces].each do |name, location|
 101   directory location do
 102     owner "postgres"
 103     group "postgres"
 104     mode "700"
 105     recursive true
 106   end
 107
 108   link "#{basedir}/tablespaces/#{name}" do
 109     to location
 110   end
 111
 112   postgresql_tablespace name do
 113     cluster node[:nominatim][:dbcluster]
 114     location "#{basedir}/tablespaces/#{name}"
 115   end
 116 end
 117
 118 ## Nominatim backend
 119
 120 include_recipe "git"
 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   python3-pyosmium
 135   python3-psycopg2
 136   python3-dotenv
 137   python3-psutil
 138   python3-jinja2
 139   python3-icu
 140   python3-datrie
 141   python3-yaml
 142   php-pgsql
 143   php-intl
 144   ruby
 145   ruby-file-tail
 146   ruby-pg
 147   ruby-webrick
 148 ]
 149
 150 source_directory = "#{basedir}/src/nominatim"
 151 build_directory = "#{basedir}/src/build"
 152 project_directory = "#{basedir}/planet-project"
 153 bin_directory = "#{basedir}/bin"
 154 cfg_directory = "#{basedir}/etc"
 155 ui_directory = "#{basedir}/ui"
 156 qa_bin_directory = "#{basedir}/src/Nominatim-Data-Analyser"
 157 qa_data_directory = "#{basedir}/qa-data"
 158
 159 [basedir, "#{basedir}/src", cfg_directory, bin_directory, build_directory, project_directory].each do |path|
 160   directory path do
 161     owner "nominatim"
 162     group "nominatim"
 163     mode "755"
 164     recursive true
 165   end
 166 end
 167
 168 directory "#{bin_directory}/maintenance" do
 169   owner "nominatim"
 170   group "nominatim"
 171   mode "775"
 172 end
 173
 174 if node[:nominatim][:flatnode_file]
 175   directory File.dirname(node[:nominatim][:flatnode_file]) do
 176     recursive true
 177   end
 178 end
 179
 180 # Normally syncing via chef is a bad idea because syncing might involve
 181 # an update of database functions which should not be done while an update
 182 # is ongoing. Therefore we sync in between update cycles. There is an
 183 # exception for slaves: they get DB function updates from the master, so
 184 # only the source code needs to be updated, which chef may do.
 185 git source_directory do
 186   action node[:nominatim][:state] == "slave" ? :sync : :checkout
 187   repository node[:nominatim][:repository]
 188   revision node[:nominatim][:revision]
 189   enable_submodules true
 190   user "nominatim"
 191   group "nominatim"
 192   not_if { node[:nominatim][:state] != "slave" && File.exist?("#{source_directory}/README.md") }
 193   notifies :run, "execute[compile_nominatim]"
 194 end
 195
 196 remote_file "#{source_directory}/data/country_osm_grid.sql.gz" do
 197   action :create_if_missing
 198   source "https://www.nominatim.org/data/country_grid.sql.gz"
 199   owner "nominatim"
 200   group "nominatim"
 201   mode "644"
 202 end
 203
 204 execute "compile_nominatim" do
 205   action :nothing
 206   user "nominatim"
 207   cwd build_directory
 208   command "cmake #{source_directory} && make"
 209   notifies :run, "execute[install_nominatim]"
 210 end
 211
 212 execute "install_nominatim" do
 213   action :nothing
 214   cwd build_directory
 215   command "make install"
 216 end
 217
 218 # Project directory
 219
 220 template "#{project_directory}/.env" do
 221   source "nominatim.env.erb"
 222   owner "nominatim"
 223   group "nominatim"
 224   mode "664"
 225   variables :base_url => node[:nominatim][:state] == "off" ? node[:fqdn] : "nominatim.openstreetmap.org",
 226             :dbname => node[:nominatim][:dbname],
 227             :flatnode_file => node[:nominatim][:flatnode_file],
 228             :log_file => "#{node[:nominatim][:logdir]}/query.log",
 229             :tokenizer => node[:nominatim][:config][:tokenizer]
 230 end
 231
 232 %w[wikimedia-importance.sql.gz gb_postcodes.csv.gz us_postcodes.csv.gz].each do |fname|
 233   remote_file "#{project_directory}/#{fname}" do
 234     action :create
 235     source "https://www.nominatim.org/data/#{fname}"
 236     owner "nominatim"
 237     group "nominatim"
 238     mode "644"
 239   end
 240 end
 241
 242 # Webserver + frontend
 243
 244 %w[user_agent referrer email generic].each do |name|
 245   file "#{cfg_directory}/nginx_blocked_#{name}.conf" do
 246     action :create_if_missing
 247     owner "nominatim"
 248     group "adm"
 249     mode "664"
 250   end
 251 end
 252
 253 node[:nominatim][:fpm_pools].each do |name, data|
 254   php_fpm name do
 255     port data[:port]
 256     pm data[:pm]
 257     pm_max_children data[:max_children]
 258     pm_start_servers 20
 259     pm_min_spare_servers 10
 260     pm_max_spare_servers 20
 261     pm_max_requests 10000
 262     prometheus_port data[:prometheus_port]
 263   end
 264 end
 265
 266 ssl_certificate node[:fqdn] do
 267   domains [node[:fqdn],
 268            "nominatim.openstreetmap.org",
 269            "nominatim.osm.org",
 270            "nominatim.openstreetmap.com",
 271            "nominatim.openstreetmap.net",
 272            "nominatim.openstreetmaps.org",
 273            "nominatim.openmaps.org",
 274            "nominatim.qgis.org"]
 275   notifies :reload, "service[nginx]"
 276 end
 277
 278 include_recipe "nginx"
 279
 280 nginx_site "default" do
 281   action [:delete]
 282 end
 283
 284 frontends = search(:node, "recipes:web\\:\\:frontend").sort_by(&:name)
 285
 286 nginx_site "nominatim" do
 287   template "nginx.erb"
 288   directory project_directory
 289   variables :pools => node[:nominatim][:fpm_pools],
 290             :frontends => frontends,
 291             :confdir => "#{basedir}/etc",
 292             :ui_directory => ui_directory
 293 end
 294
 295 template "/etc/logrotate.d/nginx" do
 296   source "logrotate.nginx.erb"
 297   owner "root"
 298   group "root"
 299   mode "644"
 300 end
 301
 302 # Updates
 303
 304 %w[nominatim-update
 305    nominatim-update-source
 306    nominatim-update-refresh-db
 307    nominatim-update-data
 308    nominatim-daily-maintenance].each do |fname|
 309   template "#{bin_directory}/#{fname}" do
 310     source "#{fname}.erb"
 311     owner "nominatim"
 312     group "nominatim"
 313     mode "554"
 314     variables :bindir => bin_directory,
 315               :srcdir => source_directory,
 316               :builddir => build_directory,
 317               :projectdir => project_directory,
 318               :qabindir => qa_bin_directory,
 319               :qadatadir => qa_data_directory
 320   end
 321 end
 322
 323 systemd_service "nominatim-update" do
 324   description "Update the Nominatim database"
 325   exec_start "#{bin_directory}/nominatim-update"
 326   restart "on-success"
 327   standard_output "append:#{node[:nominatim][:logdir]}/update.log"
 328   standard_error "inherit"
 329   working_directory project_directory
 330 end
 331
 332 systemd_service "nominatim-update-maintenance-trigger" do
 333   description "Trigger daily maintenance tasks for Nominatim DB"
 334   exec_start "ln -sf #{bin_directory}/nominatim-daily-maintenance #{bin_directory}/maintenance/"
 335   user "nominatim"
 336 end
 337
 338 systemd_timer "nominatim-update-maintenance-trigger" do
 339   action node[:nominatim][:state] != "off" ? :create : :delete
 340   description "Schedule daily maintenance tasks for Nominatim DB"
 341   on_calendar "*-*-* 02:03:00 UTC"
 342 end
 343
 344 service "nominatim-update-maintenance-trigger" do
 345   action node[:nominatim][:state] != "off" ? :enable : :disable
 346 end
 347
 348 # Nominatim UI
 349
 350 git ui_directory do
 351   action :sync
 352   repository node[:nominatim][:ui_repository]
 353   revision node[:nominatim][:ui_revision]
 354   user "nominatim"
 355   group "nominatim"
 356 end
 357
 358 template "#{ui_directory}/dist/theme/config.theme.js" do
 359   source "ui-config.js.erb"
 360   owner "nominatim"
 361   group "nominatim"
 362   mode "664"
 363 end
 364
 365 # Nominatim QA
 366
 367 if node[:nominatim][:enable_qa_tiles]
 368   package "python3-geojson"
 369
 370   git qa_bin_directory do
 371     repository node[:nominatim][:qa_repository]
 372     revision node[:nominatim][:qa_revision]
 373     enable_submodules true
 374     user "nominatim"
 375     group "nominatim"
 376     notifies :run, "execute[compile_qa]"
 377   end
 378
 379   execute "compile_qa" do
 380     action :nothing
 381     user "nominatim"
 382     cwd "#{qa_bin_directory}/clustering-vt"
 383     command "make"
 384   end
 385
 386   directory qa_data_directory do
 387     owner "nominatim"
 388     group "nominatim"
 389     mode "755"
 390     recursive true
 391   end
 392
 393   template "#{qa_bin_directory}/analyser/config/config.yaml" do
 394     source "qa_config.erb"
 395     owner "nominatim"
 396     group "nominatim"
 397     mode "755"
 398     variables :outputdir => "#{qa_data_directory}/new"
 399   end
 400
 401   ssl_certificate "qa-tile.nominatim.openstreetmap.org" do
 402     domains ["qa-tile.nominatim.openstreetmap.org"]
 403     notifies :reload, "service[nginx]"
 404   end
 405
 406   nginx_site "qa-tiles.nominatim" do
 407     template "nginx-qa-tiles.erb"
 408     directory build_directory
 409     variables :qa_data_directory => qa_data_directory
 410   end
 411
 412 end
 413
 414 # Replication
 415
 416 cron_d "nominatim-clean-db" do
 417   action node[:nominatim][:state] == "master" ? :create : :delete
 418   minute "5"
 419   hour "*/4"
 420   user "postgres"
 421   command "#{bin_directory}/clean-db-nominatim"
 422   mailto email_errors
 423 end
 424
 425 if node[:nominatim][:state] == "master"
 426   postgresql_user "replication" do
 427     cluster node[:nominatim][:dbcluster]
 428     password data_bag_item("nominatim", "passwords")["replication"]
 429     replication true
 430   end
 431
 432   directory node[:rsyncd][:modules][:archive][:path] do
 433     owner "postgres"
 434     group "postgres"
 435     mode "700"
 436   end
 437
 438   template "#{bin_directory}/clean-db-nominatim" do
 439     source "clean-db-nominatim.erb"
 440     owner "nominatim"
 441     group "nominatim"
 442     mode "755"
 443     variables :archive_dir => node[:rsyncd][:modules][:archive][:path],
 444               :update_stop_file => "#{basedir}/status/updates_disabled",
 445               :streaming_clients => search(:node, "nominatim_state:slave").map { |slave| slave[:fqdn] }.join(" ")
 446   end
 447 end
 448
 449 # Maintenance
 450
 451 cron_d "nominatim-backup" do
 452   action (node[:nominatim][:enable_backup] && node[:nominatim][:state] != "off") ? :create : :delete
 453   minute "0"
 454   hour "3"
 455   day "1"
 456   user "nominatim"
 457   command "#{bin_directory}/backup-nominatim"
 458   mailto email_errors
 459 end
 460
 461 cron_d "nominatim-vacuum-db" do
 462   action node[:nominatim][:state] != "off" ? :create : :delete
 463   minute "20"
 464   hour "0"
 465   user "postgres"
 466   command "#{bin_directory}/vacuum-db-nominatim"
 467   mailto email_errors
 468 end
 469
 470 %w[backup-nominatim vacuum-db-nominatim].each do |fname|
 471   template "#{bin_directory}/#{fname}" do
 472     source "#{fname}.erb"
 473     owner "nominatim"
 474     group "nominatim"
 475     mode "755"
 476     variables :db => node[:nominatim][:dbname]
 477   end
 478 end
 479
 480 # Logging
 481
 482 template "/etc/logrotate.d/nominatim" do
 483   source "logrotate.nominatim.erb"
 484   owner "root"
 485   group "root"
 486   mode "644"
 487 end
 488
 489 # Monitoring
 490
 491 munin_plugin_conf "nominatim" do
 492   template "munin.erb"
 493   variables :db => node[:nominatim][:dbname],
 494             :querylog => "#{node[:nominatim][:logdir]}/query.log"
 495 end
 496
 497 munin_plugin "nominatim_importlag" do
 498   target "#{source_directory}/munin/nominatim_importlag"
 499 end
 500
 501 munin_plugin "nominatim_query_speed" do
 502   target "#{source_directory}/munin/nominatim_query_speed_querylog"
 503 end
 504
 505 munin_plugin "nominatim_requests" do
 506   target "#{source_directory}/munin/nominatim_requests_querylog"
 507 end
 508
 509 prometheus_exporter "nominatim" do
 510   port 8082
 511   user "www-data"
 512   options [
 513     "--nominatim.query-log=#{node[:nominatim][:logdir]}/query.log",
 514     "--nominatim.database-name=#{node[:nominatim][:dbname]}"
 515   ]
 516 end
 517
 518 include_recipe "fail2ban"
 519
 520 frontend_addresses = frontends.collect { |f| f.ipaddresses(:role => :external) }
 521
 522 fail2ban_jail "nominatim_limit_req" do
 523   filter "nginx-limit-req"
 524   logpath "#{node[:nominatim][:logdir]}/nominatim.openstreetmap.org-error.log"
 525   ports [80, 443]
 526   maxretry 20
 527   ignoreips frontend_addresses.flatten.sort
 528 end