gnt-instance 46.7 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
#!/usr/bin/python
#

# Copyright (C) 2006, 2007 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.


22
23
24
25
# pylint: disable-msg=W0401,W0614
# W0401: Wildcard import ganeti.cli
# W0614: Unused import %s from wildcard import (since we need cli)

Iustin Pop's avatar
Iustin Pop committed
26
27
import sys
import os
28
import itertools
29
import simplejson
30
import time
Iustin Pop's avatar
Iustin Pop committed
31
32
33
34
35
36
from cStringIO import StringIO

from ganeti.cli import *
from ganeti import opcodes
from ganeti import constants
from ganeti import utils
37
38
39
40
41
42
43
44
45
from ganeti import errors


_SHUTDOWN_CLUSTER = "cluster"
_SHUTDOWN_NODES_BOTH = "nodes"
_SHUTDOWN_NODES_PRI = "nodes-pri"
_SHUTDOWN_NODES_SEC = "nodes-sec"
_SHUTDOWN_INSTANCES = "instances"

46

47
48
_VALUE_TRUE = "true"

49
#: default list of options for L{ListInstances}
50
_LIST_DEF_FIELDS = [
51
  "name", "hypervisor", "os", "pnode", "status", "oper_ram",
52
53
  ]

54

55
def _ExpandMultiNames(mode, names, client=None):
56
57
58
59
  """Expand the given names using the passed mode.

  For _SHUTDOWN_CLUSTER, all instances will be returned. For
  _SHUTDOWN_NODES_PRI/SEC, all instances having those nodes as
60
  primary/secondary will be returned. For _SHUTDOWN_NODES_BOTH, all
61
62
63
64
  instances having those nodes as either primary or secondary will be
  returned. For _SHUTDOWN_INSTANCES, the given instances will be
  returned.

65
66
67
68
69
70
71
72
73
74
75
76
  @param mode: one of L{_SHUTDOWN_CLUSTER}, L{_SHUTDOWN_NODES_BOTH},
      L{_SHUTDOWN_NODES_PRI}, L{_SHUTDOWN_NODES_SEC} or
      L{_SHUTDOWN_INSTANCES}
  @param names: a list of names; for cluster, it must be empty,
      and for node and instance it must be a list of valid item
      names (short names are valid as usual, e.g. node1 instead of
      node1.example.com)
  @rtype: list
  @return: the list of names after the expansion
  @raise errors.ProgrammerError: for unknown selection type
  @raise errors.OpPrereqError: for invalid input parameters

77
  """
78
79
  if client is None:
    client = GetClient()
80
81
  if mode == _SHUTDOWN_CLUSTER:
    if names:
82
83
      raise errors.OpPrereqError("Cluster filter mode takes no arguments",
                                 errors.ECODE_INVAL)
84
    idata = client.QueryInstances([], ["name"], False)
85
86
87
88
89
90
    inames = [row[0] for row in idata]

  elif mode in (_SHUTDOWN_NODES_BOTH,
                _SHUTDOWN_NODES_PRI,
                _SHUTDOWN_NODES_SEC):
    if not names:
91
      raise errors.OpPrereqError("No node names passed", errors.ECODE_INVAL)
92
    ndata = client.QueryNodes(names, ["name", "pinst_list", "sinst_list"],
93
                              False)
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
    ipri = [row[1] for row in ndata]
    pri_names = list(itertools.chain(*ipri))
    isec = [row[2] for row in ndata]
    sec_names = list(itertools.chain(*isec))
    if mode == _SHUTDOWN_NODES_BOTH:
      inames = pri_names + sec_names
    elif mode == _SHUTDOWN_NODES_PRI:
      inames = pri_names
    elif mode == _SHUTDOWN_NODES_SEC:
      inames = sec_names
    else:
      raise errors.ProgrammerError("Unhandled shutdown type")

  elif mode == _SHUTDOWN_INSTANCES:
    if not names:
109
110
      raise errors.OpPrereqError("No instance names passed",
                                 errors.ECODE_INVAL)
111
    idata = client.QueryInstances(names, ["name"], False)
112
113
114
    inames = [row[0] for row in idata]

  else:
115
    raise errors.OpPrereqError("Unknown mode '%s'" % mode, errors.ECODE_INVAL)
116
117

  return inames
Iustin Pop's avatar
Iustin Pop committed
118
119


120
def _ConfirmOperation(inames, text, extra=""):
121
122
123
124
125
  """Ask the user to confirm an operation on a list of instances.

  This function is used to request confirmation for doing an operation
  on a given list of instances.

126
127
128
129
130
131
132
133
  @type inames: list
  @param inames: the list of names that we display when
      we ask for confirmation
  @type text: str
  @param text: the operation that the user should confirm
      (e.g. I{shutdown} or I{startup})
  @rtype: boolean
  @return: True or False depending on user's confirmation.
134
135
136

  """
  count = len(inames)
137
138
  msg = ("The %s will operate on %d instances.\n%s"
         "Do you want to continue?" % (text, count, extra))
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
  affected = ("\nAffected instances:\n" +
              "\n".join(["  %s" % name for name in inames]))

  choices = [('y', True, 'Yes, execute the %s' % text),
             ('n', False, 'No, abort the %s' % text)]

  if count > 20:
    choices.insert(1, ('v', 'v', 'View the list of affected instances'))
    ask = msg
  else:
    ask = msg + affected

  choice = AskUser(ask, choices)
  if choice == 'v':
    choices.pop(1)
154
    choice = AskUser(msg + affected, choices)
155
156
157
  return choice


