From 23ad5fd9cb1350b0180af6230134a40b5999a7b5 Mon Sep 17 00:00:00 2001
From: jtudelag <jtudelag@redhat.com>
Date: Mon, 26 Feb 2018 09:49:57 +0100
Subject: [PATCH] Clarify RGWs configuration when using ceph_conf_overrides.

To avoid future misconfigurations, clarify that the only valid
scheme is [client.rgw.*] instead of [client.radosgw.*].
---
 group_vars/all.yml.sample             | 7 +++++++
 group_vars/rhcs.yml.sample            | 7 +++++++
 roles/ceph-defaults/defaults/main.yml | 7 +++++++
 3 files changed, 21 insertions(+)

diff --git a/group_vars/all.yml.sample b/group_vars/all.yml.sample
index e4d59daa8..cc6481216 100644
--- a/group_vars/all.yml.sample
+++ b/group_vars/all.yml.sample
@@ -500,6 +500,11 @@ dummy:
 # Ceph configuration file override.
 # This allows you to specify more configuration options
 # using an INI style format.
+#
+# When configuring RGWs, make sure you use the form [client.rgw.*]
+# instead of [client.radosgw.*].
+# For more examples check the profiles directory of https://github.com/ceph/ceph-ansible.
+#
 # The following sections are supported: [global], [mon], [osd], [mds], [rgw]
 #
 # Example:
@@ -507,6 +512,8 @@ dummy:
 #   global:
 #     foo: 1234
 #     bar: 5678
+#   "client.rgw.{{ hostvars[groups.get(rgw_group_name)[0]]['ansible_hostname'] }}":
+#     rgw_zone: zone1
 #
 #ceph_conf_overrides: {}
 
diff --git a/group_vars/rhcs.yml.sample b/group_vars/rhcs.yml.sample
index 989696a79..5a6f17285 100644
--- a/group_vars/rhcs.yml.sample
+++ b/group_vars/rhcs.yml.sample
@@ -500,6 +500,11 @@ ceph_rhcs_version: 3
 # Ceph configuration file override.
 # This allows you to specify more configuration options
 # using an INI style format.
+#
+# When configuring RGWs, make sure you use the form [client.rgw.*]
+# instead of [client.radosgw.*].
+# For more examples check the profiles directory of https://github.com/ceph/ceph-ansible.
+#
 # The following sections are supported: [global], [mon], [osd], [mds], [rgw]
 #
 # Example:
@@ -507,6 +512,8 @@ ceph_rhcs_version: 3
 #   global:
 #     foo: 1234
 #     bar: 5678
+#   "client.rgw.{{ hostvars[groups.get(rgw_group_name)[0]]['ansible_hostname'] }}":
+#     rgw_zone: zone1
 #
 #ceph_conf_overrides: {}
 
diff --git a/roles/ceph-defaults/defaults/main.yml b/roles/ceph-defaults/defaults/main.yml
index d1b4ef2f7..0de35990b 100644
--- a/roles/ceph-defaults/defaults/main.yml
+++ b/roles/ceph-defaults/defaults/main.yml
@@ -492,6 +492,11 @@ rgw_pull_proto: "http"
 # Ceph configuration file override.
 # This allows you to specify more configuration options
 # using an INI style format.
+#
+# When configuring RGWs, make sure you use the form [client.rgw.*]
+# instead of [client.radosgw.*].
+# For more examples check the profiles directory of https://github.com/ceph/ceph-ansible.
+#
 # The following sections are supported: [global], [mon], [osd], [mds], [rgw]
 #
 # Example:
@@ -499,6 +504,8 @@ rgw_pull_proto: "http"
 #   global:
 #     foo: 1234
 #     bar: 5678
+#   "client.rgw.{{ hostvars[groups.get(rgw_group_name)[0]]['ansible_hostname'] }}":
+#     rgw_zone: zone1
 #
 ceph_conf_overrides: {}