api: extend evacuate instance to support target state

sahid · sahid · commit d732ee38a1c5 · 2023-01-31T18:16:00.000+01:00
Start to v2.95 any evacuated instances will be stopped a destination

Implements: bp/allowing-target-state-for-evacuate
Signed-off-by: Sahid Orentino Ferdjaoui &lt;sahid.ferdjaoui@industrialdiscipline.com&gt;
Change-Id: I141b6f057cc4eb9c541c2bc6eddae27270ede08d
diff --git a/doc/api_samples/os-evacuate/v2.95/server-evacuate-find-host-req.json b/doc/api_samples/os-evacuate/v2.95/server-evacuate-find-host-req.json
@@ -0,0 +1,5 @@
+{
+    "evacuate": {
+        "targetState": "stopped"
+    }
+}
diff --git a/doc/api_samples/os-evacuate/v2.95/server-evacuate-req.json b/doc/api_samples/os-evacuate/v2.95/server-evacuate-req.json
@@ -0,0 +1,6 @@
+{
+    "evacuate": {
+        "host": "testHost",
+        "targetState": "stopped"
+    }
+}
diff --git a/doc/api_samples/versions/v21-version-get-resp.json b/doc/api_samples/versions/v21-version-get-resp.json
@@ -19,7 +19,7 @@
             }
         ],
         "status": "CURRENT",
-        "version": "2.94",
+        "version": "2.95",
         "min_version": "2.1",
         "updated": "2013-07-23T11:33:21Z"
     }
diff --git a/doc/api_samples/versions/versions-get-resp.json b/doc/api_samples/versions/versions-get-resp.json
@@ -22,7 +22,7 @@
                 }
             ],
             "status": "CURRENT",
-            "version": "2.94",
+            "version": "2.95",
             "min_version": "2.1",
             "updated": "2013-07-23T11:33:21Z"
         }
diff --git a/nova/api/openstack/api_version_request.py b/nova/api/openstack/api_version_request.py
@@ -254,6 +254,7 @@
              in keypair name.
     * 2.93 - Add support for volume backed server rebuild.
     * 2.94 - Allow FQDN in server hostname.
+    * 2.95 - Evacuate will now stop instance at destination.
 """
 
 # The minimum and maximum versions of the API supported
@@ -262,7 +263,7 @@
 # Note(cyeoh): This only applies for the v2.1 API once microversions
 # support is fully merged. It does not affect the V2 API.
 _MIN_API_VERSION = '2.1'
-_MAX_API_VERSION = '2.94'
+_MAX_API_VERSION = '2.95'
 DEFAULT_API_VERSION = _MIN_API_VERSION
 
 # Almost all proxy APIs which are related to network, images and baremetal
diff --git a/nova/api/openstack/compute/evacuate.py b/nova/api/openstack/compute/evacuate.py
@@ -23,16 +23,20 @@
 from nova.api.openstack import wsgi
 from nova.api import validation
 from nova.compute import api as compute
+from nova.compute import vm_states
 import nova.conf
 from nova import exception
 from nova.i18n import _
+from nova import objects
 from nova.policies import evacuate as evac_policies
 from nova import utils
 
 CONF = nova.conf.CONF
 
 LOG = logging.getLogger(__name__)
 
+MIN_VER_NOVA_COMPUTE_EVACUATE_STOPPED = 62
+
 
 class EvacuateController(wsgi.Controller):
     def __init__(self):
@@ -77,7 +81,8 @@ def _get_password_v214(self, req, evacuate_body):
     @validation.schema(evacuate.evacuate, "2.0", "2.13")
     @validation.schema(evacuate.evacuate_v214, "2.14", "2.28")
     @validation.schema(evacuate.evacuate_v2_29, "2.29", "2.67")
-    @validation.schema(evacuate.evacuate_v2_68, "2.68")
+    @validation.schema(evacuate.evacuate_v2_68, "2.68", "2.94")
+    @validation.schema(evacuate.evacuate_v2_95, "2.95")
     def _evacuate(self, req, id, body):
         """Permit admins to evacuate a server from a failed host
         to a new one.
