summaryrefslogtreecommitdiff
path: root/novaclient/v2/volumes.py
blob: f0403af631e4913e418676458bb613640bed58da (plain)
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
# 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 (1.1 extension).
"""

import warnings

import six
from six.moves.urllib import parse

from novaclient import base


class Volume(base.Resource):
    """
    DEPRECATED: A volume is an extra block level storage to the OpenStack
    instances.
    """
    NAME_ATTR = 'display_name'

    def __repr__(self):
        return "<Volume: %s>" % self.id

    def delete(self):
        """
        DEPRECATED: Delete this volume.
        """
        self.manager.delete(self)


class VolumeManager(base.ManagerWithFind):
    """
    DEPRECATED: Manage :class:`Volume` resources.
    """
    resource_class = Volume

    def create(self, size, snapshot_id=None, display_name=None,
               display_description=None, volume_type=None,
               availability_zone=None, imageRef=None):
        """
        DEPRECATED: Create a volume.

        :param size: Size of volume in GB
        :param snapshot_id: ID of the snapshot
        :param display_name: Name of the volume
        :param display_description: Description of the volume
        :param volume_type: Type of volume
        :param availability_zone: Availability Zone for volume
        :rtype: :class:`Volume`
        :param imageRef: reference to an image stored in glance
        """
        warnings.warn('The novaclient.v2.volumes.VolumeManager.create() '
                      'method is deprecated and will be removed after Nova '
                      '13.0.0 is released. Use python-cinderclient or '
                      'python-openstacksdk instead.', DeprecationWarning)
        # NOTE(melwitt): Ensure we use the volume endpoint for this call
        with self.alternate_service_type('volume'):
            body = {'volume': {'size': size,
                               'snapshot_id': snapshot_id,
                               'display_name': display_name,
                               'display_description': display_description,
                               'volume_type': volume_type,
                               'availability_zone': availability_zone,
                               'imageRef': imageRef}}
            return self._create('/volumes', body, 'volume')

    def get(self, volume_id):
        """
        DEPRECATED: Get a volume.

        :param volume_id: The ID of the volume to get.
        :rtype: :class:`Volume`
        """
        warnings.warn('The novaclient.v2.volumes.VolumeManager.get() '
                      'method is deprecated and will be removed after Nova '
                      '13.0.0 is released. Use python-cinderclient or '
                      'python-openstacksdk instead.', DeprecationWarning)
        with self.alternate_service_type('volume'):
            return self._get("/volumes/%s" % volume_id, "volume")

    def list(self, detailed=True, search_opts=None):
        """
        DEPRECATED: Get a list of all volumes.

        :rtype: list of :class:`Volume`
        """
        warnings.warn('The novaclient.v2.volumes.VolumeManager.list() '
                      'method is deprecated and will be removed after Nova '
                      '13.0.0 is released. Use python-cinderclient or '
                      'python-openstacksdk instead.', DeprecationWarning)
        with self.alternate_service_type('volume'):
            search_opts = search_opts or {}

            if 'name' in search_opts.keys():
                search_opts['display_name'] = search_opts.pop('name')

            qparams = dict((k, v) for (k, v) in
                           six.iteritems(search_opts) if v)

            query_str = '?%s' % parse.urlencode(qparams) if qparams else ''

            if detailed is True:
                return self._list("/volumes/detail%s" % query_str, "volumes")
            else:
                return self._list("/volumes%s" % query_str, "volumes")

    def delete(self, volume):
        """
        DEPRECATED: Delete a volume.

        :param volume: The :class:`Volume` to delete.
        """
        warnings.warn('The novaclient.v2.volumes.VolumeManager.delete() '
                      'method is deprecated and will be removed after Nova '
                      '13.0.0 is released. Use python-cinderclient or '
                      'python-openstacksdk instead.', DeprecationWarning)
        with self.alternate_service_type('volume'):
            self._delete("/volumes/%s" % base.getid(volume))

    def create_server_volume(self, server_id, volume_id, device):
        """
        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
        :rtype: :class:`Volume`
        """
        body = {'volumeAttachment': {'volumeId': volume_id,
                                     'device': device}}
        return self._create("/servers/%s/os-volume_attachments" % server_id,
                            body, "volumeAttachment")

    def update_server_volume(self, server_id, attachment_id, new_volume_id):
        """
        Update the volume identified by the attachment ID, that is attached to
        the given server ID

        :param server_id: The ID of the server
        :param attachment_id: The ID of the attachment
        :param new_volume_id: The ID of the new volume to attach
        :rtype: :class:`Volume`
        """
        body = {'volumeAttachment': {'volumeId': new_volume_id}}
        return self._update("/servers/%s/os-volume_attachments/%s" %
                            (server_id, attachment_id,),
                            body, "volumeAttachment")

    def get_server_volume(self, server_id, attachment_id):
        """
        Get the volume identified by the attachment ID, that is attached to
        the given server ID

        :param server_id: The ID of the server
        :param attachment_id: The ID of the attachment
        :rtype: :class:`Volume`
        """
        return self._get("/servers/%s/os-volume_attachments/%s" % (server_id,
                         attachment_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, attachment_id):
        """
        Detach a volume identified by the attachment ID from the given server

        :param server_id: The ID of the server
        :param attachment_id: The ID of the attachment
        """
        self._delete("/servers/%s/os-volume_attachments/%s" %
                     (server_id, attachment_id,))