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

4
# Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011 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
G_FIELDS = ["name", "uuid",
77
            "alloc_policy",
78
            "node_cnt", "node_list",
79
80
            "ctime", "mtime", "serial_no",
            ]  # "tags" is missing to be able to use _COMMON_FIELDS here.
81

82
83
84
85
86
87
88
89
90
91
92
93
94
95
_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,
  }

96
97
98
# Request data version field
_REQ_DATA_VERSION = "__version__"

99
100
101
# Feature string for instance creation request data version 1
_INST_CREATE_REQV1 = "instance-create-reqv1"

102
103
104
# Feature string for instance reinstall request version 1
_INST_REINSTALL_REQV1 = "instance-reinstall-reqv1"

105
106
107
# 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
108
109
110
111
112
113
114
115

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

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

  """
116
117
  @staticmethod
  def GET():
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
118
119
120
121
122
123
124
    """Returns the remote API version.

    """
    return constants.RAPI_VERSION


class R_2_info(baserlib.R_Generic):
125
  """/2/info resource.
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
126
127

  """
128
129
  @staticmethod
  def GET():
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
130
131
132
    """Returns cluster information.

    """
Iustin Pop's avatar
Iustin Pop committed
133
    client = baserlib.GetClient()
134
    return client.QueryClusterInfo()
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
135
136


137
138
139
140
141
142
143
144
145
class R_2_features(baserlib.R_Generic):
  """/2/features resource.

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

    """
146
    return [_INST_CREATE_REQV1, _INST_REINSTALL_REQV1]
147
148


Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
149
150
151
152
class R_2_os(baserlib.R_Generic):
  """/2/os resource.

  """
153
154
  @staticmethod
  def GET():
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
155
156
157
158
159
160
161
    """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
162
    cl = baserlib.GetClient()
163
    op = opcodes.OpDiagnoseOS(output_fields=["name", "variants"], names=[])
Iustin Pop's avatar
Iustin Pop committed
164
165
166
167
    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
168
169

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

172
    os_names = []
173
174
    for (name, variants) in diagnose_data:
      os_names.extend(cli.CalculateOSNames(name, variants))
175
176

    return os_names
177

178

179
180
181
182
class R_2_redist_config(baserlib.R_Generic):
  """/2/redistribute-config resource.

  """
183
184
  @staticmethod
  def PUT():
185
186
187
    """Redistribute configuration to all nodes.

    """
188
    return baserlib.SubmitJob([opcodes.OpClusterRedistConf()])
189
190


191
192
193
194
195
196
197
198
199
200
class R_2_cluster_modify(baserlib.R_Generic):
  """/2/modify resource.

  """
  def PUT(self):
    """Modifies cluster parameters.

    @return: a job id

    """
201
    op = baserlib.FillOpcode(opcodes.OpClusterSetParams, self.request_body,
202
203
204
205
206
                             None)

    return baserlib.SubmitJob([op])


207
208
209
210
class R_2_jobs(baserlib.R_Generic):
  """/2/jobs resource.

  """
211
212
  @staticmethod
  def GET():
213
214
    """Returns a dictionary of jobs.

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

217
218
    """
    fields = ["id"]
Iustin Pop's avatar
Iustin Pop committed
219
    cl = baserlib.GetClient()
220
    # Convert the list of lists to the list of ids
Iustin Pop's avatar
Iustin Pop committed
221
    result = [job_id for [job_id] in cl.QueryJobs(None, fields)]
222
223
    return baserlib.BuildUriList(result, "/2/jobs/%s",
                                 uri_fields=("id", "uri"))
224
225
226
227
228
229
230
231
232


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
233
234
235
236
237
238
239
240
    @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
241

