chore: add some docs to olricd.yaml

Author: buraksezer

cmd/olricd/olricd.yaml

@@ -1,15 +1,47 @@
 olricd:
+  # BindAddr denotes the address that Olric will bind to for communication
+  # with other Olric nodes.
   bindAddr: 0.0.0.0
+
+  # BindPort denotes the address that Olric will bind to for communication
+  # with other Olric nodes.
   bindPort: 3320
+
+  # Default Serializer implementation uses gob for encoding/decoding.
   serializer: msgpack
+
+  # KeepAlivePeriod denotes whether the operating system should send
+  # keep-alive messages on the connection.
   keepAlivePeriod: 300s
+
+  # Timeout for bootstrap control
+  #
+  # An Olric node checks operation status before taking any action for the
+  # cluster events, responding incoming requests and running API functions.
+  # Bootstrapping status is one of the most important checkpoints for an
+  # "operable" Olric node. BootstrapTimeout sets a deadline to check
+  # bootstrapping status without blocking indefinitely.
   bootstrapTimeout: 5s
-  partitionCount:  13
+
+  # PartitionCount is 271, by default.
+  partitionCount: 271
+
+  # ReplicaCount is 1, by default.
   replicaCount: 1
+
+  # Minimum number of successful writes to return a response for a write request.
   writeQuorum: 1
+
+  # Minimum number of successful reads to return a response for a read request.
   readQuorum: 1
+
+  # Switch to control read-repair algorithm which helps to reduce entropy.
   readRepair: false
+
+  # Default value is SyncReplicationMode.
   replicationMode: 0 # sync mode. for async, set 1
+
+  # Minimum number of members to form a cluster and run any query on the cluster.
   memberCountQuorum: 1
   routingTablePushInterval: 1m
 
@@ -19,26 +51,100 @@ storageEngines:
       tableSize: 1048576
 
 client:
+  # Timeout for TCP dial.
+  #
+  # The timeout includes name resolution, if required. When using TCP, and the host in the address parameter
+  # resolves to multiple IP addresses, the timeout is spread over each consecutive dial, such that each is
+  # given an appropriate fraction of the time to connect.
   dialTimeout: -1s
+
+  # Timeout for socket reads. If reached, commands will fail
+  # with a timeout instead of blocking. Use value -1 for no timeout and 0 for default.
+  # Default is DefaultReadTimeout
   readTimeout: 3s
+
+  # Timeout for socket writes. If reached, commands will fail
+  # with a timeout instead of blocking.
+  # Default is DefaultWriteTimeout
   writeTimeout: 3s
+
+  # KeepAlive specifies the interval between keep-alive
+  # probes for an active network connection.
+  # If zero, keep-alive probes are sent with a default value
+  # (currently 15 seconds), if supported by the protocol and operating
+  # system. Network protocols or operating systems that do
+  # not support keep-alives ignore this field.
+  # If negative, keep-alive probes are disabled.
   keepAlive: 15s
+
+  # Minimum TCP connection count in the pool for a host:port
   minConn: 1
+
+  # Maximum TCP connection count in the pool for a host:port
   maxConn: 100
+
+  # Timeout for getting a new connection from the pool. If reached, commands will fail
+  # with a timeout instead of blocking. Use value -1 for no timeout and 0 for default.
+  # Default is DefaultPoolTimeout
   poolTimeout: 3s
 
 logging:
+  # DefaultLogVerbosity denotes default log verbosity level.
+  #
+  # * 1 - Generally useful for this to ALWAYS be visible to an operator
+  #   * Programmer errors
+  #   * Logging extra info about a panic
+  #   * CLI argument handling
+  # * 2 - A reasonable default log level if you don't want verbosity.
+  #   * Information about config (listening on X, watching Y)
+  #   * Errors that repeat frequently that relate to conditions that can be
+  #     corrected
+  # * 3 - Useful steady state information about the service and
+  #     important log messages that may correlate to
+  #   significant changes in the system.  This is the recommended default log
+  #     level for most systems.
+  #   * Logging HTTP requests and their exit code
+  #   * System state changing
+  #   * Controller state change events
+  #   * Scheduler log messages
+  # * 4 - Extended information about changes
+  #   * More info about system state changes
+  # * 5 - Debug level verbosity
+  #   * Logging in particularly thorny parts of code where you may want to come
+  #     back later and check it
+  # * 6 - Trace level verbosity
+  #   * Context to understand the steps leading up to neterrors and warnings
+  #   * More information for troubleshooting reported issues
   verbosity: 6
+
+  # Default LogLevel is DEBUG. Available levels: "DEBUG", "WARN", "ERROR", "INFO"
   level: DEBUG
   output: stderr
 
 memberlist:
   environment: local
+
+  # Configuration related to what address to bind to and ports to
+  # listen on. The port is used for both UDP and TCP gossip. It is
+  # assumed other nodes are running on this port, but they do not need
+  # to.
   bindAddr: 0.0.0.0
   bindPort: 3322
+
+  # EnableCompression is used to control message compression. This can
+  # be used to reduce bandwidth usage at the cost of slightly more CPU
+  # utilization. This is only available starting at protocol version 1.
   enableCompression: false
+
+  # JoinRetryInterval is the time gap between attempts to join an existing
+  # cluster.
   joinRetryInterval: 1ms
+
+  # MaxJoinAttempts denotes the maximum number of attemps to join an existing
+  # cluster before forming a new one.
   maxJoinAttempts: 1
+
+  # See service discovery plugins
   #peers:
   #  - "localhost:3325"