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