rlib2.py 19.7 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
#
#

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


"""Remote API version 2 baserlib.library.

"""

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

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
33

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

44
N_FIELDS = ["name", "offline", "master_candidate", "drained",
45
            "dtotal", "dfree",
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
46
            "mtotal", "mnode", "mfree",
47
48
            "pinst_cnt", "sinst_cnt", "tags",
            "ctotal", "cnodes", "csockets",
49
50
            "pip", "sip", "serial_no", "role",
            "pinst_list", "sinst_list",
51
            ]
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
52

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

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

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

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

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

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

    """
    return constants.RAPI_VERSION


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

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

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


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

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

    Can return error 500 in case of a problem.

    Example: ["debian-etch"]

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

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

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

118
119
120
121
122
123
124
125

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

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

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

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


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
144
145
146
147
148
149
150
151
    @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
152

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

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
164
165
166
167
168
  def DELETE(self):
    """Cancel not-yet-started job.

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

172
173
174
175
176
177
178

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
179

180
    """
Iustin Pop's avatar
Iustin Pop committed
181
    client = baserlib.GetClient()
Iustin Pop's avatar
Iustin Pop committed
182

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


Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
193
194
class R_2_nodes_name(baserlib.R_Generic):
  """/2/nodes/[node_name] resources.
195
196

  """
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
197
198
199
200
201
  def GET(self):
    """Send information about a node.

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

    return baserlib.MapFields(N_FIELDS, result[0])
207
208


209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
class R_2_nodes_name_role(baserlib.R_Generic):
  """ /2/nodes/[node_name]/role resource.

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

    @return: Node role

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

    return _NR_MAP[result[0][0]]

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

    @return: a job id

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

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

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

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

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

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

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

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

    return baserlib.SubmitJob([op])


267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
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)

    op = opcodes.OpEvacuateNode(node_name=node_name,
                                remote_node=remote_node,
                                iallocator=iallocator)

    return baserlib.SubmitJob([op])


286
class R_2_nodes_name_migrate(baserlib.R_Generic):
287
  """/2/nodes/[node_name]/migrate resource.
288
289
290
291
292
293
294
295
296
297
298
299
300
301

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

    """
    node_name = self.items[0]
    live = bool(self._checkIntVariable("live", default=1))

    op = opcodes.OpMigrateNode(node_name=node_name, live=live)

    return baserlib.SubmitJob([op])


302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
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])


328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
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])


358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
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])


381
382
383
384
385
386
387
388
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
389
    client = baserlib.GetClient()
390

391
392
393
    use_locking = self.useLocking()
    if self.useBulk():
      bulkdata = client.QueryInstances([], I_FIELDS, use_locking)
394
      return baserlib.MapBulkFields(bulkdata, I_FIELDS)
395
    else:
396
      instancesdata = client.QueryInstances([], ["name"], use_locking)
397
      instanceslist = [row[0] for row in instancesdata]
398
399
400
      return baserlib.BuildUriList(instanceslist, "/2/instances/%s",
                                   uri_fields=("id", "uri"))

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

Iustin Pop's avatar
Iustin Pop committed
404
    @return: a job id
405
406

    """
Iustin Pop's avatar
Iustin Pop committed
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
    if not isinstance(self.req.request_body, dict):
      raise http.HttpBadRequest("Invalid body contents, not a dictionary")

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

    # disk processing
    disk_data = fn('disks')
    if not isinstance(disk_data, list):
      raise http.HttpBadRequest("The 'disks' parameter should be a list")
    disks = []
    for idx, d in enumerate(disk_data):
      if not isinstance(d, int):
        raise http.HttpBadRequest("Disk %d specification wrong: should"
                                  " be an integer")
      disks.append({"size": d})
    # nic processing (one nic only)
Guido Trotter's avatar
Guido Trotter committed
427
428
429
430
431
432
433
434
435
    nics = [{"mac": fn("mac", constants.VALUE_AUTO)}]
    if fn("ip", None) is not None:
      nics[0]["ip"] = fn("ip")
    if fn("mode", None) is not None:
      nics[0]["mode"] = fn("mode")
    if fn("link", None) is not None:
      nics[0]["link"] = fn("link")
    if fn("bridge", None) is not None:
       nics[0]["bridge"] = fn("bridge")
436

Iustin Pop's avatar
Iustin Pop committed
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
    op = opcodes.OpCreateInstance(
      mode=constants.INSTANCE_CREATE,
      instance_name=fn('name'),
      disks=disks,
      disk_template=fn('disk_template'),
      os_type=fn('os'),
      pnode=fn('pnode', None),
      snode=fn('snode', None),
      iallocator=fn('iallocator', None),
      nics=nics,
      start=fn('start', True),
      ip_check=fn('ip_check', True),
      wait_for_sync=True,
      hypervisor=fn('hypervisor', None),
      hvparams=hvparams,
      beparams=beparams,
      file_storage_dir=fn('file_storage_dir', None),
      file_driver=fn('file_driver', 'loop'),
Iustin Pop's avatar
Iustin Pop committed
455
      dry_run=bool(self.dryRun()),
Iustin Pop's avatar
Iustin Pop committed
456
457
458
      )

    return baserlib.SubmitJob([op])