242
    """
Iustin Pop's avatar
Iustin Pop committed
243
244
245
246
    fields = ["id", "ops", "status", "summary",
              "opstatus", "opresult", "oplog",
              "received_ts", "start_ts", "end_ts",
              ]
247
    job_id = self.items[0]
Iustin Pop's avatar
Iustin Pop committed
248
    result = baserlib.GetClient().QueryJobs([job_id, ], fields)[0]
Iustin Pop's avatar
Iustin Pop committed
249
250
    if result is None:
      raise http.HttpNotFound()
251
252
    return baserlib.MapFields(fields, result)

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
253
254
255
256
257
  def DELETE(self):
    """Cancel not-yet-started job.

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

261

262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
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,
      }


311
312
313
314
315
316
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
317

318
    """
Iustin Pop's avatar
Iustin Pop committed
319
    client = baserlib.GetClient()
Iustin Pop's avatar
Iustin Pop committed
320

321
    if self.useBulk():
322
      bulkdata = client.QueryNodes([], N_FIELDS, False)
323
      return baserlib.MapBulkFields(bulkdata, N_FIELDS)
324
325
326
327
328
    else:
      nodesdata = client.QueryNodes([], ["name"], False)
      nodeslist = [row[0] for row in nodesdata]
      return baserlib.BuildUriList(nodeslist, "/2/nodes/%s",
                                   uri_fields=("id", "uri"))
329
330


Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
331
class R_2_nodes_name(baserlib.R_Generic):
332
  """/2/nodes/[node_name] resource.
333
334

  """
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
335
336
337
338
339
  def GET(self):
    """Send information about a node.

    """
    node_name = self.items[0]
Iustin Pop's avatar
Iustin Pop committed
340
    client = baserlib.GetClient()
341
342
343
344

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

    return baserlib.MapFields(N_FIELDS, result[0])
347
348


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
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

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

    node_name = self.items[0]
376
    role = self.request_body
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406

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


407
408
409
410
411
412
413
414
415
416
417
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)
418
419
    early_r = bool(self._checkIntVariable("early_release", default=0))
    dry_run = bool(self.dryRun())
420

421
    cl = baserlib.GetClient()
422

423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
    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
444
445


446
class R_2_nodes_name_migrate(baserlib.R_Generic):
447
  """/2/nodes/[node_name]/migrate resource.
448
449
450
451
452
453
454
455

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

    """
    node_name = self.items[0]

456
457
458
459
460
461
462
463
464
465
466
467
    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)
468
469
470
471

    return baserlib.SubmitJob([op])


472
class R_2_nodes_name_storage(baserlib.R_Generic):
473
  """/2/nodes/[node_name]/storage resource.
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497

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


498
class R_2_nodes_name_storage_modify(baserlib.R_Generic):
499
  """/2/nodes/[node_name]/storage/modify resource.
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527

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


528
class R_2_nodes_name_storage_repair(baserlib.R_Generic):
529
  """/2/nodes/[node_name]/storage/repair resource.
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550

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


551
552
553
def _ParseCreateGroupRequest(data, dry_run):
  """Parses a request for creating a node group.

Iustin Pop's avatar
Iustin Pop committed
554
  @rtype: L{opcodes.OpGroupAdd}
555
556
557
558
559
560
  @return: Group creation opcode

  """
  group_name = baserlib.CheckParameter(data, "name")
  alloc_policy = baserlib.CheckParameter(data, "alloc_policy", default=None)

Iustin Pop's avatar
Iustin Pop committed
561
  return opcodes.OpGroupAdd(group_name=group_name,
562
563
564
565
                            alloc_policy=alloc_policy,
                            dry_run=dry_run)


566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
class R_2_groups(baserlib.R_Generic):
  """/2/groups resource.

  """
  def GET(self):
    """Returns a list of all node groups.

    """
    client = baserlib.GetClient()

    if self.useBulk():
      bulkdata = client.QueryGroups([], G_FIELDS, False)
      return baserlib.MapBulkFields(bulkdata, G_FIELDS)
    else:
      data = client.QueryGroups([], ["name"], False)
      groupnames = [row[0] for row in data]
      return baserlib.BuildUriList(groupnames, "/2/groups/%s",
                                   uri_fields=("name", "uri"))

