nominatim: add nominatim tool to global path

[chef.git] / cookbooks / nominatim / recipes / default.rb

diff --git a/cookbooks/nominatim/recipes/default.rb b/cookbooks/nominatim/recipes/default.rb
index 055b87072c771c758bbb1caf290e83a3646502c7..09ff3ff959f5c0618ad07a66ac53e34be15b7178 100644 (file)
--- a/cookbooks/nominatim/recipes/default.rb
+++ b/cookbooks/nominatim/recipes/default.rb
@@ -1,14 +1,14 @@
 #
 #

-# Cookbook Name:: nominatim
+# Cookbook:: nominatim

 # Recipe:: base
 #
 # Recipe:: base
 #

-# Copyright 2015, 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
 #
 #
 # 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,
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,


@@ -17,13 +17,25 @@
 # limitations under the License.
 #
 
 # limitations under the License.
 #
 

+include_recipe "accounts"
+include_recipe "munin"
+include_recipe "php::fpm"
+include_recipe "prometheus"
+

 basedir = data_bag_item("accounts", "nominatim")["home"]
 email_errors = data_bag_item("accounts", "lonvia")["email"]
 
 basedir = data_bag_item("accounts", "nominatim")["home"]
 email_errors = data_bag_item("accounts", "lonvia")["email"]
 

+directory basedir do
+  owner "nominatim"
+  group "nominatim"
+  mode "755"
+  recursive true
+end
+

 directory node[:nominatim][:logdir] do
   owner "nominatim"
   group "nominatim"
 directory node[:nominatim][:logdir] do
   owner "nominatim"
   group "nominatim"

-  mode 0o755
+  mode "755"

   recursive true
 end
 
   recursive true
 end
 


@@ -31,27 +43,24 @@ file "#{node[:nominatim][:logdir]}/query.log" do
   action :create_if_missing
   owner "www-data"
   group "adm"
   action :create_if_missing
   owner "www-data"
   group "adm"

-  mode 0o664
+  mode "664"

 end
 
 file "#{node[:nominatim][:logdir]}/update.log" do
   action :create_if_missing
   owner "nominatim"
   group "adm"
 end
 
 file "#{node[:nominatim][:logdir]}/update.log" do
   action :create_if_missing
   owner "nominatim"
   group "adm"

-  mode 0o664
-end
-
-directory "#{basedir}/status" do
-  owner "nominatim"
-  group "postgres"
-  mode 0o775
+  mode "664"

 end
 
 ## Postgresql
 
 include_recipe "postgresql"
 
 end
 
 ## Postgresql
 
 include_recipe "postgresql"
 

-package "postgis"
+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
 
 node[:nominatim][:dbadmins].each do |user|
   postgresql_user user do


@@ -80,17 +89,17 @@ end
 directory "#{basedir}/tablespaces" do
   owner "postgres"
   group "postgres"
 directory "#{basedir}/tablespaces" do
   owner "postgres"
   group "postgres"

-  mode 0o700
+  mode "700"

 end
 
 end
 

-# Note: tablespaces must be exactly in the same location on each
+# 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"
 #       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 0o700
+    mode "700"

     recursive true
   end
 
     recursive true
   end
 


@@ -104,7 +113,7 @@ node[:nominatim][:tablespaces].each do |name, location|
   end
 end
 
   end
 end
 

-if node[:nominatim][:state] == "master" # ~FC023
+if node[:nominatim][:state] == "master"

   postgresql_user "replication" do
     cluster node[:nominatim][:dbcluster]
     password data_bag_item("nominatim", "passwords")["replication"]
   postgresql_user "replication" do
     cluster node[:nominatim][:dbcluster]
     password data_bag_item("nominatim", "passwords")["replication"]


@@ -114,17 +123,17 @@ if node[:nominatim][:state] == "master" # ~FC023
   directory node[:rsyncd][:modules][:archive][:path] do
     owner "postgres"
     group "postgres"
   directory node[:rsyncd][:modules][:archive][:path] do
     owner "postgres"
     group "postgres"

