rgw: multisite refact

Add the possibility to deploy rgw multisite configuration with a mix of
secondary and primary zones on a same rgw node.
Before that, on a same node, all instances were either primary
zones *OR* secondary.

Now you can define a rgw instance like following:

```
rgw_instances:
  - instance_name: 'rgw0'
    rgw_zonemaster: false
    rgw_zonesecondary: true
    rgw_zonegroupmaster: false
    rgw_realm: 'france'
    rgw_zonegroup: 'zonegroup-france'
    rgw_zone: paris-00
    radosgw_address: "{{ _radosgw_address }}"
    radosgw_frontend_port: 8080
    rgw_zone_user: jacques.chirac
    rgw_zone_user_display_name: "Jacques Chirac"
    system_access_key: P9Eb6S8XNyo4dtZZUUMy
    system_secret_key: qqHCUtfdNnpHq3PZRHW5un9l0bEBM812Uhow0XfB
    endpoint: http://192.168.101.12:8080
```

Basically it's now possible to define `rgw_zonemaster`,
`rgw_zonesecondary` and `rgw_zonegroupmaster` at the intsance
level instead of the whole node level.

Also, this commit adds an option `deploy_secondary_zones` (default True)
which can be set to `False` in order to explicitly ask the playbook to
not deploy secondary zones in case where the corresponding endpoint are
not deployed yet.

Closes: https://bugzilla.redhat.com/show_bug.cgi?id=1915478

Signed-off-by: Guillaume Abrioux <gabrioux@redhat.com>

module_utils/ca_common.py

@@ -100,6 +100,7 @@ def exit_module(module, out, rc, cmd, err, startd, changed=False):
     )
     module.exit_json(**result)
 