158
159
160
161
162
163
def _EnsureInstancesExist(client, names):
  """Check for and ensure the given instance names exist.

  This function will raise an OpPrereqError in case they don't
  exist. Otherwise it will exit cleanly.

Iustin Pop's avatar
Iustin Pop committed
164
  @type client: L{ganeti.luxi.Client}
165
166
167
168
169
170
171
172
  @param client: the client to use for the query
  @type names: list
  @param names: the list of instance names to query
  @raise errors.OpPrereqError: in case any instance is missing

  """
  # TODO: change LUQueryInstances to that it actually returns None
  # instead of raising an exception, or devise a better mechanism
173
  result = client.QueryInstances(names, ["name"], False)
174
175
  for orig_name, row in zip(names, result):
    if row[0] is None:
176
177
      raise errors.OpPrereqError("Instance '%s' does not exist" % orig_name,
                                 errors.ECODE_NOENT)
178
179


180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
def GenericManyOps(operation, fn):
  """Generic multi-instance operations.

  The will return a wrapper that processes the options and arguments
  given, and uses the passed function to build the opcode needed for
  the specific operation. Thus all the generic loop/confirmation code
  is abstracted into this function.

  """
  def realfn(opts, args):
    if opts.multi_mode is None:
      opts.multi_mode = _SHUTDOWN_INSTANCES
    cl = GetClient()
    inames = _ExpandMultiNames(opts.multi_mode, args, client=cl)
    if not inames:
      raise errors.OpPrereqError("Selection filter does not match"
196
                                 " any instances", errors.ECODE_INVAL)
197
198
199
200
201
202
203
204
205
206
207
208
209
    multi_on = opts.multi_mode != _SHUTDOWN_INSTANCES or len(inames) > 1
    if not (opts.force_multi or not multi_on
            or _ConfirmOperation(inames, operation)):
      return 1
    jex = JobExecutor(verbose=multi_on, cl=cl)
    for name in inames:
      op = fn(name, opts)
      jex.QueueJob(name, op)
    jex.WaitOrShow(not opts.submit_only)
    return 0
  return realfn


Iustin Pop's avatar
Iustin Pop committed
210
def ListInstances(opts, args):
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
211
  """List instances and their properties.
Iustin Pop's avatar
Iustin Pop committed
212

213
214
215
216
217
218
  @param opts: the command line options selected by the user
  @type args: list
  @param args: should be an empty list
  @rtype: int
  @return: the desired exit code

Iustin Pop's avatar
Iustin Pop committed
219
220
  """
  if opts.output is None:
221
222
223
    selected_fields = _LIST_DEF_FIELDS
  elif opts.output.startswith("+"):
    selected_fields = _LIST_DEF_FIELDS + opts.output[1:].split(",")
Iustin Pop's avatar
Iustin Pop committed
224
225
226
  else:
    selected_fields = opts.output.split(",")

227
  output = GetClient().QueryInstances(args, selected_fields, opts.do_locking)
Iustin Pop's avatar
Iustin Pop committed
228
229

  if not opts.no_headers:
230
231
232
    headers = {
      "name": "Instance", "os": "OS", "pnode": "Primary_node",
      "snodes": "Secondary_Nodes", "admin_state": "Autostart",
Iustin Pop's avatar
Iustin Pop committed
233
      "oper_state": "Running",
234
      "oper_ram": "Memory", "disk_template": "Disk_template",
235
      "ip": "IP_address", "mac": "MAC_address",
236
      "nic_mode": "NIC_Mode", "nic_link": "NIC_Link",
Iustin Pop's avatar
Iustin Pop committed
237
      "bridge": "Bridge",
238
      "sda_size": "Disk/0", "sdb_size": "Disk/1",
239
      "disk_usage": "DiskUsage",
240
      "status": "Status", "tags": "Tags",
241
      "network_port": "Network_port",
242
243
      "hv/kernel_path": "Kernel_path",
      "hv/initrd_path": "Initrd_path",
Iustin Pop's avatar
Iustin Pop committed
244
245
246
247
248
249
      "hv/boot_order": "Boot_order",
      "hv/acpi": "ACPI",
      "hv/pae": "PAE",
      "hv/cdrom_image_path": "CDROM_image_path",
      "hv/nic_type": "NIC_type",
      "hv/disk_type": "Disk_type",
250
      "hv/vnc_bind_address": "VNC_bind_address",
251
      "serial_no": "SerialNo", "hypervisor": "Hypervisor",
252
      "hvparams": "Hypervisor_parameters",
Iustin Pop's avatar
Iustin Pop committed
253
254
      "be/memory": "Configured_memory",
      "be/vcpus": "VCPUs",
255
      "vcpus": "VCPUs",
256
      "be/auto_balance": "Auto_balance",
Iustin Pop's avatar
Iustin Pop committed
257
258
      "disk.count": "Disks", "disk.sizes": "Disk_sizes",
      "nic.count": "NICs", "nic.ips": "NIC_IPs",
259
      "nic.modes": "NIC_modes", "nic.links": "NIC_links",
Iustin Pop's avatar
Iustin Pop committed
260
      "nic.bridges": "NIC_bridges", "nic.macs": "NIC_MACs",
261
      "ctime": "CTime", "mtime": "MTime", "uuid": "UUID",
262
      }
263
264
265
  else:
    headers = None

266
  unitfields = ["be/memory", "oper_ram", "sd(a|b)_size", "disk\.size/.*"]
267
  numfields = ["be/memory", "oper_ram", "sd(a|b)_size", "be/vcpus",
Iustin Pop's avatar
Iustin Pop committed
268
               "serial_no", "(disk|nic)\.count", "disk\.size/.*"]
269

270
271
  list_type_fields = ("tags", "disk.sizes", "nic.macs", "nic.ips",
                      "nic.modes", "nic.links", "nic.bridges")
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
  # change raw values to nicer strings
  for row in output:
    for idx, field in enumerate(selected_fields):
      val = row[idx]
      if field == "snodes":
        val = ",".join(val) or "-"
      elif field == "admin_state":
        if val:
          val = "yes"
        else:
          val = "no"
      elif field == "oper_state":
        if val is None:
          val = "(node down)"
        elif val: # True
          val = "running"
        else:
          val = "stopped"
      elif field == "oper_ram":
        if val is None:
          val = "(node down)"
      elif field == "sda_size" or field == "sdb_size":
        if val is None:
          val = "N/A"