-    mode 0o700
+    mode "700"

   end
 
   template "/usr/local/bin/clean-db-nominatim" do
     source "clean-db-nominatim.erb"
     owner "root"
     group "root"
   end
 
   template "/usr/local/bin/clean-db-nominatim" do
     source "clean-db-nominatim.erb"
     owner "root"
     group "root"

-    mode 0o755
+    mode "755"

     variables :archive_dir => node[:rsyncd][:modules][:archive][:path],
               :update_stop_file => "#{basedir}/status/updates_disabled",
     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[:fdqn] }.join(" ")
+              :streaming_clients => search(:node, "nominatim_state:slave").map { |slave| slave[:fqdn] }.join(" ")

   end
 end
 
   end
 end
 


@@ -132,28 +141,46 @@ end
 
 include_recipe "git"
 
 
 include_recipe "git"
 

-package "build-essential"
-package "cmake"
-package "g++"
-package "libboost-dev"
-package "libboost-system-dev"
-package "libboost-filesystem-dev"
-package "libexpat1-dev"
-package "zlib1g-dev"
-package "libxml2-dev"
-package "libbz2-dev"
-package "libpq-dev"
-package "libgeos++-dev"
-package "libproj-dev"
-package "osmosis"
+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
+  python3-dotenv
+  python3-psutil
+  python3-jinja2
+  python3-icu
+  python3-datrie
+  php-pgsql
+  php-intl
+  php-symfony-dotenv
+  ruby
+  ruby-file-tail
+  ruby-pg
+]

 
 source_directory = "#{basedir}/nominatim"
 build_directory = "#{basedir}/bin"
 
 source_directory = "#{basedir}/nominatim"
 build_directory = "#{basedir}/bin"

+ui_directory = "#{basedir}/ui"
+qa_bin_directory = "#{basedir}/Nominatim-Data-Analyser"
+qa_data_directory = "#{basedir}/qa-data"

 
 directory build_directory do
   owner "nominatim"
   group "nominatim"
 
 directory build_directory do
   owner "nominatim"
   group "nominatim"

-  mode 0o755
+  mode "755"

   recursive true
 end
 
   recursive true
 end
 


@@ -169,7 +196,16 @@ git source_directory do
   enable_submodules true
   user "nominatim"
   group "nominatim"
   enable_submodules true
   user "nominatim"
   group "nominatim"

-  notifies :run, "execute[compile_nominatim]", :immediately
+  not_if { node[:nominatim][:state] != "slave" && File.exist?("#{source_directory}/README.md") }
+  notifies :run, "execute[compile_nominatim]"
+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 "644"

 end
 
 execute "compile_nominatim" do
 end
 
 execute "compile_nominatim" do


@@ -179,27 +215,48 @@ execute "compile_nominatim" do
   command "cmake #{source_directory} && make"
 end
 
   command "cmake #{source_directory} && make"
 end
 

+link "/usr/local/bin/nominatim" do
+  to "#{build_directory}/nominatim"
+end
+

 template "#{source_directory}/.git/hooks/post-merge" do
   source "git-post-merge-hook.erb"
   owner "nominatim"
   group "nominatim"
 template "#{source_directory}/.git/hooks/post-merge" do
   source "git-post-merge-hook.erb"
   owner "nominatim"
   group "nominatim"

-  mode 0o755
+  mode "755"

   variables :srcdir => source_directory,
             :builddir => build_directory,
             :dbname => node[:nominatim][:dbname]
 end
 
   variables :srcdir => source_directory,
             :builddir => build_directory,
             :dbname => node[:nominatim][:dbname]
 end
 

-template "#{build_directory}/settings/local.php" do
-  source "settings.erb"
+template "#{build_directory}/.env" do
+  source "nominatim.env.erb"

   owner "nominatim"
   group "nominatim"
   owner "nominatim"
   group "nominatim"