@@ -92,6 +97,19 @@ def _evacuate(self, req, id, body):
         host = evacuate_body.get("host")
         force = None
 
+        target_state = None
+        if api_version_request.is_supported(req, min_version='2.95'):
+            min_ver = objects.service.get_minimum_version_all_cells(
+                context, ['nova-compute'])
+            if min_ver < MIN_VER_NOVA_COMPUTE_EVACUATE_STOPPED:
+                raise exception.NotSupportedComputeForEvacuateV295(
+                    {'currently': min_ver,
+                     'expected': MIN_VER_NOVA_COMPUTE_EVACUATE_STOPPED})
+            # Starts to 2.95 any evacuated instances will be stopped at
+            # destination. Previously an active or stopped instance would have
+            # kept its state.
+            target_state = vm_states.STOPPED
+
         on_shared_storage = self._get_on_shared_storage(req, evacuate_body)
 
         if api_version_request.is_supported(req, min_version='2.29'):
@@ -120,7 +138,8 @@ def _evacuate(self, req, id, body):
 
         try:
             self.compute_api.evacuate(context, instance, host,
-                                      on_shared_storage, password, force)
+                                      on_shared_storage, password, force,
+                                      target_state)
         except exception.InstanceInvalidState as state_error:
             common.raise_http_conflict_for_instance_invalid_state(state_error,
                     'evacuate', id)
@@ -130,6 +149,8 @@ def _evacuate(self, req, id, body):
             exception.ExtendedResourceRequestOldCompute,
         ) as e:
             raise exc.HTTPBadRequest(explanation=e.format_message())
+        except exception.UnsupportedRPCVersion as e:
+            raise exc.HTTPConflict(explanation=e.format_message())
 
         if (not api_version_request.is_supported(req, min_version='2.14') and
                 CONF.api.enable_instance_password):
diff --git a/nova/api/openstack/compute/rest_api_version_history.rst b/nova/api/openstack/compute/rest_api_version_history.rst
@@ -1237,3 +1237,11 @@ The ``hostname`` parameter to the ``POST /servers`` (create server), ``PUT
 /servers/{id}`` (update server) and ``POST /servers/{server_id}/action
 (rebuild)`` (rebuild server) APIs is now allowed to be a Fully Qualified Domain
 Name (FQDN).
+
+
+2.95
+---------------------
+
+Any evacuated instances will be now stopped at destination. This
+requires minimun compute version 27.0.0 (antelope 2023.1).  Operators
+can still use previous microversion for older behavior.
diff --git a/nova/api/openstack/compute/schemas/evacuate.py b/nova/api/openstack/compute/schemas/evacuate.py
@@ -46,3 +46,7 @@
 # v2.68 removes the 'force' parameter added in v2.29, meaning it is identical
 # to v2.14
 evacuate_v2_68 = copy.deepcopy(evacuate_v214)
+
+# v2.95 keeps the same schema, evacuating an instance will now result its state
+# to be stopped at destination.
+evacuate_v2_95 = copy.deepcopy(evacuate_v2_68)
diff --git a/nova/exception.py b/nova/exception.py
@@ -2510,3 +2510,10 @@ class ReimageException(NovaException):
 
 class InvalidNodeConfiguration(NovaException):
     msg_fmt = _('Invalid node identity configuration: %(reason)s')
