rlib2.py 33.1 KB
Newer Older
1
2
3
#
#

4
# Copyright (C) 2006, 2007, 2008, 2009, 2010 Google Inc.
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
#
# 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.

24
  PUT or POST?
25
  ============
26
27
28
29
30
31
32
33
34
35
36
37

  According to RFC2616 the main difference between PUT and POST is that
  POST can create new resources but PUT can only create the resource the
  URI was pointing to on the PUT request.

  To be in context of this module for instance creation POST on
  /2/instances is legitim while PUT would be not, due to it does create a
  new entity and not just replace /2/instances with it.

  So when adding new methods, if they are operating on the URI entity itself,
  PUT should be prefered over POST.

38
39
"""

Iustin Pop's avatar
Iustin Pop committed
40
41
42
43
# pylint: disable-msg=C0103

# C0103: Invalid name, since the R_* names are not conforming

Iustin Pop's avatar
Iustin Pop committed
44
from ganeti import opcodes
45
46
from ganeti import http
from ganeti import constants
Iustin Pop's avatar
Iustin Pop committed
47
from ganeti import cli
48
from ganeti import utils
Michael Hanselmann's avatar
Michael Hanselmann committed
49
from ganeti import rapi
Iustin Pop's avatar
Iustin Pop committed
50
from ganeti.rapi import baserlib
51

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
52

Iustin Pop's avatar
Iustin Pop committed
53
_COMMON_FIELDS = ["ctime", "mtime", "uuid", "serial_no", "tags"]
54
55
56
I_FIELDS = ["name", "admin_state", "os",
            "pnode", "snodes",
            "disk_template",
57
            "nic.ips", "nic.macs", "nic.modes", "nic.links", "nic.bridges",
58
            "network_port",
59
            "disk.sizes", "disk_usage",
60
            "beparams", "hvparams",
61
            "oper_state", "oper_ram", "oper_vcpus", "status",
Iustin Pop's avatar
Iustin Pop committed
62
            ] + _COMMON_FIELDS
63

64
N_FIELDS = ["name", "offline", "master_candidate", "drained",
65
            "dtotal", "dfree",
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
66
            "mtotal", "mnode", "mfree",
Iustin Pop's avatar
Iustin Pop committed
67
            "pinst_cnt", "sinst_cnt",
68
            "ctotal", "cnodes", "csockets",
Iustin Pop's avatar
Iustin Pop committed
69
            "pip", "sip", "role",
70
            "pinst_list", "sinst_list",
Iustin Pop's avatar
Iustin Pop committed
71
            ] + _COMMON_FIELDS
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
72

73
74
75
76
77
78
79
80
81
82
83
84
85
86
_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,
  }

87
88
89
# Request data version field
_REQ_DATA_VERSION = "__version__"

90
91
92
# Feature string for instance creation request data version 1
_INST_CREATE_REQV1 = "instance-create-reqv1"

93
94
95
# Timeout for /2/jobs/[job_id]/wait. Gives job up to 10 seconds to change.
_WFJC_TIMEOUT = 10

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
96
97
98
99
100
101
102
103

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

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

  """
104
105
  @staticmethod
  def GET():
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
106
107
108
109
110
111
112
113
114
115
    """Returns the remote API version.

    """
    return constants.RAPI_VERSION


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

  """
116
117
  @staticmethod
  def GET():
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
118
119
120
    """Returns cluster information.

    """
Iustin Pop's avatar
Iustin Pop committed
121
    client = baserlib.GetClient()
122
    return client.QueryClusterInfo()
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
123
124


125
126
127
128
129
130
131
132
133
class R_2_features(baserlib.R_Generic):
  """/2/features resource.

  """
  @staticmethod
  def GET():
    """Returns list of optional RAPI features implemented.

    """
134
    return [_INST_CREATE_REQV1]
135
136


Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
137
138
139
140
class R_2_os(baserlib.R_Generic):
  """/2/os resource.

  """
141
142
  @staticmethod
  def GET():
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
143
144
145
146
147
148
149
    """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
150
    cl = baserlib.GetClient()
151
152
    op = opcodes.OpDiagnoseOS(output_fields=["name", "valid", "variants"],
                              names=[])