585
586
587
588
589
590
591
  def POST(self):
    """Create a node group.

    @return: a job id

    """
    baserlib.CheckType(self.request_body, dict, "Body contents")
592
    op = _ParseCreateGroupRequest(self.request_body, self.dryRun())
593
594
    return baserlib.SubmitJob([op])

595
596

class R_2_groups_name(baserlib.R_Generic):
597
  """/2/groups/[group_name] resource.
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612

  """
  def GET(self):
    """Send information about a node group.

    """
    group_name = self.items[0]
    client = baserlib.GetClient()

    result = baserlib.HandleItemQueryErrors(client.QueryGroups,
                                            names=[group_name], fields=G_FIELDS,
                                            use_locking=self.useLocking())

    return baserlib.MapFields(G_FIELDS, result[0])

613
614
615
616
  def DELETE(self):
    """Delete a node group.

    """
617
    op = opcodes.OpGroupRemove(group_name=self.items[0],
618
619
620
621
622
                               dry_run=bool(self.dryRun()))

    return baserlib.SubmitJob([op])


623
624
625
def _ParseModifyGroupRequest(name, data):
  """Parses a request for modifying a node group.

626
  @rtype: L{opcodes.OpGroupSetParams}
627
628
629
630
  @return: Group modify opcode

  """
  alloc_policy = baserlib.CheckParameter(data, "alloc_policy", default=None)
631
  return opcodes.OpGroupSetParams(group_name=name, alloc_policy=alloc_policy)
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650


class R_2_groups_name_modify(baserlib.R_Generic):
  """/2/groups/[group_name]/modify resource.

  """
  def PUT(self):
    """Changes some parameters of node group.

    @return: a job id

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

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

    return baserlib.SubmitJob([op])


651
652
653
654
655
656
657
658
659
660
def _ParseRenameGroupRequest(name, data, dry_run):
  """Parses a request for renaming a node group.

  @type name: string
  @param name: name of the node group to rename
  @type data: dict
  @param data: the body received by the rename request
  @type dry_run: bool
  @param dry_run: whether to perform a dry run

661
  @rtype: L{opcodes.OpGroupRename}
662
663
664
665
666
667
  @return: Node group rename opcode

  """
  old_name = name
  new_name = baserlib.CheckParameter(data, "new_name")

668
  return opcodes.OpGroupRename(old_name=old_name, new_name=new_name,
669
670
671
672
                               dry_run=dry_run)


class R_2_groups_name_rename(baserlib.R_Generic):
673
  """/2/groups/[group_name]/rename resource.
674
675
676
677
678
679
680
681
682
683
684
685

  """
  def PUT(self):
    """Changes the name of a node group.

    @return: a job id

    """
    baserlib.CheckType(self.request_body, dict, "Body contents")
    op = _ParseRenameGroupRequest(self.items[0], self.request_body,
                                  self.dryRun())
    return baserlib.SubmitJob([op])
686
687


688
class R_2_groups_name_assign_nodes(baserlib.R_Generic):
689
  """/2/groups/[group_name]/assign-nodes resource.