-  mode 0o664
-  variables :dbname => node[:nominatim][:dbname],
+  mode "664"
+  variables :base_url => node[:nominatim][:state] == "off" ? node[:fqdn] : "nominatim.openstreetmap.org",
+            :dbname => node[:nominatim][:dbname],

             :flatnode_file => node[:nominatim][:flatnode_file],
             :flatnode_file => node[:nominatim][:flatnode_file],

-            :log_file => "#{node[:nominatim][:logdir]}/query.log"
+            :log_file => "#{node[:nominatim][:logdir]}/query.log",
+            :tokenizer => node[:nominatim][:config][:tokenizer]
+end
+
+git ui_directory do
+  action :sync
+  repository node[:nominatim][:ui_repository]
+  revision node[:nominatim][:ui_revision]
+  user "nominatim"
+  group "nominatim"
+end
+
+template "#{ui_directory}/dist/theme/config.theme.js" do
+  source "ui-config.js.erb"
+  owner "nominatim"
+  group "nominatim"
+  mode "664"

 end
 
 end
 

-if node[:nominatim][:flatnode_file] # ~FC023
+if node[:nominatim][:flatnode_file]

   directory File.dirname(node[:nominatim][:flatnode_file]) do
     recursive true
   end
   directory File.dirname(node[:nominatim][:flatnode_file]) do
     recursive true
   end


@@ -209,149 +266,183 @@ template "/etc/logrotate.d/nominatim" do
   source "logrotate.nominatim.erb"
   owner "root"
   group "root"
   source "logrotate.nominatim.erb"
   owner "root"
   group "root"

-  mode 0o644
+  mode "644"

 end
 
 external_data = [
 end
 
 external_data = [

-  "wikipedia_article.sql.bin",
-  "wikipedia_redirect.sql.bin",
-  "gb_postcode_data.sql.gz"
+  "wikimedia-importance.sql.gz",
+  "gb_postcodes.csv.gz",
+  "us_postcodes.csv.gz"

 ]
 
 external_data.each do |fname|
 ]
 
 external_data.each do |fname|

-  remote_file "#{source_directory}/data/#{fname}" do
-    action :create_if_missing
-    source "http://www.nominatim.org/data/#{fname}"
+  remote_file "#{build_directory}/#{fname}" do
+    action :create
+    source "https://www.nominatim.org/data/#{fname}"

     owner "nominatim"
     group "nominatim"
     owner "nominatim"
     group "nominatim"

-    mode 0o644
+    mode "644"

   end
 end
 
   end
 end
 

-template "/etc/cron.d/nominatim" do
-  action node[:nominatim][:state] == :off ? :delete : :create
-  source "nominatim.cron.erb"
-  owner "root"
-  group "root"
-  mode "0644"
-  variables :bin_directory => "#{source_directory}/utils", :mailto => email_errors
+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
+
+  systemd_timer "nominatim-update-maintenance-trigger" do
+    action :delete
+  end
+else
+  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
+
+  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
+
+  systemd_service "nominatim-update-maintenance-trigger" do
+    description "Trigger maintenance tasks for Nominatim DB"
+    exec_start "touch #{basedir}/status/update_maintenance"
+    user "nominatim"
+  end
+
+  systemd_timer "nominatim-update-maintenance-trigger" do
+    action :create
+    description "Schedule maintenance tasks for Nominatim DB"
+    on_calendar "*-*-* 02:03:00 UTC"
+  end
+
+  service "nominatim-update-maintenance-trigger" do
+    action [:enable]
+  end

 end
 
 template "#{source_directory}/utils/nominatim-update" do
   source "updater.erb"
   user "nominatim"
   group "nominatim"
 end
 
 template "#{source_directory}/utils/nominatim-update" do
   source "updater.erb"
   user "nominatim"
   group "nominatim"

