]> git.openstreetmap.org Git - chef.git/blob - cookbooks/nominatim/recipes/default.rb
nominatim: add qa tile generation
[chef.git] / 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   python3-dotenv
172   python3-psutil
173   python3-jinja2
174   python3-icu
175   php-pgsql
176   php-intl
177   php-symfony-dotenv
178 ]
179
180 source_directory = "#{basedir}/nominatim"
181 build_directory = "#{basedir}/bin"
182 ui_directory = "#{basedir}/ui"
183 qa_bin_directory = "#{basedir}/Nominatim-Data-Analyser"
184 qa_data_directory = "#{basedir}/qa-data"
185
186 directory build_directory do
187   owner "nominatim"
188   group "nominatim"
189   mode "755"
190   recursive true
191 end
192
193 # Normally syncing via chef is a bad idea because syncing might involve
194 # an update of database functions which should not be done while an update
195 # is ongoing. Therefore we sync in between update cycles. There is an
196 # exception for slaves: they get DB function updates from the master, so
197 # only the source code needs to be updated, which chef may do.
198 git source_directory do
199   action node[:nominatim][:state] == "slave" ? :sync : :checkout
200   repository node[:nominatim][:repository]
201   revision node[:nominatim][:revision]
202   enable_submodules true
203   user "nominatim"
204   group "nominatim"
205   not_if { node[:nominatim][:state] != "slave" && File.exist?("#{source_directory}/README.md") }
206   notifies :run, "execute[compile_nominatim]"
207 end
208
209 remote_file "#{source_directory}/data/country_osm_grid.sql.gz" do
210   action :create_if_missing
211   source "https://www.nominatim.org/data/country_grid.sql.gz"
212   owner "nominatim"
213   group "nominatim"
214   mode "644"
215 end
216
217 execute "compile_nominatim" do
218   action :nothing
219   user "nominatim"
220   cwd build_directory
221   command "cmake #{source_directory} && make"
222 end
223
224 template "#{source_directory}/.git/hooks/post-merge" do
225   source "git-post-merge-hook.erb"
226   owner "nominatim"
227   group "nominatim"
228   mode "755"
229   variables :srcdir => source_directory,
230             :builddir => build_directory,
231             :dbname => node[:nominatim][:dbname]
232 end
233
234 template "#{build_directory}/.env" do
235   source "nominatim.env.erb"
236   owner "nominatim"
237   group "nominatim"
238   mode "664"
239   variables :base_url => node[:nominatim][:state] == "off" ? node[:fqdn] : "nominatim.openstreetmap.org",
240             :dbname => node[:nominatim][:dbname],
241             :flatnode_file => node[:nominatim][:flatnode_file],
242             :log_file => "#{node[:nominatim][:logdir]}/query.log"
243 end
244
245 git ui_directory do
246   action :sync
247   repository node[:nominatim][:ui_repository]
248   revision node[:nominatim][:ui_revision]
249   user "nominatim"
250   group "nominatim"
251 end
252
253 template "#{ui_directory}/dist/theme/config.theme.js" do
254   source "ui-config.js.erb"
255   owner "nominatim"
256   group "nominatim"
257   mode "664"
258 end
259
260 if node[:nominatim][:flatnode_file]
261   directory File.dirname(node[:nominatim][:flatnode_file]) do
262     recursive true
263   end
264 end
265
266 template "/etc/logrotate.d/nominatim" do
267   source "logrotate.nominatim.erb"
268   owner "root"
269   group "root"
270   mode "644"
271 end
272
273 external_data = [
274   "wikimedia-importance.sql.gz",
275   "gb_postcodes.csv.gz",
276   "us_postcodes.csv.gz"
277 ]
278
279 external_data.each do |fname|
280   remote_file "#{build_directory}/#{fname}" do
281     action :create_if_missing
282     source "https://www.nominatim.org/data/#{fname}"
283     owner "nominatim"
284     group "nominatim"
285     mode "644"
286   end
287 end
288
289 if node[:nominatim][:state] == "off"
290   cron_d "nominatim-backup" do
291     action :delete
292   end
293
294   cron_d "nominatim-vacuum-db" do
295     action :delete
296   end
297
298   cron_d "nominatim-clean-db" do
299     action :delete
300   end
301
302   cron_d "nominatim-update-maintenance-trigger" do
303     action :delete
304   end
305 else
306   cron_d "nominatim-backup" do
307     action node[:nominatim][:enable_backup] ? :create : :delete
308     minute "0"
309     hour "3"
310     day "1"
311     user "nominatim"
312     command "/usr/local/bin/backup-nominatim"
313     mailto email_errors
314   end
315
316   cron_d "nominatim-vacuum-db" do
317     minute "20"
318     hour "0"
319     user "postgres"
320     command "/usr/local/bin/vacuum-db-nominatim"
321     mailto email_errors
322   end
323
324   cron_d "nominatim-clean-db" do
325     action node[:nominatim][:state] == "master" ? :create : :delete
326     minute "5"
327     hour "*/4"
328     user "postgres"
329     command "/usr/local/bin/clean-db-nominatim"
330     mailto email_errors
331   end
332
333   cron_d "nominatim-update-maintenance-trigger" do
334     minute "18"
335     hour "1"
336     user "nominatim"
337     command "touch #{basedir}/status/update_maintenance"
338     mailto email_errors
339   end
340 end
341
342 template "#{source_directory}/utils/nominatim-update" do
343   source "updater.erb"
344   user "nominatim"
345   group "nominatim"
346   mode "755"
347   variables :bindir => build_directory,
348             :srcdir => source_directory,
349             :logfile => "#{node[:nominatim][:logdir]}/update.log",
350             :branch => node[:nominatim][:revision],
351             :update_stop_file => "#{basedir}/status/updates_disabled",
352             :update_maintenance_trigger => "#{basedir}/status/update_maintenance"
353 end
354
355 template "/etc/init.d/nominatim-update" do
356   source "updater.init.erb"
357   user "nominatim"
358   group "nominatim"
359   mode "755"
360   variables :source_directory => source_directory
361 end
362
363 %w[backup-nominatim vacuum-db-nominatim].each do |fname|
364   template "/usr/local/bin/#{fname}" do
365     source "#{fname}.erb"
366     owner "root"
367     group "root"
368     mode "755"
369     variables :db => node[:nominatim][:dbname]
370   end
371 end
372
373 ## webserver frontend
374
375 directory "#{basedir}/etc" do
376   owner "nominatim"
377   group "adm"
378   mode "775"
379 end
380
381 %w[user_agent referrer email generic].each do |name|
382   file "#{basedir}/etc/nginx_blocked_#{name}.conf" do
383     action :create_if_missing
384     owner "nominatim"
385     group "adm"
386     mode "664"
387   end
388 end
389
390 node[:nominatim][:fpm_pools].each do |name, data|
391   php_fpm name do
392     port data[:port]
393     pm data[:pm]
394     pm_max_children data[:max_children]
395     pm_start_servers 20
396     pm_min_spare_servers 10
397     pm_max_spare_servers 20
398     pm_max_requests 10000
399     prometheus_port data[:prometheus_port]
400   end
401 end
402
403 ssl_certificate node[:fqdn] do
404   domains [node[:fqdn],
405            "nominatim.openstreetmap.org",
406            "nominatim.osm.org",
407            "nominatim.openstreetmap.com",
408            "nominatim.openstreetmap.net",
409            "nominatim.openstreetmaps.org",
410            "nominatim.openmaps.org",
411            "nominatim.qgis.org"]
412   notifies :reload, "service[nginx]"
413 end
414
415 package "apache2" do
416   action :remove
417 end
418
419 include_recipe "nginx"
420
421 nginx_site "default" do
422   action [:delete]
423 end
424
425 frontends = search(:node, "recipes:web\\:\\:frontend").sort_by(&:name)
426
427 nginx_site "nominatim" do
428   template "nginx.erb"
429   directory build_directory
430   variables :pools => node[:nominatim][:fpm_pools],
431             :frontends => frontends,
432             :confdir => "#{basedir}/etc",
433             :ui_directory => ui_directory
434 end
435
436 template "/etc/logrotate.d/nginx" do
437   source "logrotate.nginx.erb"
438   owner "root"
439   group "root"
440   mode "644"
441 end
442
443 munin_plugin_conf "nominatim" do
444   template "munin.erb"
445   variables :db => node[:nominatim][:dbname],
446             :querylog => "#{node[:nominatim][:logdir]}/query.log"
447 end
448
449 munin_plugin "nominatim_importlag" do
450   target "#{source_directory}/munin/nominatim_importlag"
451 end
452
453 munin_plugin "nominatim_query_speed" do
454   target "#{source_directory}/munin/nominatim_query_speed_querylog"
455 end
456
457 munin_plugin "nominatim_requests" do
458   target "#{source_directory}/munin/nominatim_requests_querylog"
459 end
460
461 directory "#{basedir}/status" do
462   owner "nominatim"
463   group "postgres"
464   mode "775"
465 end
466
467 include_recipe "fail2ban"
468
469 frontend_addresses = frontends.collect { |f| f.ipaddresses(:role => :external) }
470
471 fail2ban_jail "nominatim_limit_req" do
472   filter "nginx-limit-req"
473   logpath "#{node[:nominatim][:logdir]}/nominatim.openstreetmap.org-error.log"
474   ports [80, 443]
475   maxretry 20
476   ignoreips frontend_addresses.flatten.sort
477 end
478
479 ### QA tile generation
480
481 if node[:nominatim][:enable_qa_tiles]
482   git qa_bin_directory do
483     repository node[:nominatim][:qa_repository]
484     revision node[:nominatim][:qa_revision]
485     enable_submodules true
486     user "nominatim"
487     group "nominatim"
488     notifies :run, "execute[compile_qa]"
489   end
490
491   execute "compile_nominatim" do
492     action :nothing
493     user "nominatim"
494     cwd "#{qa_bin_directory}/clustering-vt"
495     command "make"
496   end
497
498   directory qa_data_directory do
499     owner "nominatim"
500     group "nominatim"
501     mode "755"
502     recursive true
503   end
504
505   template "#{qa_bin_directory}/analyser/config/config.yaml" do
506     source "qa_config.erb"
507     owner "nominatim"
508     group "nominatim"
509     mode "755"
510     variables :outputdir => "#{qa_data_directory}/new"
511   end
512
513
514 end