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 # exception granted for a limited time so that they can set up their own server
  56 firewall_rule "increase-limits-gnome-proxy" do
  57   action :accept
  58   family "inet"
  59   source "net:8.43.85.23"
  60   dest "fw"
  61   proto "tcp:syn"
  62   dest_ports "https"
  63   rate_limit "s:10/sec:30"
  64 end
  65
  66 ## Postgresql
  67
  68 include_recipe "postgresql"
  69
  70 postgresql_version = node[:nominatim][:dbcluster].split("/").first
  71 postgis_version = node[:nominatim][:postgis]
  72
  73 package "postgresql-#{postgresql_version}-postgis-#{postgis_version}"
  74
  75 node[:nominatim][:dbadmins].each do |user|
  76   postgresql_user user do
  77     cluster node[:nominatim][:dbcluster]
  78     superuser true
  79     only_if { node[:nominatim][:state] != "slave" }
  80   end
  81 end
  82
  83 postgresql_user "nominatim" do
  84   cluster node[:nominatim][:dbcluster]
  85   superuser true
  86   only_if { node[:nominatim][:state] != "slave" }
  87 end
  88
  89 postgresql_user "www-data" do
  90   cluster node[:nominatim][:dbcluster]
  91   only_if { node[:nominatim][:state] != "slave" }
  92 end
  93
  94 postgresql_munin "nominatim" do
  95   cluster node[:nominatim][:dbcluster]
  96   database node[:nominatim][:dbname]
  97 end
  98
  99 directory "#{basedir}/tablespaces" do
 100   owner "postgres"
 101   group "postgres"
 102   mode "700"
 103 end
 104
 105 # NOTE: tablespaces must be exactly in the same location on each
 106 #       Nominatim instance when replication is in use. Therefore
 107 #       use symlinks to canonical directory locations.
 108 node[:nominatim][:tablespaces].each do |name, location|
 109   directory location do
 110     owner "postgres"
 111     group "postgres"
 112     mode "700"
 113     recursive true
 114   end
 115
 116   link "#{basedir}/tablespaces/#{name}" do
 117     to location
 118   end
 119
 120   postgresql_tablespace name do
 121     cluster node[:nominatim][:dbcluster]
 122     location "#{basedir}/tablespaces/#{name}"
 123   end
 124 end
 125
 126 if node[:nominatim][:state] == "master"
 127   postgresql_user "replication" do
 128     cluster node[:nominatim][:dbcluster]
 129     password data_bag_item("nominatim", "passwords")["replication"]
 130     replication true
 131   end
 132
 133   directory node[:rsyncd][:modules][:archive][:path] do
 134     owner "postgres"
 135     group "postgres"
 136     mode "700"
 137   end
 138
 139   template "/usr/local/bin/clean-db-nominatim" do
 140     source "clean-db-nominatim.erb"
 141     owner "root"
 142     group "root"
 143     mode "755"
 144     variables :archive_dir => node[:rsyncd][:modules][:archive][:path],
 145               :update_stop_file => "#{basedir}/status/updates_disabled",
 146               :streaming_clients => search(:node, "nominatim_state:slave").map { |slave| slave[:fqdn] }.join(" ")
 147   end
 148 end
 149
 150 ## Nominatim backend
 151
 152 include_recipe "git"
 153
 154 package %w[
 155   build-essential
 156   cmake
 157   g++
 158   libboost-dev
 159   libboost-system-dev
 160   libboost-filesystem-dev
 161   libexpat1-dev
 162   zlib1g-dev
 163   libxml2-dev
 164   libbz2-dev
 165   libpq-dev
 166   libgeos++-dev
 167   libproj-dev
 168   python3-pyosmium
 169   pyosmium
 170   python3-psycopg2
 171   python3-dotenv
 172   php-pgsql
 173   php-intl
 174   php-symfony-dotenv
 175 ]
 176
 177 source_directory = "#{basedir}/nominatim"
 178 build_directory = "#{basedir}/bin"
 179 ui_directory = "#{basedir}/ui"
 180
 181 directory build_directory do
 182   owner "nominatim"
 183   group "nominatim"
 184   mode "755"
 185   recursive true
 186 end
 187
 188 # Normally syncing via chef is a bad idea because syncing might involve
 189 # an update of database functions which should not be done while an update
 190 # is ongoing. Therefore we sync in between update cycles. There is an
 191 # exception for slaves: they get DB function updates from the master, so
 192 # only the source code needs to be updated, which chef may do.
 193 git source_directory do
 194   action node[:nominatim][:state] == "slave" ? :sync : :checkout
 195   repository node[:nominatim][:repository]
 196   revision node[:nominatim][:revision]
 197   enable_submodules true
 198   user "nominatim"
 199   group "nominatim"
 200   not_if { node[:nominatim][:state] != "slave" && File.exist?("#{source_directory}/README.md") }
 201   notifies :run, "execute[compile_nominatim]"
 202 end
 203
 204 remote_file "#{source_directory}/data/country_osm_grid.sql.gz" do
 205   action :create_if_missing
 206   source "https://www.nominatim.org/data/country_grid.sql.gz"
 207   owner "nominatim"
 208   group "nominatim"
 209   mode "644"
 210 end
 211
 212 execute "compile_nominatim" do
 213   action :nothing
 214   user "nominatim"
 215   cwd build_directory
 216   command "cmake #{source_directory} && make"
 217 end
 218
 219 template "#{source_directory}/.git/hooks/post-merge" do
 220   source "git-post-merge-hook.erb"
 221   owner "nominatim"
 222   group "nominatim"
 223   mode "755"
 224   variables :srcdir => source_directory,
 225             :builddir => build_directory,
 226             :dbname => node[:nominatim][:dbname]
 227 end
 228
 229 template "#{build_directory}/.env" do
 230   source "nominatim.env.erb"
 231   owner "nominatim"
 232   group "nominatim"
 233   mode "664"
 234   variables :base_url => node[:nominatim][:state] == "off" ? node[:fqdn] : "nominatim.openstreetmap.org",
 235             :dbname => node[:nominatim][:dbname],
 236             :flatnode_file => node[:nominatim][:flatnode_file],
 237             :log_file => "#{node[:nominatim][:logdir]}/query.log"
 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_postcode_data.sql.gz",
 271   "us_postcode_data.sql.gz"
 272 ]
 273
 274 external_data.each do |fname|
 275   remote_file "#{build_directory}/#{fname}" do
 276     action :create_if_missing
 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   cron_d "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   cron_d "nominatim-update-maintenance-trigger" do
 329     minute "18"
 330     hour "1"
 331     user "nominatim"
 332     command "touch #{basedir}/status/update_maintenance"
 333     mailto email_errors
 334   end
 335 end
 336
 337 template "#{source_directory}/utils/nominatim-update" do
 338   source "updater.erb"
 339   user "nominatim"
 340   group "nominatim"
 341   mode "755"
 342   variables :bindir => build_directory,
 343             :srcdir => source_directory,
 344             :logfile => "#{node[:nominatim][:logdir]}/update.log",
 345             :branch => node[:nominatim][:revision],
 346             :update_stop_file => "#{basedir}/status/updates_disabled",
 347             :update_maintenance_trigger => "#{basedir}/status/update_maintenance"
 348 end
 349
 350 template "/etc/init.d/nominatim-update" do
 351   source "updater.init.erb"
 352   user "nominatim"
 353   group "nominatim"
 354   mode "755"
 355   variables :source_directory => source_directory
 356 end
 357
 358 %w[backup-nominatim vacuum-db-nominatim].each do |fname|
 359   template "/usr/local/bin/#{fname}" do
 360     source "#{fname}.erb"
 361     owner "root"
 362     group "root"
 363     mode "755"
 364     variables :db => node[:nominatim][:dbname]
 365   end
 366 end
 367
 368 ## webserver frontend
 369
 370 directory "#{basedir}/etc" do
 371   owner "nominatim"
 372   group "adm"
 373   mode "775"
 374 end
 375
 376 %w[user_agent referrer email generic].each do |name|
 377   file "#{basedir}/etc/nginx_blocked_#{name}.conf" do
 378     action :create_if_missing
 379     owner "nominatim"
 380     group "adm"
 381     mode "664"
 382   end
 383 end
 384
 385 node[:nominatim][:fpm_pools].each do |name, data|
 386   php_fpm name do
 387     port data[:port]
 388     pm data[:pm]
 389     pm_max_children data[:max_children]
 390     pm_start_servers 20
 391     pm_min_spare_servers 10
 392     pm_max_spare_servers 20
 393     pm_max_requests 10000
 394     prometheus_port data[:prometheus_port]
 395   end
 396 end
 397
 398 ssl_certificate node[:fqdn] do
 399   domains [node[:fqdn],
 400            "nominatim.openstreetmap.org",
 401            "nominatim.osm.org",
 402            "nominatim.openstreetmap.com",
 403            "nominatim.openstreetmap.net",
 404            "nominatim.openstreetmaps.org",
 405            "nominatim.openmaps.org",
 406            "nominatim.qgis.org"]
 407   notifies :reload, "service[nginx]"
 408 end
 409
 410 package "apache2" do
 411   action :remove
 412 end
 413
 414 include_recipe "nginx"
 415
 416 nginx_site "default" do
 417   action [:delete]
 418 end
 419
 420 frontends = search(:node, "recipes:web\\:\\:frontend").sort_by(&:name)
 421
 422 nginx_site "nominatim" do
 423   template "nginx.erb"
 424   directory build_directory
 425   variables :pools => node[:nominatim][:fpm_pools],
 426             :frontends => frontends,
 427             :confdir => "#{basedir}/etc",
 428             :ui_directory => ui_directory
 429 end
 430
 431 template "/etc/logrotate.d/nginx" do
 432   source "logrotate.nginx.erb"
 433   owner "root"
 434   group "root"
 435   mode "644"
 436 end
 437
 438 munin_plugin_conf "nominatim" do
 439   template "munin.erb"
 440   variables :db => node[:nominatim][:dbname],
 441             :querylog => "#{node[:nominatim][:logdir]}/query.log"
 442 end
 443
 444 munin_plugin "nominatim_importlag" do
 445   target "#{source_directory}/munin/nominatim_importlag"
 446 end
 447
 448 munin_plugin "nominatim_query_speed" do
 449   target "#{source_directory}/munin/nominatim_query_speed_querylog"
 450 end
 451
 452 munin_plugin "nominatim_requests" do
 453   target "#{source_directory}/munin/nominatim_requests_querylog"
 454 end
 455
 456 directory "#{basedir}/status" do
 457   owner "nominatim"
 458   group "postgres"
 459   mode "775"
 460 end
 461
 462 include_recipe "fail2ban"
 463
 464 frontend_addresses = frontends.collect { |f| f.ipaddresses(:role => :external) }
 465
 466 fail2ban_jail "nominatim_limit_req" do
 467   filter "nginx-limit-req"
 468   logpath "#{node[:nominatim][:logdir]}/nominatim.openstreetmap.org-error.log"
 469   ports [80, 443]
 470   maxretry 20
 471   ignoreips frontend_addresses.flatten.sort
 472 end