rlib2.py 13.9 KB
Newer Older
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
#
#

# Copyright (C) 2006, 2007, 2008 Google Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.


"""Remote API version 2 baserlib.library.

"""

Iustin Pop's avatar
Iustin Pop committed
26
from ganeti import opcodes
27
28
from ganeti import http
from ganeti import constants
Iustin Pop's avatar
Iustin Pop committed
29
from ganeti import cli
Iustin Pop's avatar
Iustin Pop committed
30
from ganeti.rapi import baserlib
31

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
32

33
34
35
I_FIELDS = ["name", "admin_state", "os",
            "pnode", "snodes",
            "disk_template",
Guido Trotter's avatar
Guido Trotter committed
36
            "nic.ips", "nic.macs", "nic.modes", "nic.links",
37
            "network_port",
38
            "disk.sizes", "disk_usage",
39
            "beparams", "hvparams",
40
41
42
            "oper_state", "oper_ram", "status",
            "tags"]

43
N_FIELDS = ["name", "offline", "master_candidate", "drained",
44
            "dtotal", "dfree",
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
45
            "mtotal", "mnode", "mfree",
46
47
48
            "pinst_cnt", "sinst_cnt", "tags",
            "ctotal", "cnodes", "csockets",
            ]
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
49

50
51
52
53
54
55
56
57
58
59
60
61
62
63
_NR_DRAINED = "drained"
_NR_MASTER_CANDIATE = "master-candidate"
_NR_MASTER = "master"
_NR_OFFLINE = "offline"
_NR_REGULAR = "regular"

_NR_MAP = {
  "M": _NR_MASTER,
  "C": _NR_MASTER_CANDIATE,
  "D": _NR_DRAINED,
  "O": _NR_OFFLINE,
  "R": _NR_REGULAR,
  }

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

class R_version(baserlib.R_Generic):
  """/version resource.

  This resource should be used to determine the remote API version and
  to adapt clients accordingly.

  """
  def GET(self):
    """Returns the remote API version.

    """
    return constants.RAPI_VERSION


class R_2_info(baserlib.R_Generic):
  """Cluster info.

  """
  def GET(self):
    """Returns cluster information.

    """
Iustin Pop's avatar
Iustin Pop committed
87
    client = baserlib.GetClient()
88
    return client.QueryClusterInfo()
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
89
90
91
92
93
94
95
96
97
98
99
100
101
102


class R_2_os(baserlib.R_Generic):
  """/2/os resource.

  """
  def GET(self):
    """Return a list of all OSes.

    Can return error 500 in case of a problem.

    Example: ["debian-etch"]

    """
Iustin Pop's avatar
Iustin Pop committed
103
104
105
106
107
108
    cl = baserlib.GetClient()
    op = opcodes.OpDiagnoseOS(output_fields=["name", "valid"], names=[])
    job_id = baserlib.SubmitJob([op], cl)
    # we use custom feedback function, instead of print we log the status
    result = cli.PollJob(job_id, cl, feedback_fn=baserlib.FeedbackFn)
    diagnose_data = result[0]
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
109
110

    if not isinstance(diagnose_data, list):
Iustin Pop's avatar
Iustin Pop committed
111
      raise http.HttpBadGateway(message="Can't get OS list")
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
112
113

    return [row[0] for row in diagnose_data if row[1]]
114

115
116
117
118
119
120
121
122

class R_2_jobs(baserlib.R_Generic):
  """/2/jobs resource.

  """
  def GET(self):
    """Returns a dictionary of jobs.

Iustin Pop's avatar
Iustin Pop committed
123
    @return: a dictionary with jobs id and uri.
Iustin Pop's avatar
Iustin Pop committed
124

125
126
    """
    fields = ["id"]
Iustin Pop's avatar
Iustin Pop committed
127
    cl = baserlib.GetClient()
128
    # Convert the list of lists to the list of ids
Iustin Pop's avatar
Iustin Pop committed
129
    result = [job_id for [job_id] in cl.QueryJobs(None, fields)]
130
131
    return baserlib.BuildUriList(result, "/2/jobs/%s",
                                 uri_fields=("id", "uri"))
132
133
134
135
136
137
138
139
140


class R_2_jobs_id(baserlib.R_Generic):
  """/2/jobs/[job_id] resource.

  """
  def GET(self):
    """Returns a job status.

Iustin Pop's avatar
Iustin Pop committed
141
142
143
144
145
146
147
148
    @return: a dictionary with job parameters.
        The result includes:
            - id: job ID as a number
            - status: current job status as a string
            - ops: involved OpCodes as a list of dictionaries for each
              opcodes in the job
            - opstatus: OpCodes status as a list
            - opresult: OpCodes results as a list of lists
Iustin Pop's avatar
Iustin Pop committed
149

150
    """