Iustin Pop's avatar
Iustin Pop committed
153
154
155
156
    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
157
158

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

161
162
163
164
165
166
    os_names = []
    for (name, valid, variants) in diagnose_data:
      if valid:
        os_names.extend(cli.CalculateOSNames(name, variants))

    return os_names
167

168

169
170
171
172
class R_2_redist_config(baserlib.R_Generic):
  """/2/redistribute-config resource.

  """
173
174
  @staticmethod
  def PUT():
175
176
177
178
179
180
    """Redistribute configuration to all nodes.

    """
    return baserlib.SubmitJob([opcodes.OpRedistributeConfig()])


181
182
183
184
class R_2_jobs(baserlib.R_Generic):
  """/2/jobs resource.

  """
185
186
  @staticmethod
  def GET():
187
188
    """Returns a dictionary of jobs.

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

191
192
    """
    fields = ["id"]
Iustin Pop's avatar
Iustin Pop committed
193
    cl = baserlib.GetClient()
194
    # Convert the list of lists to the list of ids
Iustin Pop's avatar
Iustin Pop committed
195
    result = [job_id for [job_id] in cl.QueryJobs(None, fields)]
196
197
    return baserlib.BuildUriList(result, "/2/jobs/%s",
                                 uri_fields=("id", "uri"))
198
199
200
201
202
203
204
205
206


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
207
208
209
210
211
212
213
214
    @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
215

216
    """
Iustin Pop's avatar
Iustin Pop committed
217
218
219
220
    fields = ["id", "ops", "status", "summary",
              "opstatus", "opresult", "oplog",
              "received_ts", "start_ts", "end_ts",
              ]
221
    job_id = self.items[0]
Iustin Pop's avatar
Iustin Pop committed
222
    result = baserlib.GetClient().QueryJobs([job_id, ], fields)[0]
Iustin Pop's avatar
Iustin Pop committed
223
224
    if result is None:
      raise http.HttpNotFound()
225
226
    return baserlib.MapFields(fields, result)

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
227
228
229
230
231
  def DELETE(self):
    """Cancel not-yet-started job.

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

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
class R_2_jobs_id_wait(baserlib.R_Generic):
  """/2/jobs/[job_id]/wait resource.

  """
  # WaitForJobChange provides access to sensitive information and blocks
  # machine resources (it's a blocking RAPI call), hence restricting access.
  GET_ACCESS = [rapi.RAPI_ACCESS_WRITE]

  def GET(self):
    """Waits for job changes.

    """
    job_id = self.items[0]

    fields = self.getBodyParameter("fields")
    prev_job_info = self.getBodyParameter("previous_job_info", None)
    prev_log_serial = self.getBodyParameter("previous_log_serial", None)

    if not isinstance(fields, list):
      raise http.HttpBadRequest("The 'fields' parameter should be a list")

    if not (prev_job_info is None or isinstance(prev_job_info, list)):
      raise http.HttpBadRequest("The 'previous_job_info' parameter should"
                                " be a list")

    if not (prev_log_serial is None or
            isinstance(prev_log_serial, (int, long))):
      raise http.HttpBadRequest("The 'previous_log_serial' parameter should"
                                " be a number")

    client = baserlib.GetClient()
    result = client.WaitForJobChangeOnce(job_id, fields,
                                         prev_job_info, prev_log_serial,
                                         timeout=_WFJC_TIMEOUT)
    if not result:
      raise http.HttpNotFound()

    if result == constants.JOB_NOTCHANGED:
      # No changes
      return None

    (job_info, log_entries) = result

    return {
      "job_info": job_info,
      "log_entries": log_entries,
      }


285
286
287
288
289
290
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
291

292
    """
Iustin Pop's avatar
Iustin Pop committed
293
    client = baserlib.GetClient()
Iustin Pop's avatar
Iustin Pop committed
294

295
    if self.useBulk():
296
      bulkdata = client.QueryNodes([], N_FIELDS, False)
297
      return baserlib.MapBulkFields(bulkdata, N_FIELDS)
298
299
300
301
302
    else:
      nodesdata = client.QueryNodes([], ["name"], False)
      nodeslist = [row[0] for row in nodesdata]
      return baserlib.BuildUriList(nodeslist, "/2/nodes/%s",
                                   uri_fields=("id", "uri"))
303
304


Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
305
306
class R_2_nodes_name(baserlib.R_Generic):
  """/2/nodes/[node_name] resources.
