]> git.openstreetmap.org Git - chef.git/blob - cookbooks/nominatim/recipes/default.rb
26e4d4caf53b8f021dcd4245f61e5ac3f3a618ab
[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 include_recipe "prometheus"
24
25 basedir = data_bag_item("accounts", "nominatim")["home"]
26 email_errors = data_bag_item("accounts", "lonvia")["email"]
27
28 directory basedir do
29   owner "nominatim"
30   group "nominatim"
31   mode "755"
32   recursive true
33 end
34
35 ## Log directory setup
36
37 directory node[:nominatim][:logdir] do
38   owner "nominatim"
39   group "nominatim"
40   mode "755"
41   recursive true
42 end
43
44 file "#{node[:nominatim][:logdir]}/query.log" do
45   action :create_if_missing
46   owner "www-data"
47   group "adm"
48   mode "664"
49 end
50
51 file "#{node[:nominatim][:logdir]}/update.log" do
52   action :create_if_missing
53   owner "nominatim"
54   group "adm"
55   mode "664"
56 end
57
58 ## Postgresql
59
60 include_recipe "postgresql"
61
62 postgresql_version = node[:nominatim][:dbcluster].split("/").first
63 postgis_version = node[:nominatim][:postgis]
64
65 package "postgresql-#{postgresql_version}-postgis-#{postgis_version}"
66
67 node[:nominatim][:dbadmins].each do |user|
68   postgresql_user user do
69     cluster node[:nominatim][:dbcluster]
70     superuser true
71     only_if { node[:nominatim][:state] != "slave" }
72   end
73 end
74
75 postgresql_user "nominatim" do
76   cluster node[:nominatim][:dbcluster]
77   superuser true
78   only_if { node[:nominatim][:state] != "slave" }
79 end
80
81 postgresql_user "www-data" do
82   cluster node[:nominatim][:dbcluster]
83   only_if { node[:nominatim][:state] != "slave" }
84 end
85
86 postgresql_munin "nominatim" do
87   cluster node[:nominatim][:dbcluster]
88   database node[:nominatim][:dbname]
89 end
90
91 directory "#{basedir}/tablespaces" do
92   owner "postgres"
93   group "postgres"
94   mode "700"
95 end
96
97 # NOTE: tablespaces must be exactly in the same location on each
98 #       Nominatim instance when replication is in use. Therefore
99 #       use symlinks to canonical directory locations.
100 node[:nominatim][:tablespaces].each do |name, location|
101   directory location do
102     owner "postgres"
103     group "postgres"
104     mode "700"
105     recursive true
106   end
107
108   link "#{basedir}/tablespaces/#{name}" do
109     to location
110   end
111
112   postgresql_tablespace name do
113     cluster node[:nominatim][:dbcluster]
114     location "#{basedir}/tablespaces/#{name}"
115   end
116 end
117
118 ## Nominatim backend
119
120 include_recipe "git"
121
122 package %w[
123   build-essential
124   cmake
125   g++
126   libboost-dev
127   libboost-system-dev
128   libboost-filesystem-dev
129   libexpat1-dev
130   zlib1g-dev
131   libbz2-dev
132   libpq-dev
133   libproj-dev
134   liblua5.3-dev
135   lua5.3
136   python3-pyosmium
137   python3-psycopg2
138   python3-dotenv
139   python3-psutil
140   python3-jinja2
141   python3-icu
142   python3-datrie
143   python3-yaml
144   php-pgsql
145   php-intl
146   ruby
147   ruby-file-tail
148   ruby-pg
149   ruby-webrick
150 ]
151
152 source_directory = "#{basedir}/src/nominatim"
153 build_directory = "#{basedir}/src/build"
154 project_directory = "#{basedir}/planet-project"
155 bin_directory = "#{basedir}/bin"
156 cfg_directory = "#{basedir}/etc"
157 ui_directory = "#{basedir}/ui"
158 qa_bin_directory = "#{basedir}/src/Nominatim-Data-Analyser"
159 qa_data_directory = "#{basedir}/qa-data"
160
161 [basedir, "#{basedir}/src", cfg_directory, bin_directory, build_directory, project_directory].each do |path|
162   directory path do
163     owner "nominatim"
164     group "nominatim"
165     mode "755"
166     recursive true
167   end
168 end
169
170 directory "#{bin_directory}/maintenance" do
171   owner "nominatim"
172   group "nominatim"
173   mode "775"
174 end
175
176 if node[:nominatim][:flatnode_file]
177   directory File.dirname(node[:nominatim][:flatnode_file]) do
178     recursive true
179   end
180 end
181
182 # Normally syncing via chef is a bad idea because syncing might involve
183 # an update of database functions which should not be done while an update
184 # is ongoing. Therefore we sync in between update cycles. There is an
185 # exception for slaves: they get DB function updates from the master, so
186 # only the source code needs to be updated, which chef may do.
187 git source_directory do
188   action node[:nominatim][:state] == "slave" ? :sync : :checkout
189   repository node[:nominatim][:repository]
190   revision node[:nominatim][:revision]
191   enable_submodules true
192   user "nominatim"
193   group "nominatim"
194   not_if { node[:nominatim][:state] != "slave" && File.exist?("#{source_directory}/README.md") }
195   notifies :run, "execute[compile_nominatim]"
196 end
197
198 remote_file "#{source_directory}/data/country_osm_grid.sql.gz" do
199   action :create_if_missing
200   source "https://nominatim.org/data/country_grid.sql.gz"
201   owner "nominatim"
202   group "nominatim"
203   mode "644"
204 end
205
206 execute "compile_nominatim" do
207   action :nothing
208   user "nominatim"
209   cwd build_directory
210   command "cmake #{source_directory} && make"
211   notifies :run, "execute[install_nominatim]"
212 end
213
214 execute "install_nominatim" do
215   action :nothing
216   cwd build_directory
217   command "make install"
218 end
219
220 # Project directory
221
222 template "#{project_directory}/.env" do
223   source "nominatim.env.erb"
224   owner "nominatim"
225   group "nominatim"
226   mode "664"
227   variables :base_url => node[:nominatim][:state] == "off" ? node[:fqdn] : "nominatim.openstreetmap.org",
228             :dbname => node[:nominatim][:dbname],
229             :flatnode_file => node[:nominatim][:flatnode_file],
230             :log_file => "#{node[:nominatim][:logdir]}/query.log",
231             :tokenizer => node[:nominatim][:config][:tokenizer],
232             :forward_dependencies => node[:nominatim][:config][:forward_dependencies]
233 end
234
235 remote_file "#{project_directory}/wikimedia-importance.sql.gz" do
236   action :create_if_missing
237   source "https://nominatim.org/data/wikimedia-importance.sql.gz"
238   owner "nominatim"
239   group "nominatim"
240   mode "644"
241 end
242
243 %w[gb_postcodes.csv.gz us_postcodes.csv.gz].each do |fname|
244   remote_file "#{project_directory}/#{fname}" do
245     action :create
246     source "https://nominatim.org/data/#{fname}"
247     owner "nominatim"
248     group "nominatim"
249     mode "644"
250   end
251 end
252
253 # Webserver + frontend
254
255 %w[user_agent referrer email generic].each do |name|
256   file "#{cfg_directory}/nginx_blocked_#{name}.conf" do
257     action :create_if_missing
258     owner "nominatim"
259     group "adm"
260     mode "664"
261   end
262 end
263
264 node[:nominatim][:fpm_pools].each do |name, data|
265   php_fpm name do
266     port data[:port]
267     pm data[:pm]
268     pm_max_children data[:max_children]
269     pm_start_servers 20
270     pm_min_spare_servers 10
271     pm_max_spare_servers 20
272     pm_max_requests 10000
273     prometheus_port data[:prometheus_port]
274   end
275 end
276
277 ssl_certificate node[:fqdn] do
278   domains [node[:fqdn],
279            "nominatim.openstreetmap.org",
280            "nominatim.osm.org",
281            "nominatim.openstreetmap.com",
282            "nominatim.openstreetmap.net",
283            "nominatim.openstreetmaps.org",
284            "nominatim.openmaps.org",
285            "nominatim.qgis.org"]
286   notifies :reload, "service[nginx]"
287 end
288
289 include_recipe "nginx"
290
291 nginx_site "default" do
292   action [:delete]
293 end
294
295 frontends = search(:node, "recipes:web\\:\\:frontend").sort_by(&:name)
296
297 nginx_site "nominatim" do
298   template "nginx.erb"
299   directory project_directory
300   variables :pools => node[:nominatim][:fpm_pools],
301             :frontends => frontends,
302             :confdir => "#{basedir}/etc",
303             :ui_directory => ui_directory
304 end
305
306 template "/etc/logrotate.d/nginx" do
307   source "logrotate.nginx.erb"
308   owner "root"
309   group "root"
310   mode "644"
311 end
312
313 # Updates
314
315 %w[nominatim-update
316    nominatim-update-source
317    nominatim-update-refresh-db
318    nominatim-update-data
319    nominatim-daily-maintenance].each do |fname|
320   template "#{bin_directory}/#{fname}" do
321     source "#{fname}.erb"
322     owner "nominatim"
323     group "nominatim"
324     mode "554"
325     variables :bindir => bin_directory,
326               :srcdir => source_directory,
327               :builddir => build_directory,
328               :projectdir => project_directory,
329               :qabindir => qa_bin_directory,
330               :qadatadir => qa_data_directory
331   end
332 end
333
334 systemd_service "nominatim-update" do
335   description "Update the Nominatim database"
336   exec_start "#{bin_directory}/nominatim-update"
337   restart "on-success"
338   standard_output "append:#{node[:nominatim][:logdir]}/update.log"
339   standard_error "inherit"
340   working_directory project_directory
341 end
342
343 systemd_service "nominatim-update-maintenance-trigger" do
344   description "Trigger daily maintenance tasks for Nominatim DB"
345   exec_start "ln -sf #{bin_directory}/nominatim-daily-maintenance #{bin_directory}/maintenance/"
346   user "nominatim"
347 end
348
349 systemd_timer "nominatim-update-maintenance-trigger" do
350   action node[:nominatim][:state] != "off" ? :create : :delete
351   description "Schedule daily maintenance tasks for Nominatim DB"
352   on_calendar "*-*-* 02:03:00 UTC"
353 end
354
355 service "nominatim-update-maintenance-trigger" do
356   action node[:nominatim][:state] != "off" ? :enable : :disable
357 end
358
359 # Nominatim UI
360
361 git ui_directory do
362   action :sync
363   repository node[:nominatim][:ui_repository]
364   revision node[:nominatim][:ui_revision]
365   user "nominatim"
366   group "nominatim"
367 end
368
369 template "#{ui_directory}/dist/theme/config.theme.js" do
370   source "ui-config.js.erb"
371   owner "nominatim"
372   group "nominatim"
373   mode "664"
374 end
375
376 # Nominatim QA
377
378 if node[:nominatim][:enable_qa_tiles]
379   package "python3-geojson"
380
381   git qa_bin_directory do
382     repository node[:nominatim][:qa_repository]
383     revision node[:nominatim][:qa_revision]
384     enable_submodules true
385     user "nominatim"
386     group "nominatim"
387     notifies :run, "execute[compile_qa]"
388   end
389
390   execute "compile_qa" do
391     action :nothing
392     user "nominatim"
393     cwd "#{qa_bin_directory}/clustering-vt"
394     command "make"
395   end
396
397   directory qa_data_directory do
398     owner "nominatim"
399     group "nominatim"
400     mode "755"
401     recursive true
402   end
403
404   template "#{qa_bin_directory}/analyser/config/config.yaml" do
405     source "qa_config.erb"
406     owner "nominatim"
407     group "nominatim"
408     mode "755"
409     variables :outputdir => "#{qa_data_directory}/new"
410   end
411
412   ssl_certificate "qa-tile.nominatim.openstreetmap.org" do
413     domains ["qa-tile.nominatim.openstreetmap.org"]
414     notifies :reload, "service[nginx]"
415   end
416
417   nginx_site "qa-tiles.nominatim" do
418     template "nginx-qa-tiles.erb"
419     directory build_directory
420     variables :qa_data_directory => qa_data_directory
421   end
422
423 end
424
425 # Replication
426
427 cron_d "nominatim-clean-db" do
428   action node[:nominatim][:state] == "master" ? :create : :delete
429   minute "5"
430   hour "*/4"
431   user "postgres"
432   command "#{bin_directory}/clean-db-nominatim"
433   mailto email_errors
434 end
435
436 if node[:nominatim][:state] == "master"
437   postgresql_user "replication" do
438     cluster node[:nominatim][:dbcluster]
439     password data_bag_item("nominatim", "passwords")["replication"]
440     replication true
441   end
442
443   directory node[:rsyncd][:modules][:archive][:path] do
444     owner "postgres"
445     group "postgres"
446     mode "700"
447   end
448
449   template "#{bin_directory}/clean-db-nominatim" do
450     source "clean-db-nominatim.erb"
451     owner "nominatim"
452     group "nominatim"
453     mode "755"
454     variables :archive_dir => node[:rsyncd][:modules][:archive][:path],
455               :update_stop_file => "#{basedir}/status/updates_disabled",
456               :streaming_clients => search(:node, "nominatim_state:slave").map { |slave| slave[:fqdn] }.join(" ")
457   end
458 end
459
460 # Maintenance
461
462 cron_d "nominatim-backup" do
463   action (node[:nominatim][:enable_backup] && node[:nominatim][:state] != "off") ? :create : :delete
464   minute "0"
465   hour "3"
466   day "1"
467   user "nominatim"
468   command "#{bin_directory}/backup-nominatim"
469   mailto email_errors
470 end
471
472 cron_d "nominatim-vacuum-db" do
473   action node[:nominatim][:state] != "off" ? :create : :delete
474   minute "20"
475   hour "0"
476   user "postgres"
477   command "#{bin_directory}/vacuum-db-nominatim"
478   mailto email_errors
479 end
480
481 %w[backup-nominatim vacuum-db-nominatim].each do |fname|
482   template "#{bin_directory}/#{fname}" do
483     source "#{fname}.erb"
484     owner "nominatim"
485     group "nominatim"
486     mode "755"
487     variables :db => node[:nominatim][:dbname]
488   end
489 end
490
491 # Logging
492
493 template "/etc/logrotate.d/nominatim" do
494   source "logrotate.nominatim.erb"
495   owner "root"
496   group "root"
497   mode "644"
498 end
499
500 # Monitoring
501
502 munin_plugin_conf "nominatim" do
503   template "munin.erb"
504   variables :db => node[:nominatim][:dbname],
505             :querylog => "#{node[:nominatim][:logdir]}/query.log"
506 end
507
508 munin_plugin "nominatim_importlag" do
509   target "#{source_directory}/munin/nominatim_importlag"
510 end
511
512 munin_plugin "nominatim_query_speed" do
513   target "#{source_directory}/munin/nominatim_query_speed_querylog"
514 end
515
516 munin_plugin "nominatim_requests" do
517   target "#{source_directory}/munin/nominatim_requests_querylog"
518 end
519
520 prometheus_exporter "nominatim" do
521   port 8082
522   user "www-data"
523   restrict_address_families "AF_UNIX"
524   options [
525     "--nominatim.query-log=#{node[:nominatim][:logdir]}/query.log",
526     "--nominatim.database-name=#{node[:nominatim][:dbname]}"
527   ]
528 end
529
530 include_recipe "fail2ban"
531
532 frontend_addresses = frontends.collect { |f| f.ipaddresses(:role => :external) }
533
534 fail2ban_jail "nominatim_limit_req" do
535   filter "nginx-limit-req"
536   logpath "#{node[:nominatim][:logdir]}/nominatim.openstreetmap.org-error.log"
537   ports [80, 443]
538   maxretry 20
539   ignoreips frontend_addresses.flatten.sort
540 end