296
297
      elif field == "ctime" or field == "mtime":
        val = utils.FormatTime(val)
298
      elif field in list_type_fields:
Iustin Pop's avatar
Iustin Pop committed
299
        val = ",".join(str(item) for item in val)
300
301
      elif val is None:
        val = "-"
302
303
      row[idx] = str(val)

304
305
  data = GenerateTable(separator=opts.separator, headers=headers,
                       fields=selected_fields, unitfields=unitfields,
306
                       numfields=numfields, data=output, units=opts.units)
307
308

  for line in data:
309
    ToStdout(line)
Iustin Pop's avatar
Iustin Pop committed
310
311
312
313
314
315
316

  return 0


def AddInstance(opts, args):
  """Add an instance to the cluster.

Iustin Pop's avatar
Iustin Pop committed
317
  This is just a wrapper over GenericInstanceCreate.
Iustin Pop's avatar
Iustin Pop committed
318
319

  """
Iustin Pop's avatar
Iustin Pop committed
320
  return GenericInstanceCreate(constants.INSTANCE_CREATE, opts, args)
Iustin Pop's avatar
Iustin Pop committed
321
322
323
  return 0


324
def BatchCreate(opts, args):
325
326
327
328
329
330
  """Create instances using a definition file.

  This function reads a json file with instances defined
  in the form::

    {"instance-name":{
331
      "disk_size": [20480],
332
333
334
335
      "template": "drbd",
      "backend": {
        "memory": 512,
        "vcpus": 1 },
336
      "os": "debootstrap",
337
338
339
340
341
342
343
344
345
346
347
348
349
      "primary_node": "firstnode",
      "secondary_node": "secondnode",
      "iallocator": "dumb"}
    }

  Note that I{primary_node} and I{secondary_node} have precedence over
  I{iallocator}.

  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain one element, the json filename
  @rtype: int
  @return: the desired exit code
350
351

  """
352
  _DEFAULT_SPECS = {"disk_size": [20 * 1024],
353
354
355
356
                    "backend": {},
                    "iallocator": None,
                    "primary_node": None,
                    "secondary_node": None,
357
                    "nics": None,
358
359
360
                    "start": True,
                    "ip_check": True,
                    "hypervisor": None,
Iustin Pop's avatar
Iustin Pop committed
361
                    "hvparams": {},
362
363
364
365
366
                    "file_storage_dir": None,
                    "file_driver": 'loop'}

  def _PopulateWithDefaults(spec):
    """Returns a new hash combined with default values."""
367
368
369
    mydict = _DEFAULT_SPECS.copy()
    mydict.update(spec)
    return mydict
370
371
372
373
374
375
376

  def _Validate(spec):
    """Validate the instance specs."""
    # Validate fields required under any circumstances
    for required_field in ('os', 'template'):
      if required_field not in spec:
        raise errors.OpPrereqError('Required field "%s" is missing.' %
377
                                   required_field, errors.ECODE_INVAL)
378
379
380
381
382
    # Validate special fields
    if spec['primary_node'] is not None:
      if (spec['template'] in constants.DTS_NET_MIRROR and
          spec['secondary_node'] is None):
        raise errors.OpPrereqError('Template requires secondary node, but'
383
384
                                   ' there was no secondary provided.',
                                   errors.ECODE_INVAL)
385
386
    elif spec['iallocator'] is None:
      raise errors.OpPrereqError('You have to provide at least a primary_node'
387
388
                                 ' or an iallocator.',
                                 errors.ECODE_INVAL)
389

Iustin Pop's avatar
Iustin Pop committed
390
391
    if (spec['hvparams'] and
        not isinstance(spec['hvparams'], dict)):
392
393
      raise errors.OpPrereqError('Hypervisor parameters must be a dict.',
                                 errors.ECODE_INVAL)
394
395
396

  json_filename = args[0]
  try:
397
    instance_data = simplejson.loads(utils.ReadFile(json_filename))
Iustin Pop's avatar
Iustin Pop committed
398
399
400
  except Exception, err:
    ToStderr("Can't parse the instance definition file: %s" % str(err))
    return 1
401

402
403
  jex = JobExecutor()

404
405
406
  # Iterate over the instances and do:
  #  * Populate the specs with default value
  #  * Validate the instance specs
407
408
409
  i_names = utils.NiceSort(instance_data.keys())
  for name in i_names:
    specs = instance_data[name]
410
411
412
    specs = _PopulateWithDefaults(specs)
    _Validate(specs)

Iustin Pop's avatar
Iustin Pop committed
413
414
    hypervisor = specs['hypervisor']
    hvparams = specs['hvparams']
415

416
417
418
419
420
421
422
    disks = []
    for elem in specs['disk_size']:
      try:
        size = utils.ParseUnit(elem)
      except ValueError, err:
        raise errors.OpPrereqError("Invalid disk size '%s' for"
                                   " instance %s: %s" %
423
                                   (elem, name, err), errors.ECODE_INVAL)
424
425
      disks.append({"size": size})

426
427
428
    utils.ForceDictType(specs['backend'], constants.BES_PARAMETER_TYPES)
    utils.ForceDictType(hvparams, constants.HVS_PARAMETER_TYPES)

429
430
431
432
433
434
435
436
437
    tmp_nics = []
    for field in ('ip', 'mac', 'mode', 'link', 'bridge'):
      if field in specs:
        if not tmp_nics:
          tmp_nics.append({})
        tmp_nics[0][field] = specs[field]

    if specs['nics'] is not None and tmp_nics:
      raise errors.OpPrereqError("'nics' list incompatible with using"
438
439
                                 " individual nic fields as well",
                                 errors.ECODE_INVAL)
