ceph/doc/config-ref/osd-config.rst

===================
 OSD Configuration
===================

+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| Setting                                 | Type                | Default Value         | Description                                    |
+=========================================+=====================+=======================+================================================+
| ``osd auto upgrade tmap``               | Boolean             | True                  | Uses ``tmap`` for ``omap`` on old objects.     |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd tmapput sets users tmap``         | Boolean             | False                 | Uses ``tmap`` for debugging only.              |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd data``                            | String              | None                  |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd journal``                         | String              | None                  |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd journal size``                    | 32-bit Int          | 0                     | The size of the journal in MBs.                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd max write size``                  | 32-bit Int          | 90                    | The size of the maximum x to write in MBs.     |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd balance reads``                   | Boolean             | False                 | Load balance reads?                            |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd shed reads``                      | 32-bit Int          | False (0)             | Forward from primary to replica.               |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd shed reads min latency``          | Double              | .01                   | The minimum local latency.                     |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd shed reads min latency diff``     | Double              | 1.5                   | Percentage difference from peer. 150% default. |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd client message size cap``         | 64-bit Int Unsigned | 500*1024L*1024L       | Client data allowed in-memory. 500MB default.  |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd stat refresh interval``           | 64-bit Int Unsigned | .5                    | The status refresh interval in seconds.        |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd pg bits``                         | 32-bit Int          | 6                     | Placement group bits per OSD.                  |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd pgp bits``                        | 32-bit Int          | 4                     | Placement group p bits per OSD?                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd pg layout``                       | 32-bit Int          | 2                     | Placement Group bits ? per OSD?                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd min rep``                         | 32-bit Int          | 1                     | Need a description.                            |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd max rep``                         | 32-bit Int          | 10                    | Need a description.                            |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd min raid width``                  | 32-bit Int          | 3                     | The minimum RAID width.                        |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd max raid width``                  | 32-bit Int          | 2                     | The maximum RAID width.                        |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd pool default crush rule``         | 32-bit Int          | 0                     |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd pool default size``               | 32-bit Int          | 2                     |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd pool default pg num``             | 32-bit Int          | 8                     |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd pool default pgp num``            | 32-bit Int          | 8                     |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd map cache max``                   | 32-bit Int          | 250                   |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd map message max``                 | 32-bit Int          | 100                   |  // max maps per MOSDMap message               |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd op threads``                      | 32-bit Int          | 2                     |    // 0 == no threading                        |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd disk threads``                    | 32-bit Int          | 1                     |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd recovery threads``                | 32-bit Int          | 1                     |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd recover clone overlap``           | Boolean             | false                 | // preserve clone overlap during rvry/migrat   |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd backfill scan min``               | 32-bit Int          | 64                    |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd backfill scan max``               | 32-bit Int          | 512                   |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd op thread timeout``               | 32-bit Int          | 30                    |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd backlog thread timeout``          | 32-bit Int          | 60*60*1               |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd recovery thread timeout``         | 32-bit Int          | 30                    |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd snap trim thread timeout``        | 32-bit Int          | 60*60*1               |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd scrub thread timeout``            | 32-bit Int          | 60                    |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd scrub finalize thread timeout``   | 32-bit Int          | 60*10                 |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd remove thread timeout``           | 32-bit Int          | 60*60                 |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd command thread timeout``          | 32-bit Int          | 10*60                 |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd age``                             | Float               | .8                    |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd age time``                        | 32-bit Int          | 0                     |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd heartbeat interval``              | 32-bit Int          | 1                     |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd mon heartbeat interval``          | 32-bit Int          | 30                    |  // if no peers | ping monitor                 |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd heartbeat grace``                 | 32-bit Int          | 20                    |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd mon report interval max``         | 32-bit Int          | 120                   |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd mon report interval min``         | 32-bit Int          | 5                     |  // pg stats | failures | up thru | boot.      |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd mon ack timeout``                 | 32-bit Int          | 30                    | // time out a mon if it doesn't ack stats      |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd min down reporters``              | 32-bit Int          | 1                     | // num OSDs needed to report a down OSD        |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd min down reports``                | 32-bit Int          | 3                     | // num times a down OSD must be reported       |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd default data pool replay window`` | 32-bit Int          | 45                    |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd preserve trimmed log``            | Boolean             | true                  |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd auto mark unfound lost``          | Boolean             | false                 |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd recovery delay start``            | Float               | 15                    |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd recovery max active``             | 32-bit Int          | 5                     |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd recovery max chunk``              | 64-bit Int Unsigned | 1<<20                 |  // max size of push chunk                     |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd recovery forget lost objects``    | Boolean             | false                 |   // off for now                               |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd max scrubs``                      | 32-bit Int          | 1                     |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd scrub load threshold``            | Float               | 0.5                   |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd scrub min interval``              | Float               | 300                   |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd scrub max interval``              | Float               | 60*60*24              |   // once a day                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd auto weight``                     | Boolean             | false                 |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd class error timeout``             | Double              | 60.0                  |  // seconds                                    |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd class timeout``                   | Double              | 60*60.0               | // seconds                                     |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd class dir``                       | String              | $libdir/rados-classes | where rados plugins are stored                 |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd check for log corruption``        | Boolean             | false                 |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd use stale snap``                  | Boolean             | false                 |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd rollback to cluster snap``        | String              | ""                    |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd default notify timeout``          | 32-bit Int Unsigned | 30                    | // default notify timeout in seconds           |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd kill backfill at``                | 32-bit Int          | 0                     |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd min pg log entries``              | 32-bit Int Unsigned | 1000                  | // num entries to keep in pg log when trimming |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd op complaint time``               | Float               | 30                    | // how old in secs makes op complaint-worthy   |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+
| ``osd command max records``             | 32-bit Int          | 256                   |                                                |
+-----------------------------------------+---------------------+-----------------------+------------------------------------------------+