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>
pull/1269/head
Kyle Squizzato 2017-02-01 13:29:45 -05:00
parent d7cc546924
commit 8b71de086d
1 changed files with 4 additions and 1 deletions

View File

@ -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