Use playbook variables in tasks that use hostsvars (#266)

Closes #259

Before the patch, some tasks use the `hostsvars` magic variable,
but it does not take into account the variables from the playbook.

Now the `role_vars` variable has been added in `hostsvars`,
in which all role variables are stored, taking into account the playbook
and other places where variables are declared.

Author: hackallcode

defaults/main.yml

@@ -1,42 +1,16 @@
 ---
 
-cartridge_remove_temporary_files: false
-
-cartridge_package_path: null
-cartridge_defaults: {}
-cartridge_enable_tarantool_repo: true
-
-cartridge_bootstrap_vshard: false
-cartridge_app_config: null
-cartridge_auth: null
-cartridge_failover: null
-cartridge_failover_params: null
-cartridge_wait_buckets_discovery: true
-
-restarted: null
-expelled: false
-stateboard: false
-cartridge_multiversion: false
+# Common variables
 
-instance_start_timeout: 60
-instance_discover_buckets_timeout: 60
-edit_topology_timeout: 60
-
-cartridge_app_install_dir: /usr/share/tarantool
-cartridge_app_instances_dir: /usr/share/tarantool
-cartridge_conf_dir: /etc/tarantool/conf.d
-cartridge_run_dir: /var/run/tarantool
-cartridge_data_dir: /var/lib/tarantool
-cartridge_memtx_dir_parent: null
-cartridge_vinyl_dir_parent: null
-cartridge_wal_dir_parent: null
+cartridge_app_name: null
+cartridge_cluster_cookie: null
+cartridge_remove_temporary_files: false
 
-cartridge_app_user: tarantool
-cartridge_app_group: tarantool
+# Role scenario configuration
 
-cartridge_custom_steps: []
-cartridge_custom_steps_dir: null
 cartridge_scenario: null
+cartridge_custom_steps_dir: null
+cartridge_custom_steps: []
 
 cartridge_scenario_name: 'default'
 cartridge_custom_scenarios: {}
@@ -76,22 +50,78 @@ cartridge_role_scenarios:
     - configure_failover
     - cleanup
 
+# Application package configuration
+
+cartridge_package_path: null
+cartridge_enable_tarantool_repo: true
+
+# TGZ specific configuration
+
+cartridge_multiversion: false
+
+cartridge_install_tarantool_for_tgz: true
+
+cartridge_app_user: tarantool
+cartridge_app_group: tarantool
+
+cartridge_data_dir: /var/lib/tarantool
+cartridge_memtx_dir_parent: null
+cartridge_vinyl_dir_parent: null
+cartridge_wal_dir_parent: null
+cartridge_run_dir: /var/run/tarantool
+cartridge_conf_dir: /etc/tarantool/conf.d
+cartridge_app_install_dir: /usr/share/tarantool
+cartridge_app_instances_dir: /usr/share/tarantool
+
 cartridge_configure_systemd_unit_files: true
 cartridge_systemd_dir: /etc/systemd/system
 
 cartridge_configure_tmpfiles: true
 cartridge_tmpfiles_dir: /usr/lib/tmpfiles.d/
 
-cartridge_install_tarantool_for_tgz: true
-
 cartridge_keep_num_latest_dists: 2
 
-# Facts initialized in 'main.yml' (for correct 'tasks_from' option usage)
-temporary_files: []
+# Instances configuration
+
+cartridge_defaults: {}
+config: null
+zone: null
+
+restarted: null
+expelled: false
+stateboard: false
+
+cartridge_wait_buckets_discovery: true
+instance_start_timeout: 60
+instance_discover_buckets_timeout: 60
+
+# Replicasets configuration
+
+replicaset_alias: null
+failover_priority: null
+roles: null
+all_rw: null
+vshard_group: null
+weight: null
+edit_topology_timeout: 60
+
+## Cluster configuration
+
+cartridge_bootstrap_vshard: false
+cartridge_app_config: null
+cartridge_auth: null
+cartridge_failover: null
+cartridge_failover_params: null
+
+# Internal role facts that can be set by the user
+
+cartridge_delivered_package_path: null
+cartridge_control_instance: null
+
+# Cross-step facts (for correct 'tasks_from' option usage)
+
 delivered_package_path: null
-package_info: null
-systemd_units_info: null
+control_instance: null
+temporary_files: []
 needs_restart: null
 non_expelled_instance: null
-control_instance: null
-dists_dirs_to_remove: null

doc/scenario.md

@@ -208,7 +208,7 @@ remove `connect_to_membership` step from scenario:
 
 If you are using multiversion, then most likely you are upgrading to the new version of the package gradually:
 first storages, then routers, etc. To do this, the same scenario to update the package version is used several times.
-Let's remove duplication by declaring a custom script and then using it!
+Let's remove duplication by declaring a custom scenario and then using it!
 
 Firstly you should to define custom scenarios in hosts file:
 
@@ -282,6 +282,7 @@ Some of useful facts are established during preparation, so you can use them at
 - `scenario_steps` - description of scenario steps. Each step is a dictionary with fields:
   - `name` - name of step;
   - `path` - path to YAML file of step;
+- `role_vars` - dictionary with all role variables.
 
 ## Role Steps Description
 

doc/variables.md

@@ -8,8 +8,6 @@ vshard bootstrapping, and failover.
 * `cartridge_app_name` (`string`): application name, required;
 * `cartridge_cluster_cookie` (`string`, required): cluster cookie for all
   cluster instances;
-* `cartridge_multiversion` (`boolean`, default: `false`): use multiversion
-  approach for TGZ package.
 * `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));
@@ -19,11 +17,13 @@ vshard bootstrapping, and failover.
 For more details see [scenario documentation](/doc/scenario.md).
 
 * `cartridge_scenario` (`list-of-strings`): list of steps to be launched
-  (see [change scenario](/README.md#using-scenario) for more details)
+  (see [change scenario](/README.md#using-scenario) for more details);
 * `cartridge_custom_steps_dir` (`string`, default: `null`): path to directory
-  containing YAML files of custom steps (see [change scenario](/README.md#using-scenario) for more details)
+  containing YAML files of custom steps (see [change scenario](/README.md#using-scenario) for more details);
 * `cartridge_custom_steps` (`list-of-dicts`, default: `[]`): list of custom steps
-  (see [change scenario](/README.md#using-scenario) for more details)
+  (see [change scenario](/README.md#using-scenario) for more details);
+* `cartridge_scenario_name` (`string`, default: `default`): name of scenario to be launched;
+* `cartridge_custom_scenarios` (`dict-of-lists`, default: `{}`): dictionary of custom scenarios;
 
 ## Application package configuration
 
@@ -69,6 +69,9 @@ For more details see [scenario documentation](/doc/scenario.md).
 * `cartridge_tmpfiles_dir` (`string`, default: `/usr/lib/tmpfiles.d/`): a directory where
   tmpfile configuration should be placed;
 
+* `cartridge_keep_num_latest_dists` (`number`, default: 2): the number of application
+  versions that should be kept during distribution rotation;
+
 ## Instances configuration
 
 * `config` (`dict`, required): [instance configuration](/doc/instances.md);
@@ -94,6 +97,7 @@ For more details see [scenario documentation](/doc/scenario.md).
 * `failover_priority` (`list-of-strings`): failover priority;
 * `roles` (`list-of-strings`, required if `replicaset_alias` specified): roles to be enabled on the replicaset;
 * `all_rw` (`boolean`): indicates that that all servers in the replicaset should be read-write;
+* `vshard_group` (`string`): name of vshard group the replicaset belongs to;
 * `weight` (`number`): vshard replicaset weight (matters only if `vshard-storage` role is enabled);
 * `edit_topology_timeout` (`number`, default: `60`): time in seconds to wait until a cluster become
   healthy after editing topology;

library/cartridge_connect_to_membership.py

@@ -32,6 +32,9 @@ def connect_to_membership(params):
     changed = False
 
     for instance_name, instance_vars in hostvars.items():
+        if 'role_vars' in instance_vars:
+            instance_vars = instance_vars['role_vars']
+
         if helpers.is_expelled(instance_vars) or helpers.is_stateboard(instance_vars):
             continue
 

library/cartridge_edit_topology.py

@@ -118,9 +118,9 @@ def get_cluster_instances(control_console):
 
 def get_configured_replicasets(hostvars, play_hosts):
     replicasets = {}
-    for instance_name, instance_vars in hostvars.items():
-        if instance_name not in play_hosts:
-            continue
+
+    for instance_name in play_hosts:
+        instance_vars = hostvars[instance_name]['role_vars']
 
         if helpers.is_expelled(instance_vars) or helpers.is_stateboard(instance_vars):
             continue
@@ -148,7 +148,8 @@ def get_instances_to_configure(hostvars, play_hosts):
     instances = {}
 
     for instance_name in play_hosts:
-        instance_vars = hostvars[instance_name]
+        instance_vars = hostvars[instance_name]['role_vars']
+
         if helpers.is_stateboard(instance_vars):
             continue
 

library/cartridge_get_control_instance.py

@@ -110,7 +110,8 @@ def get_control_instance(params):
 
     if not control_instance_candidates:
         for instance_name in play_hosts:
-            instance_vars = hostvars[instance_name]
+            instance_vars = hostvars[instance_name]['role_vars']
+
             if helpers.is_expelled(instance_vars) or helpers.is_stateboard(instance_vars):
                 continue
 
@@ -122,6 +123,8 @@ def get_control_instance(params):
         return helpers.ModuleRes(failed=True, msg=errmsg)
 
     advertise_uris = [
+        hostvars[instance_name]['role_vars']['config']['advertise_uri']
+        if 'role_vars' in hostvars[instance_name] else
         hostvars[instance_name]['config']['advertise_uri']
         for instance_name in control_instance_candidates
     ]
@@ -137,6 +140,8 @@ def get_control_instance(params):
     # instance_vars['instance_info'], but if control instance is not
     # in play_hosts, instance_info isn't computed for it
     instance_vars = hostvars[control_instance_name]
+    if 'role_vars' in instance_vars:
+        instance_vars = instance_vars['role_vars']
     run_dir = instance_vars.get('cartridge_run_dir', helpers.DEFAULT_RUN_DIR)
     control_instance_console_sock = helpers.get_instance_console_sock(
         run_dir, app_name, control_instance_name,

library/cartridge_get_not_expelled_instance.py

@@ -20,7 +20,7 @@ def get_one_not_expelled_instance(params):
     not_expelled_instance_name = None
 
     for instance_name in play_hosts:
-        instance_vars = hostvars[instance_name]
+        instance_vars = hostvars[instance_name]['role_vars']
         if helpers.is_expelled(instance_vars) or helpers.is_stateboard(instance_vars):
             continue
 

library/cartridge_get_single_instances_for_each_machine.py

@@ -30,7 +30,7 @@ def get_one_not_expelled_instance_for_machine(params):
     for instance_name in play_hosts:
         instance_vars = hostvars[instance_name]
 
-        if helpers.is_expelled(instance_vars):
+        if helpers.is_expelled(instance_vars['role_vars']):
             continue
 
         machine_hostname = get_machine_hostname(instance_vars, instance_name)