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

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


"""Remote API version 2 baserlib.library.

"""

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

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
32

Iustin Pop's avatar
Iustin Pop committed
33

34
35
36
37
I_FIELDS = ["name", "admin_state", "os",
            "pnode", "snodes",
            "disk_template",
            "nic.ips", "nic.macs", "nic.bridges",
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
49
            "pinst_cnt", "sinst_cnt", "tags",
            "ctotal", "cnodes", "csockets",
            ]
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78


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

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

  """
  DOC_URI = "/version"

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

    """
    return constants.RAPI_VERSION


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

  """
  DOC_URI = "/2/info"

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

    Example::

Iustin Pop's avatar
Iustin Pop committed
79
80
81
    {
      "config_version": 2000000,
      "name": "cluster",
Iustin Pop's avatar
Iustin Pop committed
82
      "software_version": "2.0.0~beta2",
Iustin Pop's avatar
Iustin Pop committed
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
      "os_api_version": 10,
      "export_version": 0,
      "candidate_pool_size": 10,
      "enabled_hypervisors": [
        "fake"
      ],
      "hvparams": {
        "fake": {}
       },
      "default_hypervisor": "fake",
      "master": "node1.example.com",
      "architecture": [
        "64bit",
        "x86_64"
      ],
      "protocol_version": 20,
      "beparams": {
        "default": {
          "auto_balance": true,
          "vcpus": 1,
          "memory": 128
         }
        }
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
106
107
108
      }

    """
Iustin Pop's avatar
Iustin Pop committed
109
    client = baserlib.GetClient()
110
    return client.QueryClusterInfo()
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126


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

  """
  DOC_URI = "/2/os"

  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
127
128
129
130
131
132
    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
133
134

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

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

139
140
141
142
143
144
145
146
147
148

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

  """
  DOC_URI = "/2/jobs"

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

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

151
152
    """
    fields = ["id"]
Iustin Pop's avatar
Iustin Pop committed
153
    cl = baserlib.GetClient()
154
    # Convert the list of lists to the list of ids
Iustin Pop's avatar
Iustin Pop committed
155
    result = [job_id for [job_id] in cl.QueryJobs(None, fields)]
156
157
    return baserlib.BuildUriList(result, "/2/jobs/%s",
                                 uri_fields=("id", "uri"))
158
159
160
161
162
163
164
165
166
167
168


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

  """
  DOC_URI = "/2/jobs/[job_id]"

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

Iustin Pop's avatar
Iustin Pop committed
169
170
171
172
173
174
175
176
    @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
177

178
    """
Iustin Pop's avatar
Iustin Pop committed
179
180
181
182
    fields = ["id", "ops", "status", "summary",
              "opstatus", "opresult", "oplog",
              "received_ts", "start_ts", "end_ts",
              ]
183
    job_id = self.items[0]
Iustin Pop's avatar
Iustin Pop committed
184
    result = baserlib.GetClient().QueryJobs([job_id, ], fields)[0]
Iustin Pop's avatar
Iustin Pop committed
185
186
    if result is None:
      raise http.HttpNotFound()
187
188
    return baserlib.MapFields(fields, result)

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
189
190
191
192
193
  def DELETE(self):
    """Cancel not-yet-started job.

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

197
198
199
200
201
202

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

  """
  DOC_URI = "/2/nodes"
Iustin Pop's avatar
Iustin Pop committed
203

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

Iustin Pop's avatar
Iustin Pop committed
207
    Example::
208

Iustin Pop's avatar
Iustin Pop committed
209
      [
210
211
212
213
214
215
216
        {
          "id": "node1.example.com",
          "uri": "\/instances\/node1.example.com"
        },
        {
          "id": "node2.example.com",
          "uri": "\/instances\/node2.example.com"
Iustin Pop's avatar
Iustin Pop committed
217
218
        }
      ]
219

Iustin Pop's avatar
Iustin Pop committed
220
    If the optional 'bulk' argument is provided and set to 'true'
221
222
223
    value (i.e '?bulk=1'), the output contains detailed
    information about nodes as a list.

Iustin Pop's avatar
Iustin Pop committed
224
225
226
    Example::

      [
227
228
229
230
231
232
233
234
235
        {
          "pinst_cnt": 1,
          "mfree": 31280,
          "mtotal": 32763,
          "name": "www.example.com",
          "tags": [],
          "mnode": 512,
          "dtotal": 5246208,
          "sinst_cnt": 2,
236
237
          "dfree": 5171712,
          "offline": false
238
239
        },
        ...
Iustin Pop's avatar
Iustin Pop committed
240
241
242
      ]

    @return: a dictionary with 'name' and 'uri' keys for each of them
243
244

    """
Iustin Pop's avatar
Iustin Pop committed
245
    client = baserlib.GetClient()
Iustin Pop's avatar
Iustin Pop committed
246

247
    if self.useBulk():
248
      bulkdata = client.QueryNodes([], N_FIELDS, False)