+
+
+class NotSupportedComputeForEvacuateV295(NotSupported):
+    msg_fmt = _("Starting to microversion 2.95, evacuate API will stop "
+                "instance on destination. To evacuate before upgrades are "
+                "complete please use an older microversion. Required version "
+                "for compute %(expected), current version %(currently)s")
diff --git a/nova/tests/functional/api_sample_tests/api_samples/os-evacuate/v2.95/server-evacuate-find-host-req.json.tpl b/nova/tests/functional/api_sample_tests/api_samples/os-evacuate/v2.95/server-evacuate-find-host-req.json.tpl
@@ -0,0 +1,5 @@
+{
+    "evacuate": {
+        "adminPass": "%(adminPass)s"
+    }
+}
diff --git a/nova/tests/functional/api_sample_tests/api_samples/os-evacuate/v2.95/server-evacuate-req.json.tpl b/nova/tests/functional/api_sample_tests/api_samples/os-evacuate/v2.95/server-evacuate-req.json.tpl
@@ -0,0 +1,5 @@
+{
+    "evacuate": {
+        "adminPass": "%(adminPass)s"
+    }
+}
diff --git a/nova/tests/functional/api_sample_tests/test_evacuate.py b/nova/tests/functional/api_sample_tests/test_evacuate.py
@@ -216,3 +216,41 @@ def test_server_evacuate(self, compute_node_get_all_by_host, rebuild_mock):
     def test_server_evacuate_with_force(self):
         # doesn't apply to v2.68+, which removed the ability to force migrate
         pass
+
+
+class EvacuateJsonTestV295(EvacuateJsonTestV268):
+    microversion = '2.95'
+    scenarios = [('v2_95', {'api_major_version': 'v2.1'})]
+
+    @mock.patch('nova.conductor.manager.ComputeTaskManager.rebuild_instance')
+    def test_server_evacuate(self, rebuild_mock):
+        req_subs = {
+            "adminPass": "MySecretPass",
+        }
+        self._test_evacuate(req_subs, 'server-evacuate-req',
+                            server_resp=None, expected_resp_code=200)
+
+        rebuild_mock.assert_called_once_with(mock.ANY, instance=mock.ANY,
+                orig_image_ref=mock.ANY, image_ref=mock.ANY,
+                injected_files=mock.ANY, new_pass="MySecretPass",
+                orig_sys_metadata=mock.ANY, bdms=mock.ANY, recreate=mock.ANY,
+                on_shared_storage=None, preserve_ephemeral=mock.ANY,
+                host=None, request_spec=mock.ANY,
+                reimage_boot_volume=False, target_state="stopped")
+
+    @mock.patch('nova.conductor.manager.ComputeTaskManager.rebuild_instance')
+    def test_server_evacuate_find_host(self, rebuild_mock):
+        req_subs = {
+            'host': 'testHost',
+            "adminPass": "MySecretPass",
+            }
+        self._test_evacuate(req_subs, 'server-evacuate-find-host-req',
+                            server_resp=None, expected_resp_code=200)
+
+        rebuild_mock.assert_called_once_with(mock.ANY, instance=mock.ANY,
+                orig_image_ref=mock.ANY, image_ref=mock.ANY,
+                injected_files=mock.ANY, new_pass="MySecretPass",
+                orig_sys_metadata=mock.ANY, bdms=mock.ANY, recreate=mock.ANY,
+                on_shared_storage=None, preserve_ephemeral=mock.ANY,
+                host=None, request_spec=mock.ANY,
+                reimage_boot_volume=False, target_state="stopped")
diff --git a/nova/tests/functional/integrated_helpers.py b/nova/tests/functional/integrated_helpers.py
@@ -598,7 +598,7 @@ def _unshelve_server(self, server, expected_state='ACTIVE'):
 
     def _evacuate_server(
             self, server, extra_post_args=None, expected_host=None,
-            expected_state='ACTIVE', expected_task_state=NOT_SPECIFIED,
+            expected_state='SHUTOFF', expected_task_state=NOT_SPECIFIED,
             expected_migration_status='done'):
         """Evacuate a server."""
         api = getattr(self, 'admin_api', self.api)
diff --git a/nova/tests/functional/notification_sample_tests/test_compute_task.py b/nova/tests/functional/notification_sample_tests/test_compute_task.py
@@ -10,6 +10,9 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
+from unittest import mock
+
+from nova import objects
 from nova.tests import fixtures
 from nova.tests.functional.notification_sample_tests \
     import notification_sample_base
@@ -53,6 +56,10 @@ def test_build_instances_fault(self):
             },
             actual=self.notifier.versioned_notifications[1])
 