440
441
442
443
444
    elif specs['nics'] is not None:
      tmp_nics = specs['nics']
    elif not tmp_nics:
      tmp_nics = [{}]

445
    op = opcodes.OpCreateInstance(instance_name=name,
446
                                  disks=disks,
447
448
449
                                  disk_template=specs['template'],
                                  mode=constants.INSTANCE_CREATE,
                                  os_type=specs['os'],
450
                                  force_variant=opts.force_variant,
451
452
                                  pnode=specs['primary_node'],
                                  snode=specs['secondary_node'],
453
                                  nics=tmp_nics,
454
455
456
457
458
459
460
461
462
463
                                  start=specs['start'],
                                  ip_check=specs['ip_check'],
                                  wait_for_sync=True,
                                  iallocator=specs['iallocator'],
                                  hypervisor=hypervisor,
                                  hvparams=hvparams,
                                  beparams=specs['backend'],
                                  file_storage_dir=specs['file_storage_dir'],
                                  file_driver=specs['file_driver'])

464
465
466
    jex.QueueJob(name, op)
  # we never want to wait, just show the submitted job IDs
  jex.WaitOrShow(False)
467
468
469
470

  return 0


471
472
473
def ReinstallInstance(opts, args):
  """Reinstall an instance.

474
475
476
477
478
479
  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain only one element, the name of the
      instance to be reinstalled
  @rtype: int
  @return: the desired exit code
480
481

  """
482
483
484
485
486
487
  # first, compute the desired name list
  if opts.multi_mode is None:
    opts.multi_mode = _SHUTDOWN_INSTANCES

  inames = _ExpandMultiNames(opts.multi_mode, args)
  if not inames:
488
489
    raise errors.OpPrereqError("Selection filter does not match any instances",
                               errors.ECODE_INVAL)
490

491
  # second, if requested, ask for an OS
492
  if opts.select_os is True:
493
494
    op = opcodes.OpDiagnoseOS(output_fields=["name", "valid", "variants"],
                              names=[])
495
496
497
    result = SubmitOpCode(op)

    if not result:
498
      ToStdout("Can't get the OS list")
499
500
      return 1

501
    ToStdout("Available OS templates:")
502
503
    number = 0
    choices = []
504
505
506
507
508
509
    for (name, valid, variants) in result:
      if valid:
        for entry in CalculateOSNames(name, variants):
          ToStdout("%3s: %s", number, entry)
          choices.append(("%s" % number, entry, entry))
          number += 1
510
511

    choices.append(('x', 'exit', 'Exit gnt-instance reinstall'))
512
    selected = AskUser("Enter OS template number (or x to abort):",
513
514
515
                       choices)

    if selected == 'exit':
516
      ToStderr("User aborted reinstall, exiting")
517
518
      return 1

519
    os_name = selected
520
  else:
521
    os_name = opts.os
522

523
524
525
526
527
528
529
  # third, get confirmation: multi-reinstall requires --force-multi
  # *and* --force, single-reinstall just --force
  multi_on = opts.multi_mode != _SHUTDOWN_INSTANCES or len(inames) > 1
  if multi_on:
    warn_msg = "Note: this will remove *all* data for the below instances!\n"
    if not ((opts.force_multi and opts.force) or
            _ConfirmOperation(inames, "reinstall", extra=warn_msg)):
530
      return 1
531
532
533
  else:
    if not opts.force:
      usertext = ("This will reinstall the instance %s and remove"
Iustin Pop's avatar
Iustin Pop committed
534
                  " all data. Continue?") % inames[0]
535
536
537
538
539
540
      if not AskUser(usertext):
        return 1

  jex = JobExecutor(verbose=multi_on)
  for instance_name in inames:
    op = opcodes.OpReinstallInstance(instance_name=instance_name,
541
542
                                     os_type=os_name,
                                     force_variant=opts.force_variant)
543
    jex.QueueJob(instance_name, op)
544

545
  jex.WaitOrShow(not opts.submit_only)
546
547
548
  return 0


Iustin Pop's avatar
Iustin Pop committed
549
550
551
def RemoveInstance(opts, args):
  """Remove an instance.

552
553
554
555
556
557
  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain only one element, the name of
      the instance to be removed
  @rtype: int
  @return: the desired exit code
Iustin Pop's avatar
Iustin Pop committed
558
559
560
561

  """
  instance_name = args[0]
  force = opts.force
562
  cl = GetClient()
Iustin Pop's avatar
Iustin Pop committed
563
564

  if not force:
565
566
    _EnsureInstancesExist(cl, [instance_name])

Iustin Pop's avatar
Iustin Pop committed
567
568
569
    usertext = ("This will remove the volumes of the instance %s"
                " (including mirrors), thus removing all the data"
                " of the instance. Continue?") % instance_name
570
    if not AskUser(usertext):
Iustin Pop's avatar
Iustin Pop committed
571
572
      return 1

Iustin Pop's avatar
Iustin Pop committed
573
  op = opcodes.OpRemoveInstance(instance_name=instance_name,
574
                                ignore_failures=opts.ignore_failures,
575
                                shutdown_timeout=opts.shutdown_timeout)
576
  SubmitOrSend(op, opts, cl=cl)
Iustin Pop's avatar
Iustin Pop committed
577
578
579
  return 0


580
def RenameInstance(opts, args):
Guido Trotter's avatar
Guido Trotter committed
581
  """Rename an instance.
582

583
584
585
586
587
588
  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain two elements, the old and the
      new instance names
  @rtype: int
  @return: the desired exit code
589
590
591
592
593

  """
  op = opcodes.OpRenameInstance(instance_name=args[0],
                                new_name=args[1],
                                ignore_ip=opts.ignore_ip)
