[sheepdog] [PATCH 03/11] Doc. "Sheepdog Basic" add chapter "configuration"

[Valerio Pachera]

Signed-off-by: Valerio Pachera <sirio81 at gmail.com>
---
 doc/configuration.rst |  116 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 116 insertions(+)
 create mode 100644 doc/configuration.rst

diff --git a/doc/configuration.rst b/doc/configuration.rst
new file mode 100644
index 0000000..804aadc
--- /dev/null
+++ b/doc/configuration.rst
@@ -0,0 +1,116 @@
+Configuration / Setup
+======================
+
+**VERY IMPORTANT:** your hosts' clock have to be synchronized!
+
+Install and configure *ntp* or *ntpdate*.
+Once done, you can proceed to run corosync.
+
+There's almost no configuration required.
+Only corosync has a configuration file that requires a 
+single parameter to be modified.
+
+On each node: configure corosync simply by adding the host ip.
+
+::
+
+    /etc/corosync/corosync.conf
+    ...
+    interface {
+        # The following values need to be set based on your environment
+        ringnumber: 0
+        bindnetaddr: <Insert Your IP>
+        mcastaddr: 226.94.1.1
+        mcastport: 5405
+    }
+    ...
+
+and restart the service
+
+::
+
+    service corosync restart
+  
+Finaly, check if the process is running:
+
+::
+
+    pgrep -l corosync
+    
+In case your distro doesn't provide a configuration file, here's a template.
+
+::
+
+    # Please read the openais.conf.5 manual page
+    totem {
+            version: 2
+
+            # How long before declaring a token lost (ms)
+            token: 3000
+
+            # How many token retransmits before forming a new configuration
+            token_retransmits_before_loss_const: 10
+
+            # How long to wait for join messages in the membership protocol (ms)
+            join: 60
+
+            # How long to wait for consensus to be achieved before starting a new round of membership configuration (ms)
+            consensus: 3600
+
+            # Turn off the virtual synchrony filter
+            vsftype: none
+
+            # Number of messages that may be sent by one processor on receipt of the token
+            max_messages: 20
+
+            # Limit generated nodeids to 31-bits (positive signed integers)
+            clear_node_high_bit: yes
+
+            # Disable encryption
+            secauth: off
+
+            # How many threads to use for encryption/decryption
+            threads: 0
+
+            # Optionally assign a fixed node id (integer)
+            # nodeid: 1234
+
+            # This specifies the mode of redundant ring, which may be none, active, or passive.
+            interface {
+                    # The following values need to be set based on your environment 
+                    ringnumber: 0
+                    bindnetaddr: <Insert Your IP>
+                    mcastaddr: 226.94.1.1
+                    mcastport: 5405
+            }
+    }
+
+    amf {
+            mode: disabled
+    }
+
+    service {
+            # Load the Pacemaker Cluster Resource Manager
+            ver:       0
+            name:      pacemaker
+    }
+
+    aisexec {
+            user:   root
+            group:  root
+    }
+
+    logging {
+            fileline: off
+            to_stderr: yes
+            to_logfile: no
+            to_syslog: yes
+            syslog_facility: daemon
+            debug: off
+            timestamp: on
+            logger_subsys {
+                    subsys: AMF
+                    debug: off
+                    tags: enter|leave|trace1|trace2|trace3|trace4|trace6
+            }
+    }
-- 
1.7.10.4