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