Allow to disable persisting cluster cookie in app conf file (#339)

Added `cartridge_not_save_cookie_in_app_config` variable that allows disabling persisting cluster
cookie in the application configuration file. In this case, it's the user's responsibility to configure 
the cluster cookie for all instances.

Author: dokshina

CHANGELOG.md

@@ -21,6 +21,8 @@ README.md to use the newest tag with new release
   and specified state
 - `wait_cluster_has_no_issues` step to wait until cluster has no issues
 - availability to upload ZIP configs to TDG
+- `cartridge_not_save_cookie_in_app_config` variable that allows to disable persisting cluster
+  cookie in the application configuration file
 
 ## [1.9.0] - 2021-04-30
 

create-packages.sh

@@ -133,14 +133,21 @@ if [ -z "${skip_cartridge}" ]; then
     rm -rf ${app_name}
     cartridge create --name ${app_name}
 
+    # configure vshard group "hot"
     awk '{gsub(/cartridge.cfg\({/, "&\n    vshard_groups = { hot = { bucket_count = 20000 } },")}1' \
         ${app_name}/init.lua >${app_name}/temp.lua
     mv ${app_name}/temp.lua ${app_name}/init.lua
 
+    # add dependencies to app.roles.custom role
     awk '{gsub(/-- dependencies/, "dependencies")}1' \
         ${app_name}/app/roles/custom.lua >${app_name}/temp.lua
     mv ${app_name}/temp.lua ${app_name}/app/roles/custom.lua
 
+    # remove setting cluster_cookie on cartridge.cfg
+    awk '{gsub(/cluster_cookie/, "-- cluster_cookie")}1' \
+        ${app_name}/init.lua >${app_name}/temp.lua
+    mv ${app_name}/temp.lua ${app_name}/init.lua
+
     lazy_pack tgz "${app_name}" "${version}"
     lazy_pack rpm "${app_name}" "${version}"
     lazy_pack deb "${app_name}" "${version}"

defaults/main.yml

@@ -4,6 +4,7 @@
 
 cartridge_app_name: null
 cartridge_cluster_cookie: null
+cartridge_not_save_cookie_in_app_config: false
 cartridge_remove_temporary_files: false
 
 # Role scenario configuration

doc/scenario.md

@@ -427,6 +427,7 @@ Input facts (set by config):
 - `stateboard` - indicates that the instance is a stateboard;
 - `cartridge_app_name` - application name;
 - `cartridge_cluster_cookie` - cluster cookie for all cluster instances;
+- `cartridge_not_save_cookie_in_app_config` - flag indicates that cluster cookie shouldn't be persisted in application configuration file;
 - `cartridge_defaults` - default configuration parameters values for instances;
 - `cartridge_app_user` - user which will own the links;
 - `cartridge_app_group` - group which will own the links.
@@ -447,6 +448,7 @@ Input facts (set by role):
 Input facts (set by config):
 
 - `cartridge_cluster_cookie` - cluster cookie for all cluster instances (is needed to check if configuration file was changed);
+- `cartridge_not_save_cookie_in_app_config` - flag indicates that cluster cookie shouldn't be persisted in application configuration file;
 - `restarted` - if instance should be restarted or not (user forced decision).
 
 ### wait_instance_started

doc/variables.md

@@ -8,6 +8,7 @@ vshard bootstrapping, and failover.
 * `cartridge_app_name` (`string`): application name, required;
 * `cartridge_cluster_cookie` (`string`): cluster cookie for all
   cluster instances;
+* `cartridge_not_save_cookie_in_app_config` (`boolean`, default: `false`) - flag indicates that cluster cookie shouldn't be persisted in application configuration file;
 * `cartridge_remove_temporary_files` (`boolean`, optional, default: `false`):
   indicates if temporary files should be removed
   (more details in description of [`cleanup` step API](/doc/scenario.md#cleanup));

library/cartridge_get_cached_facts.py

@@ -18,6 +18,7 @@
         'cartridge_auth',
         'cartridge_bootstrap_vshard',
         'cartridge_cluster_cookie',
+        'cartridge_not_save_cookie_in_app_config',
         'cartridge_conf_dir',
         'cartridge_configure_systemd_unit_files',
         'cartridge_configure_tmpfiles',

library/cartridge_get_needs_restart.py

@@ -13,6 +13,7 @@
     'config': {'required': False, 'type': 'dict'},
     'cartridge_defaults': {'required': False, 'type': 'dict'},
     'cluster_cookie': {'required': False, 'type': 'str'},
+    'cartridge_not_save_cookie_in_app_config': {'required': False, 'type': 'bool'},
     'stateboard': {'required': False, 'type': 'bool'},
 }
 
@@ -64,7 +65,7 @@ def check_needs_restart_to_update_config(params, control_console):
         'app_name',
         'config',
         'cartridge_defaults',
-        'cluster_cookie',
+        'cartridge_not_save_cookie_in_app_config',
         'stateboard',
     }
     for arg in required_args:
@@ -75,9 +76,14 @@ def check_needs_restart_to_update_config(params, control_console):
     app_name = params['app_name']
     new_instance_conf = params['config']
     new_default_conf = params['cartridge_defaults']
-    cluster_cookie = params['cluster_cookie']
+    cluster_cookie = params.get('cluster_cookie')
+    cartridge_not_save_cookie_in_app_config = params['cartridge_not_save_cookie_in_app_config']
     stateboard = params['stateboard']
 
+    if not cartridge_not_save_cookie_in_app_config and cluster_cookie is None:
+        return None, "'cartridge_cluster_cookie' should be set to check for configuration updates " + \
+            "when 'cartridge_not_save_cookie_in_app_config' is false"
+
     if not os.path.exists(instance_info['conf_file']):
         return True, None
 
@@ -106,7 +112,8 @@ def check_needs_restart_to_update_config(params, control_console):
         if err is not None:
             return None, "Failed to read current default config: %s" % err
 
-        new_default_conf.update({'cluster_cookie': cluster_cookie})
+        if not cartridge_not_save_cookie_in_app_config:
+            new_default_conf['cluster_cookie'] = cluster_cookie
         if check_conf_updated(new_default_conf, current_default_conf, helpers.DYNAMIC_BOX_CFG_PARAMS):
             return True, None
 

library/cartridge_validate_config.py

@@ -14,6 +14,7 @@
 PARAMS_THE_SAME_FOR_ALL_HOSTS = [
     'cartridge_app_name',
     'cartridge_cluster_cookie',
+    'cartridge_not_save_cookie_in_app_config',
     'cartridge_auth',
     'cartridge_bootstrap_vshard',
     'cartridge_failover',
@@ -91,6 +92,7 @@
     'cartridge_package_path': str,
     'cartridge_app_name': str,
     'cartridge_cluster_cookie': str,
+    'cartridge_not_save_cookie_in_app_config': bool,
     'cartridge_defaults': dict,
     'cartridge_bootstrap_vshard': bool,
     'cartridge_wait_buckets_discovery': bool,

molecule/cluster_cookie/Dockerfile.j2

@@ -0,0 +1 @@
+../common/Dockerfile.j2

molecule/cluster_cookie/converge.yml

@@ -0,0 +1,31 @@
+---
+
+- name: 'Configure instances'
+  hosts: cluster
+  roles:
+    - ansible-cartridge
+  become: true
+  become_user: root
+  gather_facts: false
+  vars:
+    cartridge_scenario:
+      - eval
+    cartridge_eval_body:
+      return require('cartridge.cluster-cookie').cookie()
+
+- name: 'Print and check instances cluster cookie'
+  hosts: cluster
+  become: true
+  become_user: root
+  gather_facts: false
+  tasks:
+    - name: 'Debug instance cluster cookie'
+      debug:
+        msg: '{{ eval_res[0] }}'
+
+    - name: 'Check instance cluster cookie'
+      assert:
+        msg: 'Default Cartridge cluster cookie should be set'
+        success_msg: 'Default Cartridge cluster cookie is set'
+        that: >-
+          eval_res[0] == "secret-cluster-cookie"