594
  SubmitOrSend(op, opts)
595
596
597
  return 0


Iustin Pop's avatar
Iustin Pop committed
598
599
600
601
def ActivateDisks(opts, args):
  """Activate an instance's disks.

  This serves two purposes:
602
603
    - it allows (as long as the instance is not running)
      mounting the disks and modifying them from the node
Iustin Pop's avatar
Iustin Pop committed
604
605
    - it repairs inactive secondary drbds

606
607
608
609
610
611
  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain only one element, the instance name
  @rtype: int
  @return: the desired exit code

Iustin Pop's avatar
Iustin Pop committed
612
613
  """
  instance_name = args[0]
614
615
  op = opcodes.OpActivateInstanceDisks(instance_name=instance_name,
                                       ignore_size=opts.ignore_size)
616
  disks_info = SubmitOrSend(op, opts)
Iustin Pop's avatar
Iustin Pop committed
617
  for host, iname, nname in disks_info:
618
    ToStdout("%s:%s:%s", host, iname, nname)
Iustin Pop's avatar
Iustin Pop committed
619
620
621
622
  return 0


def DeactivateDisks(opts, args):
Iustin Pop's avatar
Iustin Pop committed
623
  """Deactivate an instance's disks.
Iustin Pop's avatar
Iustin Pop committed
624
625
626
627

  This function takes the instance name, looks for its primary node
  and the tries to shutdown its block devices on that node.

628
629
630
631
632
633
  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain only one element, the instance name
  @rtype: int
  @return: the desired exit code

Iustin Pop's avatar
Iustin Pop committed
634
635
636
  """
  instance_name = args[0]
  op = opcodes.OpDeactivateInstanceDisks(instance_name=instance_name)
637
  SubmitOrSend(op, opts)
Iustin Pop's avatar
Iustin Pop committed
638
639
640
  return 0


Iustin Pop's avatar
Iustin Pop committed
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
def RecreateDisks(opts, args):
  """Recreate an instance's disks.

  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain only one element, the instance name
  @rtype: int
  @return: the desired exit code

  """
  instance_name = args[0]
  if opts.disks:
    try:
      opts.disks = [int(v) for v in opts.disks.split(",")]
    except (ValueError, TypeError), err:
      ToStderr("Invalid disks value: %s" % str(err))
      return 1
  else:
    opts.disks = []

  op = opcodes.OpRecreateInstanceDisks(instance_name=instance_name,
                                       disks=opts.disks)
  SubmitOrSend(op, opts)
  return 0


Iustin Pop's avatar
Iustin Pop committed
667
def GrowDisk(opts, args):
668
  """Grow an instance's disks.
Iustin Pop's avatar
Iustin Pop committed
669

670
671
672
673
674
675
  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain two elements, the instance name
      whose disks we grow and the disk name, e.g. I{sda}
  @rtype: int
  @return: the desired exit code
Iustin Pop's avatar
Iustin Pop committed
676
677
678
679

  """
  instance = args[0]
  disk = args[1]
680
681
682
  try:
    disk = int(disk)
  except ValueError, err:
683
684
    raise errors.OpPrereqError("Invalid disk index: %s" % str(err),
                               errors.ECODE_INVAL)
Iustin Pop's avatar
Iustin Pop committed
685
  amount = utils.ParseUnit(args[2])
686
687
  op = opcodes.OpGrowDisk(instance_name=instance, disk=disk, amount=amount,
                          wait_for_sync=opts.wait_for_sync)
688
  SubmitOrSend(op, opts)
Iustin Pop's avatar
Iustin Pop committed
689
690
691
  return 0


692
def _StartupInstance(name, opts):
693
  """Startup instances.
Iustin Pop's avatar
Iustin Pop committed
694

695
696
  This returns the opcode to start an instance, and its decorator will
  wrap this into a loop starting all desired instances.
697

698
  @param name: the name of the instance to act on
699
  @param opts: the command line options selected by the user
700
  @return: the opcode needed for the operation
Iustin Pop's avatar
Iustin Pop committed
701
702

  """
703
704
705
706
707
708
709
710
  op = opcodes.OpStartupInstance(instance_name=name,
                                 force=opts.force)
  # do not add these parameters to the opcode unless they're defined
  if opts.hvparams:
    op.hvparams = opts.hvparams
  if opts.beparams:
    op.beparams = opts.beparams
  return op
Iustin Pop's avatar
Iustin Pop committed
711

712

713
def _RebootInstance(name, opts):
714
715
  """Reboot instance(s).

716
717
  This returns the opcode to reboot an instance, and its decorator
  will wrap this into a loop rebooting all desired instances.
718

719
  @param name: the name of the instance to act on
720
  @param opts: the command line options selected by the user
721
  @return: the opcode needed for the operation
722
723

  """
724
  return opcodes.OpRebootInstance(instance_name=name,
725
                                  reboot_type=opts.reboot_type,
726
                                  ignore_secondaries=opts.ignore_secondaries,
727
                                  shutdown_timeout=opts.shutdown_timeout)
Iustin Pop's avatar
Iustin Pop committed
728

729

730
def _ShutdownInstance(name, opts):
Iustin Pop's avatar
Iustin Pop committed
731
732
  """Shutdown an instance.

733
734
735
736
  This returns the opcode to shutdown an instance, and its decorator
  will wrap this into a loop shutting down all desired instances.

  @param name: the name of the instance to act on
737
  @param opts: the command line options selected by the user
738
  @return: the opcode needed for the operation
Iustin Pop's avatar
Iustin Pop committed
739
740

  """
741
742
  return opcodes.OpShutdownInstance(instance_name=name,
                                    timeout=opts.timeout)
Iustin Pop's avatar
Iustin Pop committed
743
744
745
746
747


