archipelago conf: Add comments on settings

diff --git a/xseg/conf/archipelago.conf b/xseg/conf/archipelago.conf
index efa4c7c..9d15c47 100644 (file)
--- a/xseg/conf/archipelago.conf
+++ b/xseg/conf/archipelago.conf
@@ -1,11 +1,18 @@
 # xseg
-#SPEC="segdev:xsegbd:1024:5120:12"
+
+# Max xseg ports supported by segment
 SEGMENT_PORTS = 1024
+# Max segment size
 SEGMENT_SIZE = 5120
 
+# Start port of xsegbd devices
 XSEGBD_START=0
+# End port of xsegbd devices
 XSEGBD_END=499
+
+# Start of port range that can be used by the vlmc tool
 VTOOL_START=1003
+# End of port range that can be used by the vlmc tool
 VTOOL_END=1022
 
 # (peer role, peer type)
@@ -20,19 +27,40 @@ VTOOL_END=1022
 #      file_blocker
 #      mapperd
 #      vlmcd
+#
 # Order matters. Peers will be started with list order and stopped with reversed
 # order.
+
 roles = [('blockerb', 'file_blocker'),
          ('blockerm', 'file_blocker'),
          ('mapperd', 'mapperd'),
          ('vlmcd', 'vlmcd')]
 
-#nr_ops: Max number of flying operations
-#log_level: verbosity levels for each xseg peer
+# Generic peer options
+# portno_start: Start of port range that will be used by the peer
+# portno_end: End of port range that will be used by the peer
+# nr_ops: Max number of flying operations
+# log_level: verbosity levels for each xseg peer
 #            0 - Error
 #            1 - Warnings
 #            2 - Info
 #            3 - Debug
+# Warning: debug level 3 logs A LOT!
+# nr_threads: Number of threads of each peer. Currently only blockers supports
+#            threads with the following tricks:
+#            a) Threads in file_blocker are I/O threads that block.
+#            b) Threads in rados_blocker are processing threads. For lock
+#            congestion reasons, avoid setting them to a value larger than 4.
+
+
+# file_blocker specific options:
+#
+# archip_dir: Where archipelago files will reside
+# fdcache: Fd cache size
+
+# rados_blocker specific options:
+#
+# pool: rados pool where objects will reside
 
 blockerb= {
     'portno_start': 1000,
@@ -54,6 +82,11 @@ blockerm = {
     'fdcache': 512,
 }
 
+# mapperd specific options:
+#
+# blockerb_port: target port that will be used to communicate with the blockerb
+# blockerm_port: target port that will be used to communicate with the blockerm
+
 mapperd = {
     'portno_start': 1001,
     'portno_end': 1001,
@@ -63,6 +96,11 @@ mapperd = {
     'blockerm_port': 1002
 }
 
+# vlmcd specific options:
+#
+# blocker_port: target port that will be used to communicate with the blockerb
+# mapper_port: target port that will be used to communicate with the mapper
+
 vlmcd = {
     'portno_start': 500,
     'portno_end': 999,