307
308

  """
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
309
310
311
312
313
  def GET(self):
    """Send information about a node.

    """
    node_name = self.items[0]
Iustin Pop's avatar
Iustin Pop committed
314
    client = baserlib.GetClient()
315
316
317
318

    result = baserlib.HandleItemQueryErrors(client.QueryNodes,
                                            names=[node_name], fields=N_FIELDS,
                                            use_locking=self.useLocking())
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
319
320

    return baserlib.MapFields(N_FIELDS, result[0])
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
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

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

    node_name = self.items[0]
350
    role = self.request_body
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

    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])


381
382
383
384
385
386
387
388
389
390
391
class R_2_nodes_name_evacuate(baserlib.R_Generic):
  """/2/nodes/[node_name]/evacuate resource.

  """
  def POST(self):
    """Evacuate all secondary instances off a node.

    """
    node_name = self.items[0]
    remote_node = self._checkStringVariable("remote_node", default=None)
    iallocator = self._checkStringVariable("iallocator", default=None)
392
393
    early_r = bool(self._checkIntVariable("early_release", default=0))
    dry_run = bool(self.dryRun())
394

395
    cl = baserlib.GetClient()
396

397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
    op = opcodes.OpNodeEvacuationStrategy(nodes=[node_name],
                                          iallocator=iallocator,
                                          remote_node=remote_node)

    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)

    jobs = []
    for iname, node in result:
      if dry_run:
        jid = None
      else:
        op = opcodes.OpReplaceDisks(instance_name=iname,
                                    remote_node=node, disks=[],
                                    mode=constants.REPLACE_DISK_CHG,
                                    early_release=early_r)
        jid = baserlib.SubmitJob([op])
      jobs.append((jid, iname, node))

    return jobs
418
419


420
class R_2_nodes_name_migrate(baserlib.R_Generic):
421
  """/2/nodes/[node_name]/migrate resource.
