From effe719e8f715ffadcab1d8e91b04e22a8881dc2 Mon Sep 17 00:00:00 2001 From: Sean McGinnis Date: Wed, 4 Dec 2019 09:21:15 -0600 Subject: [PATCH] Elaborate on terminate_connection documentation We have had issues with drivers not handling terminate_connection correctly when the connector argument is None. In these cases, the driver is expected to terminate all connections to the volume. This adds additional information to the volume driver interface docstring to try to better point out this expectation. Change-Id: Ibbf481da981428cd921fb9cb6bec6af8f6f330b3 Signed-off-by: Sean McGinnis --- cinder/interface/volume_driver.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/cinder/interface/volume_driver.py b/cinder/interface/volume_driver.py index 2d31676ee47..028b8dd4353 100644 --- a/cinder/interface/volume_driver.py +++ b/cinder/interface/volume_driver.py @@ -207,6 +207,9 @@ class VolumeDriverCore(base.CinderInterface): def terminate_connection(self, volume, connector): """Remove access to a volume. + Note: If ``connector`` is ``None``, then all connections to the volume + should be terminated. + :param volume: The volume to remove. :param connector: The Dictionary containing information about the connection. This is optional when doing a