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