1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
# Copyright 2011 Denali Systems, Inc.
# All Rights Reserved.
#
# 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
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
"""
Volume interface
"""
import warnings
from novaclient import api_versions
from novaclient import base
class Volume(base.Resource):
"""
A volume is an extra block level storage to the OpenStack
instances.
"""
NAME_ATTR = 'display_name'
def __repr__(self):
return "<Volume: %s>" % self.id
class VolumeManager(base.Manager):
"""
Manage :class:`Volume` resources. This is really about volume attachments.
"""
resource_class = Volume
@api_versions.wraps("2.0", "2.48")
def create_server_volume(self, server_id, volume_id, device=None):
"""
Attach a volume identified by the volume ID to the given server ID
:param server_id: The ID of the server
:param volume_id: The ID of the volume to attach.
:param device: The device name (optional)
:rtype: :class:`Volume`
"""
body = {'volumeAttachment': {'volumeId': volume_id}}
if device is not None:
body['volumeAttachment']['device'] = device
return self._create("/servers/%s/os-volume_attachments" % server_id,
body, "volumeAttachment")
@api_versions.wraps("2.49", "2.78")
def create_server_volume(self, server_id, volume_id, device=None,
tag=None):
"""
Attach a volume identified by the volume ID to the given server ID
:param server_id: The ID of the server
:param volume_id: The ID of the volume to attach.
:param device: The device name (optional)
:param tag: The tag (optional)
:rtype: :class:`Volume`
"""
body = {'volumeAttachment': {'volumeId': volume_id}}
if device is not None:
body['volumeAttachment']['device'] = device
if tag is not None:
body['volumeAttachment']['tag'] = tag
return self._create("/servers/%s/os-volume_attachments" % server_id,
body, "volumeAttachment")
@api_versions.wraps("2.79")
def create_server_volume(self, server_id, volume_id, device=None,
tag=None, delete_on_termination=False):
"""
Attach a volume identified by the volume ID to the given server ID
:param server_id: The ID of the server.
:param volume_id: The ID of the volume to attach.
:param device: The device name (optional).
:param tag: The tag (optional).
:param delete_on_termination: Marked whether to delete the attached
volume when the server is deleted
(optional).
:rtype: :class:`Volume`
"""
# TODO(mriedem): Move this body construction into a private common
# helper method for all versions of create_server_volume to use.
body = {'volumeAttachment': {'volumeId': volume_id}}
if device is not None:
body['volumeAttachment']['device'] = device
if tag is not None:
body['volumeAttachment']['tag'] = tag
if delete_on_termination:
body['volumeAttachment']['delete_on_termination'] = (
delete_on_termination)
return self._create("/servers/%s/os-volume_attachments" % server_id,
body, "volumeAttachment")
@api_versions.wraps("2.0", "2.84")
def update_server_volume(self, server_id, src_volid, dest_volid):
"""
Swaps the existing volume attachment to point to a new volume.
Takes a server, a source (attached) volume and a destination volume and
performs a hypervisor assisted data migration from src to dest volume,
detaches the original (source) volume and attaches the new destination
volume. Note that not all backing hypervisor drivers support this
operation and it may be disabled via policy.
:param server_id: The ID of the server
:param source_volume: The ID of the src volume
:param dest_volume: The ID of the destination volume
:rtype: :class:`Volume`
"""
body = {'volumeAttachment': {'volumeId': dest_volid}}
return self._update("/servers/%s/os-volume_attachments/%s" %
(server_id, src_volid,),
body, "volumeAttachment")
@api_versions.wraps("2.85")
def update_server_volume(self, server_id, src_volid, dest_volid,
delete_on_termination=None):
"""
Swaps the existing volume attachment to point to a new volume.
Takes a server, a source (attached) volume and a destination volume and
performs a hypervisor assisted data migration from src to dest volume,
detaches the original (source) volume and attaches the new destination
volume. Note that not all backing hypervisor drivers support this
operation and it may be disabled via policy.
:param server_id: The ID of the server
:param source_volume: The ID of the src volume
:param dest_volume: The ID of the destination volume
:param delete_on_termination: Marked whether to delete the attached
volume when the server is deleted
(optional).
:rtype: :class:`Volume`
"""
body = {'volumeAttachment': {'volumeId': dest_volid}}
if delete_on_termination is not None:
body['volumeAttachment']['delete_on_termination'] = (
delete_on_termination)
return self._update("/servers/%s/os-volume_attachments/%s" %
(server_id, src_volid),
body, "volumeAttachment")
def get_server_volume(self, server_id, volume_id=None, attachment_id=None):
"""
Get the volume identified by the volume ID, that is attached to
the given server ID
:param server_id: The ID of the server
:param volume_id: The ID of the volume to attach
:rtype: :class:`Volume`
"""
if attachment_id is not None and volume_id is not None:
raise TypeError("You cannot specify both volume_id "
"and attachment_id arguments.")
elif attachment_id is not None:
warnings.warn("attachment_id argument "
"of volumes.get_server_volume "
"method is deprecated in favor "
"of volume_id.")
volume_id = attachment_id
if volume_id is None:
raise TypeError("volume_id is required argument.")
return self._get("/servers/%s/os-volume_attachments/%s" % (server_id,
volume_id,), "volumeAttachment")
def get_server_volumes(self, server_id):
"""
Get a list of all the attached volumes for the given server ID
:param server_id: The ID of the server
:rtype: list of :class:`Volume`
"""
return self._list("/servers/%s/os-volume_attachments" % server_id,
"volumeAttachments")
def delete_server_volume(self, server_id, volume_id=None,
attachment_id=None):
"""
Detach a volume identified by the volume ID from the given server
:param server_id: The ID of the server
:param volume_id: The ID of the volume to attach
:returns: An instance of novaclient.base.TupleWithMeta
"""
if attachment_id is not None and volume_id is not None:
raise TypeError("You cannot specify both volume_id "
"and attachment_id arguments.")
elif attachment_id is not None:
warnings.warn("attachment_id argument "
"of volumes.delete_server_volume "
"method is deprecated in favor "
"of volume_id.")
volume_id = attachment_id
if volume_id is None:
raise TypeError("volume_id is required argument.")
return self._delete("/servers/%s/os-volume_attachments/%s" %
(server_id, volume_id,))
|
