From ca7f23d0d1876dc53ef4d5ecbf2c5f367aafe13e Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Thu, 3 Dec 2020 12:41:25 +0000 Subject: [PATCH] compute: Add 'server volume update' command We're not going to expose the ability to swap volumes since that's a things humans should not generally use. From the API docs [1]: When updating volumeId, this API is typically meant to only be used as part of a larger orchestrated volume migration operation initiated in the block storage service via the os-retype or os-migrate_volume volume actions. Direct usage of this API to update volumeId is not recommended and may result in needing to hard reboot the server to update details within the guest such as block storage serial IDs. Furthermore, updating volumeId via this API is only implemented by certain compute drivers. We *do* want users to have the ability to change the delete on termination behavior though, so that's what we expose. [1] https://docs.openstack.org/api-ref/compute/?expanded=update-a-volume-attachment-detail#update-a-volume-attachment Change-Id: I50938e1237b4d298521b26a5f9cb90c018dfebaf Signed-off-by: Stephen Finucane --- lower-constraints.txt | 2 +- openstackclient/compute/v2/server.py | 16 +-- openstackclient/compute/v2/server_volume.py | 67 ++++++++++ .../unit/compute/v2/test_server_volume.py | 120 ++++++++++++++++++ ...server-volume-update-89740dca61596dd1.yaml | 3 + requirements.txt | 2 +- setup.cfg | 1 + 7 files changed, 201 insertions(+), 10 deletions(-) diff --git a/lower-constraints.txt b/lower-constraints.txt index 287f7d459..25f71e45a 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -71,7 +71,7 @@ python-cinderclient==3.3.0 python-dateutil==2.5.3 python-keystoneclient==3.22.0 python-mimeparse==1.6.0 -python-novaclient==15.1.0 +python-novaclient==17.0.0 python-subunit==1.0.0 pytz==2013.6 PyYAML==3.13 diff --git a/openstackclient/compute/v2/server.py b/openstackclient/compute/v2/server.py index 50299d65d..fa27f68c8 100644 --- a/openstackclient/compute/v2/server.py +++ b/openstackclient/compute/v2/server.py @@ -513,27 +513,27 @@ class AddServerVolume(command.Command): '--tag', metavar='', help=_( - "Tag for the attached volume. " - "(Supported by API versions '2.49' - '2.latest')" + 'Tag for the attached volume ' + '(supported by --os-compute-api-version 2.49 or above)' ), ) + # TODO(stephenfin): These should be called 'delete-on-termination' and + # 'preserve-on-termination' termination_group = parser.add_mutually_exclusive_group() termination_group.add_argument( '--enable-delete-on-termination', action='store_true', help=_( - "Specify if the attached volume should be deleted when the " - "server is destroyed. " - "(Supported by API versions '2.79' - '2.latest')" + 'Delete the volume when the server is destroyed ' + '(supported by --os-compute-api-version 2.79 or above)' ), ) termination_group.add_argument( '--disable-delete-on-termination', action='store_true', help=_( - "Specify if the attached volume should not be deleted when " - "the server is destroyed. " - "(Supported by API versions '2.79' - '2.latest')" + 'Do not delete the volume when the server is destroyed ' + '(supported by --os-compute-api-version 2.79 or above)' ), ) return parser diff --git a/openstackclient/compute/v2/server_volume.py b/openstackclient/compute/v2/server_volume.py index 8a931ae5a..b53c92fe5 100644 --- a/openstackclient/compute/v2/server_volume.py +++ b/openstackclient/compute/v2/server_volume.py @@ -16,6 +16,7 @@ from novaclient import api_versions from osc_lib.command import command +from osc_lib import exceptions from osc_lib import utils from openstackclient.i18n import _ @@ -71,3 +72,69 @@ class ListServerVolume(command.Lister): ) for s in volumes ), ) + + +class UpdateServerVolume(command.Command): + """Update a volume attachment on the server.""" + + def get_parser(self, prog_name): + parser = super(UpdateServerVolume, self).get_parser(prog_name) + parser.add_argument( + 'server', + help=_('Server to update volume for (name or ID)'), + ) + parser.add_argument( + 'volume', + help=_('Volume (ID)'), + ) + termination_group = parser.add_mutually_exclusive_group() + termination_group.add_argument( + '--delete-on-termination', + action='store_true', + dest='delete_on_termination', + default=None, + help=_( + 'Delete the volume when the server is destroyed ' + '(supported by --os-compute-api-version 2.85 or above)' + ), + ) + termination_group.add_argument( + '--preserve-on-termination', + action='store_false', + dest='delete_on_termination', + help=_( + 'Preserve the volume when the server is destroyed ' + '(supported by --os-compute-api-version 2.85 or above)' + ), + ) + return parser + + def take_action(self, parsed_args): + + compute_client = self.app.client_manager.compute + + if parsed_args.delete_on_termination is not None: + if compute_client.api_version < api_versions.APIVersion('2.85'): + msg = _( + '--os-compute-api-version 2.85 or greater is required to ' + 'support the --(no-)delete-on-termination option' + ) + raise exceptions.CommandError(msg) + + server = utils.find_resource( + compute_client.servers, + parsed_args.server, + ) + + # NOTE(stephenfin): This may look silly, and that's because it is. + # This API was originally used only for the swapping volumes, which + # is an internal operation that should only be done by + # orchestration software rather than a human. We're not going to + # expose that, but we are going to expose the ability to change the + # delete on termination behavior. + compute_client.volumes.update_server_volume( + server.id, + parsed_args.volume, + parsed_args.volume, + delete_on_termination=parsed_args.delete_on_termination, + ) diff --git a/openstackclient/tests/unit/compute/v2/test_server_volume.py b/openstackclient/tests/unit/compute/v2/test_server_volume.py index d09c28745..4d4916b7e 100644 --- a/openstackclient/tests/unit/compute/v2/test_server_volume.py +++ b/openstackclient/tests/unit/compute/v2/test_server_volume.py @@ -12,6 +12,7 @@ # from novaclient import api_versions +from osc_lib import exceptions from openstackclient.compute.v2 import server_volume from openstackclient.tests.unit.compute.v2 import fakes as compute_fakes @@ -165,3 +166,122 @@ class TestServerVolumeList(TestServerVolume): ) self.servers_volumes_mock.get_server_volumes.assert_called_once_with( self.server.id) + + +class TestServerVolumeUpdate(TestServerVolume): + + def setUp(self): + super().setUp() + + self.server = compute_fakes.FakeServer.create_one_server() + self.servers_mock.get.return_value = self.server + + # Get the command object to test + self.cmd = server_volume.UpdateServerVolume(self.app, None) + + def test_server_volume_update(self): + + arglist = [ + self.server.id, + 'foo', + ] + verifylist = [ + ('server', self.server.id), + ('volume', 'foo'), + ('delete_on_termination', None), + ] + parsed_args = self.check_parser(self.cmd, arglist, verifylist) + + result = self.cmd.take_action(parsed_args) + + # This is a no-op + self.servers_volumes_mock.update_server_volume.assert_not_called() + self.assertIsNone(result) + + def test_server_volume_update_with_delete_on_termination(self): + self.app.client_manager.compute.api_version = \ + api_versions.APIVersion('2.85') + + arglist = [ + self.server.id, + 'foo', + '--delete-on-termination', + ] + verifylist = [ + ('server', self.server.id), + ('volume', 'foo'), + ('delete_on_termination', True), + ] + parsed_args = self.check_parser(self.cmd, arglist, verifylist) + + result = self.cmd.take_action(parsed_args) + + self.servers_volumes_mock.update_server_volume.assert_called_once_with( + self.server.id, 'foo', 'foo', + delete_on_termination=True) + self.assertIsNone(result) + + def test_server_volume_update_with_preserve_on_termination(self): + self.app.client_manager.compute.api_version = \ + api_versions.APIVersion('2.85') + + arglist = [ + self.server.id, + 'foo', + '--preserve-on-termination', + ] + verifylist = [ + ('server', self.server.id), + ('volume', 'foo'), + ('delete_on_termination', False), + ] + parsed_args = self.check_parser(self.cmd, arglist, verifylist) + + result = self.cmd.take_action(parsed_args) + + self.servers_volumes_mock.update_server_volume.assert_called_once_with( + self.server.id, 'foo', 'foo', + delete_on_termination=False) + self.assertIsNone(result) + + def test_server_volume_update_with_delete_on_termination_pre_v285(self): + self.app.client_manager.compute.api_version = \ + api_versions.APIVersion('2.84') + + arglist = [ + self.server.id, + 'foo', + '--delete-on-termination', + ] + verifylist = [ + ('server', self.server.id), + ('volume', 'foo'), + ('delete_on_termination', True), + ] + parsed_args = self.check_parser(self.cmd, arglist, verifylist) + + self.assertRaises( + exceptions.CommandError, + self.cmd.take_action, + parsed_args) + + def test_server_volume_update_with_preserve_on_termination_pre_v285(self): + self.app.client_manager.compute.api_version = \ + api_versions.APIVersion('2.84') + + arglist = [ + self.server.id, + 'foo', + '--preserve-on-termination', + ] + verifylist = [ + ('server', self.server.id), + ('volume', 'foo'), + ('delete_on_termination', False), + ] + parsed_args = self.check_parser(self.cmd, arglist, verifylist) + + self.assertRaises( + exceptions.CommandError, + self.cmd.take_action, + parsed_args) diff --git a/releasenotes/notes/add-server-volume-update-89740dca61596dd1.yaml b/releasenotes/notes/add-server-volume-update-89740dca61596dd1.yaml index d1c0501ff..b8a3de1a4 100644 --- a/releasenotes/notes/add-server-volume-update-89740dca61596dd1.yaml +++ b/releasenotes/notes/add-server-volume-update-89740dca61596dd1.yaml @@ -3,3 +3,6 @@ features: - | Add ``server volume list`` command, to list the volumes attached to an instance. + - | + Add ``server volume update`` command, to update the volumes attached to + an instance. diff --git a/requirements.txt b/requirements.txt index ed55ce379..21e291013 100644 --- a/requirements.txt +++ b/requirements.txt @@ -9,6 +9,6 @@ openstacksdk>=0.52.0 # Apache-2.0 osc-lib>=2.3.0 # Apache-2.0 oslo.i18n>=3.15.3 # Apache-2.0 python-keystoneclient>=3.22.0 # Apache-2.0 -python-novaclient>=15.1.0 # Apache-2.0 +python-novaclient>=17.0.0 # Apache-2.0 python-cinderclient>=3.3.0 # Apache-2.0 stevedore>=2.0.1 # Apache-2.0 diff --git a/setup.cfg b/setup.cfg index 3fe7fa38f..ef6db5787 100644 --- a/setup.cfg +++ b/setup.cfg @@ -154,6 +154,7 @@ openstack.compute.v2 = server_image_create = openstackclient.compute.v2.server_image:CreateServerImage server_volume_list = openstackclient.compute.v2.server_volume:ListServerVolume + server_volume_update = openstackclient.compute.v2.server_volume:UpdateServerVolume usage_list = openstackclient.compute.v2.usage:ListUsage usage_show = openstackclient.compute.v2.usage:ShowUsage