Iustin Pop's avatar
Iustin Pop committed
151
152
153
154
    fields = ["id", "ops", "status", "summary",
              "opstatus", "opresult", "oplog",
              "received_ts", "start_ts", "end_ts",
              ]
155
    job_id = self.items[0]
Iustin Pop's avatar
Iustin Pop committed
156
    result = baserlib.GetClient().QueryJobs([job_id, ], fields)[0]
Iustin Pop's avatar
Iustin Pop committed
157
158
    if result is None:
      raise http.HttpNotFound()
159
160
    return baserlib.MapFields(fields, result)

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
161
162
163
164
165
  def DELETE(self):
    """Cancel not-yet-started job.

    """
    job_id = self.items[0]
Iustin Pop's avatar
Iustin Pop committed
166
    result = baserlib.GetClient().CancelJob(job_id)
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
167
168
    return result

169
170
171
172
173
174
175

class R_2_nodes(baserlib.R_Generic):
  """/2/nodes resource.

  """
  def GET(self):
    """Returns a list of all nodes.
Iustin Pop's avatar
Iustin Pop committed
176

177
    """
Iustin Pop's avatar
Iustin Pop committed
178
    client = baserlib.GetClient()
Iustin Pop's avatar
Iustin Pop committed
179

180
    if self.useBulk():
181
      bulkdata = client.QueryNodes([], N_FIELDS, False)
182
      return baserlib.MapBulkFields(bulkdata, N_FIELDS)
183
184
185
186
187
    else:
      nodesdata = client.QueryNodes([], ["name"], False)
      nodeslist = [row[0] for row in nodesdata]
      return baserlib.BuildUriList(nodeslist, "/2/nodes/%s",
                                   uri_fields=("id", "uri"))
188
189


Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
190
191
class R_2_nodes_name(baserlib.R_Generic):
  """/2/nodes/[node_name] resources.
192
193

  """
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
194
195
196
197
198
  def GET(self):
    """Send information about a node.

    """
    node_name = self.items[0]
Iustin Pop's avatar
Iustin Pop committed
199
    client = baserlib.GetClient()
200
    result = client.QueryNodes(names=[node_name], fields=N_FIELDS,
201
                               use_locking=self.useLocking())
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
202
203

    return baserlib.MapFields(N_FIELDS, result[0])
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
class R_2_nodes_name_role(baserlib.R_Generic):
  """ /2/nodes/[node_name]/role resource.

  """
  def GET(self):
    """Returns the current node role.

    @return: Node role

    """
    node_name = self.items[0]
    client = baserlib.GetClient()
    result = client.QueryNodes(names=[node_name], fields=["role"],
                               use_locking=self.useLocking())

    return _NR_MAP[result[0][0]]

  def PUT(self):
    """Sets the node role.

    @return: a job id

    """
    if not isinstance(self.req.request_body, basestring):
      raise http.HttpBadRequest("Invalid body contents, not a string")

    node_name = self.items[0]
    role = self.req.request_body

    if role == _NR_REGULAR:
      candidate = False
      offline = False
      drained = False

    elif role == _NR_MASTER_CANDIATE:
      candidate = True
      offline = drained = None

    elif role == _NR_DRAINED:
      drained = True
      candidate = offline = None

    elif role == _NR_OFFLINE:
      offline = True
      candidate = drained = None

    else:
      raise http.HttpBadRequest("Can't set '%s' role" % role)

    op = opcodes.OpSetNodeParams(node_name=node_name,
                                 master_candidate=candidate,
                                 offline=offline,
                                 drained=drained,
                                 force=bool(self.useForce()))

    return baserlib.SubmitJob([op])


264
265
266
267
268
269
270
271
class R_2_instances(baserlib.R_Generic):
  """/2/instances resource.

  """
  def GET(self):
    """Returns a list of all available instances.

    """
Iustin Pop's avatar
Iustin Pop committed
272
    client = baserlib.GetClient()
273

274
275
276
    use_locking = self.useLocking()
    if self.useBulk():
      bulkdata = client.QueryInstances([], I_FIELDS, use_locking)
277
      return baserlib.MapBulkFields(bulkdata, I_FIELDS)
278
    else:
279
      instancesdata = client.QueryInstances([], ["name"], use_locking)
280
      instanceslist = [row[0] for row in instancesdata]
281
282
283
      return baserlib.BuildUriList(instanceslist, "/2/instances/%s",
                                   uri_fields=("id", "uri"))

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
284
  def POST(self):
285
286
    """Create an instance.

Iustin Pop's avatar
Iustin Pop committed
287
    @return: a job id
288
289

    """
