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 <sean.mcginnis@gmail.com>
This commit is contained in:
parent
efe8df508e
commit
effe719e8f
@ -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
|
||||
|
Loading…
Reference in New Issue
Block a user