Manage more dynamic box.cfg params (#125)

Author: dokshina

README.md

@@ -324,6 +324,19 @@ Environment=TARANTOOL_PID_FILE=/var/run/tarantool/${app_name}.{instance_name}.pi
 Environment=TARANTOOL_CONSOLE_SOCK=/var/run/tarantool/${app_name}.{instance_name}.control
 ```
 
+#### Managing dymanic `box.cfg` parameters without restart
+
+Some `box.cfg` options are dynamic, it means that it can be changed without
+instance restarting.
+See [parameters](https://www.tarantool.io/en/doc/latest/reference/configuration/#configuration-parameters)
+with "Dynamic: yes".
+
+Role changes this parameters without restarting the instance.
+If other parameters are changed, instance is restarted anyway.
+
+**Note**, that if `restarted` flag is set, instance will be restarted anyway without changing dynamic parameters in runtime.
+You can use this flag to force instance restarting.
+
 #### Increasing memtx_memory in runtime
 
 If you specified in `config.memtx_memory` value that increases current `memtx_memory`, this role will try to increase this value in runtime.

library/cartridge_instance.py

@@ -3,6 +3,7 @@
 from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.helpers import ModuleRes, CartridgeException, cartridge_errcodes
 from ansible.module_utils.helpers import get_control_console
+from ansible.module_utils.helpers import dynamic_box_cfg_params, memory_size_box_cfg_params
 
 import os
 
@@ -14,21 +15,119 @@
 }
 
 
+def serialize_dict(d):
+    parts = []
+
+    for k, v in d.items():
+        value_str = None
+        if type(v) == str:
+            value_str = "'%s'" % v
+        elif type(v) == float or type(v) == int:
+            value_str = "%s" % v
+        elif type(v) == bool:
+            value_str = 'true' if v else 'false'
+        else:
+            raise CartridgeException(
+                cartridge_errcodes.BAD_VALUE_TYPE,
+                "Unknown value type: {}" % type(v)
+            )
+
+        parts.append("%s = %s" % (k, value_str))
+
+    return '{ %s }' % ', '.join(parts)
+
+
+def box_cfg_was_called(control_console):
+    return control_console.eval('''
+        return type(box.cfg) ~= 'function'
+    ''')
+
+
+def get_box_cfg(control_console):
+    return control_console.eval('''
+        return type(box.cfg) == 'table' and box.cfg or box.NULL
+    ''')
+
+
+def is_dynamic_param(param_name):
+    return param_name in dynamic_box_cfg_params
+
+
+def is_memory_size_param(param_name):
+    return param_name in memory_size_box_cfg_params
+
+
+def change_memory_size(param_name, cartridge_defaults, config, control_console):
+    new_memory_size = config.get(param_name, cartridge_defaults.get(param_name))
+
+    if new_memory_size is None:
+        return False
+
+    # Get current memory size
+    current_memory_size = control_console.eval('''
+        return type(box.cfg) ~= 'function' and box.cfg.{} or box.NULL
+    '''.format(param_name))
+
+    if current_memory_size is None:
+        # box.cfg wasn't called
+        return False
+
+    if new_memory_size <= current_memory_size:
+        return False
+
+    # try to increase memory size
+    increased = control_console.eval('''
+        local ok, err = pcall(function()
+            box.cfg {{ {param_name} = {new_memory_size} }}
+        end)
+        if not ok then
+            if tostring(err):find("cannot decrease memory size at runtime") == nil then
+                error('failed to set {param_name}: ' .. tostring(err))
+            end
+        end
+        return ok
+    '''.format(param_name=param_name, new_memory_size=new_memory_size))
+
+    return increased
+
+
+def change_dynamic_params(cartridge_defaults, config, control_console):
+    params = dict()
+
+    # Get current values
+    current_box_cfg = get_box_cfg(control_console)
+    if current_box_cfg is None:
+        return False
+
+    for param_name, param_value in config.items():
+        if is_dynamic_param(param_name) and not is_memory_size_param(param_name):
+            params.update({param_name: param_value})
+
+    for param_name, param_value in cartridge_defaults.items():
+        if param_name in params:
+            continue
+        if is_dynamic_param(param_name) and not is_memory_size_param(param_name):
+            params.update({param_name: param_value})
+
+    if not params:
+        return False
+
+    serialized_params = serialize_dict(params)
+
+    new_box_cfg = control_console.eval('''
+        box.cfg({serialized_params})
+        return box.cfg
+    '''.format(serialized_params=serialized_params))
+
+    changed = new_box_cfg != current_box_cfg
+    return changed
+
+
 def manage_instance(params):
     config = params['config']
     cartridge_defaults = params['cartridge_defaults']
     control_sock = params['control_sock']
 
-    # Check if memtx_memory parameter is specified
-    if 'memtx_memory' not in config and 'memtx_memory' not in cartridge_defaults:
-        return ModuleRes(success=True, changed=False)
-
-    new_memtx_memory = None
-    if 'memtx_memory' in config:
-        new_memtx_memory = config['memtx_memory']
-    else:
-        new_memtx_memory = cartridge_defaults['memtx_memory']
-
     # Check if instance isn't started yet
     if not os.path.exists(control_sock):
         return ModuleRes(success=True, changed=False)
@@ -46,31 +145,24 @@ def manage_instance(params):
 
         raise e
 
-    # Get current memtx memory
-    current_memtx_memory = control_console.eval('''
-        return type(box.cfg) ~= 'function' and box.cfg.memtx_memory or box.NULL
-    ''')
-    if current_memtx_memory is None:
-        # box.cfg wasn't called
+    if not box_cfg_was_called(control_console):
         return ModuleRes(success=True, changed=False)
 
-    if new_memtx_memory <= current_memtx_memory:
-        return ModuleRes(success=True, changed=False)
+    # Change memory size
+    memory_size_changed = False
 
-    # try to increase memtx_memory
-    increased = control_console.eval('''
-        local ok, err = pcall(function()
-            box.cfg {{ memtx_memory = {} }}
-        end)
-        if not ok then
-            if tostring(err):find("cannot decrease memory size at runtime") == nil then
-                error('failed to set memtx_memory: ' .. tostring(err))
-            end
-        end
-        return ok
-    '''.format(new_memtx_memory))
+    for param_name in memory_size_box_cfg_params:
+        if param_name in config or param_name in cartridge_defaults:
+            memory_size_changed = memory_size_changed or change_memory_size(
+                param_name, cartridge_defaults, config, control_console
+            )
+
+    # Change dynamic params
+    dynamic_params_changed = change_dynamic_params(cartridge_defaults, config, control_console)
+
+    changed = memory_size_changed or dynamic_params_changed
 
-    return ModuleRes(success=True, changed=increased)
+    return ModuleRes(success=True, changed=changed)
 
 
 def main():

library/cartridge_needs_restart.py

@@ -3,6 +3,7 @@
 from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.helpers import ModuleRes, CartridgeException, cartridge_errcodes
 from ansible.module_utils.helpers import get_control_console
+from ansible.module_utils.helpers import dynamic_box_cfg_params
 
 import os
 
@@ -70,9 +71,9 @@ def check_conf_updated(new_conf, old_conf, ignore_keys=[]):
     return False
 
 
-def get_memtx_memory(control_console):
+def get_current_cfg(control_console):
     return control_console.eval('''
-        return type(box.cfg) ~= 'function' and box.cfg.memtx_memory or box.NULL
+        return type(box.cfg) ~= 'function' and box.cfg or box.NULL
     ''')
 
 
@@ -125,7 +126,7 @@ def needs_restart(params):
         control_console,
         conf_section_name
     )
-    if check_conf_updated(new_instance_conf, current_instance_conf, ['memtx_memory']):
+    if check_conf_updated(new_instance_conf, current_instance_conf, dynamic_box_cfg_params):
         return ModuleRes(success=True, changed=True)
 
     if not stateboard:
@@ -136,22 +137,24 @@ def needs_restart(params):
             appname
         )
         new_default_conf.update({'cluster_cookie': cluster_cookie})
-        if check_conf_updated(new_default_conf, current_default_conf, ['memtx_memory']):
+        if check_conf_updated(new_default_conf, current_default_conf, dynamic_box_cfg_params):
             return ModuleRes(success=True, changed=True)
 
-    new_memtx_memory = None
-    if 'memtx_memory' in new_instance_conf:
-        new_memtx_memory = new_instance_conf['memtx_memory']
-    elif not stateboard and 'memtx_memory' in new_default_conf:
-        new_memtx_memory = new_default_conf['memtx_memory']
-
-    # This code is ran after attempt to change memtx_memory in runtime
-    # If current memtx_memory wasn't changed to the new value,
-    # it mean that instance should be restarted to apply change
-    if new_memtx_memory is not None:
-        current_memtx_memory = get_memtx_memory(control_console)
-        if current_memtx_memory != new_memtx_memory:
-            return ModuleRes(success=True, changed=True)
+    current_cfg = get_current_cfg(control_console)
+
+    for param_name in dynamic_box_cfg_params:
+        new_value = None
+        if param_name in new_instance_conf:
+            new_value = new_instance_conf[param_name]
+        elif not stateboard and param_name in new_default_conf:
+            new_value = new_default_conf[param_name]
+
+        # This code is ran after attempt to change parameter in runtime
+        # If current parameter wasn't changed to the new value,
+        # it mean that instance should be restarted to apply change
+        if new_value is not None:
+            if current_cfg[param_name] != new_value:
+                return ModuleRes(success=True, changed=True)
 
     return ModuleRes(success=True, changed=False)
 

module_utils/helpers.py

@@ -23,11 +23,52 @@ def __init__(self):
         self.BROKEN_PIPE = 'BROKEN_PIPE'
         self.FUNCTION_ERROR = 'FUNCTION_ERROR'
         self.MISSED_SECTION = 'MISSED_SECTION'
+        self.BAD_VALUE_TYPE = 'BAD_VALUE_TYPE'
 
 
 cartridge_errcodes = CartridgeErrorCodes()
 
 
+# parameters of instance configuration that can be changed dynamically
+dynamic_box_cfg_params = set([
+    'memtx_memory',
+    'vinyl_memory',
+    'custom_proc_title',
+    'listen',
+    'read_only',
+    'sql_cache_size',
+    'vinyl_timeout',
+    'worker_pool_threads',
+    'vinyl_cache',
+    'checkpoint_interval',
+    'checkpoint_count',
+    'checkpoint_wal_threshold',
+    'snap_io_rate_limit',
+    'replication_connect_timeout',
+    'replication_connect_quorum',
+    'replication_skip_conflict',
+    'replication_sync_lag',
+    'replication_sync_timeout',
+    'replication_timeout',
+    'replication_synchro_quorum',
+    'replication_synchro_timeout',
+    'io_collect_interval',
+    'net_msg_max',
+    'readahead',
+    'log_level',
+    'too_long_threshold',
+    'log_format',
+    'feedback_enabled',
+    'feedback_host',
+    'feedback_interval',
+])
+
+memory_size_box_cfg_params = set([
+    'memtx_memory',
+    'vinyl_memory',
+])
+
+
 class CartridgeException(Exception):
     def __init__(self, code, message):
         super(CartridgeException, self).__init__(message)

tasks/start_instance.yml

@@ -5,8 +5,7 @@
     config: '{{ config }}'
     cartridge_defaults: '{{ cartridge_defaults }}'
   when: >-
-    not restarted and not expelled and
-    (config.memtx_memory is defined or cartridge_defaults.memtx_memory is defined )
+    not restarted and not expelled
   tags: cartridge-instances
 
 - name: Check if instance restart is forced or required to apply changes

unit/helpers.py

@@ -31,7 +31,5 @@ def add_replicaset(instance, alias, roles, servers,
     return replicaset
 
 
-def set_box_cfg(instace, memtx_memory):
-    instace.set_box_cfd({
-        'memtx_memory': memtx_memory,
-    })
+def set_box_cfg(instance, **kwargs):
+    instance.set_box_cfg(kwargs)

unit/instance.py

@@ -226,7 +226,7 @@ def set_variable(self, name, value):
             encoded_value=json.dumps(value)
         ))
 
-    def set_box_cfd(self, new_box_cfg):
+    def set_box_cfg(self, new_box_cfg):
         self.eval('''
             local value = require('json').decode('{encoded_value}')
             require('cartridge').internal.set_box_cfg(value)