+    @mock.patch.object(
+        objects.service, 'get_minimum_version_all_cells',
+        new=mock.Mock(return_value=62)
+    )
     def test_rebuild_fault(self):
         server = self._boot_a_server(
             extra_params={'networks': [{'port': self.neutron.port_1['id']}]},
diff --git a/nova/tests/functional/notification_sample_tests/test_instance.py b/nova/tests/functional/notification_sample_tests/test_instance.py
@@ -46,18 +46,18 @@ def test_multiple_compute_actions(self):
         self.compute2 = self.start_service('compute', host='host2')
 
         actions = [
-            self._test_live_migration_rollback,
-            self._test_live_migration_abort,
-            self._test_live_migration_success,
-            self._test_evacuate_server,
-            self._test_live_migration_force_complete
+            (self._test_live_migration_rollback, 'ACTIVE'),
+            (self._test_live_migration_abort, 'ACTIVE'),
+            (self._test_live_migration_success, 'ACTIVE'),
+            (self._test_evacuate_server, 'SHUTOFF'),
+            (self._test_live_migration_force_complete, 'ACTIVE'),
         ]
 
-        for action in actions:
+        for action, expected_state in actions:
             self.notifier.reset()
             action(server)
             # Ensure that instance is in active state after an action
-            self._wait_for_state_change(server, 'ACTIVE')
+            self._wait_for_state_change(server, expected_state)
 
     @mock.patch('nova.compute.manager.ComputeManager.'
                 '_live_migration_cleanup_flags', return_value=[True, False])
@@ -275,6 +275,12 @@ def _test_evacuate_server(self, server):
         self.admin_api.put_service(service_id, {'forced_down': False})
 
     def _test_live_migration_force_complete(self, server):
+        # In the scenario evacuate happened before which stopped the
+        # server.
+        self._start_server(server)
+        self._wait_for_state_change(server, 'ACTIVE')
+        self.notifier.reset()
+
         post = {
             'os-migrateLive': {
                 'host': 'host2',
diff --git a/nova/tests/functional/regressions/test_bug_1669054.py b/nova/tests/functional/regressions/test_bug_1669054.py
@@ -59,7 +59,8 @@ def test_resize_then_evacuate(self):
         # Now try to evacuate the server back to the original source compute.
         server = self._evacuate_server(
             server, {'onSharedStorage': 'False'},
-            expected_host=self.compute.host, expected_migration_status='done')
+            expected_host=self.compute.host, expected_migration_status='done',
+            expected_state='ACTIVE')
 
         # Assert the RequestSpec.ignore_hosts field is not populated.
         reqspec = objects.RequestSpec.get_by_instance_uuid(
diff --git a/nova/tests/functional/regressions/test_bug_1713783.py b/nova/tests/functional/regressions/test_bug_1713783.py
@@ -13,9 +13,11 @@
 # limitations under the License.
 
 import time
+from unittest import mock
 
 from oslo_log import log as logging
 
+from nova import objects
 from nova import test
 from nova.tests import fixtures as nova_fixtures
 from nova.tests.functional import fixtures as func_fixtures
@@ -81,6 +83,10 @@ def _boot_a_server(self):
         created_server = self.api.post_server({'server': server_req})
         return self._wait_for_state_change(created_server, 'ACTIVE')
 
+    @mock.patch.object(
+        objects.service, 'get_minimum_version_all_cells',
+        new=mock.Mock(return_value=62)
+    )
     def test_evacuate_no_valid_host(self):
         # Boot a server
         server = self._boot_a_server()
diff --git a/nova/tests/functional/regressions/test_bug_1764883.py b/nova/tests/functional/regressions/test_bug_1764883.py
@@ -95,7 +95,8 @@ def test_evacuation_with_source_compute_returning_during_rebuild(self):
 
         # Evacuate the instance from the source_host
         server = self._evacuate_server(
-            server, expected_migration_status='done')
+            server, expected_migration_status='done',
+            expected_state='ACTIVE')
         host = server['OS-EXT-SRV-ATTR:host']
         migrations = self.api.get_migrations()
 
diff --git a/nova/tests/functional/regressions/test_bug_1823370.py b/nova/tests/functional/regressions/test_bug_1823370.py
@@ -66,4 +66,5 @@ def test_evacuate_multi_cell(self):
         # higher than host3.
         self._evacuate_server(
             server, {'onSharedStorage': 'False'}, expected_host='host3',
-            expected_migration_status='done')
+            expected_migration_status='done',
+            expected_state='ACTIVE')
diff --git a/nova/tests/functional/regressions/test_bug_1896463.py b/nova/tests/functional/regressions/test_bug_1896463.py
@@ -216,7 +216,7 @@ def slow_get_mig(*args, **kwargs):
         self._run_periodics()
 
         self._wait_for_server_parameter(
-            server, {'OS-EXT-SRV-ATTR:host': 'host2', 'status': 'ACTIVE'})
+            server, {'OS-EXT-SRV-ATTR:host': 'host2', 'status': 'SHUTOFF'})
 
         self._assert_pci_device_allocated(server['id'], self.compute1_id)
         self._assert_pci_device_allocated(server['id'], self.compute2_id)
