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   php-pgsql
 172   php-intl
 173   php-symfony-dotenv
 174 ]
 175
 176 source_directory = "#{basedir}/nominatim"
 177 build_directory = "#{basedir}/bin"
 178 ui_directory = "#{basedir}/ui"
 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]", :immediately
 201 end
 202
 203 execute "compile_nominatim" do
 204   action :nothing
 205   user "nominatim"
 206   cwd build_directory
 207   command "cmake #{source_directory} && make"
 208 end
 209
 210 template "#{source_directory}/.git/hooks/post-merge" do
 211   source "git-post-merge-hook.erb"
 212   owner "nominatim"
 213   group "nominatim"
 214   mode "755"
 215   variables :srcdir => source_directory,
 216             :builddir => build_directory,
 217             :dbname => node[:nominatim][:dbname]
 218 end
 219
 220 template "#{build_directory}/.env" do
 221   source "nominatim.env.erb"
 222   owner "nominatim"
 223   group "nominatim"
 224   mode "664"
 225   variables :base_url => node[:nominatim][:state] == "off" ? node[:fqdn] : "nominatim.openstreetmap.org",
 226             :dbname => node[:nominatim][:dbname],
 227             :flatnode_file => node[:nominatim][:flatnode_file],
 228             :log_file => "#{node[:nominatim][:logdir]}/query.log"
 229 end
 230
 231 git ui_directory do
 232   action :sync
 233   repository node[:nominatim][:ui_repository]
 234   revision node[:nominatim][:ui_revision]
 235   user "nominatim"
 236   group "nominatim"
 237 end
 238
 239 template "#{ui_directory}/dist/config.js" do
 240   source "ui-config.js.erb"
 241   owner "nominatim"
 242   group "nominatim"
 243   mode "664"
 244 end
 245
 246 if node[:nominatim][:flatnode_file]
 247   directory File.dirname(node[:nominatim][:flatnode_file]) do
 248     recursive true
 249   end
 250 end
 251
 252 template "/etc/logrotate.d/nominatim" do
 253   source "logrotate.nominatim.erb"
 254   owner "root"
 255   group "root"
 256   mode "644"
 257 end
 258
 259 external_data = [
 260   "wikimedia-importance.sql.gz",
 261   "gb_postcode_data.sql.gz"
 262 ]
 263
 264 external_data.each do |fname|
 265   remote_file "#{source_directory}/data/#{fname}" do
 266     action :create_if_missing
 267     source "https://www.nominatim.org/data/#{fname}"
 268     owner "nominatim"
 269     group "nominatim"
 270     mode "644"
 271   end
 272 end
 273
 274 remote_file "#{source_directory}/data/country_osm_grid.sql.gz" do
 275   action :create_if_missing
 276   source "https://www.nominatim.org/data/country_grid.sql.gz"
 277   owner "nominatim"
 278   group "nominatim"
 279   mode "644"
 280 end
 281
 282 if node[:nominatim][:state] == "off"
 283   cron_d "nominatim-backup" do
 284     action :delete
 285   end
 286
 287   cron_d "nominatim-vacuum-db" do
 288     action :delete
 289   end
 290
 291   cron_d "nominatim-clean-db" do
 292     action :delete
 293   end
 294
 295   cron_d "nominatim-update-maintenance-trigger" do
 296     action :delete
 297   end
 298 else
 299   cron_d "nominatim-backup" do
 300     action node[:nominatim][:enable_backup] ? :create : :delete
 301     minute "0"
 302     hour "3"
 303     day "1"
 304     user "nominatim"
 305     command "/usr/local/bin/backup-nominatim"
 306     mailto email_errors
 307   end
 308
 309   cron_d "nominatim-vacuum-db" do
 310     minute "20"
 311     hour "0"
 312     user "postgres"
 313     command "/usr/local/bin/vacuum-db-nominatim"
 314     mailto email_errors
 315   end
 316
 317   cron_d "nominatim-clean-db" do
 318     action node[:nominatim][:state] == "master" ? :create : :delete
 319     minute "5"
 320     hour "*/4"
 321     user "postgres"
 322     command "/usr/local/bin/clean-db-nominatim"
 323     mailto email_errors
 324   end
 325
 326   cron_d "nominatim-update-maintenance-trigger" do
 327     minute "18"
 328     hour "1"
 329     user "nominatim"
 330     command "touch #{basedir}/status/update_maintenance"
 331     mailto email_errors
 332   end
 333 end
 334
 335 template "#{source_directory}/utils/nominatim-update" do
 336   source "updater.erb"
 337   user "nominatim"
 338   group "nominatim"
 339   mode "755"
 340   variables :bindir => build_directory,
 341             :srcdir => source_directory,
 342             :logfile => "#{node[:nominatim][:logdir]}/update.log",
 343             :branch => node[:nominatim][:revision],
 344             :update_stop_file => "#{basedir}/status/updates_disabled",
 345             :update_maintenance_trigger => "#{basedir}/status/update_maintenance"
 346 end
 347
 348 template "/etc/init.d/nominatim-update" do
 349   source "updater.init.erb"
 350   user "nominatim"
 351   group "nominatim"
 352   mode "755"
 353   variables :source_directory => source_directory
 354 end
 355
 356 %w[backup-nominatim vacuum-db-nominatim].each do |fname|
 357   template "/usr/local/bin/#{fname}" do
 358     source "#{fname}.erb"
 359     owner "root"
 360     group "root"
 361     mode "755"
 362     variables :db => node[:nominatim][:dbname]
 363   end
 364 end
 365
 366 ## webserver frontend
 367
 368 directory "#{basedir}/etc" do
 369   owner "nominatim"
 370   group "adm"
 371   mode "775"
 372 end
 373
 374 %w[user_agent referrer email generic].each do |name|
 375   file "#{basedir}/etc/nginx_blocked_#{name}.conf" do
 376     action :create_if_missing
 377     owner "nominatim"
 378     group "adm"
 379     mode "664"
 380   end
 381 end
 382
 383 node[:nominatim][:fpm_pools].each do |name, data|
 384   php_fpm name do
 385     port data[:port]
 386     pm data[:pm]
 387     pm_max_children data[:max_children]
 388     pm_start_servers 20
 389     pm_min_spare_servers 10
 390     pm_max_spare_servers 20
 391     pm_max_requests 10000
 392     prometheus_port data[:prometheus_port]
 393   end
 394 end
 395
 396 ssl_certificate node[:fqdn] do
 397   domains [node[:fqdn],
 398            "nominatim.openstreetmap.org",
 399            "nominatim.osm.org",
 400            "nominatim.openstreetmap.com",
 401            "nominatim.openstreetmap.net",
 402            "nominatim.openstreetmaps.org",
 403            "nominatim.openmaps.org"]
 404   notifies :reload, "service[nginx]"
 405 end
 406
 407 package "apache2" do
 408   action :remove
 409 end
 410
 411 include_recipe "nginx"
 412
 413 nginx_site "default" do
 414   action [:delete]
 415 end
 416
 417 frontends = search(:node, "recipes:web\\:\\:frontend").sort_by(&:name)
 418
 419 nginx_site "nominatim" do
 420   template "nginx.erb"
 421   directory build_directory
 422   variables :pools => node[:nominatim][:fpm_pools],
 423             :frontends => frontends,
 424             :confdir => "#{basedir}/etc",
 425             :ui_directory => ui_directory
 426 end
 427
 428 template "/etc/logrotate.d/nginx" do
 429   source "logrotate.nginx.erb"
 430   owner "root"
 431   group "root"
 432   mode "644"
 433 end
 434
 435 munin_plugin_conf "nominatim" do
 436   template "munin.erb"
 437   variables :db => node[:nominatim][:dbname],
 438             :querylog => "#{node[:nominatim][:logdir]}/query.log"
 439 end
 440
 441 munin_plugin "nominatim_importlag" do
 442   target "#{source_directory}/munin/nominatim_importlag"
 443 end
 444
 445 munin_plugin "nominatim_query_speed" do
 446   target "#{source_directory}/munin/nominatim_query_speed_querylog"
 447 end
 448
 449 munin_plugin "nominatim_requests" do
 450   target "#{source_directory}/munin/nominatim_requests_querylog"
 451 end
 452
 453 directory "#{basedir}/status" do
 454   owner "nominatim"
 455   group "postgres"
 456   mode "775"
 457 end
 458
 459 include_recipe "fail2ban"
 460
 461 frontend_addresses = frontends.collect { |f| f.ipaddresses(:role => :external) }
 462
 463 fail2ban_jail "nominatim_limit_req" do
 464   filter "nginx-limit-req"
 465   logpath "#{node[:nominatim][:logdir]}/nominatim.openstreetmap.org-error.log"
 466   ports [80, 443]
 467   maxretry 5
 468   ignoreips frontend_addresses.flatten.sort
 469 end