690
691
692
693
694
695
696
697

  """
  def PUT(self):
    """Assigns nodes to a group.

    @return: a job id

    """
698
    op = baserlib.FillOpcode(opcodes.OpGroupAssignNodes, self.request_body, {
699
700
701
702
703
704
705
706
      "group_name": self.items[0],
      "dry_run": self.dryRun(),
      "force": self.useForce(),
      })

    return baserlib.SubmitJob([op])


707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
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:
723
      size = i[constants.IDISK_SIZE]
724
725
726
727
728
    except KeyError:
      raise http.HttpBadRequest("Disk %d specification wrong: missing disk"
                                " size" % idx)

    disk = {
729
      constants.IDISK_SIZE: size,
730
731
732
733
      }

    # Optional disk access mode
    try:
734
      disk_access = i[constants.IDISK_MODE]
735
736
737
    except KeyError:
      pass
    else:
738
      disk[constants.IDISK_MODE] = disk_access
739
740
741
742
743
744
745
746
747
748
749
750
751
752

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

753
    for field in constants.INIC_PARAMS:
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
      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"),
775
776
    os_type=baserlib.CheckParameter(data, "os"),
    osparams=baserlib.CheckParameter(data, "osparams", default={}),
777
778
    force_variant=baserlib.CheckParameter(data, "force_variant",
                                          default=False),
779
    no_install=baserlib.CheckParameter(data, "no_install", default=False),
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
    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),
795
796
797
798
799
800
    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),
801
802
803
804
805
806
807
808
    iallocator=baserlib.CheckParameter(data, "iallocator", default=None),
    hypervisor=baserlib.CheckParameter(data, "hypervisor", default=None),
    hvparams=hvparams,
    beparams=beparams,
    dry_run=dry_run,
    )


809
810
811
812
813
814
815
816
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
817
    client = baserlib.GetClient()
818

819
820
821
    use_locking = self.useLocking()
    if self.useBulk():
      bulkdata = client.QueryInstances([], I_FIELDS, use_locking)
822
      return baserlib.MapBulkFields(bulkdata, I_FIELDS)
823
    else:
824
      instancesdata = client.QueryInstances([], ["name"], use_locking)
825
      instanceslist = [row[0] for row in instancesdata]
826
827
828
      return baserlib.BuildUriList(instanceslist, "/2/instances/%s",
                                   uri_fields=("id", "uri"))

829
830
  def _ParseVersion0CreateRequest(self):
    """Parses an instance creation request version 0.
831

832
    Request data version 0 is deprecated and should not be used anymore.
833

834
835
    @rtype: L{opcodes.OpCreateInstance}
    @return: Instance creation opcode
Iustin Pop's avatar
Iustin Pop committed
836

837
    """
838
    # Do not modify anymore, request data version 0 is deprecated
839
    beparams = baserlib.MakeParamsDict(self.request_body,
Iustin Pop's avatar
Iustin Pop committed
840
                                       constants.BES_PARAMETERS)
841
    hvparams = baserlib.MakeParamsDict(self.request_body,
Iustin Pop's avatar
Iustin Pop committed
842
843
844
845
846
847
848
849
850
851
852
                                       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"
853
                                  " be an integer" % idx)
Iustin Pop's avatar
Iustin Pop committed
854
      disks.append({"size": d})
855

Iustin Pop's avatar
Iustin Pop committed
856
    # nic processing (one nic only)
Guido Trotter's avatar
Guido Trotter committed
857
858
859
860
861
862
863
864
    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:
865
      nics[0]["bridge"] = fn("bridge")
866

867
    # Do not modify anymore, request data version 0 is deprecated
868
    return opcodes.OpCreateInstance(
Iustin Pop's avatar
Iustin Pop committed
869
870
871
872
873
874
875
876
877
878
879
      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),
880
      name_check=fn('name_check', True),
Iustin Pop's avatar
Iustin Pop committed
881
882
883
884
885
      wait_for_sync=True,
      hypervisor=fn('hypervisor', None),
      hvparams=hvparams,
      beparams=beparams,
      file_storage_dir=fn('file_storage_dir', None),
886
      file_driver=fn('file_driver', constants.FD_LOOP),
Iustin Pop's avatar
Iustin Pop committed
887
      dry_run=bool(self.dryRun()),
Iustin Pop's avatar
Iustin Pop committed
888
889
      )

890
891
892
893
894
895
  def POST(self):
    """Create an instance.

    @return: a job id

    """
Luca Bigliardi's avatar
Luca Bigliardi committed
896
    if not isinstance(self.request_body, dict):
897
898
899
900
901
902
903
      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()
904
    elif data_version == 1:
Luca Bigliardi's avatar
Luca Bigliardi committed
905
      op = _ParseInstanceCreateRequestVersion1(self.request_body,
906
                                               self.dryRun())
907
908
    else:
      raise http.HttpBadRequest("Unsupported request data version %s" %
909
                                data_version)
910

Iustin Pop's avatar
Iustin Pop committed
911
    return baserlib.SubmitJob([op])
912

913

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
914
class R_2_instances_name(baserlib.R_Generic):
915
  """/2/instances/[instance_name] resource.