422
423
424
425
426
427
428
429

  """
  def POST(self):
    """Migrate all primary instances from a node.

    """
    node_name = self.items[0]

430
431
432
433
434
435
436
437
438
439
440
441
    if "live" in self.queryargs and "mode" in self.queryargs:
      raise http.HttpBadRequest("Only one of 'live' and 'mode' should"
                                " be passed")
    elif "live" in self.queryargs:
      if self._checkIntVariable("live", default=1):
        mode = constants.HT_MIGRATION_LIVE
      else:
        mode = constants.HT_MIGRATION_NONLIVE
    else:
      mode = self._checkStringVariable("mode", default=None)

    op = opcodes.OpMigrateNode(node_name=node_name, mode=mode)
442
443
444
445

    return baserlib.SubmitJob([op])


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
class R_2_nodes_name_storage(baserlib.R_Generic):
  """/2/nodes/[node_name]/storage ressource.

  """
  # LUQueryNodeStorage acquires locks, hence restricting access to GET
  GET_ACCESS = [rapi.RAPI_ACCESS_WRITE]

  def GET(self):
    node_name = self.items[0]

    storage_type = self._checkStringVariable("storage_type", None)
    if not storage_type:
      raise http.HttpBadRequest("Missing the required 'storage_type'"
                                " parameter")

    output_fields = self._checkStringVariable("output_fields", None)
    if not output_fields:
      raise http.HttpBadRequest("Missing the required 'output_fields'"
                                " parameter")

    op = opcodes.OpQueryNodeStorage(nodes=[node_name],
                                    storage_type=storage_type,
                                    output_fields=output_fields.split(","))
    return baserlib.SubmitJob([op])


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
class R_2_nodes_name_storage_modify(baserlib.R_Generic):
  """/2/nodes/[node_name]/storage/modify ressource.

  """
  def PUT(self):
    node_name = self.items[0]

    storage_type = self._checkStringVariable("storage_type", None)
    if not storage_type:
      raise http.HttpBadRequest("Missing the required 'storage_type'"
                                " parameter")

    name = self._checkStringVariable("name", None)
    if not name:
      raise http.HttpBadRequest("Missing the required 'name'"
                                " parameter")

    changes = {}

    if "allocatable" in self.queryargs:
      changes[constants.SF_ALLOCATABLE] = \
        bool(self._checkIntVariable("allocatable", default=1))

    op = opcodes.OpModifyNodeStorage(node_name=node_name,
                                     storage_type=storage_type,
                                     name=name,
                                     changes=changes)
    return baserlib.SubmitJob([op])


502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
class R_2_nodes_name_storage_repair(baserlib.R_Generic):
  """/2/nodes/[node_name]/storage/repair ressource.

  """
  def PUT(self):
    node_name = self.items[0]

    storage_type = self._checkStringVariable("storage_type", None)
    if not storage_type:
      raise http.HttpBadRequest("Missing the required 'storage_type'"
                                " parameter")

    name = self._checkStringVariable("name", None)
    if not name:
      raise http.HttpBadRequest("Missing the required 'name'"
                                " parameter")

    op = opcodes.OpRepairNodeStorage(node_name=node_name,
                                     storage_type=storage_type,
                                     name=name)
    return baserlib.SubmitJob([op])


525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
def _ParseInstanceCreateRequestVersion1(data, dry_run):
  """Parses an instance creation request version 1.

  @rtype: L{opcodes.OpCreateInstance}
  @return: Instance creation opcode

  """
  # Disks
  disks_input = baserlib.CheckParameter(data, "disks", exptype=list)

  disks = []
  for idx, i in enumerate(disks_input):
    baserlib.CheckType(i, dict, "Disk %d specification" % idx)

    # Size is mandatory
    try:
541
      size = i[constants.IDISK_SIZE]
542
543
544
545
546
    except KeyError:
      raise http.HttpBadRequest("Disk %d specification wrong: missing disk"
                                " size" % idx)

    disk = {
547
      constants.IDISK_SIZE: size,
548
549
550
551
      }

    # Optional disk access mode
    try:
552
      disk_access = i[constants.IDISK_MODE]
553
554
555
    except KeyError:
      pass
    else:
556
      disk[constants.IDISK_MODE] = disk_access
557
558
559
560
561
562
563
564
565
566
567
568
569
570

    disks.append(disk)

  assert len(disks_input) == len(disks)

  # Network interfaces
  nics_input = baserlib.CheckParameter(data, "nics", exptype=list)

  nics = []
  for idx, i in enumerate(nics_input):
    baserlib.CheckType(i, dict, "NIC %d specification" % idx)

    nic = {}

571
    for field in constants.INIC_PARAMS:
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
      try:
        value = i[field]
      except KeyError:
        continue

      nic[field] = value

    nics.append(nic)

  assert len(nics_input) == len(nics)

  # HV/BE parameters
  hvparams = baserlib.CheckParameter(data, "hvparams", default={})
  utils.ForceDictType(hvparams, constants.HVS_PARAMETER_TYPES)

  beparams = baserlib.CheckParameter(data, "beparams", default={})
  utils.ForceDictType(beparams, constants.BES_PARAMETER_TYPES)

  return opcodes.OpCreateInstance(
    mode=baserlib.CheckParameter(data, "mode"),
    instance_name=baserlib.CheckParameter(data, "name"),
593
594
    os_type=baserlib.CheckParameter(data, "os"),
    osparams=baserlib.CheckParameter(data, "osparams", default={}),
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
    force_variant=baserlib.CheckParameter(data, "force_variant",
                                          default=False),
    pnode=baserlib.CheckParameter(data, "pnode", default=None),
    snode=baserlib.CheckParameter(data, "snode", default=None),
    disk_template=baserlib.CheckParameter(data, "disk_template"),
    disks=disks,
    nics=nics,
    src_node=baserlib.CheckParameter(data, "src_node", default=None),
    src_path=baserlib.CheckParameter(data, "src_path", default=None),
    start=baserlib.CheckParameter(data, "start", default=True),
    wait_for_sync=True,
    ip_check=baserlib.CheckParameter(data, "ip_check", default=True),
    name_check=baserlib.CheckParameter(data, "name_check", default=True),
    file_storage_dir=baserlib.CheckParameter(data, "file_storage_dir",
                                             default=None),
    file_driver=baserlib.CheckParameter(data, "file_driver",
                                        default=constants.FD_LOOP),
612
613
614
615
616
617
    source_handshake=baserlib.CheckParameter(data, "source_handshake",
                                             default=None),
    source_x509_ca=baserlib.CheckParameter(data, "source_x509_ca",
                                           default=None),
    source_instance_name=baserlib.CheckParameter(data, "source_instance_name",
                                                 default=None),
618
619
620
621
622
623
624
625
    iallocator=baserlib.CheckParameter(data, "iallocator", default=None),
    hypervisor=baserlib.CheckParameter(data, "hypervisor", default=None),
    hvparams=hvparams,
    beparams=beparams,
    dry_run=dry_run,
    )


626
627
628
629
630
631
632
633
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
634
    client = baserlib.GetClient()
635

636
637
638
    use_locking = self.useLocking()
    if self.useBulk():
      bulkdata = client.QueryInstances([], I_FIELDS, use_locking)
639
      return baserlib.MapBulkFields(bulkdata, I_FIELDS)
640
    else:
641
      instancesdata = client.QueryInstances([], ["name"], use_locking)
642
      instanceslist = [row[0] for row in instancesdata]
643
644
645
      return baserlib.BuildUriList(instanceslist, "/2/instances/%s",
                                   uri_fields=("id", "uri"))

646
647
  def _ParseVersion0CreateRequest(self):
    """Parses an instance creation request version 0.
