README: Don't use underscores for opts in ceph_conf_overrides

Adding underscores in the ceph_conf_overrides variable can result in incorrect
config options appearing.  A note has been added to clarify that using
underscores here can cause this behavior and recommending not to do it.

See: https://github.com/ceph/ceph-ansible/issues/1262

Signed-off-by: Kyle Squizzato <ksquizz@gmail.com>

diff --git a/README.md b/README.md
index a2d8be69bf5edb2ce747c586c0a34e41f363300a..8a9c4af1a0d891426b86be419def93fcf39bb64d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -48,7 +48,10 @@ ceph_conf_overrides:
      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
+### Note
+* It is not recommended to use underscores when defining options in the `ceph_conf_overrides` variable (ex. osd_mkfs_type) as this may cause issues with
+incorrect configuration options appearing in ceph.conf.
+* 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.
 
 ## Special notes