def ReplaceDisks(opts, args):
  """Replace the disks of an instance

748
749
750
751
752
  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain only one element, the instance name
  @rtype: int
  @return: the desired exit code
Iustin Pop's avatar
Iustin Pop committed
753
754
755

  """
  instance_name = args[0]
756
  new_2ndary = opts.dst_node
757
  iallocator = opts.iallocator
758
  if opts.disks is None:
759
    disks = []
760
  else:
761
762
763
    try:
      disks = [int(i) for i in opts.disks.split(",")]
    except ValueError, err:
764
765
      raise errors.OpPrereqError("Invalid disk index passed: %s" % str(err),
                                 errors.ECODE_INVAL)
766
  cnt = [opts.on_primary, opts.on_secondary, opts.auto,
767
768
         new_2ndary is not None, iallocator is not None].count(True)
  if cnt != 1:
769
    raise errors.OpPrereqError("One and only one of the -p, -s, -a, -n and -i"
770
                               " options must be passed", errors.ECODE_INVAL)
771
  elif opts.on_primary:
772
    mode = constants.REPLACE_DISK_PRI
773
  elif opts.on_secondary:
774
    mode = constants.REPLACE_DISK_SEC
775
776
777
778
  elif opts.auto:
    mode = constants.REPLACE_DISK_AUTO
    if disks:
      raise errors.OpPrereqError("Cannot specify disks when using automatic"
779
                                 " mode", errors.ECODE_INVAL)
780
781
782
  elif new_2ndary is not None or iallocator is not None:
    # replace secondary
    mode = constants.REPLACE_DISK_CHG
783
784

  op = opcodes.OpReplaceDisks(instance_name=args[0], disks=disks,
785
786
                              remote_node=new_2ndary, mode=mode,
                              iallocator=iallocator)
787
  SubmitOrSend(op, opts)
Iustin Pop's avatar
Iustin Pop committed
788
789
790
791
792
793
794
795
796
  return 0


def FailoverInstance(opts, args):
  """Failover an instance.

  The failover is done by shutting it down on its present node and
  starting it on the secondary.

797
798
799
800
801
  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain only one element, the instance name
  @rtype: int
  @return: the desired exit code
Iustin Pop's avatar
Iustin Pop committed
802
803

  """
804
  cl = GetClient()
805
806
  instance_name = args[0]
  force = opts.force
Iustin Pop's avatar
Iustin Pop committed
807

808
  if not force:
809
810
    _EnsureInstancesExist(cl, [instance_name])

811
812
813
814
815
    usertext = ("Failover will happen to image %s."
                " This requires a shutdown of the instance. Continue?" %
                (instance_name,))
    if not AskUser(usertext):
      return 1
Iustin Pop's avatar
Iustin Pop committed
816

817
  op = opcodes.OpFailoverInstance(instance_name=instance_name,
818
                                  ignore_consistency=opts.ignore_consistency,
819
                                  shutdown_timeout=opts.shutdown_timeout)
820
  SubmitOrSend(op, opts, cl=cl)
821
  return 0
Iustin Pop's avatar
Iustin Pop committed
822
823


824
825
826
827
828
def MigrateInstance(opts, args):
  """Migrate an instance.

  The migrate is done without shutdown.

Iustin Pop's avatar
Iustin Pop committed
829
830
831
832
833
  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain only one element, the instance name
  @rtype: int
  @return: the desired exit code
834
835

  """
836
  cl = GetClient()
837
838
839
840
  instance_name = args[0]
  force = opts.force

  if not force:
841
842
    _EnsureInstancesExist(cl, [instance_name])

843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
    if opts.cleanup:
      usertext = ("Instance %s will be recovered from a failed migration."
                  " Note that the migration procedure (including cleanup)" %
                  (instance_name,))
    else:
      usertext = ("Instance %s will be migrated. Note that migration" %
                  (instance_name,))
    usertext += (" is **experimental** in this version."
                " This might impact the instance if anything goes wrong."
                " Continue?")
    if not AskUser(usertext):
      return 1

  op = opcodes.OpMigrateInstance(instance_name=instance_name, live=opts.live,
                                 cleanup=opts.cleanup)
858
  SubmitOpCode(op, cl=cl)
859
860
861
  return 0


Iustin Pop's avatar
Iustin Pop committed
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
def MoveInstance(opts, args):
  """Move an instance.

  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain only one element, the instance name
  @rtype: int
  @return: the desired exit code

  """
  cl = GetClient()
  instance_name = args[0]
  force = opts.force

  if not force:
    usertext = ("Instance %s will be moved."
                " This requires a shutdown of the instance. Continue?" %
                (instance_name,))
    if not AskUser(usertext):
      return 1

  op = opcodes.OpMoveInstance(instance_name=instance_name,
884
                              target_node=opts.node,
885
                              shutdown_timeout=opts.shutdown_timeout)
Iustin Pop's avatar
Iustin Pop committed
886
887
888
889
  SubmitOrSend(op, opts, cl=cl)
  return 0


Iustin Pop's avatar
Iustin Pop committed
890
891
892
def ConnectToInstanceConsole(opts, args):
  """Connect to the console of an instance.

893
894
895
896
897
  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain only one element, the instance name
  @rtype: int
  @return: the desired exit code
Iustin Pop's avatar
Iustin Pop committed
898
899
900
901
902

  """
  instance_name = args[0]

  op = opcodes.OpConnectConsole(instance_name=instance_name)
903
  cmd = SubmitOpCode(op)
904
905

  if opts.show_command:
906
    ToStdout("%s", utils.ShellQuoteArgs(cmd))
907
908
909
910
  else:
    try:
      os.execvp(cmd[0], cmd)
    finally:
911
      ToStderr("Can't run console command %s with arguments:\n'%s'",
912
               cmd[0], " ".join(cmd))
