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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
|
# Copyright(c) 2018 Nippon Telegraph and Telephone Corporation
#
# 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.
import typing as ty
from openstack import exceptions
from openstack.instance_ha.v1 import host as _host
from openstack.instance_ha.v1 import notification as _notification
from openstack.instance_ha.v1 import segment as _segment
from openstack.instance_ha.v1 import vmove as _vmove
from openstack import proxy
from openstack import resource
class Proxy(proxy.Proxy):
"""Proxy class for ha resource handling.
Create method for each action of each API.
"""
_resource_registry = {
"host": _host.Host,
"notification": _notification.Notification,
"segment": _segment.Segment,
"vmove": _vmove.VMove,
}
def notifications(self, **query):
"""Return a generator of notifications.
:param kwargs query: Optional query parameters to be sent to
limit the notifications being returned.
:returns: A generator of notifications
"""
return self._list(_notification.Notification, **query)
def get_notification(self, notification):
"""Get a single notification.
:param notification: The value can be the ID of a notification or a
:class:`~masakariclient.sdk.ha.v1.notification.Notification`
instance.
:returns: One
:class:`~masakariclient.sdk.ha.v1.notification.Notification`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_notification.Notification, notification)
def create_notification(self, **attrs):
"""Create a new notification.
:param dict attrs: Keyword arguments which will be used to create
a :class:`masakariclient.sdk.ha.v1.notification.Notification`,
comprised of the propoerties on the Notification class.
:returns: The result of notification creation
:rtype: :class:`masakariclient.sdk.ha.v1.notification.Notification`
"""
return self._create(_notification.Notification, **attrs)
def segments(self, **query):
"""Return a generator of segments.
:param kwargs query: Optional query parameters to be sent to
limit the segments being returned.
:returns: A generator of segments
"""
return self._list(_segment.Segment, **query)
def get_segment(self, segment):
"""Get a single segment.
:param segment: The value can be the ID of a segment or a
:class:`~masakariclient.sdk.ha.v1.segment.Segment` instance.
:returns: One :class:`~masakariclient.sdk.ha.v1.segment.Segment`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
"""
return self._get(_segment.Segment, segment)
def create_segment(self, **attrs):
"""Create a new segment.
:param dict attrs: Keyword arguments which will be used to create
a :class:`masakariclient.sdk.ha.v1.segment.Segment`,
comprised of the propoerties on the Segment class.
:returns: The result of segment creation
:rtype: :class:`masakariclient.sdk.ha.v1.segment.Segment`
"""
return self._create(_segment.Segment, **attrs)
def update_segment(self, segment, **attrs):
"""Update a segment.
:param segment: The value can be the ID of a segment or a
:class:`~masakariclient.sdk.ha.v1.segment.Segment` instance.
:param dict attrs: Keyword arguments which will be used to update
a :class:`masakariclient.sdk.ha.v1.segment.Segment`,
comprised of the propoerties on the Segment class.
:returns: The updated segment.
:rtype: :class:`masakariclient.sdk.ha.v1.segment.Segment`
"""
return self._update(_segment.Segment, segment, **attrs)
def delete_segment(self, segment, ignore_missing=True):
"""Delete a segment.
:param segment:
The value can be either the ID of a segment or a
:class:`~masakariclient.sdk.ha.v1.segment.Segment` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the segment does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent segment.
:returns: ``None``
"""
return self._delete(
_segment.Segment, segment, ignore_missing=ignore_missing
)
def hosts(self, segment_id, **query):
"""Return a generator of hosts.
:param segment_id: The ID of a failover segment.
:param kwargs query: Optional query parameters to be sent to
limit the hosts being returned.
:returns: A generator of hosts
"""
return self._list(_host.Host, segment_id=segment_id, **query)
def create_host(self, segment_id, **attrs):
"""Create a new host.
:param segment_id: The ID of a failover segment.
:param dict attrs: Keyword arguments which will be used to create
a :class:`masakariclient.sdk.ha.v1.host.Host`,
comprised of the propoerties on the Host class.
:returns: The results of host creation
"""
return self._create(_host.Host, segment_id=segment_id, **attrs)
def get_host(self, host, segment_id=None):
"""Get a single host.
:param segment_id: The ID of a failover segment.
:param host: The value can be the ID of a host or a :class:
`~masakariclient.sdk.ha.v1.host.Host` instance.
:returns: One :class:`~masakariclient.sdk.ha.v1.host.Host`
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
:raises: :class:`~openstack.exceptions.InvalidRequest`
when segment_id is None.
"""
if segment_id is None:
raise exceptions.InvalidRequest("'segment_id' must be specified.")
host_id = resource.Resource._get_id(host)
return self._get(_host.Host, host_id, segment_id=segment_id)
def update_host(self, host, segment_id, **attrs):
"""Update the host.
:param segment_id: The ID of a failover segment.
:param host: The value can be the ID of a host or a :class:
`~masakariclient.sdk.ha.v1.host.Host` instance.
:param dict attrs: The attributes to update on the host represented.
:returns: The updated host
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
:raises: :class:`~openstack.exceptions.InvalidRequest`
when segment_id is None.
"""
host_id = resource.Resource._get_id(host)
return self._update(
_host.Host, host_id, segment_id=segment_id, **attrs
)
def delete_host(self, host, segment_id=None, ignore_missing=True):
"""Delete the host.
:param segment_id: The ID of a failover segment.
:param host: The value can be the ID of a host or a :class:
`~masakariclient.sdk.ha.v1.host.Host` instance.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.NotFoundException` will be
raised when the host does not exist.
When set to ``True``, no exception will be set when
attempting to delete a nonexistent host.
:returns: ``None``
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
:raises: :class:`~openstack.exceptions.InvalidRequest`
when segment_id is None.
"""
if segment_id is None:
raise exceptions.InvalidRequest("'segment_id' must be specified.")
host_id = resource.Resource._get_id(host)
return self._delete(
_host.Host,
host_id,
segment_id=segment_id,
ignore_missing=ignore_missing,
)
def vmoves(self, notification, **query):
"""Return a generator of vmoves.
:param notification: The value can be the UUID of a notification or
a :class: `~masakariclient.sdk.ha.v1.notification.Notification`
instance.
:param kwargs query: Optional query parameters to be sent to
limit the vmoves being returned.
:returns: A generator of vmoves
"""
notification_id = resource.Resource._get_id(notification)
return self._list(
_vmove.VMove,
notification_id=notification_id,
**query,
)
def get_vmove(self, vmove, notification):
"""Get a single vmove.
:param vmove: The value can be the UUID of one vmove or
a :class: `~masakariclient.sdk.ha.v1.vmove.VMove` instance.
:param notification: The value can be the UUID of a notification or
a :class: `~masakariclient.sdk.ha.v1.notification.Notification`
instance.
:returns: one 'VMove' resource class.
:raises: :class:`~openstack.exceptions.NotFoundException`
when no resource can be found.
:raises: :class:`~openstack.exceptions.InvalidRequest`
when notification_id is None.
"""
notification_id = resource.Resource._get_id(notification)
vmove_id = resource.Resource._get_id(vmove)
return self._get(
_vmove.VMove,
vmove_id,
notification_id=notification_id,
)
# ========== Utilities ==========
def wait_for_status(
self,
res: resource.ResourceT,
status: str,
failures: ty.Optional[list[str]] = None,
interval: ty.Union[int, float, None] = 2,
wait: ty.Optional[int] = None,
attribute: str = 'status',
callback: ty.Optional[ty.Callable[[int], None]] = None,
) -> resource.ResourceT:
"""Wait for the resource to be in a particular status.
:param session: The session to use for making this request.
:param resource: The resource to wait on to reach the status. The
resource must have a status attribute specified via ``attribute``.
:param status: Desired status of the resource.
:param failures: Statuses that would indicate the transition
failed such as 'ERROR'. Defaults to ['ERROR'].
:param interval: Number of seconds to wait between checks.
:param wait: Maximum number of seconds to wait for transition.
Set to ``None`` to wait forever.
:param attribute: Name of the resource attribute that contains the
status.
:param callback: A callback function. This will be called with a single
value, progress. This is API specific but is generally a percentage
value from 0-100.
:return: The updated resource.
:raises: :class:`~openstack.exceptions.ResourceTimeout` if the
transition to status failed to occur in ``wait`` seconds.
:raises: :class:`~openstack.exceptions.ResourceFailure` if the resource
transitioned to one of the states in ``failures``.
:raises: :class:`~AttributeError` if the resource does not have a
``status`` attribute
"""
return resource.wait_for_status(
self, res, status, failures, interval, wait, attribute, callback
)
def wait_for_delete(
self,
res: resource.ResourceT,
interval: int = 2,
wait: int = 120,
callback: ty.Optional[ty.Callable[[int], None]] = None,
) -> resource.ResourceT:
"""Wait for a resource to be deleted.
:param res: The resource to wait on to be deleted.
:param interval: Number of seconds to wait before to consecutive
checks.
:param wait: Maximum number of seconds to wait before the change.
:param callback: A callback function. This will be called with a single
value, progress, which is a percentage value from 0-100.
:returns: The resource is returned on success.
:raises: :class:`~openstack.exceptions.ResourceTimeout` if transition
to delete failed to occur in the specified seconds.
"""
return resource.wait_for_delete(self, res, interval, wait, callback)
|