648

649
    Request data version 0 is deprecated and should not be used anymore.
650

651
652
    @rtype: L{opcodes.OpCreateInstance}
    @return: Instance creation opcode
Iustin Pop's avatar
Iustin Pop committed
653

654
    """
655
    # Do not modify anymore, request data version 0 is deprecated
656
    beparams = baserlib.MakeParamsDict(self.request_body,
Iustin Pop's avatar
Iustin Pop committed
657
                                       constants.BES_PARAMETERS)
658
    hvparams = baserlib.MakeParamsDict(self.request_body,
Iustin Pop's avatar
Iustin Pop committed
659
660
661
662
663
664
665
666
667
668
669
                                       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"
670
                                  " be an integer" % idx)
Iustin Pop's avatar
Iustin Pop committed
671
      disks.append({"size": d})
672

Iustin Pop's avatar
Iustin Pop committed
673
    # nic processing (one nic only)
Guido Trotter's avatar
Guido Trotter committed
674
675
676
677
678
679
680
681
    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:
682
      nics[0]["bridge"] = fn("bridge")
683

684
    # Do not modify anymore, request data version 0 is deprecated
685
    return opcodes.OpCreateInstance(
Iustin Pop's avatar
Iustin Pop committed
686
687
688
689
690
691
692
693
694
695
696
      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),
697
      name_check=fn('name_check', True),
Iustin Pop's avatar
Iustin Pop committed
698
699
700
701
702
      wait_for_sync=True,
      hypervisor=fn('hypervisor', None),
      hvparams=hvparams,
      beparams=beparams,
      file_storage_dir=fn('file_storage_dir', None),
703
      file_driver=fn('file_driver', constants.FD_LOOP),
Iustin Pop's avatar
Iustin Pop committed
704
      dry_run=bool(self.dryRun()),
Iustin Pop's avatar
Iustin Pop committed
705
706
      )

707
708
709
710
711
712
  def POST(self):
    """Create an instance.

    @return: a job id

    """
Luca Bigliardi's avatar
Luca Bigliardi committed
713
    if not isinstance(self.request_body, dict):
714
715
716
717
718
719
720
      raise http.HttpBadRequest("Invalid body contents, not a dictionary")

    # Default to request data version 0
    data_version = self.getBodyParameter(_REQ_DATA_VERSION, 0)

    if data_version == 0:
      op = self._ParseVersion0CreateRequest()
721
    elif data_version == 1:
Luca Bigliardi's avatar
Luca Bigliardi committed
722
      op = _ParseInstanceCreateRequestVersion1(self.request_body,
723
                                               self.dryRun())
724
725
    else:
      raise http.HttpBadRequest("Unsupported request data version %s" %
726
                                data_version)
727

Iustin Pop's avatar
Iustin Pop committed
728
    return baserlib.SubmitJob([op])
729

730

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
731
732
class R_2_instances_name(baserlib.R_Generic):
  """/2/instances/[instance_name] resources.