249
      return baserlib.MapBulkFields(bulkdata, N_FIELDS)
250
251
252
253
254
    else:
      nodesdata = client.QueryNodes([], ["name"], False)
      nodeslist = [row[0] for row in nodesdata]
      return baserlib.BuildUriList(nodeslist, "/2/nodes/%s",
                                   uri_fields=("id", "uri"))
255
256


Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
257
258
class R_2_nodes_name(baserlib.R_Generic):
  """/2/nodes/[node_name] resources.
259
260

  """
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
261
262
263
264
265
266
267
  DOC_URI = "/nodes/[node_name]"

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

    """
    node_name = self.items[0]
Iustin Pop's avatar
Iustin Pop committed
268
    client = baserlib.GetClient()
269
    result = client.QueryNodes(names=[node_name], fields=N_FIELDS,
270
                               use_locking=self.useLocking())
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
271
272

    return baserlib.MapFields(N_FIELDS, result[0])
273
274


275
276
277
278
279
280
281
282
283
284
class R_2_instances(baserlib.R_Generic):
  """/2/instances resource.

  """
  DOC_URI = "/2/instances"

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


Iustin Pop's avatar
Iustin Pop committed
285
286
287
    Example::

      [
288
289
290
291
292
293
294
        {
          "name": "web.example.com",
          "uri": "\/instances\/web.example.com"
        },
        {
          "name": "mail.example.com",
          "uri": "\/instances\/mail.example.com"
Iustin Pop's avatar
Iustin Pop committed
295
296
        }
      ]
297
298
299
300
301

    If the optional 'bulk' argument is provided and set to 'true'
    value (i.e '?bulk=1'), the output contains detailed
    information about instances as a list.

Iustin Pop's avatar
Iustin Pop committed
302
303
304
    Example::

      [
305
306
        {
           "status": "running",
Iustin Pop's avatar
Iustin Pop committed
307
308
309
310
           "disk_usage": 20480,
           "nic.bridges": [
             "xen-br0"
            ],
311
312
           "name": "web.example.com",
           "tags": ["tag1", "tag2"],
Iustin Pop's avatar
Iustin Pop committed
313
314
315
316
317
318
319
           "beparams": {
             "vcpus": 2,
             "memory": 512
           },
           "disk.sizes": [
               20480
           ],
320
           "pnode": "node1.example.com",
Iustin Pop's avatar
Iustin Pop committed
321
           "nic.macs": ["01:23:45:67:89:01"],
322
323
324
325
326
327
328
           "snodes": ["node2.example.com"],
           "disk_template": "drbd",
           "admin_state": true,
           "os": "debian-etch",
           "oper_state": true
        },
        ...
Iustin Pop's avatar
Iustin Pop committed
329
330
      ]

Iustin Pop's avatar
Iustin Pop committed
331
    @return: a dictionary with 'name' and 'uri' keys for each of them.
332
333

    """
Iustin Pop's avatar
Iustin Pop committed
334
    client = baserlib.GetClient()
335

336
337
338
    use_locking = self.useLocking()
    if self.useBulk():
      bulkdata = client.QueryInstances([], I_FIELDS, use_locking)
339
      return baserlib.MapBulkFields(bulkdata, I_FIELDS)
340
    else:
341
      instancesdata = client.QueryInstances([], ["name"], use_locking)
342
      instanceslist = [row[0] for row in instancesdata]
343
344
345
      return baserlib.BuildUriList(instanceslist, "/2/instances/%s",
                                   uri_fields=("id", "uri"))

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
346
  def POST(self):
347
348
    """Create an instance.

Iustin Pop's avatar
Iustin Pop committed
349
    @return: a job id
350
351

    """
Iustin Pop's avatar
Iustin Pop committed
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
    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)
    nics = [{"mac": fn("mac", constants.VALUE_AUTO),
             "ip": fn("ip", None),
             "bridge": fn("bridge", None)}]
375

Iustin Pop's avatar
Iustin Pop committed
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
    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'),
      )

    return baserlib.SubmitJob([op])
397

398

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
399
400
class R_2_instances_name(baserlib.R_Generic):
  """/2/instances/[instance_name] resources.
401
402

  """
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
403
404
405
406
407
408
  DOC_URI = "/2/instances/[instance_name]"

  def GET(self):
    """Send information about an instance.

    """
Iustin Pop's avatar
Iustin Pop committed
409
    client = baserlib.GetClient()
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
410
    instance_name = self.items[0]
411
    result = client.QueryInstances(names=[instance_name], fields=I_FIELDS,
412
                                   use_locking=self.useLocking())
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
413
414

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

Iustin Pop's avatar
Iustin Pop committed
416
417
418
419
  def DELETE(self):
    """Delete an instance.

    """
Iustin Pop's avatar
Iustin Pop committed
420
421
422
    op = opcodes.OpRemoveInstance(instance_name=self.items[0],
                                  ignore_failures=False)
    return baserlib.SubmitJob([op])
