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 "munin"
  21
  22 basedir = data_bag_item("accounts", "nominatim")["home"]
  23 email_errors = data_bag_item("accounts", "lonvia")["email"]
  24
  25 directory basedir do
  26   owner "nominatim"
  27   group "nominatim"
  28   mode 0o755
  29   recursive true
  30 end
  31
  32 directory node[:nominatim][:logdir] do
  33   owner "nominatim"
  34   group "nominatim"
  35   mode 0o755
  36   recursive true
  37 end
  38
  39 file "#{node[:nominatim][:logdir]}/query.log" do
  40   action :create_if_missing
  41   owner "www-data"
  42   group "adm"
  43   mode 0o664
  44 end
  45
  46 file "#{node[:nominatim][:logdir]}/update.log" do
  47   action :create_if_missing
  48   owner "nominatim"
  49   group "adm"
  50   mode 0o664
  51 end
  52
  53 # exception granted for a limited time so that they can set up their own server
  54 firewall_rule "increase-limits-gnome-proxy" do
  55   action :accept
  56   family "inet"
  57   source "net:8.43.85.23"
  58   dest "fw"
  59   proto "tcp:syn"
  60   dest_ports "https"
  61   rate_limit "s:10/sec:30"
  62 end
  63
  64 ## Postgresql
  65
  66 include_recipe "postgresql"
  67
  68 postgresql_version = node[:nominatim][:dbcluster].split("/").first
  69 postgis_version = node[:nominatim][:postgis]
  70
  71 package "postgresql-#{postgresql_version}-postgis-#{postgis_version}"
  72
  73 node[:nominatim][:dbadmins].each do |user|
  74   postgresql_user user do
  75     cluster node[:nominatim][:dbcluster]
  76     superuser true
  77     only_if { node[:nominatim][:state] != "slave" }
  78   end
  79 end
  80
  81 postgresql_user "nominatim" do
  82   cluster node[:nominatim][:dbcluster]
  83   superuser true
  84   only_if { node[:nominatim][:state] != "slave" }
  85 end
  86
  87 postgresql_user "www-data" do
  88   cluster node[:nominatim][:dbcluster]
  89   only_if { node[:nominatim][:state] != "slave" }
  90 end
  91
  92 postgresql_munin "nominatim" do
  93   cluster node[:nominatim][:dbcluster]
  94   database node[:nominatim][:dbname]
  95 end
  96
  97 directory "#{basedir}/tablespaces" do
  98   owner "postgres"
  99   group "postgres"
 100   mode 0o700
 101 end
 102
 103 # Note: tablespaces must be exactly in the same location on each
 104 #       Nominatim instance when replication is in use. Therefore
 105 #       use symlinks to canonical directory locations.
 106 node[:nominatim][:tablespaces].each do |name, location|
 107   directory location do
 108     owner "postgres"
 109     group "postgres"
 110     mode 0o700
 111     recursive true
 112   end
 113
 114   link "#{basedir}/tablespaces/#{name}" do
 115     to location
 116   end
 117
 118   postgresql_tablespace name do
 119     cluster node[:nominatim][:dbcluster]
 120     location "#{basedir}/tablespaces/#{name}"
 121   end
 122 end
 123
 124 if node[:nominatim][:state] == "master"
 125   postgresql_user "replication" do
 126     cluster node[:nominatim][:dbcluster]
 127     password data_bag_item("nominatim", "passwords")["replication"]
 128     replication true
 129   end
 130
 131   directory node[:rsyncd][:modules][:archive][:path] do
 132     owner "postgres"
 133     group "postgres"
 134     mode 0o700
 135   end
 136
 137   template "/usr/local/bin/clean-db-nominatim" do
 138     source "clean-db-nominatim.erb"
 139     owner "root"
 140     group "root"
 141     mode 0o755
 142     variables :archive_dir => node[:rsyncd][:modules][:archive][:path],
 143               :update_stop_file => "#{basedir}/status/updates_disabled",
 144               :streaming_clients => search(:node, "nominatim_state:slave").map { |slave| slave[:fqdn] }.join(" ")
 145   end
 146 end
 147
 148 ## Nominatim backend
 149
 150 include_recipe "git"
 151
 152 package %w[
 153   build-essential
 154   cmake
 155   g++
 156   libboost-dev
 157   libboost-system-dev
 158   libboost-filesystem-dev
 159   libexpat1-dev
 160   zlib1g-dev
 161   libxml2-dev
 162   libbz2-dev
 163   libpq-dev
 164   libgeos++-dev
 165   libproj-dev
 166   python3-pyosmium
 167   pyosmium
 168   python3-psycopg2
 169   php
 170   php-fpm
 171   php-pgsql
 172   php-intl
 173 ]
 174
 175 source_directory = "#{basedir}/nominatim"
 176 build_directory = "#{basedir}/bin"
 177
 178 directory build_directory do
 179   owner "nominatim"
 180   group "nominatim"
 181   mode 0o755
 182   recursive true
 183 end
 184
 185 # Normally syncing via chef is a bad idea because syncing might involve
 186 # an update of database functions which should not be done while an update
 187 # is ongoing. Therefore we sync in between update cycles. There is an
 188 # exception for slaves: they get DB function updates from the master, so
 189 # only the source code needs to be updated, which chef may do.
 190 git source_directory do
 191   action node[:nominatim][:state] == "slave" ? :sync : :checkout
 192   repository node[:nominatim][:repository]
 193   revision node[:nominatim][:revision]
 194   enable_submodules true
 195   user "nominatim"
 196   group "nominatim"
 197   not_if { node[:nominatim][:state] != "slave" && File.exist?("#{source_directory}/README.md") }
 198   notifies :run, "execute[compile_nominatim]", :immediately
 199 end
 200
 201 execute "compile_nominatim" do
 202   action :nothing
 203   user "nominatim"
 204   cwd build_directory
 205   command "cmake #{source_directory} && make"
 206 end
 207
 208 template "#{source_directory}/.git/hooks/post-merge" do
 209   source "git-post-merge-hook.erb"
 210   owner "nominatim"
 211   group "nominatim"
 212   mode 0o755
 213   variables :srcdir => source_directory,
 214             :builddir => build_directory,
 215             :dbname => node[:nominatim][:dbname]
 216 end
 217
 218 template "#{build_directory}/settings/local.php" do
 219   source "settings.erb"
 220   owner "nominatim"
 221   group "nominatim"
 222   mode 0o664
 223   variables :base_url => node[:nominatim][:state] == "off" ? node[:fqdn] : "nominatim.openstreetmap.org",
 224             :dbname => node[:nominatim][:dbname],
 225             :flatnode_file => node[:nominatim][:flatnode_file],
 226             :log_file => "#{node[:nominatim][:logdir]}/query.log"
 227 end
 228
 229 if node[:nominatim][:flatnode_file]
 230   directory File.dirname(node[:nominatim][:flatnode_file]) do
 231     recursive true
 232   end
 233 end
 234
 235 template "/etc/logrotate.d/nominatim" do
 236   source "logrotate.nominatim.erb"
 237   owner "root"
 238   group "root"
 239   mode 0o644
 240 end
 241
 242 external_data = [
 243   "wikimedia-importance.sql.gz",
 244   "gb_postcode_data.sql.gz"
 245 ]
 246
 247 external_data.each do |fname|
 248   remote_file "#{source_directory}/data/#{fname}" do
 249     action :create_if_missing
 250     source "https://www.nominatim.org/data/#{fname}"
 251     owner "nominatim"
 252     group "nominatim"
 253     mode 0o644
 254   end
 255 end
 256
 257 remote_file "#{source_directory}/data/country_osm_grid.sql.gz" do
 258   action :create_if_missing
 259   source "https://www.nominatim.org/data/country_grid.sql.gz"
 260   owner "nominatim"
 261   group "nominatim"
 262   mode 0o644
 263 end
 264
 265 template "/etc/cron.d/nominatim" do
 266   action node[:nominatim][:state] == "off" ? :delete : :create
 267   source "nominatim.cron.erb"
 268   owner "root"
 269   group "root"
 270   mode "0644"
 271   variables :bin_directory => "#{source_directory}/utils",
 272             :mailto => email_errors,
 273             :update_maintenance_trigger => "#{basedir}/status/update_maintenance"
 274 end
 275
 276 template "#{source_directory}/utils/nominatim-update" do
 277   source "updater.erb"
 278   user "nominatim"
 279   group "nominatim"
 280   mode 0o755
 281   variables :bindir => build_directory,
 282             :srcdir => source_directory,
 283             :logfile => "#{node[:nominatim][:logdir]}/update.log",
 284             :branch => node[:nominatim][:revision],
 285             :update_stop_file => "#{basedir}/status/updates_disabled",
 286             :update_maintenance_trigger => "#{basedir}/status/update_maintenance"
 287 end
 288
 289 template "/etc/init.d/nominatim-update" do
 290   source "updater.init.erb"
 291   user "nominatim"
 292   group "nominatim"
 293   mode 0o755
 294   variables :source_directory => source_directory
 295 end
 296
 297 %w[backup-nominatim vacuum-db-nominatim].each do |fname|
 298   template "/usr/local/bin/#{fname}" do
 299     source "#{fname}.erb"
 300     owner "root"
 301     group "root"
 302     mode 0o755
 303     variables :db => node[:nominatim][:dbname]
 304   end
 305 end
 306
 307 ## webserver frontend
 308
 309 directory "#{basedir}/etc" do
 310   owner "nominatim"
 311   group "adm"
 312   mode 0o775
 313 end
 314
 315 file "#{basedir}/etc/nginx_blocked_user_agent.conf" do
 316   action :create_if_missing
 317   owner "nominatim"
 318   group "adm"
 319   mode 0o664
 320 end
 321
 322 file "#{basedir}/etc/nginx_blocked_referrer.conf" do
 323   action :create_if_missing
 324   owner "nominatim"
 325   group "adm"
 326   mode 0o664
 327 end
 328
 329 service "php7.2-fpm" do
 330   action [:enable, :start]
 331   supports :status => true, :restart => true, :reload => true
 332 end
 333
 334 node[:nominatim][:fpm_pools].each do |name, data|
 335   template "/etc/php/7.2/fpm/pool.d/#{name}.conf" do
 336     source "fpm.conf.erb"
 337     owner "root"
 338     group "root"
 339     mode 0o644
 340     variables data.merge(:name => name)
 341     notifies :reload, "service[php7.2-fpm]"
 342   end
 343 end
 344
 345 ssl_certificate node[:fqdn] do
 346   domains [node[:fqdn],
 347            "nominatim.openstreetmap.org",
 348            "nominatim.osm.org",
 349            "nominatim.openstreetmap.com",
 350            "nominatim.openstreetmap.net",
 351            "nominatim.openstreetmaps.org",
 352            "nominatim.openmaps.org"]
 353   notifies :reload, "service[nginx]"
 354 end
 355
 356 package "apache2" do
 357   action :remove
 358 end
 359
 360 include_recipe "nginx"
 361
 362 nginx_site "default" do
 363   action [:delete]
 364 end
 365
 366 nginx_site "nominatim" do
 367   template "nginx.erb"
 368   directory build_directory
 369   variables :pools => node[:nominatim][:fpm_pools],
 370             :confdir => "#{basedir}/etc"
 371 end
 372
 373 template "/etc/logrotate.d/nginx" do
 374   source "logrotate.nginx.erb"
 375   owner "root"
 376   group "root"
 377   mode 0o644
 378 end
 379
 380 munin_plugin_conf "nominatim" do
 381   template "munin.erb"
 382   variables :db => node[:nominatim][:dbname],
 383             :querylog => "#{node[:nominatim][:logdir]}/query.log"
 384 end
 385
 386 munin_plugin "nominatim_importlag" do
 387   target "#{source_directory}/munin/nominatim_importlag"
 388 end
 389
 390 munin_plugin "nominatim_query_speed" do
 391   target "#{source_directory}/munin/nominatim_query_speed_querylog"
 392 end
 393
 394 munin_plugin "nominatim_requests" do
 395   target "#{source_directory}/munin/nominatim_requests_querylog"
 396 end
 397
 398 directory "#{basedir}/status" do
 399   owner "nominatim"
 400   group "postgres"
 401   mode 0o775
 402 end