summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLinus Nordberg <linus@nordu.net>2016-11-17 10:36:34 +0100
committerLinus Nordberg <linus@nordu.net>2016-11-25 10:56:09 +0100
commite133280625b4f3214ab1c792bd0fb511e0dcfb2d (patch)
treeecb4b5e0ac7a475e18094fb76074d93b8315ba60
parent9f436ce835aba793cc06525e160bd2e07dd8f7cd (diff)
Add a bit of documentation.
-rw-r--r--doc/merge.txt6
-rwxr-xr-xtools/merge_backup.py5
-rwxr-xr-xtools/merge_dist.py5
-rwxr-xr-xtools/merge_fetch.py5
-rwxr-xr-xtools/merge_sth.py5
5 files changed, 19 insertions, 7 deletions
diff --git a/doc/merge.txt b/doc/merge.txt
index b2e2738..d12424f 100644
--- a/doc/merge.txt
+++ b/doc/merge.txt
@@ -3,9 +3,9 @@
The merge process
=================
-- merge-fetch maintains a single file 'fetched' referring to a given
- entry in 'logorder', indicating which entries are fetched and
- sequenced so far.
+- merge-fetch fetches new entries from all storage nodes. Maintains a
+ single file 'fetched' referring to a given entry in 'logorder',
+ indicating which entries are fetched and sequenced so far.
- merge-backup reads 'fetched' and pushes these entries to secondary
merge nodes, maintaining one file per secondary,
diff --git a/tools/merge_backup.py b/tools/merge_backup.py
index 2c17d90..e7cce26 100755
--- a/tools/merge_backup.py
+++ b/tools/merge_backup.py
@@ -3,7 +3,10 @@
#
# Copyright (c) 2014-2015, NORDUnet A/S.
# See LICENSE for licensing information.
-
+#
+# Copy entries indicated by file 'fetched' to all secondary merge nodes.
+# See catlfish/doc/merge.txt for more about the merge process.
+#
import sys
import base64
import select
diff --git a/tools/merge_dist.py b/tools/merge_dist.py
index ded25a1..6582eff 100755
--- a/tools/merge_dist.py
+++ b/tools/merge_dist.py
@@ -3,7 +3,10 @@
#
# Copyright (c) 2014-2015, NORDUnet A/S.
# See LICENSE for licensing information.
-
+#
+# Distribute the 'sth' file and all missing entries to all frontend nodes.
+# See catlfish/doc/merge.txt for more about the merge process.
+#
import sys
import json
import base64
diff --git a/tools/merge_fetch.py b/tools/merge_fetch.py
index ddd2f06..8c3a997 100755
--- a/tools/merge_fetch.py
+++ b/tools/merge_fetch.py
@@ -3,7 +3,10 @@
#
# Copyright (c) 2014-2015, NORDUnet A/S.
# See LICENSE for licensing information.
-
+#
+# Fetch new entries from all storage nodes.
+# See catlfish/doc/merge.txt for more about the merge process.
+#
import sys
import struct
import subprocess
diff --git a/tools/merge_sth.py b/tools/merge_sth.py
index 28ad34f..f4aec53 100755
--- a/tools/merge_sth.py
+++ b/tools/merge_sth.py
@@ -3,7 +3,10 @@
#
# Copyright (c) 2014-2015, NORDUnet A/S.
# See LICENSE for licensing information.
-
+#
+# Generate a new 'sth' file.
+# See catlfish/doc/merge.txt for more about the merge process.
+#
import sys
import json
import urllib2