+
 def fatal(message, module):
     '''
     Report a fatal error and exit

roles/ceph-config/templates/ceph.conf.j2

@@ -119,10 +119,12 @@ rgw frontends = {{ frontend_line(radosgw_frontend_type) }} {{ radosgw_frontend_o
 rgw thread pool size = {{ radosgw_thread_pool_size }}
 {% endif %}
 {% if rgw_multisite | bool %}
+{% if ((instance['rgw_zonemaster'] | default(rgw_zonemaster) | bool) or (deploy_secondary_zones | default(True) | bool)) %}
 rgw_realm = {{ instance['rgw_realm'] }}
 rgw_zonegroup = {{ instance['rgw_zonegroup'] }}
 rgw_zone = {{ instance['rgw_zone'] }}
 {% endif %}
+{% endif %}
 {% endfor %}
 {% endif %}
 {% endif %}

roles/ceph-rgw/tasks/multisite/create_zone_user.yml

@@ -5,8 +5,8 @@
   loop: "{{ rgw_instances_all }}"
   run_once: true
   when:
-    - hostvars[item.host]['rgw_zonemaster'] | bool
-    - hostvars[item.host]['rgw_zonegroupmaster'] | bool
+    - item.rgw_zonemaster | default(hostvars[item.host]['rgw_zonemaster']) | bool
+    - item.rgw_zonegroupmaster | default(hostvars[item.host]['rgw_zonegroupmaster']) | bool
 
 - name: create the zone user(s)
   radosgw_user:
@@ -22,6 +22,7 @@
   delegate_to: "{{ groups[mon_group_name][0] }}"
   run_once: true
   loop: "{{ zone_users }}"
+  when: zone_users is defined
   environment:
     CEPH_CONTAINER_IMAGE: "{{ ceph_docker_registry + '/' + ceph_docker_image + ':' + ceph_docker_image_tag if containerized_deployment | bool else None }}"
     CEPH_CONTAINER_BINARY: "{{ container_binary }}"

roles/ceph-rgw/tasks/multisite/main.yml

@@ -1,44 +1,50 @@
 ---
-- name: include_tasks create_realm_zonegroup_zone_lists.yml
-  include_tasks: create_realm_zonegroup_zone_lists.yml
+- name: set_fact realms
+  set_fact:
+    realms: '{{ realms | default([]) | union([item.rgw_realm]) }}'
+  run_once: true
+  loop: "{{ rgw_instances_all }}"
+  when: item.rgw_zonemaster | default(hostvars[item.host]['rgw_zonemaster']) | bool
+
+- name: create list zonegroups
+  set_fact:
+    zonegroups: "{{ zonegroups | default([]) | union([{ 'realm': item.rgw_realm, 'zonegroup': item.rgw_zonegroup, 'is_master': item.rgw_zonegroupmaster | default(hostvars[item.host]['rgw_zonegroupmaster']) }]) }}"
+  run_once: true
+  loop: "{{ rgw_instances_all }}"
+  when: item.rgw_zonegroupmaster | default(hostvars[item.host]['rgw_zonemaster']) | bool
+
+- name: create list zones
+  set_fact:
+    zones: "{{ zones | default([]) | union([{ 'realm': item.rgw_realm, 'zonegroup': item.rgw_zonegroup, 'zone': item.rgw_zone, 'is_master': item.rgw_zonemaster | default(hostvars[item.host]['rgw_zonemaster']), 'system_access_key': item.system_access_key, 'system_secret_key': item.system_secret_key }]) }}"
+  run_once: true
+  loop: "{{ rgw_instances_all }}"
+
+- name: create a list of dicts with each rgw endpoint and it's zone
+  set_fact:
+    zone_endpoint_pairs: "{{ zone_endpoint_pairs | default([]) | union([{ 'endpoint': hostvars[item.host]['rgw_multisite_proto'] + '://' + item.radosgw_address + ':' + item.radosgw_frontend_port | string, 'rgw_zone': item.rgw_zone, 'rgw_realm': item.rgw_realm, 'rgw_zonegroup': item.rgw_zonegroup, 'rgw_zonemaster': item.rgw_zonemaster | default(hostvars[item.host]['rgw_zonemaster']) }]) }}"
+  loop: "{{ rgw_instances_all }}"
+  run_once: true
+
+- name: create a list of zones and all their endpoints
+  set_fact:
+    zone_endpoints_list: "{{ zone_endpoints_list | default([]) | union([{'zone': item.rgw_zone, 'zonegroup': item.rgw_zonegroup, 'realm': item.rgw_realm, 'is_master': item.rgw_zonemaster, 'endpoints': ','.join(zone_endpoint_pairs | selectattr('rgw_zone','match','^'+item.rgw_zone+'$') | selectattr('rgw_realm','match','^'+item.rgw_realm+'$') | selectattr('rgw_zonegroup', 'match','^'+item.rgw_zonegroup+'$') | map(attribute='endpoint'))}]) }}"
+  loop: "{{ zone_endpoint_pairs }}"
+  run_once: true
 
 # Include the tasks depending on the zone type
 - name: include_tasks master.yml
   include_tasks: master.yml
-  when:
-    - rgw_zonemaster | bool
-    - not rgw_zonesecondary | bool
-
-- name: include_tasks start_radosgw.yml for zonemaster rgws
-  include_tasks: ../start_radosgw.yml
-  when:
-    - rgw_zonemaster | bool
-    - not rgw_zonesecondary | bool
-    - not containerized_deployment | bool
-
-- name: include_tasks start_docker_rgw.yml for zonemaster rgws
-  include_tasks: ../start_docker_rgw.yml
-  when:
-    - rgw_zonemaster | bool
-    - not rgw_zonesecondary | bool
-    - containerized_deployment | bool
 
 - name: include_tasks secondary.yml
   include_tasks: secondary.yml
-  when:
-    - not rgw_zonemaster | bool
-    - rgw_zonesecondary | bool
+  when: deploy_secondary_zones | default(True) | bool
 
-- name: include_tasks start_radosgw.yml for zonesecondary rgws
+- name: include_tasks start_radosgw.yml
   include_tasks: ../start_radosgw.yml
   when:
-    - not rgw_zonemaster | bool
-    - rgw_zonesecondary | bool
     - not containerized_deployment | bool
 
-- name: include_tasks start_docker_rgw.yml for zonesecondary rgws
+- name: include_tasks start_docker_rgw.yml
   include_tasks: ../start_docker_rgw.yml
   when:
-    - not rgw_zonemaster | bool
-    - rgw_zonesecondary | bool
     - containerized_deployment | bool

roles/ceph-rgw/tasks/multisite/secondary.yml

@@ -1,4 +1,11 @@
 ---
+- name: create list secondary_realms
+  set_fact:
+    secondary_realms: "{{ secondary_realms | default([]) | union([{ 'realm': item.rgw_realm, 'zonegroup': item.rgw_zonegroup, 'zone': item.rgw_zone, 'endpoint': item.endpoint, 'system_access_key': item.system_access_key, 'system_secret_key': item.system_secret_key, 'is_master': item.rgw_zonemaster | default(hostvars[item.host]['rgw_zonemaster']) }]) }}"
+  loop: "{{ rgw_instances_all }}"
+  run_once: true
+  when: not item.rgw_zonemaster | default(hostvars[item.host]['rgw_zonemaster']) | bool
+
 - name: ensure connection to primary cluster from mon
   uri:
     url: "{{ item.endpoint }}"
@@ -11,6 +18,7 @@
   uri:
     url: "{{ item.endpoint }}"
   loop: "{{ rgw_instances }}"
+  when: not item.rgw_zonemaster | default(rgw_zonemaster) | bool
 
 - name: fetch the realm(s)
   command: "{{ container_exec_cmd }} radosgw-admin realm pull --cluster={{ cluster }} --rgw-realm={{ item.realm }} --url={{ item.endpoint }} --access-key={{ item.system_access_key }} --secret={{ item.system_secret_key }}"

roles/ceph-rgw/tasks/start_radosgw.yml

@@ -20,6 +20,10 @@
     enabled: yes
     masked: no
   with_items: "{{ rgw_instances }}"
+  when:
+    - not rgw_multisite | bool or
+      ((rgw_multisite | bool and item.rgw_zonesecondary | default(rgw_zonesecondary) | bool and deploy_secondary_zones | default(True)) or
+      (rgw_multisite | bool and item.rgw_zonemaster | default(rgw_zonemaster)))
 
 - name: enable the ceph-radosgw.target service
   systemd:

roles/ceph-validate/tasks/check_rgw_multisite.yml

@@ -8,14 +8,16 @@
 - name: fail if either rgw_zonemaster or rgw_zonesecondary is undefined
   fail:
     msg: "rgw_zonemaster and rgw_zonesecondary must be defined"
-  when: rgw_zonemaster is undefined or rgw_zonesecondary is undefined
+  loop: "{{ rgw_instances }}"
+  when: item.rgw_zonemaster | default(rgw_zonemaster) is undefined or item.rgw_zonesecondary | default(rgw_zonesecondary) is undefined
 
 - name: fail if rgw_zonemaster and rgw_zonesecondary are both true
   fail:
     msg: "rgw_zonemaster and rgw_zonesecondary cannot both be true"
+  loop: "{{ rgw_instances }}"
   when:
-    - rgw_zonemaster | bool
-    - rgw_zonesecondary | bool
+    - item.rgw_zonemaster | default(rgw_zonemaster) | bool
+    - item.rgw_zonesecondary | default(rgw_zonesecondary) | bool
 
 - name: fail if rgw_zonegroup is not set
   fail:
@@ -58,6 +60,7 @@
     msg: "endpoint has not been set by the user"
   loop: "{{ rgw_instances }}"
   when:
-    - rgw_zonesecondary | bool
-    - rgw_pull_port is undefined and rgw_pullhost is undefined and rgw_pull_proto is undefined
-    - item.endpoint is undefined
+    - item.rgw_zonesecondary | default(rgw_zonesecondary) | bool
+    - rgw_pull_port is undefined and rgw_pullhost is undefined and item.rgw_pull_proto | default(rgw_pull_proto) is undefined
+    - item.endpoint is undefined
+

tests/functional/rgw-multisite/container/group_vars/all

@@ -29,4 +29,4 @@ ceph_conf_overrides:
 dashboard_enabled: False
 ceph_docker_registry: quay.ceph.io
 ceph_docker_image: ceph-ci/daemon
-ceph_docker_image_tag: latest-master
+ceph_docker_image_tag: latest-master

tests/functional/rgw-multisite/container/group_vars/rgws

@@ -2,6 +2,7 @@
 copy_admin_key: true
 # Enable Multisite support
 rgw_multisite: true
+rgw_multisite_proto: http
 rgw_create_pools:
   foo:
     pg_num: 16
@@ -10,7 +11,3 @@ rgw_create_pools:
     pg_num: 16
 rgw_override_bucket_index_max_shards: 16
 rgw_bucket_default_quota_max_objects: 1638400
-rgw_zonemaster: True
-rgw_zonesecondary: False
-rgw_zonegroupmaster: True
-rgw_multisite_proto: http

tests/functional/rgw-multisite/container/host_vars/osd0

@@ -1,24 +1,32 @@
+---
 rgw_instances:
   - instance_name: 'rgw0'
-    rgw_realm: 'france'
-    rgw_zonegroup: 'idf'
-    rgw_zone: 'paris'
+    rgw_zonemaster: True
+    rgw_zonesecondary: False
+    rgw_zonegroupmaster: True
+    rgw_realm: 'canada'
+    rgw_zonegroup: 'zonegroup-canada'
+    rgw_zone: montreal-00
     radosgw_address: "{{ _radosgw_address }}"
     radosgw_frontend_port: 8080
     rgw_zone_user: jacques.chirac
     rgw_zone_user_display_name: "Jacques Chirac"
     system_access_key: P9Eb6S8XNyo4dtZZUUMy
     system_secret_key: qqHCUtfdNnpHq3PZRHW5un9l0bEBM812Uhow0XfB
   - instance_name: 'rgw1'
-    rgw_realm: 'usa'
-    rgw_zonegroup: 'alaska'
-    rgw_zone: 'juneau'
+    rgw_zonemaster: false
+    rgw_zonesecondary: true
+    rgw_zonegroupmaster: false
+    rgw_realm: 'france'
+    rgw_zonegroup: 'zonegroup-france'
+    rgw_zone: montreal-01
     radosgw_address: "{{ _radosgw_address }}"
     radosgw_frontend_port: 8081
     rgw_zone_user: edward.lewis
     rgw_zone_user_display_name: "Edward Lewis"
     system_access_key: yu17wkvAx3B8Wyn08XoF
     system_secret_key: 5YZfaSUPqxSNIkZQQA3lBZ495hnIV6k2HAz710BY
+    endpoint: http://192.168.107.12:8081
 # functional testing
-rgw_multisite_endpoint_addr: 192.168.105.11
-radosgw_num_instances: 2
+rgw_multisite_endpoint_addr: 192.168.105.12
+radosgw_num_instances: 2

tests/functional/rgw-multisite/container/host_vars/rgw0

@@ -0,0 +1,29 @@
+---
+rgw_zonemaster: true
+rgw_zonesecondary: false
+rgw_zonegroupmaster: true
+rgw_multisite_proto: http
+rgw_instances:
+  - instance_name: 'rgw0'
+    rgw_realm: 'foo'
+    rgw_zonegroup: 'zonegroup123'
+    rgw_zone: 'gotham_city'
+    radosgw_address: "{{ _radosgw_address }}"
+    radosgw_frontend_port: 8080
+    rgw_zone_user: batman
+    rgw_zone_user_display_name: "Batman"
+    system_access_key: 9WA1GN33IUYC717S8KB2
+    system_secret_key: R2vWXyboYw9nluehMgtATBGDBZSuWLnR0M4xNa1W
+  - instance_name: 'rgw1'
+    rgw_realm: 'bar'
+    rgw_zonegroup: 'zonegroup456'
+    rgw_zone: 'metropolis'
+    radosgw_address: "{{ _radosgw_address }}"
+    radosgw_frontend_port: 8081
+    rgw_zone_user: superman
+    rgw_zone_user_display_name: "Superman"
+    system_access_key: S96CJL44E29AN91Y3ZC5
+    system_secret_key: ha7yWiIi7bSV2vAqMBfKjYIVKMfOBaGkWrUZifRt
+# functional testing
+rgw_multisite_endpoint_addr: 192.168.105.11
+radosgw_num_instances: 2

tests/functional/rgw-multisite/container/hosts

@@ -6,3 +6,4 @@ osd0
 
 [rgws]
 osd0
+rgw0

tests/functional/rgw-multisite/container/secondary/group_vars/all

@@ -29,4 +29,4 @@ ceph_conf_overrides:
 dashboard_enabled: False
 ceph_docker_registry: quay.ceph.io
 ceph_docker_image: ceph-ci/daemon
-ceph_docker_image_tag: latest-master
+ceph_docker_image_tag: latest-master

tests/functional/rgw-multisite/container/secondary/group_vars/rgws

@@ -1,6 +1,7 @@
 ---
 # Enable Multisite support
 rgw_multisite: true
+rgw_multisite_proto: http
 rgw_create_pools:
   foo:
     pg_num: 16
@@ -9,7 +10,3 @@ rgw_create_pools:
     pg_num: 16
 rgw_override_bucket_index_max_shards: 16
 rgw_bucket_default_quota_max_objects: 1638400
-rgw_zonemaster: False
-rgw_zonesecondary: True
-rgw_zonegroupmaster: True
-rgw_multisite_proto: http

tests/functional/rgw-multisite/container/secondary/host_vars/osd0

@@ -1,26 +1,32 @@
+---
 rgw_instances:
   - instance_name: 'rgw0'
-    rgw_realm: 'france'
-    rgw_zonegroup: 'idf'
-    rgw_zone: 'versailles'
+    rgw_zonemaster: false
+    rgw_zonesecondary: true
+    rgw_zonegroupmaster: false
+    rgw_realm: 'canada'
+    rgw_zonegroup: 'zonegroup-canada'
+    rgw_zone: paris-00
     radosgw_address: "{{ _radosgw_address }}"
     radosgw_frontend_port: 8080
     rgw_zone_user: jacques.chirac
     rgw_zone_user_display_name: "Jacques Chirac"
     system_access_key: P9Eb6S8XNyo4dtZZUUMy
     system_secret_key: qqHCUtfdNnpHq3PZRHW5un9l0bEBM812Uhow0XfB
-    endpoint: http://192.168.105.11:8080
+    endpoint: http://192.168.105.12:8080
   - instance_name: 'rgw1'
-    rgw_realm: 'usa'
-    rgw_zonegroup: 'alaska'
-    rgw_zone: 'anchorage'
+    rgw_zonemaster: True
+    rgw_zonesecondary: False
+    rgw_zonegroupmaster: True
+    rgw_realm: 'france'
+    rgw_zonegroup: 'zonegroup-france'
+    rgw_zone: paris-01
     radosgw_address: "{{ _radosgw_address }}"
     radosgw_frontend_port: 8081
     rgw_zone_user: edward.lewis
     rgw_zone_user_display_name: "Edward Lewis"
     system_access_key: yu17wkvAx3B8Wyn08XoF
     system_secret_key: 5YZfaSUPqxSNIkZQQA3lBZ495hnIV6k2HAz710BY
-    endpoint: http://192.168.105.11:8081
 # functional testing
-rgw_multisite_endpoint_addr: 192.168.107.11
-radosgw_num_instances: 2
+rgw_multisite_endpoint_addr: 192.168.107.12
+radosgw_num_instances: 2