ceph/doc/rados/configuration/index.rst
Anthony D'Atri 21d68cf137 doc: standardize config option names to use interstitial underscores
Ceph config option names may use spaces, underscores, or by one reference hyphens
as interstitial separators. Most usage within the doc tree uses underscores,
though example conf files and especially structured lists of options mostly
use spaces. Mostly. Underscores help differentiate the config names from
surrounding text, and moreover facilitate scripting, grep, awk, etc and match
their form in src/common/options.cc.

This PR conforms these occurrences of option names to use interstitial underscores instead of spaces.

Fixes: https://tracker.ceph.com/issues/48301
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-12-15 13:55:38 -08:00

53 lines
1.4 KiB
ReStructuredText

===============
Configuration
===============
Each Ceph process, daemon, or utility draws its configuration from
several sources on startup, include a local configuration, the
monitors, the command line, or environment variables. Configuration
options may be set globally such that they apply to all daemons, to
all daemons or services of a particular type, or only to a specific
daemon, process, or client.
.. raw:: html
<table cellpadding="10"><colgroup><col width="50%"><col width="50%"></colgroup><tbody valign="top"><tr><td><h3>Configuring the Object Store</h3>
For general object store configuration, refer to the following:
.. toctree::
:maxdepth: 1
Storage devices <storage-devices>
ceph-conf
.. raw:: html
</td><td><h3>Reference</h3>
To optimize the performance of your cluster, refer to the following:
.. toctree::
:maxdepth: 1
Common Settings <common>
Network Settings <network-config-ref>
Messenger v2 protocol <msgr2>
Auth Settings <auth-config-ref>
Monitor Settings <mon-config-ref>
mon-lookup-dns
Heartbeat Settings <mon-osd-interaction>
OSD Settings <osd-config-ref>
BlueStore Settings <bluestore-config-ref>
FileStore Settings <filestore-config-ref>
Journal Settings <journal-ref>
Pool, PG & CRUSH Settings <pool-pg-config-ref.rst>
Messaging Settings <ms-ref>
General Settings <general-config-ref>
.. raw:: html
</td></tr></tbody></table>