Add vm size update action

Author: 0lvin

CHANGELOG.txt

@@ -23,3 +23,6 @@ releases:
     * Update start action for fill in `network` in vm runtime properties
     * Cluster Example: Automatically add libvirt host to trusted
     * Support for reuse external vm
+    * move use_external_resource to top of instance properties
+    * add `update` action for sync vm size to values from runtime properties.
+    * rename `memory_size` to `memory_maxsize`

README.md

@@ -41,15 +41,15 @@ Description for VM
 **Supported properties:**
 * `libvirt_auth`: connection url, by default: `qemu:///system`
 * `backup_dir`: directory for save backups, by default: `./`
+* `use_external_resource`: (optional) Use external object. The default is
+  `false`.
+* `resource_id`: (optional) Used to identify the object when
+  `use_external_resource` is true.
 * `params`: params used for create object, useful for embeded template.
-  * `use_external_resource`: (optional) Use external object. The default is
-    `false`.
-  * `resource_id`: (optional) Used to identify the object when
-    `use_external_resource` is true.
   * `vcpu`: CPU count
-  * `memory_minsize`: (optional) recomended VM memory size in KiB for
-    downgrade.
   * `memory_size`: VM memory size in KiB
+  * `memory_maxsize`: (optional) recomended VM memory size in KiB for
+        downgrade. The default is value from `memory_size` * 2.
   * `nvram`: (optional) path to nvram (useful for arm)
   * `disks`: list connected disks
   * `networks`: list connected networks
@@ -75,11 +75,11 @@ Description for Network
 **Supported properties:**
 * `libvirt_auth`: connection url, by default: `qemu:///system`
 * `backup_dir`: directory for save backups, by default: `./`
+* `use_external_resource`: (optional) Use external object. The default is
+  `false`.
+* `resource_id`: (optional) Used to identify the object when
+  `use_external_resource` is true.
 * `params`: params used for create object.
-  * `use_external_resource`: (optional) Use external object. The default is
-    `false`.
-  * `resource_id`: (optional) Used to identify the object when
-    `use_external_resource` is true.
   * `dev`: Device name
   * `forwards`: settings for network `forwards`.
   * `ips`: settings for network `ips`.

cloudify_libvirt/common.py

@@ -31,6 +31,12 @@ def get_libvirt_params(**kwargs):
     template_params.update(ctx.instance.runtime_properties.get('params', {}))
     template_params.update(kwargs.get('params', {}))
     ctx.instance.runtime_properties['params'] = template_params
+
+    # update 'resource_id', 'use_external_resource' from kwargs
+    for field in ['resource_id', 'use_external_resource']:
+        if field in kwargs:
+            ctx.instance.runtime_properties[field] = kwargs[field]
+
     return libvirt_auth, template_params
 
 

cloudify_libvirt/domain_tasks.py

@@ -40,13 +40,12 @@ def _update_template_params(template_params):
 
     if not template_params.get("resource_id"):
         template_params["resource_id"] = ctx.instance.id