913
      os._exit(1)
Iustin Pop's avatar
Iustin Pop committed
914
915


916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
def _FormatLogicalID(dev_type, logical_id):
  """Formats the logical_id of a disk.

  """
  if dev_type == constants.LD_DRBD8:
    node_a, node_b, port, minor_a, minor_b, key = logical_id
    data = [
      ("nodeA", "%s, minor=%s" % (node_a, minor_a)),
      ("nodeB", "%s, minor=%s" % (node_b, minor_b)),
      ("port", port),
      ("auth key", key),
      ]
  elif dev_type == constants.LD_LV:
    vg_name, lv_name = logical_id
    data = ["%s/%s" % (vg_name, lv_name)]
  else:
    data = [str(logical_id)]

  return data


def _FormatBlockDevInfo(idx, top_level, dev, static):
Iustin Pop's avatar
Iustin Pop committed
938
939
  """Show block device information.

940
  This is only used by L{ShowInstanceConfig}, but it's too big to be
Iustin Pop's avatar
Iustin Pop committed
941
942
  left for an inline definition.

943
944
945
946
  @type idx: int
  @param idx: the index of the current disk
  @type top_level: boolean
  @param top_level: if this a top-level disk?
947
948
949
950
951
  @type dev: dict
  @param dev: dictionary with disk information
  @type static: boolean
  @param static: wheter the device information doesn't contain
      runtime information but only static data
952
953
  @return: a list of either strings, tuples or lists
      (which should be formatted at a higher indent level)
954

Iustin Pop's avatar
Iustin Pop committed
955
  """
956
  def helper(dtype, status):
957
958
959
960
961
962
    """Format one line for physical device status.

    @type dtype: str
    @param dtype: a constant from the L{constants.LDS_BLOCK} set
    @type status: tuple
    @param status: a tuple as returned from L{backend.FindBlockDevice}
963
    @return: the string representing the status
964
965

    """
Iustin Pop's avatar
Iustin Pop committed
966
    if not status:
967
968
      return "not active"
    txt = ""
969
    (path, major, minor, syncp, estt, degr, ldisk_status) = status
970
971
    if major is None:
      major_string = "N/A"
Iustin Pop's avatar
Iustin Pop committed
972
    else:
973
      major_string = str(major)
974

975
976
977
978
979
980
981
982
983
984
985
    if minor is None:
      minor_string = "N/A"
    else:
      minor_string = str(minor)

    txt += ("%s (%s:%s)" % (path, major_string, minor_string))
    if dtype in (constants.LD_DRBD8, ):
      if syncp is not None:
        sync_text = "*RECOVERING* %5.2f%%," % syncp
        if estt:
          sync_text += " ETA %ds" % estt
986
        else:
987
988
989
990
991
992
993
          sync_text += " ETA unknown"
      else:
        sync_text = "in sync"
      if degr:
        degr_text = "*DEGRADED*"
      else:
        degr_text = "ok"
994
      if ldisk_status == constants.LDS_FAULTY:
995
        ldisk_text = " *MISSING DISK*"
996
997
      elif ldisk_status == constants.LDS_UNKNOWN:
        ldisk_text = " *UNCERTAIN STATE*"
998
999
1000
1001
      else:
        ldisk_text = ""
      txt += (" %s, status %s%s" % (sync_text, degr_text, ldisk_text))
    elif dtype == constants.LD_LV:
1002
      if ldisk_status == constants.LDS_FAULTY:
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
        ldisk_text = " *FAILED* (failed drive?)"
      else:
        ldisk_text = ""
      txt += ldisk_text
    return txt

  # the header
  if top_level:
    if dev["iv_name"] is not None:
      txt = dev["iv_name"]
    else:
      txt = "disk %d" % idx
Iustin Pop's avatar
Iustin Pop committed
1015
  else:
1016
    txt = "child %d" % idx
Iustin Pop's avatar
Iustin Pop committed
1017
1018
1019
1020
1021
  if isinstance(dev["size"], int):
    nice_size = utils.FormatUnit(dev["size"], "h")
  else:
    nice_size = dev["size"]
  d1 = ["- %s: %s, size %s" % (txt, dev["dev_type"], nice_size)]
1022
1023
1024
  data = []
  if top_level:
    data.append(("access mode", dev["mode"]))
Iustin Pop's avatar
Iustin Pop committed
1025
  if dev["logical_id"] is not None:
1026
1027
1028
1029
1030
1031
1032
1033
    try:
      l_id = _FormatLogicalID(dev["dev_type"], dev["logical_id"])
    except ValueError:
      l_id = [str(dev["logical_id"])]
    if len(l_id) == 1:
      data.append(("logical_id", l_id[0]))
    else:
      data.extend(l_id)
Iustin Pop's avatar
Iustin Pop committed
1034
  elif dev["physical_id"] is not None:
1035
1036
    data.append("physical_id:")
    data.append([dev["physical_id"]])
1037
  if not static:
1038
    data.append(("on primary", helper(dev["dev_type"], dev["pstatus"])))
1039
  if dev["sstatus"] and not static:
1040
    data.append(("on secondary", helper(dev["dev_type"], dev["sstatus"])))
Iustin Pop's avatar
Iustin Pop committed
1041
1042

  if dev["children"]:
1043
1044
1045
1046
1047
    data.append("child devices:")
    for c_idx, child in enumerate(dev["children"]):
      data.append(_FormatBlockDevInfo(c_idx, False, child, static))
  d1.append(data)
  return d1
Iustin Pop's avatar
Iustin Pop committed
1048
1049


