rlib2.py 35.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",
62
            "custom_hvparams", "custom_beparams", "custom_nicparams",
Iustin Pop's avatar
Iustin Pop committed
63
            ] + _COMMON_FIELDS
64

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

76
77
78
79
80
81
82
83
84
85
86
87
88
89
_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,
  }

90
91
92
# Request data version field
_REQ_DATA_VERSION = "__version__"

93
94
95
# Feature string for instance creation request data version 1
_INST_CREATE_REQV1 = "instance-create-reqv1"

96
97
98
# 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
99
100
101
102
103
104
105
106

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

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

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

    """
    return constants.RAPI_VERSION


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

  """
119
120
  @staticmethod
  def GET():
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
121
122
123
    """Returns cluster information.

    """
Iustin Pop's avatar
Iustin Pop committed
124
    client = baserlib.GetClient()
125
    return client.QueryClusterInfo()
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
126
127


128
129
130
131
132
133
134
135
136
class R_2_features(baserlib.R_Generic):
  """/2/features resource.

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

    """
137
    return [_INST_CREATE_REQV1]
138
139


Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
140
141
142
143
class R_2_os(baserlib.R_Generic):
  """/2/os resource.

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

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

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

    return os_names
168

169

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

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

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


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

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

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

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


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

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

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

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

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
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,
      }


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

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

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


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

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

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

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

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

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

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

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


382
383
384
385
386
387
388
389
390
391
392
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)
393
394
    early_r = bool(self._checkIntVariable("early_release", default=0))
    dry_run = bool(self.dryRun())
395

396
    cl = baserlib.GetClient()
397

398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
    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
419
420


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

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

    """
    node_name = self.items[0]

431
432
433
434
435
436
437
438
439
440
441
442
    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)
443
444
445
446

    return baserlib.SubmitJob([op])


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


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


503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
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])


526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
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:
542
      size = i[constants.IDISK_SIZE]
543
544
545
546
547
    except KeyError:
      raise http.HttpBadRequest("Disk %d specification wrong: missing disk"
                                " size" % idx)

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

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

    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 = {}

572
    for field in constants.INIC_PARAMS:
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
      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"),
594
595
    os_type=baserlib.CheckParameter(data, "os"),
    osparams=baserlib.CheckParameter(data, "osparams", default={}),
596
597
    force_variant=baserlib.CheckParameter(data, "force_variant",
                                          default=False),
598
    no_install=baserlib.CheckParameter(data, "no_install", default=False),
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
    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),
614
615
616
617
618
619
    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),
620
621
622
623
624
625
626
627
    iallocator=baserlib.CheckParameter(data, "iallocator", default=None),
    hypervisor=baserlib.CheckParameter(data, "hypervisor", default=None),
    hvparams=hvparams,
    beparams=beparams,
    dry_run=dry_run,
    )


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

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

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

651
    Request data version 0 is deprecated and should not be used anymore.
652

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

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

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

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

709
710
711
712
713
714
  def POST(self):
    """Create an instance.

    @return: a job id

    """
Luca Bigliardi's avatar
Luca Bigliardi committed
715
    if not isinstance(self.request_body, dict):
716
717
718
719
720
721
722
      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()
723
    elif data_version == 1:
Luca Bigliardi's avatar
Luca Bigliardi committed
724
      op = _ParseInstanceCreateRequestVersion1(self.request_body,
725
                                               self.dryRun())
726
727
    else:
      raise http.HttpBadRequest("Unsupported request data version %s" %
728
                                data_version)
729

Iustin Pop's avatar
Iustin Pop committed
730
    return baserlib.SubmitJob([op])
731

732

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

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

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

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

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

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

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

760

761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
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])


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

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

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

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


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

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

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

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


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

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

Iustin Pop's avatar
Iustin Pop committed
838
    return baserlib.SubmitJob([op])
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
866
867
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)


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


899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
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])


918
919
920
921
922
923
924
925
926
927
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]