-  mode 0o755
+  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",
+            :qabindir => qa_bin_directory,
+            :qadatadir => qa_data_directory

 end
 
 template "/etc/init.d/nominatim-update" do
   source "updater.init.erb"
   user "nominatim"
   group "nominatim"
 end
 
 template "/etc/init.d/nominatim-update" do
   source "updater.init.erb"
   user "nominatim"
   group "nominatim"

-  mode 0o755
+  mode "755"

   variables :source_directory => source_directory
 end
 
   variables :source_directory => source_directory
 end
 

-%w(backup-nominatim vacuum-db-nominatim).each do |fname|
+%w[backup-nominatim vacuum-db-nominatim].each do |fname|

   template "/usr/local/bin/#{fname}" do
     source "#{fname}.erb"
     owner "root"
     group "root"
   template "/usr/local/bin/#{fname}" do
     source "#{fname}.erb"
     owner "root"
     group "root"

-    mode 0o755
+    mode "755"

     variables :db => node[:nominatim][:dbname]
   end
 end
 
 ## webserver frontend
 
     variables :db => node[:nominatim][:dbname]
   end
 end
 
 ## webserver frontend
 

-template "#{source_directory}/settings/ip_blocks.conf" do
-  action :create_if_missing
-  source "ipblocks.erb"
+directory "#{basedir}/etc" do

   owner "nominatim"
   owner "nominatim"

-  group "nominatim"
-  mode 0o664
-end
-
-file "#{source_directory}/settings/apache_blocks.conf" do
-  action :create_if_missing
-  owner "nominatim"
-  group "nominatim"
-  mode 0o664
-end
-
-file "#{source_directory}/settings/ip_blocks.map" do
-  action :create_if_missing
-  owner "nominatim"
-  group "nominatim"
-  mode 0o664
+  group "adm"
+  mode "775"

 end
 
 end
 

-include_recipe "apache::ssl"
-
-package "php"
-package "php-fpm"
-package "php-pgsql"
-package "php-pear"
-package "php-db"
-
-apache_module "rewrite"
-apache_module "proxy"
-apache_module "proxy_fcgi"
-apache_module "proxy_http"
-apache_module "headers"
-
-service "php5-fpm" do
-  if node[:lsb][:release].to_f >= 15.10
-    provider Chef::Provider::Service::Systemd
-    service_name "php7.0-fpm"
-  elsif node[:lsb][:release].to_f >= 14.04
-    provider Chef::Provider::Service::Upstart
+%w[user_agent referrer email generic].each do |name|
+  file "#{basedir}/etc/nginx_blocked_#{name}.conf" do
+    action :create_if_missing
+    owner "nominatim"
+    group "adm"
+    mode "664"

   end
   end

-  action [:enable, :start]
-  supports :status => true, :restart => true, :reload => true

 end
 
 end
 

-php_confdir = node[:lsb][:release].to_f >= 15.10 ? "/etc/php/7.0" : "/etc/php5"
-

 node[:nominatim][:fpm_pools].each do |name, data|
 node[:nominatim][:fpm_pools].each do |name, data|

-  template "#{php_confdir}/fpm/pool.d/#{name}.conf" do
-    source "fpm.conf.erb"
-    owner "root"
-    group "root"
-    mode 0o644
-    variables data.merge(:name => name)
-    notifies :reload, "service[php5-fpm]"
+  php_fpm name 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
+    prometheus_port data[:prometheus_port]

   end
 end
 
   end
 end
 

-apache_site "nominatim.openstreetmap.org" do
-  template "apache.erb"
-  directory source_directory
-  variables :pools => node[:nominatim][:fpm_pools]
+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",
+           "nominatim.qgis.org"]
+  notifies :reload, "service[nginx]"

 end
 
 end
 

-apache_site "default" do
-  action [:disable]
-end
+include_recipe "nginx"

 
 

