Make cluster cookie param optional

Author: dokshina

CHANGELOG.md

@@ -54,6 +54,8 @@ README.md to use the newest tag with new release
 
 - Timeout to wait for cluster health after topology editing
   renamed from `edit_topology_timeout` to `edit_topology_healthy_timeout`
+- `cartridge_cluster_cookie` now is required only for `configure_instance`,
+  `restart_instance` and `upload_app_config` steps
 
 ## [1.8.3] - 2021-04-06
 

doc/scenario.md

@@ -439,6 +439,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);
 - `restarted` - if instance should be restarted or not (user forced decision).
 
 ### wait_instance_started

doc/variables.md

@@ -6,7 +6,7 @@ vshard bootstrapping, and failover.
 ## Common variables
 
 * `cartridge_app_name` (`string`): application name, required;
-* `cartridge_cluster_cookie` (`string`, required): cluster cookie for all
+* `cartridge_cluster_cookie` (`string`): cluster cookie for all
   cluster instances;
 * `cartridge_remove_temporary_files` (`boolean`, optional, default: `false`):
   indicates if temporary files should be removed

library/cartridge_validate_config.py

@@ -10,7 +10,7 @@
     'module_hostvars': {'required': True, 'type': 'dict'}
 }
 
-INSTANCE_REQUIRED_PARAMS = ['cartridge_app_name', 'cartridge_cluster_cookie', 'config']
+INSTANCE_REQUIRED_PARAMS = ['cartridge_app_name', 'config']
 PARAMS_THE_SAME_FOR_ALL_HOSTS = [
     'cartridge_app_name',
     'cartridge_cluster_cookie',
@@ -228,6 +228,9 @@ def validate_types(all_vars):
 
 
 def check_cluster_cookie_symbols(cluster_cookie):
+    if cluster_cookie is None:
+        return None
+
     if len(cluster_cookie) > CLUSTER_COOKIE_MAX_LEN:
         errmsg = 'Cluster cookie cannot be longer than {}'.format(CLUSTER_COOKIE_MAX_LEN)
         return errmsg
@@ -247,10 +250,6 @@ def check_required_params(instance_vars, host):
             errmsg = '"{}" must be specified (missed for "{}")'.format(p, host)
             return errmsg
 
-    errmsg = check_cluster_cookie_symbols(instance_vars['cartridge_cluster_cookie'])
-    if errmsg is not None:
-        return errmsg
-
     return None
 
 
@@ -548,6 +547,10 @@ def validate_config(params):
         if errmsg is not None:
             return helpers.ModuleRes(failed=True, msg=errmsg)
 
+        errmsg = check_cluster_cookie_symbols(instance_vars.get('cartridge_cluster_cookie'))
+        if errmsg is not None:
+            return errmsg
+
         # Instance config
         errmsg = check_instance_config(instance_vars['config'], host)
         if errmsg is not None:

molecule/common/tests/test_cluster_is_healthy.py

@@ -20,7 +20,8 @@
 inventory = InventoryManager(loader=DataLoader(), sources=HOSTS_PATH)
 variable_manager = VariableManager(loader=DataLoader(), inventory=inventory)
 
-cluster_cookie = inventory.groups['cluster'].get_vars()['cartridge_cluster_cookie']
+cluster_vars = inventory.groups['cluster'].get_vars()
+cluster_cookie = cluster_vars.get('cartridge_cluster_cookie', 'secret-cookie')
 
 __authorized_session = None
 __configured_instances = None

molecule/dead_instances/hosts.yml

@@ -9,7 +9,6 @@ cluster:
 
     # common cartridge opts
     cartridge_app_name: myapp
-    cartridge_cluster_cookie: secret-cookie
 
     cartridge_package_path: ./packages/myapp-1.0.0-0.rpm
 

molecule/dead_instances/prepare.yml

@@ -8,6 +8,7 @@
   become_user: root
   gather_facts: false
   vars:
+    cartridge_cluster_cookie: secret-cookie
     cartridge_scenario_name: configure_instances
 
 - name: Join all instances except instance-5-not-joined

molecule/eval/hosts.yml

@@ -9,7 +9,6 @@ cluster:
 
     # common cartridge opts
     cartridge_app_name: myapp
-    cartridge_cluster_cookie: secret-cookie
 
     cartridge_package_path: ./packages/myapp-1.0.0-0.rpm
 

molecule/eval/prepare.yml

@@ -7,3 +7,5 @@
   become: true
   become_user: root
   gather_facts: false
+  vars:
+    cartridge_cluster_cookie: secret-cookie

molecule/rolling_update/hosts.yml

@@ -9,7 +9,6 @@ cluster:
 
     # common cartridge opts
     cartridge_app_name: myapp
-    cartridge_cluster_cookie: secret-cookie
 
     cartridge_multiversion: true