Merge "Deprecate multiattach flag on volume create"

Zuul · openstack-gerrit · commit 36a2f4b4ebe8 · 2018-01-03T18:07:43.000Z
diff --git a/cinderclient/v2/volumes.py b/cinderclient/v2/volumes.py
@@ -15,6 +15,8 @@
 
 """Volume interface (v2 extension)."""
 
+import warnings
+
 from cinderclient.apiclient import base as common_base
 from cinderclient import base
 
@@ -259,14 +261,21 @@ def create(self, size, consistencygroup_id=None,
         :param scheduler_hints: (optional extension) arbitrary key-value pairs
                             specified by the client to help boot an instance
         :param multiattach: Allow the volume to be attached to more than
-                            one instance
+                            one instance (deprecated)
         :rtype: :class:`Volume`
         """
         if metadata is None:
             volume_metadata = {}
         else:
             volume_metadata = metadata
 
+        if multiattach:
+            warnings.warn('The ``multiattach`` volume create flag is '
+                          'deprecated and will be removed in a future '
+                          'release. Multiattach capability is now controlled '
+                          'using volume type extra specs.',
+                          DeprecationWarning)
+
         body = {'volume': {'size': size,
                            'consistencygroup_id': consistencygroup_id,
                            'snapshot_id': snapshot_id,
diff --git a/cinderclient/v3/volumes.py b/cinderclient/v3/volumes.py
@@ -14,6 +14,8 @@
 #    under the License.
 
 """Volume interface (v3 extension)."""
+import warnings
+
 from cinderclient import api_versions
 from cinderclient.apiclient import base as common_base
 from cinderclient import base
@@ -95,7 +97,7 @@ def create(self, size, consistencygroup_id=None,
         :param scheduler_hints: (optional extension) arbitrary key-value pairs
                             specified by the client to help boot an instance
         :param multiattach: Allow the volume to be attached to more than
-                            one instance
+                            one instance (deprecated)
         :param backup_id: ID of the backup
         :rtype: :class:`Volume`
         """
@@ -104,6 +106,13 @@ def create(self, size, consistencygroup_id=None,
         else:
             volume_metadata = metadata
 
+        if multiattach:
+            warnings.warn('The ``multiattach`` volume create flag is '
+                          'deprecated and will be removed in a future '
+                          'release. Multiattach capability is now controlled '
+                          'using volume type extra specs.',
+                          DeprecationWarning)
+
         body = {'volume': {'size': size,
                            'consistencygroup_id': consistencygroup_id,
                            'snapshot_id': snapshot_id,
diff --git a/releasenotes/notes/deprecate-allow-multiattach-2213a100c65a95c1.yaml b/releasenotes/notes/deprecate-allow-multiattach-2213a100c65a95c1.yaml
@@ -0,0 +1,5 @@
+---
+deprecations:
+  - |
+    The ``--allow-multiattach`` flag on volume creation has now been marked
+    deprecated and will be removed in a future release.
