From fcf52fb06a5ddb3e1cbb54164511aae2b135a80e Mon Sep 17 00:00:00 2001
From: Tom Hughes <tom@compton.nu>
Date: Thu, 3 Dec 2020 19:58:59 +0000
Subject: [PATCH] Reorder planet replication cookbook to make it clearer

---
 cookbooks/planet/recipes/replication.rb       | 256 ++++++++++--------
 .../templates/default/changesets.conf.erb     |   2 +-
 2 files changed, 143 insertions(+), 115 deletions(-)

diff --git a/cookbooks/planet/recipes/replication.rb b/cookbooks/planet/recipes/replication.rb
index fa3616f90..8845f1b70 100644
--- a/cookbooks/planet/recipes/replication.rb
+++ b/cookbooks/planet/recipes/replication.rb
@@ -25,6 +25,8 @@ include_recipe "osmosis"
 
 db_passwords = data_bag_item("db", "passwords")
 
+## Install required packages
+
 package %w[
   postgresql-client
   ruby
@@ -39,6 +41,8 @@ package %w[
 
 gem_package "pg"
 
+## Build preload library to flush files
+
 remote_directory "/opt/flush" do
   source "flush"
   owner "root"
@@ -58,6 +62,8 @@ execute "/opt/flush/Makefile" do
   subscribes :run, "remote_directory[/opt/flush]"
 end
 
+## Install scripts
+
 remote_directory "/usr/local/bin" do
   source "replication-bin"
   owner "root"
@@ -89,6 +95,8 @@ template "/usr/local/bin/users-deleted" do
   mode "755"
 end
 
+## Published deleted users directory
+
 remote_directory "/store/planet/users_deleted" do
   source "users_deleted"
   owner "planet"
@@ -99,6 +107,8 @@ remote_directory "/store/planet/users_deleted" do
   files_mode "644"
 end
 
+## Published replication directory
+
 remote_directory "/store/planet/replication" do
   source "replication-cgi"
   owner "root"
@@ -109,103 +119,161 @@ remote_directory "/store/planet/replication" do
   files_mode "755"
 end
 
-directory "/store/planet/replication/changesets" do
+directory "/store/planet/replication/test" do
   owner "planet"
   group "planet"
   mode "755"
 end
 
-directory "/store/planet/replication/day" do
+## Configuration directory
+
+directory "/etc/replication" do
+  owner "root"
+  group "root"
+  mode "755"
+end
+
+## Transient state directory
+
+systemd_tmpfile "/run/replication" do
+  type "d"
   owner "planet"
   group "planet"
   mode "755"
 end
 
-directory "/store/planet/replication/hour" do
+## Persistent state directory
+
+directory "/var/lib/replication" do
   owner "planet"
   group "planet"
   mode "755"
 end
 
-directory "/store/planet/replication/minute" do
+directory "/var/lib/replication/test" do
   owner "planet"
   group "planet"
   mode "755"
 end
 
-directory "/store/planet/replication/test" do
+## Users replication
+
+template "/etc/replication/users-agreed.conf" do
+  source "users-agreed.conf.erb"
+  user "planet"
+  group "planet"
+  mode "600"
+  variables :password => db_passwords["planetdiff"]
+end
+
+## Changeset replication
+
+directory "/store/planet/replication/changesets" do
   owner "planet"
   group "planet"
   mode "755"
 end
 
-directory "/store/planet/replication/test/day" do
+template "/etc/replication/changesets.conf" do
+  source "changesets.conf.erb"
+  user "root"
+  group "planet"
+  mode "640"
+  variables :password => db_passwords["planetdiff"]
+end
+
+## Minutely replication
+
+directory "/store/planet/replication/minute" do
   owner "planet"
   group "planet"
   mode "755"
 end
 
-directory "/store/planet/replication/test/hour" do
+directory "/var/lib/replication/minute" do
   owner "planet"
   group "planet"
   mode "755"
 end
 
-directory "/store/planet/replication/test/minute" do
+template "/etc/replication/auth.conf" do
+  source "replication.auth.erb"
+  user "root"
+  group "planet"
+  mode "640"
+  variables :password => db_passwords["planetdiff"]
+end
+
+## Hourly replication
+
+directory "/store/planet/replication/hour" do
   owner "planet"
   group "planet"
   mode "755"
 end
 
-directory "/store/replication" do
+directory "/var/lib/replication/hour" do
   owner "planet"
   group "planet"
   mode "755"
 end
 
-directory "/store/replication/minute" do
+link "/var/lib/replication/hour/data" do
+  to "/store/planet/replication/hour"
+end
+
+template "/var/lib/replication/hour/configuration.txt" do
+  source "replication.config.erb"
   owner "planet"
   group "planet"
-  mode "755"
+  mode "644"
+  variables :base => "minute", :interval => 3600
 end
 
-systemd_tmpfile "/run/replication" do
-  type "d"
+## Daily replication
+
+directory "/store/planet/replication/day" do
   owner "planet"
   group "planet"
   mode "755"
 end
 
-directory "/etc/replication" do
-  owner "root"
-  group "root"
+directory "/var/lib/replication/day" do
+  owner "planet"
+  group "planet"
   mode "755"
 end
 
-directory "/var/run/lock/changeset-replication/" do
+link "/var/lib/replication/day/data" do
+  to "/store/planet/replication/day"
+end
+
+template "/var/lib/replication/day/configuration.txt" do
+  source "replication.config.erb"
   owner "planet"
   group "planet"
-  mode "750"
+  mode "644"
+  variables :base => "hour", :interval => 86400
 end
 
-directory "/var/lib/replication" do
+## Minutely replication (test feed)
+
+directory "/store/planet/replication/test/minute" do
   owner "planet"
   group "planet"
   mode "755"
 end
 
-directory "/var/lib/replication/test" do
+directory "/store/replication" do
   owner "planet"
   group "planet"
   mode "755"
 end
 
-template "/etc/replication/auth.conf" do
-  source "replication.auth.erb"
-  user "root"
+directory "/store/replication/minute" do
+  owner "planet"
   group "planet"
-  mode "640"
-  variables :password => db_passwords["planetdiff"]
+  mode "755"
 end
 
 osmdbt_config = {
@@ -249,12 +317,24 @@ systemd_timer "replication-minutely" do
   accuracy_sec 5
 end
 
+### Hourly replication (test feed)
+
+directory "/store/planet/replication/test/hour" do
+  owner "planet"
+  group "planet"
+  mode "755"
+end
+
 directory "/var/lib/replication/test/hour" do
   owner "planet"
   group "planet"
   mode "755"
 end
 
+link "/var/lib/replication/test/hour/data" do
+  to "/store/planet/replication/test/hour"
+end
+
 template "/var/lib/replication/test/hour/configuration.txt" do
   source "replication.config.erb"
   owner "planet"
@@ -263,10 +343,6 @@ template "/var/lib/replication/test/hour/configuration.txt" do
   variables :base => "test/minute", :interval => 3600
 end
 
-link "/var/lib/replication/test/hour/data" do
-  to "/store/planet/replication/test/hour"
-end
-
 systemd_service "replication-hourly" do
   description "Hourly replication"
   user "planet"
@@ -284,12 +360,24 @@ systemd_timer "replication-hourly" do
   on_calendar "*-*-* *:02/15:00"
 end
 
+## Daily replication (test feed)
+
+directory "/store/planet/replication/test/day" do
+  owner "planet"
+  group "planet"
+  mode "755"
+end
+
 directory "/var/lib/replication/test/day" do
   owner "planet"
   group "planet"
   mode "755"
 end
 
+link "/var/lib/replication/test/day/data" do
+  to "/store/planet/replication/test/day"
+end
+
 template "/var/lib/replication/test/day/configuration.txt" do
   source "replication.config.erb"
   owner "planet"
@@ -298,10 +386,6 @@ template "/var/lib/replication/test/day/configuration.txt" do
   variables :base => "test/hour", :interval => 86400
 end
 
-link "/var/lib/replication/test/day/data" do
-  to "/store/planet/replication/test/day"
-end
-
 systemd_service "replication-daily" do
   description "Daily replication"
   user "planet"
@@ -319,63 +403,7 @@ systemd_timer "replication-daily" do
   on_calendar "*-*-* *:02/15:00"
 end
 
-template "/etc/replication/changesets.conf" do
-  source "changesets.conf.erb"
-  user "root"
-  group "planet"
-  mode "640"
-  variables :password => db_passwords["planetdiff"]
-end
-
-template "/etc/replication/users-agreed.conf" do
-  source "users-agreed.conf.erb"
-  user "planet"
-  group "planet"
-  mode "600"
-  variables :password => db_passwords["planetdiff"]
-end
-
-directory "/var/lib/replication/minute" do
-  owner "planet"
-  group "planet"
-  mode "755"
-end
-
-directory "/var/lib/replication/hour" do
-  owner "planet"
-  group "planet"
-  mode "755"
-end
-
-template "/var/lib/replication/hour/configuration.txt" do
-  source "replication.config.erb"
-  owner "planet"
-  group "planet"
-  mode "644"
-  variables :base => "minute", :interval => 3600
-end
-
-link "/var/lib/replication/hour/data" do
-  to "/store/planet/replication/hour"
-end
-
-directory "/var/lib/replication/day" do
-  owner "planet"
-  group "planet"
-  mode "755"
-end
-
-template "/var/lib/replication/day/configuration.txt" do
-  source "replication.config.erb"
-  owner "planet"
-  group "planet"
-  mode "644"
-  variables :base => "hour", :interval => 86400
-end
-
-link "/var/lib/replication/day/data" do
-  to "/store/planet/replication/day"
-end
+## Enable/disable feeds
 
 if node[:planet][:replication] == "enabled"
   cron_d "users-agreed" do
@@ -400,18 +428,6 @@ if node[:planet][:replication] == "enabled"
     mailto "zerebubuth@gmail.com"
   end
 
-  service "replication-minutely.timer" do
-    action [:enable, :start]
-  end
-
-  service "replication-hourly.timer" do
-    action [:enable, :start]
-  end
-
-  service "replication-daily.timer" do
-    action [:enable, :start]
-  end
-
   cron_d "replication-minutely" do
     user "planet"
     command "/usr/local/bin/osmosis -q --replicate-apidb authFile=/etc/replication/auth.conf validateSchemaVersion=false --write-replication workingDirectory=/store/planet/replication/minute"
@@ -434,6 +450,18 @@ if node[:planet][:replication] == "enabled"
     mailto "brett@bretth.com"
     environment "LD_PRELOAD" => "/opt/flush/flush.so"
   end
+
+  service "replication-minutely.timer" do
+    action [:enable, :start]
+  end
+
+  service "replication-hourly.timer" do
+    action [:enable, :start]
+  end
+
+  service "replication-daily.timer" do
+    action [:enable, :start]
+  end
 else
   cron_d "users-agreed" do
     action :delete
@@ -447,18 +475,6 @@ else
     action :delete
   end
 
-  service "replication-minutely.timer" do
-    action [:stop, :disable]
-  end
-
-  service "replication-hourly.timer" do
-    action [:stop, :disable]
-  end
-
-  service "replication-daily.timer" do
-    action [:stop, :disable]
-  end
-
   cron_d "replication-minutely" do
     action :delete
   end
@@ -470,4 +486,16 @@ else
   cron_d "replication-daily" do
     action :delete
   end
+
+  service "replication-minutely.timer" do
+    action [:stop, :disable]
+  end
+
+  service "replication-hourly.timer" do
+    action [:stop, :disable]
+  end
+
+  service "replication-daily.timer" do
+    action [:stop, :disable]
+  end
 end
diff --git a/cookbooks/planet/templates/default/changesets.conf.erb b/cookbooks/planet/templates/default/changesets.conf.erb
index 73fc83e17..d315cbc38 100644
--- a/cookbooks/planet/templates/default/changesets.conf.erb
+++ b/cookbooks/planet/templates/default/changesets.conf.erb
@@ -1,4 +1,4 @@
 state_file: /store/planet/replication/changesets/state.yaml
 db: host=<%= node[:web][:database_host] %> dbname=openstreetmap user=planetdiff password=<%= @password %>
 data_dir: /store/planet/replication/changesets
-lock_file: /var/run/lock/changeset-replication/lockfile
+lock_file: /run/lock/replication/changesets.lock
-- 
2.43.2