-    if (not template_params.get("memory_minsize") and
+    if (not template_params.get("memory_maxsize") and
             template_params.get('memory_size')):
-        # if have no minimal memory size, set current as minimum
+        # if have no maximum memory size, set current as minimum
         # and twised memory as maximum
         memory_size = int(template_params['memory_size'])
-        template_params["memory_minsize"] = memory_size
-        template_params['memory_size'] = memory_size * 2
+        template_params['memory_maxsize'] = memory_size * 2
     if not template_params.get("instance_uuid"):
         template_params["instance_uuid"] = str(uuid.uuid4())
     if not template_params.get("domain_type"):
@@ -68,10 +67,11 @@ def configure(**kwargs):
     template_params = _update_template_params(template_params)
 
     try:
-        if template_params.get("use_external_resource"):
+        if ctx.instance.runtime_properties.get("use_external_resource"):
             # lookup the default domain by name
             try:
-                dom = conn.lookupByName(template_params["resource_id"])
+                dom = conn.lookupByName(
+                    ctx.instance.runtime_properties["resource_id"])
             except Exception as e:
                 dom = None
                 ctx.logger.info("Non critical error: {}".format(str(e)))
@@ -131,6 +131,8 @@ def _update_network_list(dom, lease_only=True):
 
     # get known by libvirt interfaces
     virt_networks = dom.interfaceAddresses(request_type)
+    ctx.logger.info("Libvirt knows about such networks: {}"
+                    .format(repr(virt_networks)))
 
     # networks from instance
     if 'params' not in ctx.instance.runtime_properties:
@@ -179,7 +181,7 @@ def reboot(**kwargs):
     resource_id = ctx.instance.runtime_properties.get('resource_id')
 
     if not resource_id:
-        ctx.logger.info("No servers for start")
+        ctx.logger.info("No servers for reboot")
         return
 
     libvirt_auth, template_params = common.get_libvirt_params(**kwargs)
@@ -209,6 +211,72 @@ def reboot(**kwargs):
         conn.close()
 
 
+@operation
+def update(**kwargs):
+    ctx.logger.info("set vcpu/memory values")
+
+    resource_id = ctx.instance.runtime_properties.get('resource_id')
+
+    if not resource_id:
+        ctx.logger.info("No servers for update")
+        return
+
+    libvirt_auth, template_params = common.get_libvirt_params(**kwargs)
+    conn = libvirt.open(libvirt_auth)
+    if conn is None:
+        raise cfy_exc.NonRecoverableError(
+            'Failed to open connection to the hypervisor'
+        )
+
+    try:
+        try:
+            dom = conn.lookupByName(resource_id)
+        except Exception as e:
+            dom = None
+            ctx.logger.info("Non critical error: {}".format(str(e)))
+
+        if dom is None:
+            raise cfy_exc.NonRecoverableError(
+                'Failed to find the domain'
+            )
+
+        # change memory values
+        if template_params.get('memory_size'):
+            ctx.logger.info("Set memory to {}"
+                            .format(repr(template_params['memory_size'])))
+            if dom.setMemory(template_params['memory_size']) < 0:
+                raise cfy_exc.NonRecoverableError(
+                    "Can not change memory amount."
+                )
+
+        state, _ = dom.state()
+        if state == libvirt.VIR_DOMAIN_RUNNING:
+            ctx.logger.info("CPU/Maximum memory size count should be changed "
+                            "on stopped vm.")
+            return
+
+        # change vcpu values
+        if template_params.get('vcpu'):
+            ctx.logger.info("Set cpu count to {}"
+                            .format(repr(template_params['vcpu'])))
+            if dom.setVcpus(template_params['vcpu']) < 0:
+                raise cfy_exc.NonRecoverableError(
+                    "Can not change cpu count."
+                )
+
+        # change max memory values
+        if template_params.get('memory_maxsize'):
+            ctx.logger.info("Set max memory to {}"
+                            .format(repr(template_params['memory_maxsize'])))
+            if dom.setMaxMemory(template_params['memory_maxsize']) < 0:
+                raise cfy_exc.NonRecoverableError(
+                    "Can not change max memory amount."
+                )
+
+    finally:
+        conn.close()
+
+
 @operation
 def start(**kwargs):
     ctx.logger.info("start")

cloudify_libvirt/network_tasks.py

@@ -54,9 +54,10 @@ def create(**kwargs):
     template_params = _update_template_params(template_params)
 
     try:
-        if template_params.get("use_external_resource"):
+        if ctx.instance.runtime_properties.get("use_external_resource"):
             # lookup the default network by name
-            network = conn.networkLookupByName(template_params["resource_id"])
+            network = conn.networkLookupByName(
+                ctx.instance.runtime_properties["resource_id"])
             if network is None:
                 raise cfy_exc.NonRecoverableError(
                     'Failed to find the network'

cloudify_libvirt/templates/domain.xml

@@ -3,7 +3,7 @@
     <partition>/machine</partition>
   </resource>
   <uuid>{{ instance_uuid }}</uuid>
-  <currentMemory unit="KiB">{{ memory_minsize }}</currentMemory>
+  <currentMemory unit="KiB">{{ memory_size }}</currentMemory>
   <on_poweroff>destroy</on_poweroff>
   <devices>
     <console type="pty" tty="/dev/pts/1">
@@ -56,7 +56,7 @@
     <acpi/>
     <apic/>
   </features>
-  <memory unit="KiB">{{ memory_size }}</memory>
+  <memory unit="KiB">{{ memory_maxsize }}</memory>
   <os>
     <type machine="pc" arch="x86_64">hvm</type>
     <boot dev="hd"/>

cloudify_libvirt/tests/test_domain.py

@@ -35,7 +35,7 @@ def _create_ctx(self):
                 'libvirt_auth': {'a': 'c'}
             },
             runtime_properties=DirtyTrackingDict({
-                'params': {'c': "d", 'e': 'g', 'memory_size': 1024},
+                'params': {'c': "d", 'e': 'g'},
                 'libvirt_auth': {'a': 'd'}
             })
         )