Iustin Pop's avatar
Iustin Pop committed
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
    if not isinstance(self.req.request_body, dict):
      raise http.HttpBadRequest("Invalid body contents, not a dictionary")

    beparams = baserlib.MakeParamsDict(self.req.request_body,
                                       constants.BES_PARAMETERS)
    hvparams = baserlib.MakeParamsDict(self.req.request_body,
                                       constants.HVS_PARAMETERS)
    fn = self.getBodyParameter

    # disk processing
    disk_data = fn('disks')
    if not isinstance(disk_data, list):
      raise http.HttpBadRequest("The 'disks' parameter should be a list")
    disks = []
    for idx, d in enumerate(disk_data):
      if not isinstance(d, int):
        raise http.HttpBadRequest("Disk %d specification wrong: should"
                                  " be an integer")
      disks.append({"size": d})
    # nic processing (one nic only)
Guido Trotter's avatar
Guido Trotter committed
310
311
312
313
314
315
316
317
318
    nics = [{"mac": fn("mac", constants.VALUE_AUTO)}]
    if fn("ip", None) is not None:
      nics[0]["ip"] = fn("ip")
    if fn("mode", None) is not None:
      nics[0]["mode"] = fn("mode")
    if fn("link", None) is not None:
      nics[0]["link"] = fn("link")
    if fn("bridge", None) is not None:
       nics[0]["bridge"] = fn("bridge")
319

Iustin Pop's avatar
Iustin Pop committed
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
    op = opcodes.OpCreateInstance(
      mode=constants.INSTANCE_CREATE,
      instance_name=fn('name'),
      disks=disks,
      disk_template=fn('disk_template'),
      os_type=fn('os'),
      pnode=fn('pnode', None),
      snode=fn('snode', None),
      iallocator=fn('iallocator', None),
      nics=nics,
      start=fn('start', True),
      ip_check=fn('ip_check', True),
      wait_for_sync=True,
      hypervisor=fn('hypervisor', None),
      hvparams=hvparams,
      beparams=beparams,
      file_storage_dir=fn('file_storage_dir', None),
      file_driver=fn('file_driver', 'loop'),
Iustin Pop's avatar
Iustin Pop committed
338
      dry_run=bool(self.dryRun()),
Iustin Pop's avatar
Iustin Pop committed
339
340
341
      )

    return baserlib.SubmitJob([op])
342

343

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
344
345
class R_2_instances_name(baserlib.R_Generic):
  """/2/instances/[instance_name] resources.
346
347

  """
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
348
349
350
351
  def GET(self):
    """Send information about an instance.

    """
Iustin Pop's avatar
Iustin Pop committed
352
    client = baserlib.GetClient()
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
353
    instance_name = self.items[0]
354
    result = client.QueryInstances(names=[instance_name], fields=I_FIELDS,
355
                                   use_locking=self.useLocking())
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
356
357

    return baserlib.MapFields(I_FIELDS, result[0])
358

Iustin Pop's avatar
Iustin Pop committed
359
360
361
362
  def DELETE(self):
    """Delete an instance.

    """
Iustin Pop's avatar
Iustin Pop committed
363
    op = opcodes.OpRemoveInstance(instance_name=self.items[0],
Iustin Pop's avatar
Iustin Pop committed
364
365
                                  ignore_failures=False,
                                  dry_run=bool(self.dryRun()))
Iustin Pop's avatar
Iustin Pop committed
366
    return baserlib.SubmitJob([op])
Iustin Pop's avatar
Iustin Pop committed
367

368

369
370
371
372
373
374
class R_2_instances_name_reboot(baserlib.R_Generic):
  """/2/instances/[instance_name]/reboot resource.

  Implements an instance reboot.

  """
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
375
  def POST(self):
376
377
    """Reboot an instance.

378
379
380
    The URI takes type=[hard|soft|full] and
    ignore_secondaries=[False|True] parameters.

381
382
    """
    instance_name = self.items[0]
383
384
385
386
    reboot_type = self.queryargs.get('type',
                                     [constants.INSTANCE_REBOOT_HARD])[0]
    ignore_secondaries = bool(self.queryargs.get('ignore_secondaries',
                                                 [False])[0])
Iustin Pop's avatar
Iustin Pop committed
387
388
    op = opcodes.OpRebootInstance(instance_name=instance_name,
                                  reboot_type=reboot_type,
Iustin Pop's avatar
Iustin Pop committed
389
390
                                  ignore_secondaries=ignore_secondaries,
                                  dry_run=bool(self.dryRun()))
391

Iustin Pop's avatar
Iustin Pop committed
392
    return baserlib.SubmitJob([op])
393
394