733
734

  """
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
735
736
737
738
  def GET(self):
    """Send information about an instance.

    """
Iustin Pop's avatar
Iustin Pop committed
739
    client = baserlib.GetClient()
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
740
    instance_name = self.items[0]
741
742
743
744
745

    result = baserlib.HandleItemQueryErrors(client.QueryInstances,
                                            names=[instance_name],
                                            fields=I_FIELDS,
                                            use_locking=self.useLocking())
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
746
747

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

Iustin Pop's avatar
Iustin Pop committed
749
750
751
752
  def DELETE(self):
    """Delete an instance.

    """
Iustin Pop's avatar
Iustin Pop committed
753
    op = opcodes.OpRemoveInstance(instance_name=self.items[0],
Iustin Pop's avatar
Iustin Pop committed
754
755
                                  ignore_failures=False,
                                  dry_run=bool(self.dryRun()))
Iustin Pop's avatar
Iustin Pop committed
756
    return baserlib.SubmitJob([op])
Iustin Pop's avatar
Iustin Pop committed
757

758

759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
class R_2_instances_name_info(baserlib.R_Generic):
  """/2/instances/[instance_name]/info resource.

  """
  def GET(self):
    """Request detailed instance information.

    """
    instance_name = self.items[0]
    static = bool(self._checkIntVariable("static", default=0))

    op = opcodes.OpQueryInstanceData(instances=[instance_name],
                                     static=static)
    return baserlib.SubmitJob([op])


775
776
777
778
779
780
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
781
  def POST(self):
782
783
    """Reboot an instance.

784
785
786
    The URI takes type=[hard|soft|full] and
    ignore_secondaries=[False|True] parameters.

787
788
    """
    instance_name = self.items[0]
789
790
    reboot_type = self.queryargs.get('type',
                                     [constants.INSTANCE_REBOOT_HARD])[0]
791
    ignore_secondaries = bool(self._checkIntVariable('ignore_secondaries'))
Iustin Pop's avatar
Iustin Pop committed
792
793
    op = opcodes.OpRebootInstance(instance_name=instance_name,
                                  reboot_type=reboot_type,
Iustin Pop's avatar
Iustin Pop committed
794
795
                                  ignore_secondaries=ignore_secondaries,
                                  dry_run=bool(self.dryRun()))
796

Iustin Pop's avatar
Iustin Pop committed
797
    return baserlib.SubmitJob([op])
798
799


800
801
802
803
804
805
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
806
  def PUT(self):
807
808
    """Startup an instance.

Iustin Pop's avatar
Iustin Pop committed
809
810
    The URI takes force=[False|True] parameter to start the instance
    if even if secondary disks are failing.
811
812
813

    """
    instance_name = self.items[0]
814
    force_startup = bool(self._checkIntVariable('force'))
Iustin Pop's avatar
Iustin Pop committed
815
    op = opcodes.OpStartupInstance(instance_name=instance_name,
Iustin Pop's avatar
Iustin Pop committed
816
817
                                   force=force_startup,
                                   dry_run=bool(self.dryRun()))
818

Iustin Pop's avatar
Iustin Pop committed
819
    return baserlib.SubmitJob([op])
820
821
822
823
824
825
826
827


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
828
  def PUT(self):
829
830
831
832
    """Shutdown an instance.

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

Iustin Pop's avatar
Iustin Pop committed
836
    return baserlib.SubmitJob([op])
837
838


839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
class R_2_instances_name_reinstall(baserlib.R_Generic):
  """/2/instances/[instance_name]/reinstall resource.

  Implements an instance reinstall.

  """
  def POST(self):
    """Reinstall an instance.

    The URI takes os=name and nostartup=[0|1] optional
    parameters. By default, the instance will be started
    automatically.

    """
    instance_name = self.items[0]
    ostype = self._checkStringVariable('os')
    nostartup = self._checkIntVariable('nostartup')
    ops = [
      opcodes.OpShutdownInstance(instance_name=instance_name),
      opcodes.OpReinstallInstance(instance_name=instance_name, os_type=ostype),
      ]
    if not nostartup:
      ops.append(opcodes.OpStartupInstance(instance_name=instance_name,
                                           force=False))
    return baserlib.SubmitJob(ops)