Iustin Pop's avatar
Iustin Pop committed
423

424

425
426
427
428
429
430
431
432
433
class R_2_instances_name_reboot(baserlib.R_Generic):
  """/2/instances/[instance_name]/reboot resource.

  Implements an instance reboot.

  """

  DOC_URI = "/2/instances/[instance_name]/reboot"

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
434
  def POST(self):
435
436
    """Reboot an instance.

437
438
439
    The URI takes type=[hard|soft|full] and
    ignore_secondaries=[False|True] parameters.

440
441
    """
    instance_name = self.items[0]
442
443
    reboot_type = self.queryargs.get('type',
                                     [constants.INSTANCE_REBOOT_HARD])[0]
444
    ignore_secondaries = bool(self._checkIntVariable('ignore_secondaries'))
Iustin Pop's avatar
Iustin Pop committed
445
446
447
    op = opcodes.OpRebootInstance(instance_name=instance_name,
                                  reboot_type=reboot_type,
                                  ignore_secondaries=ignore_secondaries)
448

Iustin Pop's avatar
Iustin Pop committed
449
    return baserlib.SubmitJob([op])
450
451


452
453
454
455
456
457
458
459
460
class R_2_instances_name_startup(baserlib.R_Generic):
  """/2/instances/[instance_name]/startup resource.

  Implements an instance startup.

  """

  DOC_URI = "/2/instances/[instance_name]/startup"

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
461
  def PUT(self):
462
463
    """Startup an instance.

Iustin Pop's avatar
Iustin Pop committed
464
465
    The URI takes force=[False|True] parameter to start the instance
    if even if secondary disks are failing.
466
467
468

    """
    instance_name = self.items[0]
469
    force_startup = bool(self._checkIntVariable('force'))
Iustin Pop's avatar
Iustin Pop committed
470
471
    op = opcodes.OpStartupInstance(instance_name=instance_name,
                                   force=force_startup)
472

Iustin Pop's avatar
Iustin Pop committed
473
    return baserlib.SubmitJob([op])
474
475
476
477
478
479
480
481
482
483
484


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

  Implements an instance shutdown.

  """

  DOC_URI = "/2/instances/[instance_name]/shutdown"

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
485
  def PUT(self):
486
487
488
489
    """Shutdown an instance.

    """
    instance_name = self.items[0]
Iustin Pop's avatar
Iustin Pop committed
490
    op = opcodes.OpShutdownInstance(instance_name=instance_name)
491

Iustin Pop's avatar
Iustin Pop committed
492
    return baserlib.SubmitJob([op])
493
494


495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
class R_2_instances_name_reinstall(baserlib.R_Generic):
  """/2/instances/[instance_name]/reinstall resource.

  Implements an instance reinstall.

  """

  DOC_URI = "/2/instances/[instance_name]/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)


Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
525
526
class _R_Tags(baserlib.R_Generic):
  """ Quasiclass for tagging resources
527

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
528
529
  Manages tags. Inheriting this class you suppose to define DOC_URI and
  TAG_LEVEL for it.
530
531

  """
Iustin Pop's avatar
Iustin Pop committed
532
  TAG_LEVEL = None
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
533
534
535
536
537
538
539
540
541
542
543
544
545

  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 = ""
546
547

  def GET(self):
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
548
    """Returns a list of tags.
549
550
551
552

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

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

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
555
  def PUT(self):
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
556
    """Add a set of tags.
557

Iustin Pop's avatar
Iustin Pop committed
558
559
    The request as a list of strings should be PUT to this URI. And
    you'll have back a job id.
560
561

    """
Iustin Pop's avatar
Iustin Pop committed
562
563
564
    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
565
    return baserlib._Tags_PUT(self.TAG_LEVEL,
Iustin Pop's avatar
Iustin Pop committed
566
                              self.queryargs['tag'], name=self.name)
567
568
569
570

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

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
571
    In order to delete a set of tags, the DELETE
Iustin Pop's avatar
Iustin Pop committed
572
    request should be addressed to URI like:
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
573
    /tags?tag=[tag]&tag=[tag]
574
575
576

    """
    if 'tag' not in self.queryargs:
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
577
      # no we not gonna delete all tags
Iustin Pop's avatar
Iustin Pop committed
578
579
      raise http.HttpBadRequest("Cannot delete all tags - please specify"
                                " tag(s) using the 'tag' parameter")
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
580
    return baserlib._Tags_DELETE(self.TAG_LEVEL,
581
                                 self.queryargs['tag'],
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
                                 name=self.name)


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

  Manages per-instance tags.

  """
  DOC_URI = "/2/instances/[instance_name]/tags"
  TAG_LEVEL = constants.TAG_INSTANCE


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

  Manages per-node tags.

  """
  DOC_URI = "/2/nodes/[node_name]/tags"
  TAG_LEVEL = constants.TAG_NODE


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

  Manages cluster tags.

  """
  DOC_URI = "/2/tags"
  TAG_LEVEL = constants.TAG_CLUSTER