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