866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
class R_2_instances_name_replace_disks(baserlib.R_Generic):
  """/2/instances/[instance_name]/replace-disks resource.

  """
  def POST(self):
    """Replaces disks on an instance.

    """
    instance_name = self.items[0]
    remote_node = self._checkStringVariable("remote_node", default=None)
    mode = self._checkStringVariable("mode", default=None)
    raw_disks = self._checkStringVariable("disks", default=None)
    iallocator = self._checkStringVariable("iallocator", default=None)

    if raw_disks:
      try:
        disks = [int(part) for part in raw_disks.split(",")]
      except ValueError, err:
        raise http.HttpBadRequest("Invalid disk index passed: %s" % str(err))
    else:
      disks = []

    op = opcodes.OpReplaceDisks(instance_name=instance_name,
                                remote_node=remote_node,
                                mode=mode,
                                disks=disks,
                                iallocator=iallocator)

    return baserlib.SubmitJob([op])


897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
class R_2_instances_name_activate_disks(baserlib.R_Generic):
  """/2/instances/[instance_name]/activate-disks resource.

  """
  def PUT(self):
    """Activate disks for an instance.

    The URI might contain ignore_size to ignore current recorded size.

    """
    instance_name = self.items[0]
    ignore_size = bool(self._checkIntVariable('ignore_size'))

    op = opcodes.OpActivateInstanceDisks(instance_name=instance_name,
                                         ignore_size=ignore_size)

    return baserlib.SubmitJob([op])


916
917
918
919
920
921
922
923
924
925
class R_2_instances_name_deactivate_disks(baserlib.R_Generic):
  """/2/instances/[instance_name]/deactivate-disks resource.

  """
  def PUT(self):
    """Deactivate disks for an instance.

    """
    instance_name = self.items[0]

926
    op = opcodes.OpDeactivateInstanceDisks(instance_name=instance_name)
927
928
929
930

    return baserlib.SubmitJob([op])


931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
class R_2_instances_name_prepare_export(baserlib.R_Generic):
  """/2/instances/[instance_name]/prepare-export resource.

  """
  def PUT(self):
    """Prepares an export for an instance.

    @return: a job id

    """
    instance_name = self.items[0]
    mode = self._checkStringVariable("mode")

    op = opcodes.OpPrepareExport(instance_name=instance_name,
                                 mode=mode)

    return baserlib.SubmitJob([op])


def _ParseExportInstanceRequest(name, data):
  """Parses a request for an instance export.

  @rtype: L{opcodes.OpExportInstance}
  @return: Instance export opcode

  """
  mode = baserlib.CheckParameter(data, "mode",
                                 default=constants.EXPORT_MODE_LOCAL)
  target_node = baserlib.CheckParameter(data, "destination")
  shutdown = baserlib.CheckParameter(data, "shutdown", exptype=bool)
  remove_instance = baserlib.CheckParameter(data, "remove_instance",
                                            exptype=bool, default=False)
  x509_key_name = baserlib.CheckParameter(data, "x509_key_name", default=None)
  destination_x509_ca = baserlib.CheckParameter(data, "destination_x509_ca",
                                                default=None)

  return opcodes.OpExportInstance(instance_name=name,
                                  mode=mode,
                                  target_node=target_node,
                                  shutdown=shutdown,
                                  remove_instance=remove_instance,
                                  x509_key_name=x509_key_name,
                                  destination_x509_ca=destination_x509_ca)


class R_2_instances_name_export(baserlib.R_Generic):
  """/2/instances/[instance_name]/export resource.

  """
  def PUT(self):
    """Exports an instance.

    @return: a job id

    """
    if not isinstance(self.request_body, dict):
      raise http.HttpBadRequest("Invalid body contents, not a dictionary")

    op = _ParseExportInstanceRequest(self.items[0], self.request_body)

    return baserlib.SubmitJob([op])


