Merge pull request #84 from tobiashuste/feature-flags

Allow to set GitLab feature flags

Author: christianhueserhzdr

README.md

@@ -198,6 +198,24 @@ Choose whether GitLab's web-server Nginx redirects HTTP requests to HTTPS:
 nginx_redirect_http_to_https: 'false'
 ```
 
+#### Set GitLab feature flags
+
+Set [GitLab feature flags](https://docs.gitlab.com/ee/user/feature_flags.html)
+to enable or disable additional features.
+The variable is a list of key-value pairs which requires the `name` of the
+feature flag and its boolean state `enabled`.
+The default value is set to an empty list `[]`.
+
+```yaml
+gitlab_feature_flags:
+  - name: "vscode_web_ide"
+    enabled: true
+  - name: "chatops"
+    enabled: true
+  - name: "webauthn"
+    enabled: false  
+```
+
 #### Mattermost only use case
 
 This role can be used to run Mattermost without deploying GitLab. In this

defaults/main.yml

@@ -86,4 +86,6 @@ gitlab_registry_external_url: "http://localhost:5005"
 # Whether GitLab Omnibus is used to run Mattermost only without GitLab
 gitlab_mattermost_only_context: "false"
 
+gitlab_feature_flags: []
+
 ...

molecule/default/molecule.yml

@@ -33,13 +33,19 @@ provisioner:
     host_vars:
       instancegitlab:
         gitlab_edition: "gitlab-ce"
-#        gitlab_version: "14.5.2"
-#        gitlab_release: "ce.0"
         gitlab_additional_configurations:
           - package:
             - key: "modify_kernel_parameters"
               type: "plain"
               value: "false"
+        gitlab_feature_flags:
+          # See https://docs.gitlab.com/ee/user/feature_flags.html
+          - name: "vscode_web_ide"
+            enabled: true
+          - name: "chatops"
+            enabled: true
+          - name: "webauthn"
+            enabled: false
 verifier:
   name: ansible
 scenario:

tasks/feature-flag.yml

@@ -0,0 +1,19 @@
+# SPDX-FileCopyrightText: 2023 Helmholtz Centre for Environmental Research (UFZ)
+# SPDX-FileCopyrightText: 2023 Helmholtz-Zentrum Dresden-Rossendorf (HZDR)
+#
+# SPDX-License-Identifier: Apache-2.0
+
+---
+
+- name: "Check if feature flag is already enabled for {{ gitlab_feature_flag.name }}"
+  ansible.builtin.command:
+    cmd: "gitlab-rails runner 'is_feature_enabled = Feature.enabled?(:{{ gitlab_feature_flag.name }}); puts is_feature_enabled'"
+  register: "is_feature_enabled"
+  changed_when: false
+
+- name: "Enable or disable feature flag {{ gitlab_feature_flag.name }}"
+  ansible.builtin.command:
+    cmd: "gitlab-rails runner 'Feature.{{ 'enable' if gitlab_feature_flag.enabled else 'disable' }}(:{{ gitlab_feature_flag.name }})'"
+  when: "(is_feature_enabled.stdout == 'true' and not gitlab_feature_flag.enabled) or (is_feature_enabled.stdout == 'false' and gitlab_feature_flag.enabled)"
+
+...

tasks/main.yml

@@ -35,4 +35,13 @@
   ansible.builtin.import_tasks: configure.yml
   become: yes
 
+- name: "Force all notified handlers to run at this point. Required for feature flags."
+  ansible.builtin.meta: "flush_handlers"
+
+- name: "Set feature flags"
+  ansible.builtin.include_tasks: "feature-flag.yml"
+  loop: "{{ gitlab_feature_flags }}"
+  loop_control:
+    loop_var: "gitlab_feature_flag"
+
 ...