916
917

  """
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
918
919
920
921
  def GET(self):
    """Send information about an instance.

    """
Iustin Pop's avatar
Iustin Pop committed
922
    client = baserlib.GetClient()
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
923
    instance_name = self.items[0]
924
925
926
927
928

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

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

Iustin Pop's avatar
Iustin Pop committed
932
933
934
935
  def DELETE(self):
    """Delete an instance.

    """
Iustin Pop's avatar
Iustin Pop committed
936
    op = opcodes.OpRemoveInstance(instance_name=self.items[0],
Iustin Pop's avatar
Iustin Pop committed
937
938
                                  ignore_failures=False,
                                  dry_run=bool(self.dryRun()))
Iustin Pop's avatar
Iustin Pop committed
939
    return baserlib.SubmitJob([op])
Iustin Pop's avatar
Iustin Pop committed
940

941

942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
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])


958
959
960
961
962
963
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
964
  def POST(self):
965
966
    """Reboot an instance.

967
968
969
    The URI takes type=[hard|soft|full] and
    ignore_secondaries=[False|True] parameters.

970
971
    """
    instance_name = self.items[0]
972
973
    reboot_type = self.queryargs.get('type',
                                     [constants.INSTANCE_REBOOT_HARD])[0]
974
    ignore_secondaries = bool(self._checkIntVariable('ignore_secondaries'))
Iustin Pop's avatar
Iustin Pop committed
975
976
    op = opcodes.OpRebootInstance(instance_name=instance_name,
                                  reboot_type=reboot_type,
Iustin Pop's avatar
Iustin Pop committed
977
978
                                  ignore_secondaries=ignore_secondaries,
                                  dry_run=bool(self.dryRun()))
979

Iustin Pop's avatar
Iustin Pop committed
980
    return baserlib.SubmitJob([op])
981
982


983
984
985
986
987
988
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
989
  def PUT(self):
990
991
    """Startup an instance.

Iustin Pop's avatar
Iustin Pop committed
992
993
    The URI takes force=[False|True] parameter to start the instance
    if even if secondary disks are failing.
994
995
996

    """
    instance_name = self.items[0]
997
    force_startup = bool(self._checkIntVariable('force'))
Iustin Pop's avatar
Iustin Pop committed
998
    op = opcodes.OpStartupInstance(instance_name=instance_name,
Iustin Pop's avatar
Iustin Pop committed
999
1000
                                   force=force_startup,
                                   dry_run=bool(self.dryRun()))
1001

Iustin Pop's avatar
Iustin Pop committed
1002
    return baserlib.SubmitJob([op])
1003
1004
1005
1006
1007
1008
1009
1010


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
1011
  def PUT(self):
1012
1013
1014
1015
    """Shutdown an instance.

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

Iustin Pop's avatar
Iustin Pop committed
1019
    return baserlib.SubmitJob([op])
1020
1021


1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
def _ParseInstanceReinstallRequest(name, data):
  """Parses a request for reinstalling an instance.

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

  ostype = baserlib.CheckParameter(data, "os")
  start = baserlib.CheckParameter(data, "start", exptype=bool,
                                  default=True)
  osparams = baserlib.CheckParameter(data, "osparams", default=None)

  ops = [
    opcodes.OpShutdownInstance(instance_name=name),
    opcodes.OpReinstallInstance(instance_name=name, os_type=ostype,
                                osparams=osparams),
    ]

  if start:
    ops.append(opcodes.OpStartupInstance(instance_name=name, force=False))

  return ops


1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
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.

    """
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
    if self.request_body:
      if self.queryargs:
        raise http.HttpBadRequest("Can't combine query and body parameters")

      body = self.request_body
    else:
      if not self.queryargs:
        raise http.HttpBadRequest("Missing query parameters")
      # Legacy interface, do not modify/extend
      body = {
        "os": self._checkStringVariable("os"),
        "start": not self._checkIntVariable("nostartup"),
        }

    ops = _ParseInstanceReinstallRequest(self.items[0], body)