994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
def _ParseMigrateInstanceRequest(name, data):
  """Parses a request for an instance migration.

  @rtype: L{opcodes.OpMigrateInstance}
  @return: Instance migration opcode

  """
  mode = baserlib.CheckParameter(data, "mode", default=None)
  cleanup = baserlib.CheckParameter(data, "cleanup", exptype=bool,
                                    default=False)

  return opcodes.OpMigrateInstance(instance_name=name, mode=mode,
                                   cleanup=cleanup)


class R_2_instances_name_migrate(baserlib.R_Generic):
  """/2/instances/[instance_name]/migrate resource.

  """
  def PUT(self):
    """Migrates an instance.

    @return: a job id

    """
    baserlib.CheckType(self.request_body, dict, "Body contents")

    op = _ParseMigrateInstanceRequest(self.items[0], self.request_body)

    return baserlib.SubmitJob([op])


1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
def _ParseRenameInstanceRequest(name, data):
  """Parses a request for renaming an instance.

  @rtype: L{opcodes.OpRenameInstance}
  @return: Instance rename opcode

  """
  new_name = baserlib.CheckParameter(data, "new_name")
  ip_check = baserlib.CheckParameter(data, "ip_check", default=True)
  name_check = baserlib.CheckParameter(data, "name_check", default=True)

  return opcodes.OpRenameInstance(instance_name=name, new_name=new_name,
                                  name_check=name_check, ip_check=ip_check)


class R_2_instances_name_rename(baserlib.R_Generic):
  """/2/instances/[instance_name]/rename resource.

  """
  def PUT(self):
    """Changes the name of an instance.

    @return: a job id

    """
    baserlib.CheckType(self.request_body, dict, "Body contents")

    op = _ParseRenameInstanceRequest(self.items[0], self.request_body)

    return baserlib.SubmitJob([op])


Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1058
1059
class _R_Tags(baserlib.R_Generic):
  """ Quasiclass for tagging resources
1060

Iustin Pop's avatar
Iustin Pop committed
1061
  Manages tags. When inheriting this class you must define the
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1062
  TAG_LEVEL for it.
1063
1064

  """
Iustin Pop's avatar
Iustin Pop committed
1065
  TAG_LEVEL = None
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078

  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 = ""
1079
1080

  def GET(self):
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1081
    """Returns a list of tags.
1082
1083
1084
1085

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

    """
Iustin Pop's avatar
Iustin Pop committed
1086
    # pylint: disable-msg=W0212
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1087
    return baserlib._Tags_GET(self.TAG_LEVEL, name=self.name)
1088

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1089
  def PUT(self):
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1090
    """Add a set of tags.
1091

Iustin Pop's avatar
Iustin Pop committed
1092
1093
    The request as a list of strings should be PUT to this URI. And
    you'll have back a job id.
1094
1095

    """
Iustin Pop's avatar
Iustin Pop committed
1096
    # pylint: disable-msg=W0212
Iustin Pop's avatar
Iustin Pop committed
1097
1098
1099
    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
1100
    return baserlib._Tags_PUT(self.TAG_LEVEL,
Iustin Pop's avatar
Iustin Pop committed
1101
1102
                              self.queryargs['tag'], name=self.name,
                              dry_run=bool(self.dryRun()))
1103
1104
1105
1106

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

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1107
    In order to delete a set of tags, the DELETE
Iustin Pop's avatar
Iustin Pop committed
1108
    request should be addressed to URI like:
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1109
    /tags?tag=[tag]&tag=[tag]
1110
1111

    """
Iustin Pop's avatar
Iustin Pop committed
1112
    # pylint: disable-msg=W0212
1113
    if 'tag' not in self.queryargs:
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1114
      # no we not gonna delete all tags
Iustin Pop's avatar
Iustin Pop committed
1115
1116
      raise http.HttpBadRequest("Cannot delete all tags - please specify"
                                " tag(s) using the 'tag' parameter")
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1117
    return baserlib._Tags_DELETE(self.TAG_LEVEL,
1118
                                 self.queryargs['tag'],
Iustin Pop's avatar
Iustin Pop committed
1119
1120
                                 name=self.name,
                                 dry_run=bool(self.dryRun()))
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147


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