forked from linode/linode_api4-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathlinode.py
More file actions
507 lines (407 loc) · 17.9 KB
/
Copy pathlinode.py
File metadata and controls
507 lines (407 loc) · 17.9 KB
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
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
from __future__ import absolute_import
import string
import sys
from datetime import datetime
from os import urandom
from random import choice, randint
from linode.common import load_and_validate_keys
from linode.errors import UnexpectedResponseError
from linode.objects import Base, Image, Property, Region
from linode.objects.base import MappedObject
from linode.objects.networking import IPAddress, IPv6Pool
from linode.paginated_list import PaginatedList
from .backup import Backup
from .config import Config
from .disk import Disk
from .linode_type import Type
PASSWORD_CHARS = string.ascii_letters + string.digits + string.punctuation
class Linode(Base):
api_endpoint = '/linode/instances/{id}'
properties = {
'id': Property(identifier=True, filterable=True),
'label': Property(mutable=True, filterable=True),
'group': Property(mutable=True, filterable=True),
'status': Property(volatile=True),
'created': Property(is_datetime=True),
'updated': Property(volatile=True, is_datetime=True),
'region': Property(slug_relationship=Region, filterable=True),
'alerts': Property(),
'image': Property(slug_relationship=Image, filterable=True),
'disks': Property(derived_class=Disk),
'configs': Property(derived_class=Config),
'type': Property(slug_relationship=Type),
'backups': Property(),
'ipv4': Property(),
'ipv6': Property(),
'hypervisor': Property(),
'specs': Property(),
}
@property
def ips(self):
"""
The ips related collection is not normalized like the others, so we have to
make an ad-hoc object to return for its response
"""
if not hasattr(self, '_ips'):
result = self._client.get("{}/ips".format(Linode.api_endpoint), model=self)
if not "ipv4" in result:
raise UnexpectedResponseError('Unexpected response loading IPs', json=result)
v4pub = []
for c in result['ipv4']['public']:
i = IPAddress(self._client, c['address'], c)
v4pub.append(i)
v4pri = []
for c in result['ipv4']['private']:
i = IPAddress(self._client, c['address'], c)
v4pri.append(i)
shared_ips = []
for c in result['ipv4']['shared']:
i = IPAddress(self._client, c['address'], c)
shared_ips.append(i)
slaac = IPAddress(self._client, result['ipv6']['slaac']['address'],
result['ipv6']['slaac'])
link_local = IPAddress(self._client, result['ipv6']['link_local']['address'],
result['ipv6']['link_local'])
pools = []
for p in result['ipv6']['global']:
pools.append(IPv6Pool(self._client, p['range']))
ips = MappedObject(**{
"ipv4": {
"public": v4pub,
"private": v4pri,
"shared": shared_ips,
},
"ipv6": {
"slaac": slaac,
"link_local": link_local,
"pools": pools,
},
})
self._set('_ips', ips)
return self._ips
@property
def available_backups(self):
"""
The backups response contains what backups are available to be restored.
"""
if not hasattr(self, '_avail_backups'):
result = self._client.get("{}/backups".format(Linode.api_endpoint), model=self)
if not 'automatic' in result:
raise UnexpectedResponseError('Unexpected response loading available backups!', json=result)
automatic = []
for a in result['automatic']:
cur = Backup(self._client, a['id'], self.id, a)
automatic.append(cur)
snap = None
if result['snapshot']['current']:
snap = Backup(self._client, result['snapshot']['current']['id'], self.id,
result['snapshot']['current'])
psnap = None
if result['snapshot']['in_progress']:
psnap = Backup(self._client, result['snapshot']['in_progress']['id'], self.id,
result['snapshot']['in_progress'])
self._set('_avail_backups', MappedObject(**{
"automatic": automatic,
"snapshot": {
"current": snap,
"in_progress": psnap,
}
}))
return self._avail_backups
def _populate(self, json):
if json is not None:
# fixes ipv4 and ipv6 attribute of json to make base._populate work
if 'ipv4' in json and 'address' in json['ipv4']:
json['ipv4']['id'] = json['ipv4']['address']
if 'ipv6' in json and isinstance(json['ipv6'], list):
for j in json['ipv6']:
j['id'] = j['range']
Base._populate(self, json)
def invalidate(self):
""" Clear out cached properties """
if hasattr(self, '_avail_backups'):
del self._avail_backups
if hasattr(self, '_ips'):
del self._ips
Base.invalidate(self)
def boot(self, config=None):
resp = self._client.post("{}/boot".format(Linode.api_endpoint), model=self, data={'config_id': config.id} if config else None)
if 'error' in resp:
return False
return True
def shutdown(self):
resp = self._client.post("{}/shutdown".format(Linode.api_endpoint), model=self)
if 'error' in resp:
return False
return True
def reboot(self):
resp = self._client.post("{}/reboot".format(Linode.api_endpoint), model=self)
if 'error' in resp:
return False
return True
@staticmethod
def generate_root_password():
def _func(value):
if sys.version_info[0] < 3:
value = int(value.encode('hex'), 16)
return value
password = ''.join([
PASSWORD_CHARS[_func(c) % len(PASSWORD_CHARS)]
for c in urandom(randint(50, 128))
])
return password
# create derived objects
def create_config(self, kernel=None, label=None, devices=[], disks=[],
volumes=[], **kwargs):
"""
Creates a Linode Config with the given attributes.
:param kernel: The kernel to boot with.
:param label: The config label
:param disks: The list of disks, starting at sda, to map to this config.
:param volumes: The volumes, starting after the last disk, to map to this
config
:param devices: A list of devices to assign to this config, in device
index order. Values must be of type Disk or Volume. If this is
given, you may not include disks or volumes.
:param **kwargs: Any other arguments accepted by the api.
:returns: A new Linode Config
"""
from ..volume import Volume
hypervisor_prefix = 'sd' if self.hypervisor == 'kvm' else 'xvd'
device_names = [hypervisor_prefix + string.ascii_lowercase[i] for i in range(0, 8)]
device_map = {device_names[i]: None for i in range(0, len(device_names))}
if devices and (disks or volumes):
raise ValueError('You may not call create_config with "devices" and '
'either of "disks" or "volumes" specified!')
if not devices:
if not isinstance(disks, list):
disks = [disks]
if not isinstance(volumes, list):
volumes = [volumes]
devices = []
for d in disks:
if d is None:
devices.append(None)
elif isinstance(d, Disk):
devices.append(d)
else:
devices.append(Disk(self._client, int(d), self.id))
for v in volumes:
if v is None:
devices.append(None)
elif isinstance(v, Volume):
devices.append(v)
else:
devices.append(Volume(self._client, int(v)))
if not devices:
raise ValueError('Must include at least one disk or volume!')
for i, d in enumerate(devices):
if d is None:
pass
elif isinstance(d, Disk):
device_map[device_names[i]] = {'disk_id': d.id }
elif isinstance(d, Volume):
device_map[device_names[i]] = {'volume_id': d.id }
else:
raise TypeError('Disk or Volume expected!')
params = {
'kernel': kernel.id if issubclass(type(kernel), Base) else kernel,
'label': label if label else "{}_config_{}".format(self.label, len(self.configs)),
'devices': device_map,
}
params.update(kwargs)
result = self._client.post("{}/configs".format(Linode.api_endpoint), model=self, data=params)
self.invalidate()
if not 'id' in result:
raise UnexpectedResponseError('Unexpected response creating config!', json=result)
c = Config(self._client, result['id'], self.id, result)
return c
def create_disk(self, size, label=None, filesystem=None, read_only=False, image=None,
root_pass=None, authorized_keys=None, stackscript=None, **stackscript_args):
gen_pass = None
if image and not root_pass:
gen_pass = Linode.generate_root_password()
root_pass = gen_pass
authorized_keys = load_and_validate_keys(authorized_keys)
if image and not label:
label = "My {} Disk".format(image.label)
params = {
'size': size,
'label': label if label else "{}_disk_{}".format(self.label, len(self.disks)),
'read_only': read_only,
'filesystem': filesystem if filesystem else 'raw',
'authorized_keys': authorized_keys,
}
if image:
params.update({
'image': image.id if issubclass(type(image), Base) else image,
'root_pass': root_pass,
})
if stackscript:
params['stackscript_id'] = stackscript.id
if stackscript_args:
params['stackscript_data'] = stackscript_args
result = self._client.post("{}/disks".format(Linode.api_endpoint), model=self, data=params)
self.invalidate()
if not 'id' in result:
raise UnexpectedResponseError('Unexpected response creating disk!', json=result)
d = Disk(self._client, result['id'], self.id, result)
if gen_pass:
return d, gen_pass
return d
def enable_backups(self):
"""
Enable Backups for this Linode. When enabled, we will automatically
backup your Linode's data so that it can be restored at a later date.
For more information on Linode's Backups service and pricing, see our
`Backups Page`_
.. _Backups Page: https://www.linode.com/backups
"""
self._client.post("{}/backups/enable".format(Linode.api_endpoint), model=self)
self.invalidate()
return True
def cancel_backups(self):
"""
Cancels Backups for this Linode. All existing Backups will be lost,
including any snapshots that have been taken. This cannot be undone,
but Backups can be re-enabled at a later date.
"""
self._client.post("{}/backups/cancel".format(Linode.api_endpoint), model=self)
self.invalidate()
return True
def snapshot(self, label=None):
result = self._client.post("{}/backups".format(Linode.api_endpoint), model=self,
data={ "label": label })
if not 'id' in result:
raise UnexpectedResponseError('Unexpected response taking snapshot!', json=result)
# so the changes show up the next time they're accessed
if hasattr(self, '_avail_backups'):
del self._avail_backups
b = Backup(self._client, result['id'], self.id, result)
return b
def allocate_ip(self, public=False):
"""
Allocates a new :any:`IPAddress` for this Linode. Additional public
IPs require justification, and you may need to open a :any:`SupportTicket`
before you can add one. You may only have, at most, one private IP per
Linode.
:param public: If the new IP should be public or private. Defaults to
private.
:type public: bool
:returns: The new IPAddress
:rtype: IPAddress
"""
result = self._client.post(
"{}/ips".format(Linode.api_endpoint),
model=self,
data={
"type": "ipv4",
"public": public,
})
if not 'address' in result:
raise UnexpectedResponseError('Unexpected response allocating IP!',
json=result)
i = IPAddress(self._client, result['address'], result)
return i
def rebuild(self, image, root_pass=None, authorized_keys=None, **kwargs):
"""
Rebuilding a Linode deletes all existing Disks and Configs and deploys
a new :any:`Image` to it. This can be used to reset an existing
Linode or to install an Image on an empty Linode.
:param image: The Image to deploy to this Linode
:type image: str or Image
:param root_pass: The root password for the newly rebuilt Linode. If
omitted, a password will be generated and returned.
:type root_pass: str
:param authorized_keys: The ssh public keys to install in the linode's
/root/.ssh/authorized_keys file. Each entry may
be a single key, or a path to a file containing
the key.
:type authorized_keys: list or str
:returns: The newly generated password, if one was not provided
(otherwise True)
:rtype: str or bool
"""
ret_pass = None
if not root_pass:
ret_pass = Linode.generate_root_password()
root_pass = ret_pass
authorized_keys = load_and_validate_keys(authorized_keys)
params = {
'image': image.id if issubclass(type(image), Base) else image,
'root_pass': root_pass,
'authorized_keys': authorized_keys,
}
params.update(kwargs)
result = self._client.post('{}/rebuild'.format(Linode.api_endpoint), model=self, data=params)
if not 'id' in result:
raise UnexpectedResponseError('Unexpected response issuing rebuild!', json=result)
# update ourself with the newly-returned information
self._populate(result)
if not ret_pass:
return True
else:
return ret_pass
def rescue(self, *disks):
if disks:
disks = { x: { 'disk_id': y } for x,y in zip(('sda','sdb','sdc','sdd','sde','sdf','sdg'), disks) }
else:
disks=None
result = self._client.post('{}/rescue'.format(Linode.api_endpoint), model=self,
data={ "devices": disks })
return result
def kvmify(self):
"""
Converts this linode to KVM from Xen
"""
self._client.post('{}/kvmify'.format(Linode.api_endpoint), model=self)
return True
def mutate(self):
"""
Upgrades this Linode to the latest generation type
"""
self._client.post('{}/mutate'.format(Linode.api_endpoint), model=self)
return True
def clone(self, to_linode=None, region=None, service=None, configs=[], disks=[],
label=None, group=None, with_backups=None):
""" Clones this linode into a new linode or into a new linode in the given region """
if to_linode and region:
raise ValueError('You may only specify one of "to_linode" and "region"')
if region and not service:
raise ValueError('Specifying a region requires a "service" as well')
if not isinstance(configs, list) and not isinstance(configs, PaginatedList):
configs = [configs]
if not isinstance(disks, list) and not isinstance(disks, PaginatedList):
disks = [disks]
cids = [ c.id if issubclass(type(c), Base) else c for c in configs ]
dids = [ d.id if issubclass(type(d), Base) else d for d in disks ]
params = {
"linode_id": to_linode.id if issubclass(type(to_linode), Base) else to_linode,
"region": region.id if issubclass(type(region), Base) else region,
"type": service.id if issubclass(type(service), Base) else service,
"configs": cids if cids else None,
"disks": dids if dids else None,
"label": label,
"group": group,
"with_backups": with_backups,
}
result = self._client.post('{}/clone'.format(Linode.api_endpoint), model=self, data=params)
if not 'id' in result:
raise UnexpectedResponseError('Unexpected response cloning Linode!', json=result)
l = Linode(self._client, result['id'], result)
return l
@property
def stats(self):
"""
Returns the JSON stats for this Linode
"""
# TODO - this would be nicer if we formatted the stats
return self._client.get('{}/stats'.format(Linode.api_endpoint), model=self)
def stats_for(self, dt):
"""
Returns stats for the month containing the given datetime
"""
# TODO - this would be nicer if we formatted the stats
if not isinstance(dt, datetime):
raise TypeError('stats_for requires a datetime object!')
return self._client.get('{}/stats/'.format(dt.strftime('%Y/%m')))