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