-template "/etc/logrotate.d/apache2" do
-  source "logrotate.apache.erb"
-  owner "root"
-  group "root"
-  mode 0o644
+nginx_site "default" do
+  action [:delete]

 end
 
 end
 

-include_recipe "fail2ban"
+frontends = search(:node, "recipes:web\\:\\:frontend").sort_by(&:name)

 
 

-fail2ban_filter "nominatim" do
-  failregex '^<HOST> - - \[[^]]+\] "[^"]+" 429 '
+nginx_site "nominatim" do
+  template "nginx.erb"
+  directory build_directory
+  variables :pools => node[:nominatim][:fpm_pools],
+            :frontends => frontends,
+            :confdir => "#{basedir}/etc",
+            :ui_directory => ui_directory

 end
 
 end
 

-fail2ban_jail "nominatim" do
-  filter "nominatim"
-  logpath "/var/log/apache2/nominatim.openstreetmap.org-access.log"
-  ports [80, 443]
-  maxretry 100
+template "/etc/logrotate.d/nginx" do
+  source "logrotate.nginx.erb"
+  owner "root"
+  group "root"
+  mode "644"

 end
 
 munin_plugin_conf "nominatim" do
 end
 
 munin_plugin_conf "nominatim" do


@@ -372,6 +463,80 @@ munin_plugin "nominatim_requests" do
   target "#{source_directory}/munin/nominatim_requests_querylog"
 end
 
   target "#{source_directory}/munin/nominatim_requests_querylog"
 end
 

-munin_plugin "nominatim_throttled_ips" do
-  target "#{source_directory}/munin/nominatim_throttled_ips"
+package "ruby-webrick"
+
+prometheus_exporter "nominatim" do
+  port 8082
+  user "www-data"
+  options [
+    "--nominatim.query-log=#{node[:nominatim][:logdir]}/query.log",
+    "--nominatim.database-name=#{node[:nominatim][:dbname]}"
+  ]
+end
+
+directory "#{basedir}/status" do
+  owner "nominatim"
+  group "postgres"
+  mode "775"
+end
+
+include_recipe "fail2ban"
+
+frontend_addresses = frontends.collect { |f| f.ipaddresses(:role => :external) }
+
+fail2ban_jail "nominatim_limit_req" do
+  filter "nginx-limit-req"
+  logpath "#{node[:nominatim][:logdir]}/nominatim.openstreetmap.org-error.log"
+  ports [80, 443]
+  maxretry 20
+  ignoreips frontend_addresses.flatten.sort
+end
+
+### QA tile generation
+
+if node[:nominatim][:enable_qa_tiles]
+  package "python3-geojson"
+
+  git qa_bin_directory do
+    repository node[:nominatim][:qa_repository]
+    revision node[:nominatim][:qa_revision]
+    enable_submodules true
+    user "nominatim"
+    group "nominatim"
+    notifies :run, "execute[compile_qa]"
+  end
+
+  execute "compile_qa" do
+    action :nothing
+    user "nominatim"
+    cwd "#{qa_bin_directory}/clustering-vt"
+    command "make"
+  end
+
+  directory qa_data_directory do
+    owner "nominatim"
+    group "nominatim"
+    mode "755"
+    recursive true
+  end
+
+  template "#{qa_bin_directory}/analyser/config/config.yaml" do
+    source "qa_config.erb"
+    owner "nominatim"
+    group "nominatim"
+    mode "755"
+    variables :outputdir => "#{qa_data_directory}/new"
+  end
+
+  ssl_certificate "qa-tile.nominatim.openstreetmap.org" do
+    domains ["qa-tile.nominatim.openstreetmap.org"]
+    notifies :reload, "service[nginx]"
+  end
+
+  nginx_site "qa-tiles.nominatim" do
+    template "nginx-qa-tiles.erb"
+    directory build_directory
+    variables :qa_data_directory => qa_data_directory
+  end
+

 end
 end