#
-# Cookbook Name:: nominatim
-# Recipe:: default
+# Cookbook:: nominatim
+# Recipe:: base
#
-# Copyright 2012, OpenStreetMap Foundation
+# Copyright:: 2015, OpenStreetMap Foundation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
-# http://www.apache.org/licenses/LICENSE-2.0
+# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# limitations under the License.
#
-include_recipe "apache::ssl"
-include_recipe "postgresql"
-include_recipe "git"
-
-package "php5"
-package "php5-cli"
-package "php5-pgsql"
-package "php5-fpm"
-package "php-pear"
-package "php-apc"
+include_recipe "accounts"
+include_recipe "munin"
+include_recipe "php::fpm"
-apache_module "rewrite"
-apache_module "proxy"
-apache_module "proxy_fcgi"
-
-home_directory = data_bag_item("accounts", "nominatim")["home"]
-source_directory = "#{home_directory}/nominatim"
+basedir = data_bag_item("accounts", "nominatim")["home"]
email_errors = data_bag_item("accounts", "lonvia")["email"]
-database_cluster = node[:nominatim][:database][:cluster]
-database_version = database_cluster.sub(/\/.*/, "")
-database_name = node[:nominatim][:database][:dbname]
-
-postgis_version = node[:nominatim][:database][:postgis]
-
-service "php5-fpm" do
- provider Chef::Provider::Service::Upstart
- action [ :enable, :start ]
- supports :status => true, :restart => true, :reload => true
+directory basedir do
+ owner "nominatim"
+ group "nominatim"
+ mode "755"
+ recursive true
end
-apache_site "nominatim.openstreetmap.org" do
- template "apache.erb"
- directory source_directory
- variables :pools => node[:nominatim][:fpm_pools]
+directory node[:nominatim][:logdir] do
+ owner "nominatim"
+ group "nominatim"
+ mode "755"
+ recursive true
end
-apache_site "default" do
- action [ :disable ]
+file "#{node[:nominatim][:logdir]}/query.log" do
+ action :create_if_missing
+ owner "www-data"
+ group "adm"
+ mode "664"
end
-node[:nominatim][:fpm_pools].each do |name,data|
- template "/etc/php5/fpm/pool.d/#{name}.conf" do
- source "fpm.conf.erb"
- owner "root"
- group "root"
- mode 0644
- variables data.merge(:name => name, :port => data[:port])
- notifies :reload, "service[php5-fpm]"
- end
+file "#{node[:nominatim][:logdir]}/update.log" do
+ action :create_if_missing
+ owner "nominatim"
+ group "adm"
+ mode "664"
end
-postgresql_user "tomh" do
- cluster database_cluster
- superuser true
+# exception granted for a limited time so that they can set up their own server
+firewall_rule "increase-limits-gnome-proxy" do
+ action :accept
+ family "inet"
+ source "net:8.43.85.23"
+ dest "fw"
+ proto "tcp:syn"
+ dest_ports "https"
+ rate_limit "s:10/sec:30"
end
-postgresql_user "lonvia" do
- cluster database_cluster
- superuser true
-end
+## Postgresql
-postgresql_user "twain" do
- cluster database_cluster
- superuser true
+include_recipe "postgresql"
+
+postgresql_version = node[:nominatim][:dbcluster].split("/").first
+postgis_version = node[:nominatim][:postgis]
+
+package "postgresql-#{postgresql_version}-postgis-#{postgis_version}"
+
+node[:nominatim][:dbadmins].each do |user|
+ postgresql_user user do
+ cluster node[:nominatim][:dbcluster]
+ superuser true
+ only_if { node[:nominatim][:state] != "slave" }
+ end
end
postgresql_user "nominatim" do
- cluster database_cluster
+ cluster node[:nominatim][:dbcluster]
superuser true
+ only_if { node[:nominatim][:state] != "slave" }
end
postgresql_user "www-data" do
- cluster database_cluster
+ cluster node[:nominatim][:dbcluster]
+ only_if { node[:nominatim][:state] != "slave" }
end
postgresql_munin "nominatim" do
- cluster database_cluster
- database database_name
+ cluster node[:nominatim][:dbcluster]
+ database node[:nominatim][:dbname]
end
-directory "/var/log/nominatim" do
- owner "nominatim"
- group "nominatim"
- mode 0755
+directory "#{basedir}/tablespaces" do
+ owner "postgres"
+ group "postgres"
+ mode "700"
end
-template "/etc/logrotate.d/nominatim" do
- source "logrotate.nominatim.erb"
- owner "root"
- group "root"
- mode 0644
-end
-
-
-package "osmosis"
-package "gcc"
-package "proj-bin"
-package "libgeos-c1"
-package "postgresql-#{database_version}-postgis-#{postgis_version}"
-package "postgresql-server-dev-#{database_version}"
-package "build-essential"
-package "libxml2-dev"
-package "libgeos-dev"
-package "libgeos++-dev"
-package "libpq-dev"
-package "libbz2-dev"
-package "libtool"
-package "automake"
-package "libproj-dev"
-package "libprotobuf-c0-dev"
-package "protobuf-c-compiler"
-package "python-psycopg2"
-package "libboost-dev"
-package "libboost-system-dev"
-package "libboost-filesystem-dev"
-package "libboost-thread-dev"
-
-execute "php-pear-db" do
- command "pear install DB"
- not_if { File.exist?("/usr/share/php/DB") }
+# Note: tablespaces must be exactly in the same location on each
+# Nominatim instance when replication is in use. Therefore
+# use symlinks to canonical directory locations.
+node[:nominatim][:tablespaces].each do |name, location|
+ directory location do
+ owner "postgres"
+ group "postgres"
+ mode "700"
+ recursive true
+ end
+
+ link "#{basedir}/tablespaces/#{name}" do
+ to location
+ end
+
+ postgresql_tablespace name do
+ cluster node[:nominatim][:dbcluster]
+ location "#{basedir}/tablespaces/#{name}"
+ end
end
-execute "compile_nominatim" do
- action :nothing
- command "cd #{source_directory} && ./autogen.sh && ./configure && make"
- user "nominatim"
+if node[:nominatim][:state] == "master"
+ postgresql_user "replication" do
+ cluster node[:nominatim][:dbcluster]
+ password data_bag_item("nominatim", "passwords")["replication"]
+ replication true
+ end
+
+ directory node[:rsyncd][:modules][:archive][:path] do
+ owner "postgres"
+ group "postgres"
+ mode "700"
+ end
+
+ template "/usr/local/bin/clean-db-nominatim" do
+ source "clean-db-nominatim.erb"
+ owner "root"
+ group "root"
+ mode "755"
+ variables :archive_dir => node[:rsyncd][:modules][:archive][:path],
+ :update_stop_file => "#{basedir}/status/updates_disabled",
+ :streaming_clients => search(:node, "nominatim_state:slave").map { |slave| slave[:fqdn] }.join(" ")
+ end
end
+## Nominatim backend
+
+include_recipe "git"
+
+package %w[
+ build-essential
+ cmake
+ g++
+ libboost-dev
+ libboost-system-dev
+ libboost-filesystem-dev
+ libexpat1-dev
+ zlib1g-dev
+ libxml2-dev
+ libbz2-dev
+ libpq-dev
+ libgeos++-dev
+ libproj-dev
+ python3-pyosmium
+ pyosmium
+ python3-psycopg2
+ php-pgsql
+ php-intl
+]
+
+source_directory = "#{basedir}/nominatim"
+build_directory = "#{basedir}/bin"
+
+directory build_directory do
+ owner "nominatim"
+ group "nominatim"
+ mode "755"
+ recursive true
+end
+
+# Normally syncing via chef is a bad idea because syncing might involve
+# an update of database functions which should not be done while an update
+# is ongoing. Therefore we sync in between update cycles. There is an
+# exception for slaves: they get DB function updates from the master, so
+# only the source code needs to be updated, which chef may do.
git source_directory do
- action :checkout
+ action node[:nominatim][:state] == "slave" ? :sync : :checkout
repository node[:nominatim][:repository]
+ revision node[:nominatim][:revision]
enable_submodules true
user "nominatim"
group "nominatim"
- notifies :run, "execute[compile_nominatim]"
+ not_if { node[:nominatim][:state] != "slave" && File.exist?("#{source_directory}/README.md") }
+ notifies :run, "execute[compile_nominatim]", :immediately
end
-directory "#{source_directory}/log" do
- owner "nominatim"
- group "nominatim"
- mode 0755
+execute "compile_nominatim" do
+ action :nothing
+ user "nominatim"
+ cwd build_directory
+ command "cmake #{source_directory} && make"
end
-
template "#{source_directory}/.git/hooks/post-merge" do
- source "update_source.erb"
- owner "nominatim"
- group "nominatim"
- mode 0755
- variables :source_directory => source_directory
-end
-
-template "#{source_directory}/settings/local.php" do
- source "nominatim.erb"
+ source "git-post-merge-hook.erb"
owner "nominatim"
group "nominatim"
- mode 0664
- variables :postgres_version => database_version
+ mode "755"
+ variables :srcdir => source_directory,
+ :builddir => build_directory,
+ :dbname => node[:nominatim][:dbname]
end
-template "#{source_directory}/settings/ip_blocks.conf" do
- action :create_if_missing
- source "ipblocks.erb"
+template "#{build_directory}/settings/local.php" do
+ source "settings.erb"
owner "nominatim"
group "nominatim"
- mode 0664
+ mode "664"
+ variables :base_url => node[:nominatim][:state] == "off" ? node[:fqdn] : "nominatim.openstreetmap.org",
+ :dbname => node[:nominatim][:dbname],
+ :flatnode_file => node[:nominatim][:flatnode_file],
+ :log_file => "#{node[:nominatim][:logdir]}/query.log"
end
-file "#{source_directory}/settings/apache_blocks.conf" do
- action :create_if_missing
- owner "nominatim"
- group "nominatim"
- mode 0664
+if node[:nominatim][:flatnode_file]
+ directory File.dirname(node[:nominatim][:flatnode_file]) do
+ recursive true
+ end
end
-file "#{source_directory}/settings/ip_blocks.map" do
+template "/etc/logrotate.d/nominatim" do
+ source "logrotate.nominatim.erb"
+ owner "root"
+ group "root"
+ mode "644"
+end
+
+external_data = [
+ "wikimedia-importance.sql.gz",
+ "gb_postcode_data.sql.gz"
+]
+
+external_data.each do |fname|
+ remote_file "#{source_directory}/data/#{fname}" do
+ action :create_if_missing
+ source "https://www.nominatim.org/data/#{fname}"
+ owner "nominatim"
+ group "nominatim"
+ mode "644"
+ end
+end
+
+remote_file "#{source_directory}/data/country_osm_grid.sql.gz" do
action :create_if_missing
+ source "https://www.nominatim.org/data/country_grid.sql.gz"
owner "nominatim"
group "nominatim"
- mode 0664
+ mode "644"
end
-if node[:nominatim][:enabled]
- cron_action = :create
+if node[:nominatim][:state] == "off"
+ cron_d "nominatim-backup" do
+ action :delete
+ end
+
+ cron_d "nominatim-vacuum-db" do
+ action :delete
+ end
+
+ cron_d "nominatim-clean-db" do
+ action :delete
+ end
+
+ cron_d "nominatim-update-maintenance-trigger" do
+ action :delete
+ end
else
- cron_action = :delete
-end
+ cron_d "nominatim-backup" do
+ action node[:nominatim][:enable_backup] ? :create : :delete
+ minute "0"
+ hour "3"
+ day "1"
+ user "nominatim"
+ command "/usr/local/bin/backup-nominatim"
+ mailto email_errors
+ end
-template "/etc/cron.d/nominatim" do
- action cron_action
- source "cron.erb"
- owner "root"
- group "root"
- mode "0644"
- variables :bin_directory => "#{source_directory}/utils", :mailto => email_errors
-end
+ cron_d "nominatim-vacuum-db" do
+ minute "20"
+ hour "0"
+ user "postgres"
+ command "/usr/local/bin/vacuum-db-nominatim"
+ mailto email_errors
+ end
+ cron_d "nominatim-clean-db" do
+ action node[:nominatim][:state] == "master" ? :create : :delete
+ minute "5"
+ hour "*/4"
+ user "postgres"
+ command "/usr/local/bin/clean-db-nominatim"
+ mailto email_errors
+ end
+
+ cron_d "nominatim-update-maintenance-trigger" do
+ minute "18"
+ hour "1"
+ user "nominatim"
+ command "touch #{basedir}/status/update_maintenance"
+ mailto email_errors
+ end
+end
template "#{source_directory}/utils/nominatim-update" do
source "updater.erb"
- user "nominatim"
- group "nominatim"
- mode 0755
+ user "nominatim"
+ group "nominatim"
+ mode "755"
+ variables :bindir => build_directory,
+ :srcdir => source_directory,
+ :logfile => "#{node[:nominatim][:logdir]}/update.log",
+ :branch => node[:nominatim][:revision],
+ :update_stop_file => "#{basedir}/status/updates_disabled",
+ :update_maintenance_trigger => "#{basedir}/status/update_maintenance"
end
template "/etc/init.d/nominatim-update" do
source "updater.init.erb"
- user "nominatim"
- group "nominatim"
- mode 0755
+ user "nominatim"
+ group "nominatim"
+ mode "755"
variables :source_directory => source_directory
end
-munin_plugin_conf "nominatim" do
- template "munin.erb"
+%w[backup-nominatim vacuum-db-nominatim].each do |fname|
+ template "/usr/local/bin/#{fname}" do
+ source "#{fname}.erb"
+ owner "root"
+ group "root"
+ mode "755"
+ variables :db => node[:nominatim][:dbname]
+ end
end
-munin_plugin "nominatim_importlag" do
- target "#{source_directory}/munin/nominatim_importlag"
+## webserver frontend
+
+directory "#{basedir}/etc" do
+ owner "nominatim"
+ group "adm"
+ mode "775"
end
-munin_plugin "nominatim_query_speed" do
- target "#{source_directory}/munin/nominatim_query_speed_querylog"
+%w[user_agent referrer email].each do |name|
+ file "#{basedir}/etc/nginx_blocked_#{name}.conf" do
+ action :create_if_missing
+ owner "nominatim"
+ group "adm"
+ mode "664"
+ end
end
-munin_plugin "nominatim_requests" do
- target "#{source_directory}/munin/nominatim_requests_querylog"
+node[:nominatim][:fpm_pools].each do |name, data|
+ php_fpm name.to_s do
+ port data[:port]
+ pm data[:pm]
+ pm_max_children data[:max_children]
+ pm_start_servers 20
+ pm_min_spare_servers 10
+ pm_max_spare_servers 20
+ pm_max_requests 10000
+ end
end
-munin_plugin "nominatim_throttled_ips" do
- target "#{source_directory}/munin/nominatim_throttled_ips"
+ssl_certificate node[:fqdn] do
+ domains [node[:fqdn],
+ "nominatim.openstreetmap.org",
+ "nominatim.osm.org",
+ "nominatim.openstreetmap.com",
+ "nominatim.openstreetmap.net",
+ "nominatim.openstreetmaps.org",
+ "nominatim.openmaps.org"]
+ notifies :reload, "service[nginx]"
end
-remote_file "#{source_directory}/data/wikipedia_article.sql.bin" do
- action :create_if_missing
- source "http://www.nominatim.org/data/wikipedia_article.sql.bin"
- owner "nominatim"
- group "nominatim"
- mode 0644
+package "apache2" do
+ action :remove
end
-remote_file "#{source_directory}/data/wikipedia_redirect.sql.bin" do
- action :create_if_missing
- source "http://www.nominatim.org/data/wikipedia_redirect.sql.bin"
- owner "nominatim"
- group "nominatim"
- mode 0644
+include_recipe "nginx"
+
+nginx_site "default" do
+ action [:delete]
end
-remote_file "#{source_directory}/data/gb_postcode_data.sql.gz" do
- action :create_if_missing
- source "http://www.nominatim.org/data/gb_postcode_data.sql.gz"
- owner "nominatim"
- group "nominatim"
- mode 0644
+nginx_site "nominatim" do
+ template "nginx.erb"
+ directory build_directory
+ variables :pools => node[:nominatim][:fpm_pools],
+ :frontends => search(:node, "recipes:web\\:\\:frontend"),
+ :confdir => "#{basedir}/etc"
end
-template "/usr/local/bin/backup-nominatim" do
- source "backup-nominatim.erb"
+template "/etc/logrotate.d/nginx" do
+ source "logrotate.nginx.erb"
owner "root"
group "root"
- mode 0755
+ mode "644"
+end
+
+munin_plugin_conf "nominatim" do
+ template "munin.erb"
+ variables :db => node[:nominatim][:dbname],
+ :querylog => "#{node[:nominatim][:logdir]}/query.log"
end
-directory File.dirname(node[:nominatim][:flatnode_file]) do
+munin_plugin "nominatim_importlag" do
+ target "#{source_directory}/munin/nominatim_importlag"
+end
+
+munin_plugin "nominatim_query_speed" do
+ target "#{source_directory}/munin/nominatim_query_speed_querylog"
+end
+
+munin_plugin "nominatim_requests" do
+ target "#{source_directory}/munin/nominatim_requests_querylog"
+end
+
+directory "#{basedir}/status" do
owner "nominatim"
- group "nominatim"
- mode 0755
- recursive true
+ group "postgres"
+ mode "775"
+end
+
+include_recipe "fail2ban"
+
+fail2ban_jail "nominatim_limit_req" do
+ filter "nginx-limit-req"
+ logpath "#{node[:nominatim][:logdir]}/nominatim.openstreetmap.org-error.log"
+ ports [80, 443]
+ maxretry 5
end