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