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