X-Git-Url: https://git.openstreetmap.org./chef.git/blobdiff_plain/b20599b6503be65674c3e420be6cca91b507ac0a..794cc957324de66edab45373053be3e601090f1f:/cookbooks/nominatim/recipes/default.rb diff --git a/cookbooks/nominatim/recipes/default.rb b/cookbooks/nominatim/recipes/default.rb index 682352a6d..7eb6a1e74 100644 --- a/cookbooks/nominatim/recipes/default.rb +++ b/cookbooks/nominatim/recipes/default.rb @@ -1,14 +1,14 @@ # -# 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, @@ -17,275 +17,356 @@ # limitations under the License. # -include_recipe "apache::ssl" +include_recipe "accounts" +include_recipe "prometheus" include_recipe "postgresql" +include_recipe "python" +include_recipe "nginx" include_recipe "git" +include_recipe "fail2ban" -package "php5" -package "php5-cli" -package "php5-pgsql" -package "php5-fpm" -package "php-pear" -package "php-apc" +basedir = data_bag_item("accounts", "nominatim")["home"] +project_directory = "#{basedir}/planet-project" +bin_directory = "#{basedir}/bin" +cfg_directory = "#{basedir}/etc" +ui_directory = "#{basedir}/ui" +qa_data_directory = "#{basedir}/qa-data" -apache_module "rewrite" -apache_module "proxy" -apache_module "proxy_fcgi" - -home_directory = data_bag_item("accounts", "nominatim")["home"] -source_directory = "#{home_directory}/nominatim" -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] +[basedir, bin_directory, cfg_directory, project_directory, ui_directory].each do |path| + directory path do + owner "nominatim" + group "nominatim" + mode "755" + end end -apache_site "default" do - action [ :disable ] +if node[:nominatim][:flatnode_file] + directory File.dirname(node[:nominatim][:flatnode_file]) do + recursive true + end 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 +directory "#{bin_directory}/maintenance" do + owner "nominatim" + group "nominatim" + mode "775" end -postgresql_user "tomh" do - cluster database_cluster - superuser true +## Log directory setup + +directory node[:nominatim][:logdir] do + owner "nominatim" + group "nominatim" + mode "755" + recursive true end -postgresql_user "lonvia" do - cluster database_cluster - superuser true +file "#{node[:nominatim][:logdir]}/query.log" do + action :create_if_missing + owner "www-data" + group "adm" + mode "664" end -postgresql_user "twain" do - cluster database_cluster - superuser true +### 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 + end end postgresql_user "nominatim" do - cluster database_cluster + cluster node[:nominatim][:dbcluster] superuser true end postgresql_user "www-data" do - cluster database_cluster + cluster node[:nominatim][:dbcluster] end -postgresql_munin "nominatim" do - cluster database_cluster - database database_name -end +### Nominatim -directory "/var/log/nominatim" do - owner "nominatim" - group "nominatim" - mode 0755 -end +python_directory = "#{basedir}/venv" -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") } -end - -execute "compile_nominatim" do - action :nothing - command "cd #{source_directory} && ./autogen.sh && ./configure && make" - user "nominatim" -end +package %w[ + build-essential + libicu-dev + python3-dev + pkg-config + osm2pgsql + ruby + ruby-file-tail + ruby-pg + ruby-webrick +] -git source_directory do - action :checkout - repository node[:nominatim][:repository] - enable_submodules true - user "nominatim" - group "nominatim" - notifies :run, "execute[compile_nominatim]" +python_virtualenv python_directory do + interpreter "/usr/bin/python3" end -directory "#{source_directory}/log" do - owner "nominatim" - group "nominatim" - mode 0755 +# These are updated during the database update. +python_package "nominatim-db" do + python_virtualenv python_directory + extra_index_url node[:nominatim][:pip_index] end - -template "#{source_directory}/.git/hooks/post-merge" do - source "update_source.erb" - owner "nominatim" - group "nominatim" - mode 0755 - variables :source_directory => source_directory +python_package "nominatim-api" do + python_virtualenv python_directory + extra_index_url node[:nominatim][:pip_index] end -template "#{source_directory}/settings/local.php" do - source "nominatim.erb" +remote_directory "#{project_directory}/static-website" do + source "website" owner "nominatim" group "nominatim" - mode 0664 - variables :postgres_version => database_version + mode "755" + files_owner "nominatim" + files_group "nominatim" + files_mode "644" + purge false end -template "#{source_directory}/settings/ip_blocks.conf" do - action :create_if_missing - source "ipblocks.erb" +template "#{project_directory}/.env" do + source "nominatim.env.erb" owner "nominatim" group "nominatim" - mode 0664 + mode "664" + variables :base_url => "nominatim.openstreetmap.org", + :dbname => node[:nominatim][:dbname], + :flatnode_file => node[:nominatim][:flatnode_file], + :log_file => "#{node[:nominatim][:logdir]}/query.log", + :pool_size => node[:nominatim][:api_pool_size], + :query_timeout => node[:nominatim][:api_query_timeout], + :request_timeout => node[:nominatim][:api_request_timeout] end -file "#{source_directory}/settings/apache_blocks.conf" do +remote_file "#{project_directory}/secondary_importance.sql.gz" do action :create_if_missing + source "https://nominatim.org/data/wikimedia-secondary-importance.sql.gz" owner "nominatim" group "nominatim" - mode 0664 + mode "644" end -file "#{source_directory}/settings/ip_blocks.map" do +remote_file "#{project_directory}/wikimedia-importance.csv.gz" do action :create_if_missing + source "https://nominatim.org/data/wikimedia-importance.csv.gz" owner "nominatim" group "nominatim" - mode 0664 + mode "644" end -if node[:nominatim][:enabled] - cron_action = :create -else - cron_action = :delete +%w[gb_postcodes.csv.gz us_postcodes.csv.gz].each do |fname| + remote_file "#{project_directory}/#{fname}" do + action :create + source "https://nominatim.org/data/#{fname}" + owner "nominatim" + group "nominatim" + mode "644" + end 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 +# Webserver + frontend + +%w[user_agent referrer email generic].each do |name| + file "#{cfg_directory}/nginx_blocked_#{name}.conf" do + action :create_if_missing + owner "nominatim" + group "adm" + mode "664" + end +end + +systemd_service "nominatim" do + description "Nominatim running as a gunicorn application" + user "www-data" + group "www-data" + working_directory project_directory + standard_output "append:#{node[:nominatim][:logdir]}/gunicorn.log" + standard_error "inherit" + exec_start "#{python_directory}/bin/gunicorn --max-requests 200000 -b unix:/run/gunicorn-nominatim.openstreetmap.org.sock -w #{node[:nominatim][:api_workers]} -k uvicorn.workers.UvicornWorker 'nominatim_api.server.falcon.server:run_wsgi()'" + exec_reload "/bin/kill -s HUP $MAINPID" + kill_mode "mixed" + timeout_stop_sec 5 + private_tmp true + requires "nominatim.socket" + after "network.target" end +systemd_socket "nominatim" do + description "Gunicorn socket for Nominatim" + listen_stream "/run/gunicorn-nominatim.openstreetmap.org.sock" + socket_user "www-data" +end -template "#{source_directory}/utils/nominatim-update" do - source "updater.erb" - user "nominatim" - group "nominatim" - mode 0755 +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 -template "/etc/init.d/nominatim-update" do - source "updater.init.erb" - user "nominatim" - group "nominatim" - mode 0755 - variables :source_directory => source_directory +nginx_site "default" do + action [:delete] end -munin_plugin_conf "nominatim" do - template "munin.erb" +frontends = search(:node, "recipes:web\\:\\:frontend").sort_by(&:name) + +nginx_site "nominatim" do + template "nginx.erb" + directory project_directory + variables :pools => node[:nominatim][:fpm_pools], + :frontends => frontends, + :confdir => "#{basedir}/etc", + :ui_directory => ui_directory end -munin_plugin "nominatim_importlag" do - target "#{source_directory}/munin/nominatim_importlag" +template "/etc/logrotate.d/nginx" do + source "logrotate.nginx.erb" + owner "root" + group "root" + mode "644" +end + +### Import, update and maintenance scripts + +%w[nominatim-update + nominatim-update-data + nominatim-update-refresh-db + nominatim-daily-maintenance].each do |fname| + template "#{bin_directory}/#{fname}" do + source "#{fname}.erb" + owner "nominatim" + group "nominatim" + mode "554" + variables :bindir => bin_directory, + :projectdir => project_directory, + :venvprefix => "#{python_directory}/bin/", + :qadatadir => qa_data_directory + end end -munin_plugin "nominatim_query_speed" do - target "#{source_directory}/munin/nominatim_query_speed_querylog" +systemd_service "nominatim-update" do + description "Update the Nominatim database" + exec_start "#{bin_directory}/nominatim-update" + restart "on-success" + standard_output "journal" + standard_error "inherit" + working_directory project_directory end -munin_plugin "nominatim_requests" do - target "#{source_directory}/munin/nominatim_requests_querylog" +systemd_service "nominatim-update-maintenance-trigger" do + description "Trigger daily maintenance tasks for Nominatim DB" + exec_start "ln -sf #{bin_directory}/nominatim-daily-maintenance #{bin_directory}/maintenance/" + user "nominatim" end -munin_plugin "nominatim_throttled_ips" do - target "#{source_directory}/munin/nominatim_throttled_ips" +systemd_timer "nominatim-update-maintenance-trigger" do + action :create + description "Schedule daily maintenance tasks for Nominatim DB" + on_calendar "*-*-* 02:03:00 UTC" 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 +service "nominatim-update-maintenance-trigger" do + action :enable 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 +## Nominatim UI + +git ui_directory do + action :sync + repository node[:nominatim][:ui_repository] + revision node[:nominatim][:ui_revision] + user "nominatim" + group "nominatim" 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 +template "#{ui_directory}/dist/theme/config.theme.js" do + source "ui-config.js.erb" + owner "nominatim" + group "nominatim" + mode "664" end -template "/usr/local/bin/backup-nominatim" do - source "backup-nominatim.erb" +## Nominatim QA + +if node[:nominatim][:enable_qa_tiles] + python_package "nominatim-data-analyser" do + python_virtualenv python_directory + extra_index_url node[:nominatim][:pip_index] + end + + directory qa_data_directory do + owner "nominatim" + group "nominatim" + mode "755" + recursive true + end + + template "#{project_directory}/qa-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 qa_data_directory + variables :qa_data_directory => qa_data_directory + end +end + +## Logging and monitoring + +template "/etc/logrotate.d/nominatim" do + source "logrotate.nominatim.erb" owner "root" group "root" - mode 0755 + mode "644" end -directory File.dirname(node[:nominatim][:flatnode_file]) do - owner "nominatim" - group "nominatim" - mode 0755 - recursive true +prometheus_exporter "nominatim" do + port 8082 + user "www-data" + restrict_address_families "AF_UNIX" + options [ + "--nominatim.query-log=#{node[:nominatim][:logdir]}/query.log", + "--nominatim.database-name=#{node[:nominatim][:dbname]}" + ] end +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