459

460

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
461
462
class R_2_instances_name(baserlib.R_Generic):
  """/2/instances/[instance_name] resources.
463
464

  """
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
465
466
467
468
  def GET(self):
    """Send information about an instance.

    """
Iustin Pop's avatar
Iustin Pop committed
469
    client = baserlib.GetClient()
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
470
    instance_name = self.items[0]
471
    result = client.QueryInstances(names=[instance_name], fields=I_FIELDS,
472
                                   use_locking=self.useLocking())
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
473
474

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

Iustin Pop's avatar
Iustin Pop committed
476
477
478
479
  def DELETE(self):
    """Delete an instance.

    """
Iustin Pop's avatar
Iustin Pop committed
480
    op = opcodes.OpRemoveInstance(instance_name=self.items[0],
Iustin Pop's avatar
Iustin Pop committed
481
482
                                  ignore_failures=False,
                                  dry_run=bool(self.dryRun()))
Iustin Pop's avatar
Iustin Pop committed
483
    return baserlib.SubmitJob([op])
Iustin Pop's avatar
Iustin Pop committed
484

485

486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
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])


502
503
504
505
506
507
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
508
  def POST(self):
509
510
    """Reboot an instance.

511
512
513
    The URI takes type=[hard|soft|full] and
    ignore_secondaries=[False|True] parameters.

514
515
    """
    instance_name = self.items[0]
516
517
    reboot_type = self.queryargs.get('type',
                                     [constants.INSTANCE_REBOOT_HARD])[0]
518
    ignore_secondaries = bool(self._checkIntVariable('ignore_secondaries'))
Iustin Pop's avatar
Iustin Pop committed
519
520
    op = opcodes.OpRebootInstance(instance_name=instance_name,
                                  reboot_type=reboot_type,
Iustin Pop's avatar
Iustin Pop committed
521
522
                                  ignore_secondaries=ignore_secondaries,
                                  dry_run=bool(self.dryRun()))
523

Iustin Pop's avatar
Iustin Pop committed
524
    return baserlib.SubmitJob([op])
525
526


527
528
529
530
531
532
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
533
  def PUT(self):
534
535
    """Startup an instance.

Iustin Pop's avatar
Iustin Pop committed
536
537
    The URI takes force=[False|True] parameter to start the instance
    if even if secondary disks are failing.
538
539
540

    """
    instance_name = self.items[0]
541
    force_startup = bool(self._checkIntVariable('force'))
Iustin Pop's avatar
Iustin Pop committed
542
    op = opcodes.OpStartupInstance(instance_name=instance_name,
Iustin Pop's avatar
Iustin Pop committed
543
544
                                   force=force_startup,
                                   dry_run=bool(self.dryRun()))
545

Iustin Pop's avatar
Iustin Pop committed
546
    return baserlib.SubmitJob([op])
547
548
549
550
551
552
553
554


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
555
  def PUT(self):
556
557
558
559
    """Shutdown an instance.

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

Iustin Pop's avatar
Iustin Pop committed
563
    return baserlib.SubmitJob([op])
564
565


566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
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)


593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
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])


Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
624
625
class _R_Tags(baserlib.R_Generic):
  """ Quasiclass for tagging resources
626

Iustin Pop's avatar
Iustin Pop committed
627
  Manages tags. When inheriting this class you must define the
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
628
  TAG_LEVEL for it.
629
630

  """
Iustin Pop's avatar
Iustin Pop committed
631
  TAG_LEVEL = None
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
632
633
634
635
636
637
638
639
640
641
642
643
644

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

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

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

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

  def GET(self):
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
647
    """Returns a list of tags.
648
649
650
651

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

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

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
654
  def PUT(self):
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
655
    """Add a set of tags.
656

Iustin Pop's avatar
Iustin Pop committed
657
658
    The request as a list of strings should be PUT to this URI. And
    you'll have back a job id.
659
660

    """
Iustin Pop's avatar
Iustin Pop committed
661
662
663
    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
664
    return baserlib._Tags_PUT(self.TAG_LEVEL,
Iustin Pop's avatar
Iustin Pop committed
665
666
                              self.queryargs['tag'], name=self.name,
                              dry_run=bool(self.dryRun()))
667
668
669
670

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

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
671
    In order to delete a set of tags, the DELETE
Iustin Pop's avatar
Iustin Pop committed
672
    request should be addressed to URI like:
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
673
    /tags?tag=[tag]&tag=[tag]
674
675
676

    """
    if 'tag' not in self.queryargs:
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
677
      # no we not gonna delete all tags
Iustin Pop's avatar
Iustin Pop committed
678
679
      raise http.HttpBadRequest("Cannot delete all tags - please specify"
                                " tag(s) using the 'tag' parameter")
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
680
    return baserlib._Tags_DELETE(self.TAG_LEVEL,
681
                                 self.queryargs['tag'],
Iustin Pop's avatar
Iustin Pop committed
682
683
                                 name=self.name,
                                 dry_run=bool(self.dryRun()))
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710


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