Handle the case when gitaly['configuration'] already defined

This can happen if it is already present in
gitlab_additional_configurations. In this case send a warning that users
have to add the gitaly storage path themselves.

Author: tobiashuste

roles/gitlab/defaults/main.yml

@@ -93,4 +93,7 @@ gitlab_mattermost_only_context: "false"
 
 gitlab_feature_flags: []
 
+# Internal variable to determine whether the configuration object for Gitaly
+# is already present in gitlab_additional_configurations
+__gitaly_configuration_exists: false
 ...

roles/gitlab/tasks/configure.yml

@@ -19,6 +19,32 @@
     - "Reconfigure Primary GitLab"
     - "Reconfigure Non Primary GitLab"
 
+- name: "Ensure gitaly['configuration'] is not present in gitlab_additional_configurations"
+  when: "gitlab_use_internal_gitaly"
+  block:
+    - name: "Check if gitaly is present"
+      when:
+        - "gitlab_additional_configurations | length > 0"
+        - "item.gitaly is defined"
+      ansible.builtin.set_fact:
+        __gitaly_exists: true
+        __gitaly_item: "{{ item.gitaly }}"
+      with_items: "{{ gitlab_additional_configurations }}"
+
+    - name: "Check if gitaly['configuration'] is present"
+      when:
+        - "item.key is defined"
+        - "item.key == 'configuration'"
+      ansible.builtin.set_fact:
+        __gitaly_configuration_exists: true
+      with_items: "{{ __gitaly_item | default([]) }}"
+
+    - name: "Warn if gitaly['configuration'] is already present"
+      when:
+        - "__gitaly_configuration_exists"
+      ansible.builtin.debug:
+        msg: "Please make sure to configure gitaly storage paths yourself in gitaly['configuration']"
+
 - name: "Copy GitLab Configuration File."
   become: true
   ansible.builtin.template:

roles/gitlab/templates/gitlab.rb.j2

@@ -31,6 +31,7 @@ gitlab_rails['redis_sentinels_password'] = "{{ gitlab_redis_sentinel_password }}
 gitlab_rails['monitoring_whitelist'] = ["{{ gitlab_ip_range }}"]
 
 {% if gitlab_use_internal_gitaly %}
+{% if not __gitaly_configuration_exists %}
 gitaly['configuration'] = {
   "storage": [
     {
@@ -39,6 +40,7 @@ gitaly['configuration'] = {
     },
   ],
 }
+{% endif %}
 {% else %}
 gitaly['enable'] = false
 gitlab_rails['gitaly_token'] = "{{ gitlab_gitaly_token }}"