From: John Wilkins <john.wilkins@inktank.com>
Date: Sat, 30 Mar 2013 00:38:02 +0000 (-0700)
Subject: doc: Added heartbeat configuration settings.
X-Git-Tag: v0.62~128
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=bcc5c65305e33c148c8d0f89960e77102323d31d;p=ceph.git

doc: Added heartbeat configuration settings.

Signed-off-by: John Wilkins <john.wilkins@inktank.com>
---

diff --git a/doc/rados/configuration/mon-osd-interaction.rst b/doc/rados/configuration/mon-osd-interaction.rst
index f3f06648626f..bbedf3b14b31 100644
--- a/doc/rados/configuration/mon-osd-interaction.rst
+++ b/doc/rados/configuration/mon-osd-interaction.rst
@@ -92,6 +92,7 @@ runtime.
                 |               |<---------+ Down
 
 
+
 OSDs Report Peering Failure
 ===========================
 
@@ -125,6 +126,7 @@ configuration file, or by setting the value at runtime.
                 |          Receive New Cluster Map            |
  
 
+
 OSDs Report Their Status
 ========================
 
@@ -163,3 +165,187 @@ setting the value at runtime.
                                      |    | OSD 1
                                      |<---+ Down
 
+
+
+
+Configuration Settings
+======================
+
+When modifying heartbeat settings, you should include them in the ``[global]``
+section of your configuration file.
+
+
+Monitor Settings
+----------------
+
+``mon osd min up ratio``
+
+:Description: The minimum ratio of ``up`` OSDs before Ceph will mark 
+              OSDs ``down``.
+              
+:Type: Double
+:Default: ``.3``
+
+
+``mon osd min in ratio``
+
+:Description: The minimum ratio of ``in`` OSDs before Ceph will mark 
+              OSDs ``out``.
+              
+:Type: Double
+:Default: ``.3``
+
+
+``mon osd laggy halflife``
+
+:Description: The number of seconds laggy estimates will decay.
+:Type: Integer
+:Default: ``60*60``
+
+
+``mon osd laggy weight``
+
+:Description: The weight for new samples in laggy estimation decay.
+:Type: Double
+:Default: ``0.3``
+
+
+``mon osd adjust heartbeat grace``
+
+:Description: If set to ``true``, Ceph will scale based on laggy estimations.
+:Type: Boolean
+:Default: ``true``
+
+
+``mon osd adjust down out interval``
+
+:Description: If set to ``true``, Ceph will scaled based on laggy estimations.
+:Type: Boolean
+:Default: ``true``
+
+
+``mon osd auto mark in`` 
+
+:Description: Ceph will mark any booting OSDs as ``in`` the cluster.
+:Type: Boolean
+:Default: ``false``
+
+
+``mon osd auto mark auto out in`` 
+
+:Description: Ceph will mark booting OSDs auto marked ``out`` of the cluster 
+              as ``in`` the cluster.
+              
+:Type: Boolean
+:Default: ``true`` 
+
+
+``mon osd auto mark new in`` 
+
+:Description: Ceph will mark booting new OSDs as ``in`` the cluster.
+:Type: Boolean
+:Default: ``true`` 
+
+
+``mon osd down out interval`` 
+
+:Description: The number of seconds Ceph waits before marking an OSD ``down`` 
+              and ``out`` if it doesn't respond.
+              
+:Type: 32-bit Integer
+:Default: ``300``
+
+
+``mon osd downout subtree limit``
+
+:Description: The largest CRUSH unit type that Ceph will 
+              automatically mark ``out``. 
+
+:Type: String
+:Default: ``rack``
+
+
+``mon osd report timeout`` 
+
+:Description: The grace period in seconds before declaring unresponsive OSDs ``down``.
+:Type: 32-bit Integer
+:Default: ``900``
+
+
+
+OSD Settings
+------------
+
+``osd heartbeat address``
+
+:Description: An OSD's network address for heartbeats. 
+:Type: Address
+:Default: The host address.
+
+
+``osd heartbeat interval`` 
+
+:Description: How often an OSD pings its peers (in seconds).
+:Type: 32-bit Integer
+:Default: ``6``
+
+
+``osd heartbeat grace`` 
+
+:Description: The elapsed time when an OSD hasn't shown a heartbeat that the 
+              cluster considers it ``down``.
+ 
+:Type: 32-bit Integer
+:Default: ``20``
+
+
+``osd mon heartbeat interval`` 
+
+:Description: How often the OSD pings a monitor if it has no OSD peers.
+:Type: 32-bit Integer
+:Default: ``30`` 
+
+
+``osd mon report interval max`` 
+
+:Description: The maximum time in seconds for an OSD to report to a monitor 
+              before the monitor considers the OSD ``down``.
+
+:Type: 32-bit Integer
+:Default: ``120`` 
+
+
+``osd mon report interval min`` 
+
+:Description: The minimum number of seconds for an OSD to report to a monitor 
+              to avoid the monitor considering the OSD ``down``.
+
+:Type: 32-bit Integer
+:Default: ``5``
+:Valid Range: Should be less than ``osd mon report interval max`` 
+
+
+``osd mon ack timeout`` 
+
+:Description: The number of seconds to wait for a monitor to acknowledge a 
+              request for statistics.
+
+:Type: 32-bit Integer
+:Default: ``30`` 
+
+
+``osd min down reporters`` 
+
+:Description: The minimum number of OSDs required to report a ``down`` OSD.
+:Type: 32-bit Integer
+:Default: ``1``
+
+
+``osd min down reports`` 
+
+:Description: The minimum number of times an OSD must report that another 
+              is ``down``.
+
+:Type: 32-bit Integer
+:Default: ``3`` 
+