@@ -47,10 +47,11 @@ def test_reuse_domain_create_not_exist(self):
         _ctx = self._create_ctx()
         self._check_no_such_object_domain(
             "cloudify_libvirt.domain_tasks.libvirt.open",
-            domain_tasks.configure, [], {'ctx': _ctx, 'params': {
+            domain_tasks.configure, [], {
+                'ctx': _ctx,
                 "resource_id": 'resource',
-                "use_external_resource": True,
-            }}, 'resource')
+                "use_external_resource": True
+            }, 'resource')
 
     def test_reuse_domain_create_exist(self):
         # check that we can use domain
@@ -65,9 +66,8 @@ def test_reuse_domain_create_exist(self):
             "cloudify_libvirt.domain_tasks.libvirt.open",
             mock.Mock(return_value=connect)
         ):
-            domain_tasks.configure(ctx=_ctx, params={
-                    "resource_id": 'resource',
-                    "use_external_resource": True})
+            domain_tasks.configure(ctx=_ctx, resource_id='resource',
+                                   use_external_resource=True)
         connect.lookupByName.assert_called_with('resource')
         self.assertEqual(
             _ctx.instance.runtime_properties['resource_id'], 'resource'
@@ -86,7 +86,7 @@ def test_create(self):
         self.assertEqual(_ctx.instance.runtime_properties, {
             'libvirt_auth': {'w': 'x'},
             'params': {
-                'a': 'b', 'c': 'd', 'e': 'g', 'z': 'y', 'memory_size': 1024
+                'a': 'b', 'c': 'd', 'e': 'g', 'z': 'y'
             }
         })
 
@@ -114,17 +114,61 @@ def test_configure(self):
 
         connect = self._create_fake_connection()
         connect.defineXML = mock.Mock(return_value=domain)
+
+        # without params
         _ctx.instance.runtime_properties['params'] = {}
         _ctx.node.properties['params'] = {}
         with mock.patch(
             "cloudify_libvirt.domain_tasks.libvirt.open",
             mock.Mock(return_value=connect)
         ):
-            domain_tasks.configure(ctx=_ctx, domain_file="domain_file")
+            domain_tasks.configure(ctx=_ctx,
+                                   domain_file="domain_file")
         connect.defineXML.assert_called_with('<somexml/>')
         self.assertEqual(
             _ctx.instance.runtime_properties['resource_id'], "domain_name"
         )
+        # with params from inputs
+        _ctx.instance.runtime_properties['params'] = {}
+        _ctx.node.properties['params'] = {}
+        with mock.patch(
+            "cloudify_libvirt.domain_tasks.libvirt.open",
+            mock.Mock(return_value=connect)
+        ):
+            domain_tasks.configure(ctx=_ctx,
+                                   domain_file="domain_file",
+                                   params={"memory_size": 1024})
+        connect.defineXML.assert_called_with('<somexml/>')
+        self.assertEqual(
+            _ctx.instance.runtime_properties['params']['memory_maxsize'],
+            2048)
+        self.assertEqual(
+            _ctx.instance.runtime_properties['params']['memory_size'],
+            1024)
+
+
+    def test_update(self):
+        self._test_no_resource_id(domain_tasks.update)
+        self._test_check_correct_connect_action(domain_tasks.update)
+        self._test_check_correct_connect_no_object(domain_tasks.update)
+        # check memory
+        self._test_action_states(
+            domain_tasks.update,
+            [libvirt.VIR_DOMAIN_RUNNING],
+            'Can not change memory amount.',
+            params_update={'memory_size': 1024})
+        # check max memory
+        self._test_action_states(
+            domain_tasks.update,
+            [libvirt.VIR_DOMAIN_RUNNING_UNKNOWN],
+            'Can not change max memory amount.',
+            params_update={'memory_maxsize': 1024})
+        # check cpu
+        self._test_action_states(
+            domain_tasks.update,
+            [libvirt.VIR_DOMAIN_RUNNING_UNKNOWN],
+            'Can not change cpu count.',
+            params_update={'vcpu': 1024})
 
     def test_reboot(self):
         self._test_no_resource_id(domain_tasks.reboot)
@@ -378,10 +422,12 @@ def test_update_network_list(self):
         )
 
     def _test_action_states(self, func, states, error_text,
-                            error_check_ip=None):
+                            error_check_ip=None, params_update=None):
         _ctx = self._create_ctx()
         _ctx.instance.runtime_properties['resource_id'] = 'check'
         _ctx.instance.runtime_properties['params']['wait_for_ip'] = True