1076
1077
1078
    return baserlib.SubmitJob(ops)


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


1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
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])


1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
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]

1139
    op = opcodes.OpDeactivateInstanceDisks(instance_name=instance_name)
1140
1141
1142
1143

    return baserlib.SubmitJob([op])


1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
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")

1157
    op = opcodes.OpBackupPrepare(instance_name=instance_name,
1158
1159
1160
1161
1162
1163
1164
1165
                                 mode=mode)

    return baserlib.SubmitJob([op])


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

1166
  @rtype: L{opcodes.OpBackupExport}
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
  @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)

1180
1181
1182
1183
1184
1185
1186
  return opcodes.OpBackupExport(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)
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206


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


1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
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])


1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
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])


1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
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])


1321
class R_2_instances_name_disk_grow(baserlib.R_Generic):
1322
  """/2/instances/[instance_name]/disk/[disk_index]/grow resource.
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338

  """
  def POST(self):
    """Increases the size of an instance disk.

    @return: a job id

    """
    op = baserlib.FillOpcode(opcodes.OpGrowDisk, self.request_body, {
      "instance_name": self.items[0],
      "disk": int(self.items[1]),
      })

    return baserlib.SubmitJob([op])


Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1339
1340
class _R_Tags(baserlib.R_Generic):
  """ Quasiclass for tagging resources
1341

Iustin Pop's avatar
Iustin Pop committed
1342
  Manages tags. When inheriting this class you must define the
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1343
  TAG_LEVEL for it.
1344
1345

  """
Iustin Pop's avatar
Iustin Pop committed
1346
  TAG_LEVEL = None
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1347
1348
1349
1350
1351
1352
1353
1354
1355

  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)

1356
1357
    if self.TAG_LEVEL == constants.TAG_CLUSTER:
      self.name = None
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1358
    else:
1359
      self.name = items[0]
1360
1361

  def GET(self):
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1362
    """Returns a list of tags.
1363
1364
1365
1366

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

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

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1370
  def PUT(self):
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1371
    """Add a set of tags.
1372

Iustin Pop's avatar
Iustin Pop committed
1373
1374
    The request as a list of strings should be PUT to this URI. And
    you'll have back a job id.
1375
1376

    """
Iustin Pop's avatar
Iustin Pop committed
1377
    # pylint: disable-msg=W0212
Iustin Pop's avatar
Iustin Pop committed
1378
1379
1380
    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
1381
    return baserlib._Tags_PUT(self.TAG_LEVEL,
Iustin Pop's avatar
Iustin Pop committed
1382
1383
                              self.queryargs['tag'], name=self.name,
                              dry_run=bool(self.dryRun()))
1384
1385
1386
1387

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

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1388
    In order to delete a set of tags, the DELETE
Iustin Pop's avatar
Iustin Pop committed
1389
    request should be addressed to URI like:
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1390
    /tags?tag=[tag]&tag=[tag]
1391
1392

    """
Iustin Pop's avatar
Iustin Pop committed
1393
    # pylint: disable-msg=W0212
1394
    if 'tag' not in self.queryargs:
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1395
      # no we not gonna delete all tags
Iustin Pop's avatar
Iustin Pop committed
1396
1397
      raise http.HttpBadRequest("Cannot delete all tags - please specify"
                                " tag(s) using the 'tag' parameter")
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1398
    return baserlib._Tags_DELETE(self.TAG_LEVEL,
1399
                                 self.queryargs['tag'],
Iustin Pop's avatar
Iustin Pop committed
1400
1401
                                 name=self.name,
                                 dry_run=bool(self.dryRun()))
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422


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):
1423
  """ /2/tags resource.
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
1424
1425
1426
1427
1428

  Manages cluster tags.

  """
  TAG_LEVEL = constants.TAG_CLUSTER