928
    op = opcodes.OpDeactivateInstanceDisks(instance_name=instance_name)
929
930
931
932

    return baserlib.SubmitJob([op])


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


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


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


1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
def _ParseModifyInstanceRequest(name, data):
  """Parses a request for modifying an instance.

  @rtype: L{opcodes.OpSetInstanceParams}
  @return: Instance modify opcode

  """
  osparams = baserlib.CheckParameter(data, "osparams", default={})
  force = baserlib.CheckParameter(data, "force", default=False)
  nics = baserlib.CheckParameter(data, "nics", default=[])
  disks = baserlib.CheckParameter(data, "disks", default=[])
  disk_template = baserlib.CheckParameter(data, "disk_template", default=None)
  remote_node = baserlib.CheckParameter(data, "remote_node", default=None)
  os_name = baserlib.CheckParameter(data, "os_name", default=None)
  force_variant = baserlib.CheckParameter(data, "force_variant", default=False)

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

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

  return opcodes.OpSetInstanceParams(instance_name=name, hvparams=hvparams,
                                     beparams=beparams, osparams=osparams,
                                     force=force, nics=nics, disks=disks,
                                     disk_template=disk_template,
                                     remote_node=remote_node, os_name=os_name,
                                     force_variant=force_variant)


class R_2_instances_name_modify(baserlib.R_Generic):
  """/2/instances/[instance_name]/modify resource.

  """
  def PUT(self):
    """Changes some parameters of an instance.

    @return: a job id

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

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

    return baserlib.SubmitJob([op])


Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1110
1111
class _R_Tags(baserlib.R_Generic):
  """ Quasiclass for tagging resources
1112

Iustin Pop's avatar
Iustin Pop committed
1113
  Manages tags. When inheriting this class you must define the
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1114
  TAG_LEVEL for it.
1115
1116

  """
Iustin Pop's avatar
Iustin Pop committed
1117
  TAG_LEVEL = None
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1118
1119
1120
1121
1122
1123
1124
1125
1126

  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)

1127
1128
    if self.TAG_LEVEL == constants.TAG_CLUSTER:
      self.name = None
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1129
    else:
1130
      self.name = items[0]
1131
1132

  def GET(self):
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1133
    """Returns a list of tags.
1134
1135
1136
1137

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

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

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1141
  def PUT(self):
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1142
    """Add a set of tags.
1143

Iustin Pop's avatar
Iustin Pop committed
1144
1145
    The request as a list of strings should be PUT to this URI. And
    you'll have back a job id.
1146
1147

    """
Iustin Pop's avatar
Iustin Pop committed
1148
    # pylint: disable-msg=W0212
Iustin Pop's avatar
Iustin Pop committed
1149
1150
1151
    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
1152
    return baserlib._Tags_PUT(self.TAG_LEVEL,
Iustin Pop's avatar
Iustin Pop committed
1153
1154
                              self.queryargs['tag'], name=self.name,
                              dry_run=bool(self.dryRun()))
1155
1156
1157
1158

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

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1159
    In order to delete a set of tags, the DELETE
Iustin Pop's avatar
Iustin Pop committed
1160
    request should be addressed to URI like:
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1161
    /tags?tag=[tag]&tag=[tag]
1162
1163

    """
Iustin Pop's avatar
Iustin Pop committed
1164
    # pylint: disable-msg=W0212
1165
    if 'tag' not in self.queryargs:
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1166
      # no we not gonna delete all tags
Iustin Pop's avatar
Iustin Pop committed
1167
1168
      raise http.HttpBadRequest("Cannot delete all tags - please specify"
                                " tag(s) using the 'tag' parameter")
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1169
    return baserlib._Tags_DELETE(self.TAG_LEVEL,
1170
                                 self.queryargs['tag'],
Iustin Pop's avatar
Iustin Pop committed
1171
1172
                                 name=self.name,
                                 dry_run=bool(self.dryRun()))
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199


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