1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
def _FormatList(buf, data, indent_level):
  """Formats a list of data at a given indent level.

  If the element of the list is:
    - a string, it is simply formatted as is
    - a tuple, it will be split into key, value and the all the
      values in a list will be aligned all at the same start column
    - a list, will be recursively formatted

  @type buf: StringIO
  @param buf: the buffer into which we write the output
  @param data: the list to format
  @type indent_level: int
  @param indent_level: the indent level to format at

  """
  max_tlen = max([len(elem[0]) for elem in data
                 if isinstance(elem, tuple)] or [0])
  for elem in data:
    if isinstance(elem, basestring):
      buf.write("%*s%s\n" % (2*indent_level, "", elem))
    elif isinstance(elem, tuple):
      key, value = elem
      spacer = "%*s" % (max_tlen - len(key), "")
      buf.write("%*s%s:%s %s\n" % (2*indent_level, "", key, spacer, value))
    elif isinstance(elem, list):
      _FormatList(buf, elem, indent_level+1)

1078

Iustin Pop's avatar
Iustin Pop committed
1079
1080
1081
def ShowInstanceConfig(opts, args):
  """Compute instance run-time status.

1082
1083
1084
1085
1086
1087
1088
  @param opts: the command line options selected by the user
  @type args: list
  @param args: either an empty list, and then we query all
      instances, or should contain a list of instance names
  @rtype: int
  @return: the desired exit code

Iustin Pop's avatar
Iustin Pop committed
1089
  """
Guido Trotter's avatar
Guido Trotter committed
1090
1091
1092
1093
1094
1095
1096
1097
1098
  if not args and not opts.show_all:
    ToStderr("No instance selected."
             " Please pass in --all if you want to query all instances.\n"
             "Note that this can take a long time on a big cluster.")
    return 1
  elif args and opts.show_all:
    ToStderr("Cannot use --all if you specify instance names.")
    return 1

Iustin Pop's avatar
Iustin Pop committed
1099
  retcode = 0
1100
  op = opcodes.OpQueryInstanceData(instances=args, static=opts.static)
Iustin Pop's avatar
Iustin Pop committed
1101
1102
  result = SubmitOpCode(op)
  if not result:
1103
    ToStdout("No instances.")
Iustin Pop's avatar
Iustin Pop committed
1104
1105
1106
1107
1108
1109
1110
    return 1

  buf = StringIO()
  retcode = 0
  for instance_name in result:
    instance = result[instance_name]
    buf.write("Instance name: %s\n" % instance["name"])
1111
    buf.write("UUID: %s\n" % instance["uuid"])
1112
1113
1114
    buf.write("Serial number: %s\n" % instance["serial_no"])
    buf.write("Creation time: %s\n" % utils.FormatTime(instance["ctime"]))
    buf.write("Modification time: %s\n" % utils.FormatTime(instance["mtime"]))
1115
1116
1117
1118
1119
1120
    buf.write("State: configured to be %s" % instance["config_state"])
    if not opts.static:
      buf.write(", actual state is %s" % instance["run_state"])
    buf.write("\n")
    ##buf.write("Considered for memory checks in cluster verify: %s\n" %
    ##          instance["auto_balance"])
Iustin Pop's avatar
Iustin Pop committed
1121
1122
    buf.write("  Nodes:\n")
    buf.write("    - primary: %s\n" % instance["pnode"])
1123
    buf.write("    - secondaries: %s\n" % utils.CommaJoin(instance["snodes"]))
Iustin Pop's avatar
Iustin Pop committed
1124
    buf.write("  Operating system: %s\n" % instance["os"])
1125
1126
    if instance.has_key("network_port"):
      buf.write("  Allocated network port: %s\n" % instance["network_port"])
1127
    buf.write("  Hypervisor: %s\n" % instance["hypervisor"])
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142

    # custom VNC console information
    vnc_bind_address = instance["hv_actual"].get(constants.HV_VNC_BIND_ADDRESS,
                                                 None)
    if vnc_bind_address:
      port = instance["network_port"]
      display = int(port) - constants.VNC_BASE_PORT
      if display > 0 and vnc_bind_address == constants.BIND_ADDRESS_GLOBAL:
        vnc_console_port = "%s:%s (display %s)" % (instance["pnode"],
                                                   port,
                                                   display)
      elif display > 0 and utils.IsValidIP(vnc_bind_address):
        vnc_console_port = ("%s:%s (node %s) (display %s)" %
                             (vnc_bind_address, port,
                              instance["pnode"], display))
1143
      else:
1144
1145
1146
        # vnc bind address is a file
        vnc_console_port = "%s:%s" % (instance["pnode"],
                                      vnc_bind_address)
1147
1148
      buf.write("    - console connection: vnc to %s\n" % vnc_console_port)

1149
    for key in instance["hv_actual"]:
1150
1151
      if key in instance["hv_instance"]:
        val = instance["hv_instance"][key]
1152
      else:
1153
        val = "default (%s)" % instance["hv_actual"][key]
1154
      buf.write("    - %s: %s\n" % (key, val))
Iustin Pop's avatar
Iustin Pop committed
1155
    buf.write("  Hardware:\n")
Iustin Pop's avatar
Iustin Pop committed
1156
1157
1158
1159
    buf.write("    - VCPUs: %d\n" %
              instance["be_actual"][constants.BE_VCPUS])
    buf.write("    - memory: %dMiB\n" %
              instance["be_actual"][constants.BE_MEMORY])
1160
    buf.write("    - NICs:\n")
1161
    for idx, (ip, mac, mode, link) in enumerate(instance["nics"]):
1162
1163
      buf.write("      - nic/%d: MAC: %s, IP: %s, mode: %s, link: %s\n" %
                (idx, mac, ip, mode, link))
1164
    buf.write("  Disks:\n")
Iustin Pop's avatar
Iustin Pop committed
1165

1166
1167
    for idx, device in enumerate(instance["disks"]):
      _FormatList(buf, _FormatBlockDevInfo(idx, True, device, opts.static), 2)
Iustin Pop's avatar
Iustin Pop committed
1168