+        if params_update:
+            _ctx.instance.runtime_properties['params'].update(params_update)
         fake_states = [state for state in states]
 
         def _fake_state():
@@ -401,6 +447,9 @@ def _fake_state():
         domain.resume = mock.Mock(return_value=-1)
         domain.suspend = mock.Mock(return_value=-1)
         domain.reboot = mock.Mock(return_value=-1)
+        domain.setMemory = mock.Mock(return_value=-1)
+        domain.setMaxMemory = mock.Mock(return_value=-1)
+        domain.setVcpus = mock.Mock(return_value=-1)
 
         with mock.patch(
             "cloudify_libvirt.domain_tasks.libvirt.open",
@@ -419,6 +468,9 @@ def _fake_state():
         domain.resume = mock.Mock(return_value=0)
         domain.suspend = mock.Mock(return_value=0)
         domain.reboot = mock.Mock(return_value=0)
+        domain.setMemory = mock.Mock(return_value=0)
+        domain.setMaxMemory = mock.Mock(return_value=0)
+        domain.setVcpus = mock.Mock(return_value=0)
         fake_states = [state for state in states]
 
         def _fake_state():

cloudify_libvirt/tests/test_network.py

@@ -171,10 +171,11 @@ def test_reuse_network_create_not_exist(self):
         _ctx = self._create_ctx()
         self._check_no_such_object_network(
             "cloudify_libvirt.network_tasks.libvirt.open",
-            network_tasks.create, [], {'ctx': _ctx, 'params': {
+            network_tasks.create, [], {
+                'ctx': _ctx,
                 "resource_id": 'resource',
                 "use_external_resource": True,
-            }}, 'resource')
+            }, 'resource')
 
     def test_reuse_network_create_exist(self):
         # check that we can use network
@@ -189,9 +190,9 @@ def test_reuse_network_create_exist(self):
             "cloudify_libvirt.domain_tasks.libvirt.open",
             mock.Mock(return_value=connect)
         ):
-            network_tasks.create(ctx=_ctx, params={
-                    "resource_id": 'resource',
-                    "use_external_resource": True})
+            network_tasks.create(ctx=_ctx,
+                                 resource_id='resource',
+                                 use_external_resource=True)
         connect.networkLookupByName.assert_called_with('resource')
         self.assertEqual(
             _ctx.instance.runtime_properties['resource_id'], 'resource'

examples/templates/domain-arm.xml

@@ -3,7 +3,7 @@
     <partition>/machine</partition>
   </resource>
   <uuid>{{ instance_uuid }}</uuid>
-  <currentMemory unit="KiB">{{ memory_minsize }}</currentMemory>
+  <currentMemory unit="KiB">{{ memory_size }}</currentMemory>
   <on_poweroff>destroy</on_poweroff>
   <devices>
     <emulator>/usr/bin/qemu-system-aarch64</emulator>
@@ -66,7 +66,7 @@
   <features>
     <gic version='2'/>
   </features>
-  <memory unit="KiB">{{ memory_size }}</memory>
+  <memory unit="KiB">{{ memory_maxsize }}</memory>
   <os>
     <type arch='aarch64' machine='virt'>hvm</type>
     <loader readonly='yes' type='pflash'>/usr/share/AAVMF/AAVMF_CODE.fd</loader>