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