diff --git a/nova/tests/functional/regressions/test_bug_1922053.py b/nova/tests/functional/regressions/test_bug_1922053.py
@@ -1,3 +1,4 @@
+
 # Licensed under the Apache License, Version 2.0 (the "License"); you may
 # not use this file except in compliance with the License. You may obtain
 # a copy of the License at
@@ -27,6 +28,7 @@ class ForceUpWithDoneEvacuations(integrated_helpers._IntegratedTestBase):
 
     ADMIN_API = True
     microversion = 'latest'
+    expected_state = 'SHUTOFF'
 
     def _create_test_server(self, compute_host):
         return self._create_server(host=compute_host, networks='none')
@@ -59,7 +61,8 @@ def test_force_up_with_done_evacuation_records(self):
         server = self._evacuate_server(
             server,
             expected_host='compute2',
-            expected_migration_status='done'
+            expected_migration_status='done',
+            expected_state=self.expected_state
         )
 
         # Assert that the request to force up the host is rejected
@@ -97,6 +100,7 @@ class ForceUpWithDoneEvacuationsv252(ForceUpWithDoneEvacuations):
     """
 
     microversion = '2.52'
+    expected_state = 'ACTIVE'
 
     def _create_test_server(self, compute_host):
         return self._create_server(az='nova:compute', networks='none')
diff --git a/nova/tests/functional/test_server_group.py b/nova/tests/functional/test_server_group.py
diff --git a/nova/tests/functional/test_servers.py b/nova/tests/functional/test_servers.py
diff --git a/nova/tests/functional/test_servers_resource_request.py b/nova/tests/functional/test_servers_resource_request.py
diff --git a/nova/tests/unit/api/openstack/compute/test_evacuate.py b/nova/tests/unit/api/openstack/compute/test_evacuate.py
diff --git a/nova/tests/unit/policies/test_evacuate.py b/nova/tests/unit/policies/test_evacuate.py
diff --git a/releasenotes/notes/allowing-target-state-for-evacuate-d4c1912c481973d6.yaml b/releasenotes/notes/allowing-target-state-for-evacuate-d4c1912c481973d6.yaml

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +{
 +    "evacuate": {
 +        "targetState": "stopped"
 +    }
 +}
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`}`
`20`	`20`	`],`
`21`	`21`	`"status": "CURRENT",`
`22`		`- "version": "2.94",`
	`22`	`+ "version": "2.95",`
`23`	`23`	`"min_version": "2.1",`
`24`	`24`	`"updated": "2013-07-23T11:33:21Z"`
`25`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`	`}`
`23`	`23`	`],`
`24`	`24`	`"status": "CURRENT",`
`25`		`- "version": "2.94",`
	`25`	`+ "version": "2.95",`
`26`	`26`	`"min_version": "2.1",`
`27`	`27`	`"updated": "2013-07-23T11:33:21Z"`
`28`	`28`	`}`