From: Andrew Schoen <aschoen@redhat.com>
Date: Thu, 17 Aug 2017 16:13:55 +0000 (-0500)
Subject: docs: add docs for ceph_conf_overrides usage
X-Git-Tag: v3.0.0rc4~32^2~4
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=da4a42de0ae12f5ceea13cde0f05ac376f0df1e4;p=ceph-ansible.git

docs: add docs for ceph_conf_overrides usage

Signed-off-by: Andrew Schoen <aschoen@redhat.com>
---

diff --git a/docs/source/index.rst b/docs/source/index.rst
index bd261f713..d059810c2 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -133,9 +133,27 @@ selection or other aspects of your cluster.
 - ``journal_size``
 - ``monitor_interface`` or ``monitor_address``
 
+ceph.conf Configuration
+-----------------------
 
-Full documentation for configuring each of the ceph daemon types are in the following sections.
+The supported method for defining your ceph.conf is to use the ``ceph_conf_overrides`` variable. This allows you to specify configuration options using
+an INI format. This variable can be used to override sections already defined in ceph.conf (see: ``roles/ceph-common/templates/ceph.conf.j2``) or to provide
+new configuration options. The following sections in ceph.conf are supported: [global], [mon], [osd], [mds] and [rgw].
+
+An example::
+
+    ceph_conf_overrides:
+       global:
+         foo: 1234
+         bar: 5678
+       osd:
+         osd_mkfs_type: ext4
 
+.. note::
+    We will no longer accept pull requests that modify the ceph.conf template unless it helps the deployment. For simple configuration tweaks
+    please use the `ceph_conf_overrides` variable.
+
+Full documentation for configuring each of the ceph daemon types are in the following sections.
 
 OSD Configuration
 =================