395
396
397
398
399
400
class R_2_instances_name_startup(baserlib.R_Generic):
  """/2/instances/[instance_name]/startup resource.

  Implements an instance startup.

  """
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
401
  def PUT(self):
402
403
    """Startup an instance.

Iustin Pop's avatar
Iustin Pop committed
404
405
    The URI takes force=[False|True] parameter to start the instance
    if even if secondary disks are failing.
406
407
408
409

    """
    instance_name = self.items[0]
    force_startup = bool(self.queryargs.get('force', [False])[0])
Iustin Pop's avatar
Iustin Pop committed
410
    op = opcodes.OpStartupInstance(instance_name=instance_name,
Iustin Pop's avatar
Iustin Pop committed
411
412
                                   force=force_startup,
                                   dry_run=bool(self.dryRun()))
413

Iustin Pop's avatar
Iustin Pop committed
414
    return baserlib.SubmitJob([op])
415
416
417
418
419
420
421
422


class R_2_instances_name_shutdown(baserlib.R_Generic):
  """/2/instances/[instance_name]/shutdown resource.

  Implements an instance shutdown.

  """
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
423
  def PUT(self):
424
425
426
427
    """Shutdown an instance.

    """
    instance_name = self.items[0]
Iustin Pop's avatar
Iustin Pop committed
428
429
    op = opcodes.OpShutdownInstance(instance_name=instance_name,
                                    dry_run=bool(self.dryRun()))
430

Iustin Pop's avatar
Iustin Pop committed
431
    return baserlib.SubmitJob([op])
432
433


Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
434
435
class _R_Tags(baserlib.R_Generic):
  """ Quasiclass for tagging resources
436

Iustin Pop's avatar
Iustin Pop committed
437
  Manages tags. When inheriting this class you must define the
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
438
  TAG_LEVEL for it.
439
440

  """
Iustin Pop's avatar
Iustin Pop committed
441
  TAG_LEVEL = None
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
442
443
444
445
446
447
448
449
450
451
452
453
454

  def __init__(self, items, queryargs, req):
    """A tag resource constructor.

    We have to override the default to sort out cluster naming case.

    """
    baserlib.R_Generic.__init__(self, items, queryargs, req)

    if self.TAG_LEVEL != constants.TAG_CLUSTER:
      self.name = items[0]
    else:
      self.name = ""
455
456

  def GET(self):
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
457
    """Returns a list of tags.
458
459
460
461

    Example: ["tag1", "tag2", "tag3"]

    """
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
462
    return baserlib._Tags_GET(self.TAG_LEVEL, name=self.name)
463

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
464
  def PUT(self):
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
465
    """Add a set of tags.
466

Iustin Pop's avatar
Iustin Pop committed
467
468
    The request as a list of strings should be PUT to this URI. And
    you'll have back a job id.
469
470

    """
Iustin Pop's avatar
Iustin Pop committed
471
472
473
    if 'tag' not in self.queryargs:
      raise http.HttpBadRequest("Please specify tag(s) to add using the"
                                " the 'tag' parameter")
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
474
    return baserlib._Tags_PUT(self.TAG_LEVEL,
Iustin Pop's avatar
Iustin Pop committed
475
476
                              self.queryargs['tag'], name=self.name,
                              dry_run=bool(self.dryRun()))
477
478
479
480

  def DELETE(self):
    """Delete a tag.

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
481
    In order to delete a set of tags, the DELETE
Iustin Pop's avatar
Iustin Pop committed
482
    request should be addressed to URI like:
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
483
    /tags?tag=[tag]&tag=[tag]
484
485
486

    """
    if 'tag' not in self.queryargs:
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
487
      # no we not gonna delete all tags
Iustin Pop's avatar
Iustin Pop committed
488
489
      raise http.HttpBadRequest("Cannot delete all tags - please specify"
                                " tag(s) using the 'tag' parameter")
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
490
    return baserlib._Tags_DELETE(self.TAG_LEVEL,
491
                                 self.queryargs['tag'],
Iustin Pop's avatar
Iustin Pop committed
492
493
                                 name=self.name,
                                 dry_run=bool(self.dryRun()))
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520


class R_2_instances_name_tags(_R_Tags):
  """ /2/instances/[instance_name]/tags resource.

  Manages per-instance tags.

  """
  TAG_LEVEL = constants.TAG_INSTANCE


class R_2_nodes_name_tags(_R_Tags):
  """ /2/nodes/[node_name]/tags resource.

  Manages per-node tags.

  """
  TAG_LEVEL = constants.TAG_NODE


class R_2_tags(_R_Tags):
  """ /2/instances/tags resource.

  Manages cluster tags.

  """
  TAG_LEVEL = constants.TAG_CLUSTER