gnt-instance 54.4 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
Iustin Pop's avatar
Iustin Pop committed
30
31
32
33
from optparse import make_option
from cStringIO import StringIO

from ganeti.cli import *
34
from ganeti import cli
Iustin Pop's avatar
Iustin Pop committed
35
36
37
from ganeti import opcodes
from ganeti import constants
from ganeti import utils
38
39
40
41
42
43
44
45
46
from ganeti import errors


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

47

48
49
_VALUE_TRUE = "true"

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

55

56
def _ExpandMultiNames(mode, names, client=None):
57
58
59
60
  """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
61
  primary/secondary will be returned. For _SHUTDOWN_NODES_BOTH, all
62
63
64
65
  instances having those nodes as either primary or secondary will be
  returned. For _SHUTDOWN_INSTANCES, the given instances will be
  returned.

66
67
68
69
70
71
72
73
74
75
76
77
  @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

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

  elif mode in (_SHUTDOWN_NODES_BOTH,
                _SHUTDOWN_NODES_PRI,
                _SHUTDOWN_NODES_SEC):
    if not names:
      raise errors.OpPrereqError("No node names passed")
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
109
    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:
      raise errors.OpPrereqError("No instance names passed")
110
    idata = client.QueryInstances(names, ["name"], False)
111
112
113
114
115
116
    inames = [row[0] for row in idata]

  else:
    raise errors.OpPrereqError("Unknown mode '%s'" % mode)

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


119
def _ConfirmOperation(inames, text, extra=""):
120
121
122
123
124
  """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.

125
126
127
128
129
130
131
132
  @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.
133
134
135

  """
  count = len(inames)
136
137
  msg = ("The %s will operate on %d instances.\n%s"
         "Do you want to continue?" % (text, count, extra))
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
  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)
153
    choice = AskUser(msg + affected, choices)
154
155
156
  return choice


157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
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.

  @type client: L{luxi.Client}
  @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
172
  result = client.QueryInstances(names, ["name"], False)
173
174
175
176
177
  for orig_name, row in zip(names, result):
    if row[0] is None:
      raise errors.OpPrereqError("Instance '%s' does not exist" % orig_name)


Iustin Pop's avatar
Iustin Pop committed
178
def ListInstances(opts, args):
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
179
  """List instances and their properties.
Iustin Pop's avatar
Iustin Pop committed
180

181
182
183
184
185
186
  @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
187
188
  """
  if opts.output is None:
189
190
191
    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
192
193
194
  else:
    selected_fields = opts.output.split(",")

195
  output = GetClient().QueryInstances(args, selected_fields, opts.do_locking)
Iustin Pop's avatar
Iustin Pop committed
196
197

  if not opts.no_headers:
198
199
200
    headers = {
      "name": "Instance", "os": "OS", "pnode": "Primary_node",
      "snodes": "Secondary_Nodes", "admin_state": "Autostart",
Iustin Pop's avatar
Iustin Pop committed
201
      "oper_state": "Running",
202
      "oper_ram": "Memory", "disk_template": "Disk_template",
203
      "ip": "IP_address", "mac": "MAC_address",
Iustin Pop's avatar
Iustin Pop committed
204
      "bridge": "Bridge",
205
      "sda_size": "Disk/0", "sdb_size": "Disk/1",
206
      "disk_usage": "DiskUsage",
207
      "status": "Status", "tags": "Tags",
208
      "network_port": "Network_port",
209
210
211
212
213
214
215
216
      "hv/kernel_path": "Kernel_path",
      "hv/initrd_path": "Initrd_path",
      "hv/boot_order": "HVM_boot_order",
      "hv/acpi": "HVM_ACPI",
      "hv/pae": "HVM_PAE",
      "hv/cdrom_image_path": "HVM_CDROM_image_path",
      "hv/nic_type": "HVM_NIC_type",
      "hv/disk_type": "HVM_Disk_type",
217
      "hv/vnc_bind_address": "VNC_bind_address",
218
      "serial_no": "SerialNo", "hypervisor": "Hypervisor",
219
      "hvparams": "Hypervisor_parameters",
Iustin Pop's avatar
Iustin Pop committed
220
221
      "be/memory": "Configured_memory",
      "be/vcpus": "VCPUs",
222
      "be/auto_balance": "Auto_balance",
Iustin Pop's avatar
Iustin Pop committed
223
224
225
      "disk.count": "Disks", "disk.sizes": "Disk_sizes",
      "nic.count": "NICs", "nic.ips": "NIC_IPs",
      "nic.bridges": "NIC_bridges", "nic.macs": "NIC_MACs",
226
      }
227
228
229
  else:
    headers = None

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

Iustin Pop's avatar
Iustin Pop committed
234
235
  list_type_fields = ("tags", "disk.sizes",
                      "nic.macs", "nic.ips", "nic.bridges")
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
  # 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"
260
      elif field in list_type_fields:
Iustin Pop's avatar
Iustin Pop committed
261
        val = ",".join(str(item) for item in val)
262
263
      elif val is None:
        val = "-"
264
265
      row[idx] = str(val)

266
267
  data = GenerateTable(separator=opts.separator, headers=headers,
                       fields=selected_fields, unitfields=unitfields,
268
                       numfields=numfields, data=output, units=opts.units)
269
270

  for line in data:
271
    ToStdout(line)
Iustin Pop's avatar
Iustin Pop committed
272
273
274
275
276
277
278

  return 0


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

279
280
281
282
283
  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain only one element, the new instance name
  @rtype: int
  @return: the desired exit code
Iustin Pop's avatar
Iustin Pop committed
284
285
286
287

  """
  instance = args[0]

288
289
  (pnode, snode) = SplitNodeOption(opts.node)

290
291
292
293
  hypervisor = None
  hvparams = {}
  if opts.hypervisor:
    hypervisor, hvparams = opts.hypervisor
294

295
296
297
298
299
300
  if opts.nics:
    try:
      nic_max = max(int(nidx[0])+1 for nidx in opts.nics)
    except ValueError, err:
      raise errors.OpPrereqError("Invalid NIC index passed: %s" % str(err))
    nics = [{}] * nic_max
301
    for nidx, ndict in opts.nics:
302
303
      nidx = int(nidx)
      nics[nidx] = ndict
Iustin Pop's avatar
Iustin Pop committed
304
305
306
  elif opts.no_nics:
    # no nics
    nics = []
307
308
309
310
  else:
    # default of one nic, all auto
    nics = [{}]

Iustin Pop's avatar
Iustin Pop committed
311
  if opts.disk_template == constants.DT_DISKLESS:
312
    if opts.disks or opts.sd_size is not None:
Iustin Pop's avatar
Iustin Pop committed
313
314
315
      raise errors.OpPrereqError("Diskless instance but disk"
                                 " information passed")
    disks = []
316
  else:
317
    if not opts.disks and not opts.sd_size:
Iustin Pop's avatar
Iustin Pop committed
318
      raise errors.OpPrereqError("No disk information specified")
319
320
321
322
323
    if opts.disks and opts.sd_size is not None:
      raise errors.OpPrereqError("Please use either the '--disk' or"
                                 " '-s' option")
    if opts.sd_size is not None:
      opts.disks = [(0, {"size": opts.sd_size})]
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
    try:
      disk_max = max(int(didx[0])+1 for didx in opts.disks)
    except ValueError, err:
      raise errors.OpPrereqError("Invalid disk index passed: %s" % str(err))
    disks = [{}] * disk_max
    for didx, ddict in opts.disks:
      didx = int(didx)
      if "size" not in ddict:
        raise errors.OpPrereqError("Missing size for disk %d" % didx)
      try:
        ddict["size"] = utils.ParseUnit(ddict["size"])
      except ValueError, err:
        raise errors.OpPrereqError("Invalid disk size for disk %d: %s" %
                                   (didx, err))
      disks[didx] = ddict

340
  utils.ForceDictType(opts.beparams, constants.BES_PARAMETER_TYPES)
341
  utils.ForceDictType(hvparams, constants.HVS_PARAMETER_TYPES)
342

Iustin Pop's avatar
Iustin Pop committed
343
  op = opcodes.OpCreateInstance(instance_name=instance,
344
                                disks=disks,
Iustin Pop's avatar
Iustin Pop committed
345
                                disk_template=opts.disk_template,
346
                                nics=nics,
Iustin Pop's avatar
Iustin Pop committed
347
                                mode=constants.INSTANCE_CREATE,
348
                                os_type=opts.os, pnode=pnode,
Iustin Pop's avatar
Iustin Pop committed
349
                                snode=snode,
350
                                start=opts.start, ip_check=opts.ip_check,
351
                                wait_for_sync=opts.wait_for_sync,
352
353
                                hypervisor=hypervisor,
                                hvparams=hvparams,
Iustin Pop's avatar
Iustin Pop committed
354
                                beparams=opts.beparams,
355
                                iallocator=opts.iallocator,
356
357
                                file_storage_dir=opts.file_storage_dir,
                                file_driver=opts.file_driver,
358
                                )
359

360
  SubmitOrSend(op, opts)
Iustin Pop's avatar
Iustin Pop committed
361
362
363
  return 0


364
def BatchCreate(opts, args):
365
366
367
368
369
370
  """Create instances using a definition file.

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

    {"instance-name":{
371
      "disk_size": [20480],
372
373
374
375
      "template": "drbd",
      "backend": {
        "memory": 512,
        "vcpus": 1 },
376
      "os": "debootstrap",
377
378
379
380
381
382
383
384
385
386
387
388
389
      "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
390
391

  """
392
  _DEFAULT_SPECS = {"disk_size": [20 * 1024],
393
394
395
396
397
398
399
400
401
402
                    "backend": {},
                    "iallocator": None,
                    "primary_node": None,
                    "secondary_node": None,
                    "ip": 'none',
                    "mac": 'auto',
                    "bridge": None,
                    "start": True,
                    "ip_check": True,
                    "hypervisor": None,
Iustin Pop's avatar
Iustin Pop committed
403
                    "hvparams": {},
404
405
406
407
408
                    "file_storage_dir": None,
                    "file_driver": 'loop'}

  def _PopulateWithDefaults(spec):
    """Returns a new hash combined with default values."""
409
410
411
    mydict = _DEFAULT_SPECS.copy()
    mydict.update(spec)
    return mydict
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429

  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.' %
                                   required_field)
    # 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'
                                   ' there was no secondary provided.')
    elif spec['iallocator'] is None:
      raise errors.OpPrereqError('You have to provide at least a primary_node'
                                 ' or an iallocator.')

Iustin Pop's avatar
Iustin Pop committed
430
431
    if (spec['hvparams'] and
        not isinstance(spec['hvparams'], dict)):
432
433
434
435
      raise errors.OpPrereqError('Hypervisor parameters must be a dict.')

  json_filename = args[0]
  try:
Iustin Pop's avatar
Iustin Pop committed
436
    fd = open(json_filename, 'r')
437
438
    instance_data = simplejson.load(fd)
    fd.close()
Iustin Pop's avatar
Iustin Pop committed
439
440
441
  except Exception, err:
    ToStderr("Can't parse the instance definition file: %s" % str(err))
    return 1
442

443
444
  jex = JobExecutor()

445
446
447
  # Iterate over the instances and do:
  #  * Populate the specs with default value
  #  * Validate the instance specs
448
449
450
  i_names = utils.NiceSort(instance_data.keys())
  for name in i_names:
    specs = instance_data[name]
451
452
453
    specs = _PopulateWithDefaults(specs)
    _Validate(specs)

Iustin Pop's avatar
Iustin Pop committed
454
455
    hypervisor = specs['hypervisor']
    hvparams = specs['hvparams']
456

457
458
459
460
461
462
463
464
465
466
467
468
    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" %
                                   (elem, name, err))
      disks.append({"size": size})

    nic0 = {'ip': specs['ip'], 'bridge': specs['bridge'], 'mac': specs['mac']}

469
470
471
    utils.ForceDictType(specs['backend'], constants.BES_PARAMETER_TYPES)
    utils.ForceDictType(hvparams, constants.HVS_PARAMETER_TYPES)

472
    op = opcodes.OpCreateInstance(instance_name=name,
473
                                  disks=disks,
474
475
476
477
478
                                  disk_template=specs['template'],
                                  mode=constants.INSTANCE_CREATE,
                                  os_type=specs['os'],
                                  pnode=specs['primary_node'],
                                  snode=specs['secondary_node'],
479
                                  nics=[nic0],
480
481
482
483
484
485
486
487
488
489
                                  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'])

490
491
492
    jex.QueueJob(name, op)
  # we never want to wait, just show the submitted job IDs
  jex.WaitOrShow(False)
493
494
495
496

  return 0


497
498
499
def ReinstallInstance(opts, args):
  """Reinstall an instance.

500
501
502
503
504
505
  @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
506
507

  """
508
509
510
511
512
513
514
  # 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:
    raise errors.OpPrereqError("Selection filter does not match any instances")
515

516
  # second, if requested, ask for an OS
517
518
519
520
521
  if opts.select_os is True:
    op = opcodes.OpDiagnoseOS(output_fields=["name", "valid"], names=[])
    result = SubmitOpCode(op)

    if not result:
522
      ToStdout("Can't get the OS list")
523
524
      return 1

525
    ToStdout("Available OS templates:")
526
527
528
    number = 0
    choices = []
    for entry in result:
529
      ToStdout("%3s: %s", number, entry[0])
530
531
532
533
      choices.append(("%s" % number, entry[0], entry[0]))
      number = number + 1

    choices.append(('x', 'exit', 'Exit gnt-instance reinstall'))
534
    selected = AskUser("Enter OS template number (or x to abort):",
535
536
537
                       choices)

    if selected == 'exit':
538
      ToStderr("User aborted reinstall, exiting")
539
540
      return 1

541
    os_name = selected
542
  else:
543
    os_name = opts.os
544

545
546
547
548
549
550
551
  # 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)):
552
      return 1
553
554
555
  else:
    if not opts.force:
      usertext = ("This will reinstall the instance %s and remove"
Iustin Pop's avatar
Iustin Pop committed
556
                  " all data. Continue?") % inames[0]
557
558
559
560
561
562
563
564
      if not AskUser(usertext):
        return 1

  jex = JobExecutor(verbose=multi_on)
  for instance_name in inames:
    op = opcodes.OpReinstallInstance(instance_name=instance_name,
                                     os_type=os_name)
    jex.QueueJob(instance_name, op)
565

566
  jex.WaitOrShow(not opts.submit_only)
567
568
569
  return 0


Iustin Pop's avatar
Iustin Pop committed
570
571
572
def RemoveInstance(opts, args):
  """Remove an instance.

573
574
575
576
577
578
  @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
579
580
581
582

  """
  instance_name = args[0]
  force = opts.force
583
  cl = GetClient()
Iustin Pop's avatar
Iustin Pop committed
584
585

  if not force:
586
587
    _EnsureInstancesExist(cl, [instance_name])

Iustin Pop's avatar
Iustin Pop committed
588
589
590
    usertext = ("This will remove the volumes of the instance %s"
                " (including mirrors), thus removing all the data"
                " of the instance. Continue?") % instance_name
591
    if not AskUser(usertext):
Iustin Pop's avatar
Iustin Pop committed
592
593
      return 1

Iustin Pop's avatar
Iustin Pop committed
594
595
  op = opcodes.OpRemoveInstance(instance_name=instance_name,
                                ignore_failures=opts.ignore_failures)
596
  SubmitOrSend(op, opts, cl=cl)
Iustin Pop's avatar
Iustin Pop committed
597
598
599
  return 0


600
def RenameInstance(opts, args):
Guido Trotter's avatar
Guido Trotter committed
601
  """Rename an instance.
602

603
604
605
606
607
608
  @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
609
610
611
612
613

  """
  op = opcodes.OpRenameInstance(instance_name=args[0],
                                new_name=args[1],
                                ignore_ip=opts.ignore_ip)
614
  SubmitOrSend(op, opts)
615
616
617
  return 0


Iustin Pop's avatar
Iustin Pop committed
618
619
620
621
def ActivateDisks(opts, args):
  """Activate an instance's disks.

  This serves two purposes:
622
623
    - 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
624
625
    - it repairs inactive secondary drbds

626
627
628
629
630
631
  @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
632
633
634
  """
  instance_name = args[0]
  op = opcodes.OpActivateInstanceDisks(instance_name=instance_name)
635
  disks_info = SubmitOrSend(op, opts)
Iustin Pop's avatar
Iustin Pop committed
636
  for host, iname, nname in disks_info:
637
    ToStdout("%s:%s:%s", host, iname, nname)
Iustin Pop's avatar
Iustin Pop committed
638
639
640
641
  return 0


def DeactivateDisks(opts, args):
642
  """Deactivate an instance's disks..
Iustin Pop's avatar
Iustin Pop committed
643
644
645
646

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

647
648
649
650
651
652
  @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
653
654
655
  """
  instance_name = args[0]
  op = opcodes.OpDeactivateInstanceDisks(instance_name=instance_name)
656
  SubmitOrSend(op, opts)
Iustin Pop's avatar
Iustin Pop committed
657
658
659
  return 0


Iustin Pop's avatar
Iustin Pop committed
660
def GrowDisk(opts, args):
661
  """Grow an instance's disks.
Iustin Pop's avatar
Iustin Pop committed
662

663
664
665
666
667
668
  @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
669
670
671
672

  """
  instance = args[0]
  disk = args[1]
673
674
675
676
  try:
    disk = int(disk)
  except ValueError, err:
    raise errors.OpPrereqError("Invalid disk index: %s" % str(err))
Iustin Pop's avatar
Iustin Pop committed
677
  amount = utils.ParseUnit(args[2])
678
679
  op = opcodes.OpGrowDisk(instance_name=instance, disk=disk, amount=amount,
                          wait_for_sync=opts.wait_for_sync)
680
  SubmitOrSend(op, opts)
Iustin Pop's avatar
Iustin Pop committed
681
682
683
  return 0


Iustin Pop's avatar
Iustin Pop committed
684
def StartupInstance(opts, args):
685
  """Startup instances.
Iustin Pop's avatar
Iustin Pop committed
686

687
688
689
690
691
692
693
694
695
696
  Depending on the options given, this will start one or more
  instances.

  @param opts: the command line options selected by the user
  @type args: list
  @param args: the instance or node names based on which we
      create the final selection (in conjunction with the
      opts argument)
  @rtype: int
  @return: the desired exit code
Iustin Pop's avatar
Iustin Pop committed
697
698

  """
699
  cl = GetClient()
700
701
  if opts.multi_mode is None:
    opts.multi_mode = _SHUTDOWN_INSTANCES
702
  inames = _ExpandMultiNames(opts.multi_mode, args, client=cl)
703
704
  if not inames:
    raise errors.OpPrereqError("Selection filter does not match any instances")
705
706
707
708
  multi_on = opts.multi_mode != _SHUTDOWN_INSTANCES or len(inames) > 1
  if not (opts.force_multi or not multi_on
          or _ConfirmOperation(inames, "startup")):
    return 1
709
  jex = cli.JobExecutor(verbose=multi_on, cl=cl)
710
711
  for name in inames:
    op = opcodes.OpStartupInstance(instance_name=name,
712
                                   force=opts.force)
713
714
715
716
717
    # 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
718
719
    jex.QueueJob(name, op)
  jex.WaitOrShow(not opts.submit_only)
Iustin Pop's avatar
Iustin Pop committed
720
721
  return 0

722

723
def RebootInstance(opts, args):
724
725
726
727
  """Reboot instance(s).

  Depending on the parameters given, this will reboot one or more
  instances.
728

729
730
731
732
733
734
735
  @param opts: the command line options selected by the user
  @type args: list
  @param args: the instance or node names based on which we
      create the final selection (in conjunction with the
      opts argument)
  @rtype: int
  @return: the desired exit code
736
737

  """
738
  cl = GetClient()
739
740
  if opts.multi_mode is None:
    opts.multi_mode = _SHUTDOWN_INSTANCES
741
  inames = _ExpandMultiNames(opts.multi_mode, args, client=cl)
742
743
  if not inames:
    raise errors.OpPrereqError("Selection filter does not match any instances")
744
745
746
747
  multi_on = opts.multi_mode != _SHUTDOWN_INSTANCES or len(inames) > 1
  if not (opts.force_multi or not multi_on
          or _ConfirmOperation(inames, "reboot")):
    return 1
748
  jex = JobExecutor(verbose=multi_on, cl=cl)
749
750
751
752
  for name in inames:
    op = opcodes.OpRebootInstance(instance_name=name,
                                  reboot_type=opts.reboot_type,
                                  ignore_secondaries=opts.ignore_secondaries)
753
754
    jex.QueueJob(name, op)
  jex.WaitOrShow(not opts.submit_only)
755
  return 0
Iustin Pop's avatar
Iustin Pop committed
756

757

Iustin Pop's avatar
Iustin Pop committed
758
759
760
def ShutdownInstance(opts, args):
  """Shutdown an instance.

761
762
763
764
765
766
767
  @param opts: the command line options selected by the user
  @type args: list
  @param args: the instance or node names based on which we
      create the final selection (in conjunction with the
      opts argument)
  @rtype: int
  @return: the desired exit code
Iustin Pop's avatar
Iustin Pop committed
768
769

  """
770
  cl = GetClient()
771
772
  if opts.multi_mode is None:
    opts.multi_mode = _SHUTDOWN_INSTANCES
773
  inames = _ExpandMultiNames(opts.multi_mode, args, client=cl)
774
775
  if not inames:
    raise errors.OpPrereqError("Selection filter does not match any instances")
776
777
778
779
  multi_on = opts.multi_mode != _SHUTDOWN_INSTANCES or len(inames) > 1
  if not (opts.force_multi or not multi_on
          or _ConfirmOperation(inames, "shutdown")):
    return 1
780
781

  jex = cli.JobExecutor(verbose=multi_on, cl=cl)
782
783
  for name in inames:
    op = opcodes.OpShutdownInstance(instance_name=name)
784
785
    jex.QueueJob(name, op)
  jex.WaitOrShow(not opts.submit_only)
Iustin Pop's avatar
Iustin Pop committed
786
787
788
789
790
791
  return 0


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

792
793
794
795
796
  @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
797
798
799

  """
  instance_name = args[0]
800
  new_2ndary = opts.new_secondary
801
  iallocator = opts.iallocator
802
  if opts.disks is None:
803
    disks = []
804
  else:
805
806
807
808
    try:
      disks = [int(i) for i in opts.disks.split(",")]
    except ValueError, err:
      raise errors.OpPrereqError("Invalid disk index passed: %s" % str(err))
809
810
811
812
813
814
  cnt = [opts.on_primary, opts.on_secondary,
         new_2ndary is not None, iallocator is not None].count(True)
  if cnt != 1:
    raise errors.OpPrereqError("One and only one of the -p, -s, -n and -i"
                               " options must be passed")
  elif opts.on_primary:
815
    mode = constants.REPLACE_DISK_PRI
816
  elif opts.on_secondary:
817
    mode = constants.REPLACE_DISK_SEC
818
819
820
  elif new_2ndary is not None or iallocator is not None:
    # replace secondary
    mode = constants.REPLACE_DISK_CHG
821
822

  op = opcodes.OpReplaceDisks(instance_name=args[0], disks=disks,
823
824
                              remote_node=new_2ndary, mode=mode,
                              iallocator=iallocator)
825
  SubmitOrSend(op, opts)
Iustin Pop's avatar
Iustin Pop committed
826
827
828
829
830
831
832
833
834
  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.

835
836
837
838
839
  @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
840
841

  """
842
  cl = GetClient()
843
844
  instance_name = args[0]
  force = opts.force
Iustin Pop's avatar
Iustin Pop committed
845

846
  if not force:
847
848
    _EnsureInstancesExist(cl, [instance_name])

849
850
851
852
853
    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
854

855
856
  op = opcodes.OpFailoverInstance(instance_name=instance_name,
                                  ignore_consistency=opts.ignore_consistency)
857
  SubmitOrSend(op, opts, cl=cl)
858
  return 0
Iustin Pop's avatar
Iustin Pop committed
859
860


861
862
863
864
865
def MigrateInstance(opts, args):
  """Migrate an instance.

  The migrate is done without shutdown.

Iustin Pop's avatar
Iustin Pop committed
866
867
868
869
870
  @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
871
872

  """
873
  cl = GetClient()
874
875
876
877
  instance_name = args[0]
  force = opts.force

  if not force:
878
879
    _EnsureInstancesExist(cl, [instance_name])

880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
    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)
895
  SubmitOpCode(op, cl=cl)
896
897
898
  return 0


Iustin Pop's avatar
Iustin Pop committed
899
900
901
def ConnectToInstanceConsole(opts, args):
  """Connect to the console of an instance.

902
903
904
905
906
  @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
907
908
909
910
911

  """
  instance_name = args[0]

  op = opcodes.OpConnectConsole(instance_name=instance_name)
912
  cmd = SubmitOpCode(op)
913
914

  if opts.show_command:
915
    ToStdout("%s", utils.ShellQuoteArgs(cmd))
916
917
918
919
  else:
    try:
      os.execvp(cmd[0], cmd)
    finally:
920
      ToStderr("Can't run console command %s with arguments:\n'%s'",
921
               cmd[0], " ".join(cmd))
922
      os._exit(1)
Iustin Pop's avatar
Iustin Pop committed
923
924


925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
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
947
948
  """Show block device information.

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

952
953
954
955
  @type idx: int
  @param idx: the index of the current disk
  @type top_level: boolean
  @param top_level: if this a top-level disk?
956
957
958
959
960
  @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
961
962
  @return: a list of either strings, tuples or lists
      (which should be formatted at a higher indent level)
963

Iustin Pop's avatar
Iustin Pop committed
964
  """
965
  def helper(dtype, status):
966
967
968
969
970
971
    """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}
972
    @return: the string representing the status
973
974

    """
Iustin Pop's avatar
Iustin Pop committed
975
    if not status:
976
977
978
979
980
      return "not active"
    txt = ""
    (path, major, minor, syncp, estt, degr, ldisk) = status
    if major is None:
      major_string = "N/A"
Iustin Pop's avatar
Iustin Pop committed
981
    else:
982
      major_string = str(major)
983

984
985
986
987
988
989
990
991
992
993
994
    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
995
        else:
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
          sync_text += " ETA unknown"
      else:
        sync_text = "in sync"
      if degr:
        degr_text = "*DEGRADED*"
      else:
        degr_text = "ok"
      if ldisk:
        ldisk_text = " *MISSING DISK*"
      else:
        ldisk_text = ""
      txt += (" %s, status %s%s" % (sync_text, degr_text, ldisk_text))
    elif dtype == constants.LD_LV:
      if ldisk:
        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
1022
  else:
1023
1024
1025
1026
1027
    txt = "child %d" % idx
  d1 = ["- %s: %s" % (txt, dev["dev_type"])]
  data = []
  if top_level:
    data.append(("access mode", dev["mode"]))
Iustin Pop's avatar
Iustin Pop committed
1028
  if dev["logical_id"] is not None:
1029
1030
1031
1032
1033
1034
1035
1036
    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
1037
  elif dev["physical_id"] is not None:
1038
1039
    data.append("physical_id:")
    data.append([dev["physical_id"]])
1040
  if not static:
1041
    data.append(("on primary", helper(dev["dev_type"], dev["pstatus"])))
1042
  if dev["sstatus"] and not static:
1043
    data.append(("on secondary", helper(dev["dev_type"], dev["sstatus"])))
Iustin Pop's avatar
Iustin Pop committed
1044
1045

  if dev["children"]:
1046
1047
1048
1049
1050
    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
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
1078
1079
1080
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)

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

1084
1085
1086
1087
1088
1089
1090
  @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
1091
  """
Guido Trotter's avatar
Guido Trotter committed
1092
1093
1094
1095
1096
1097
1098
1099
1100
  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
1101
  retcode = 0
1102
  op = opcodes.OpQueryInstanceData(instances=args, static=opts.static)
Iustin Pop's avatar
Iustin Pop committed
1103
1104
  result = SubmitOpCode(op)
  if not result:
1105
    ToStdout("No instances.")
Iustin Pop's avatar
Iustin Pop committed
1106
1107
1108
1109
1110
1111
1112
    return 1

  buf = StringIO()
  retcode = 0
  for instance_name in result:
    instance = result[instance_name]
    buf.write("Instance name: %s\n" % instance["name"])
1113
1114
1115
1116
1117
1118
    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
1119
1120
1121
1122
    buf.write("  Nodes:\n")
    buf.write("    - primary: %s\n" % instance["pnode"])
    buf.write("    - secondaries: %s\n" % ", ".join(instance["snodes"]))
    buf.write("  Operating system: %s\n" % instance["os"])
1123
1124
    if instance.has_key("network_port"):
      buf.write("  Allocated network port: %s\n" % instance["network_port"])
1125
    buf.write("  Hypervisor: %s\n" % instance["hypervisor"])
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140

    # 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))
1141
      else:
1142
1143
1144
        # vnc bind address is a file
        vnc_console_port = "%s:%s" % (instance["pnode"],
                                      vnc_bind_address)
1145
1146
      buf.write("    - console connection: vnc to %s\n" % vnc_console_port)

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

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

1167
  ToStdout(buf.getvalue().rstrip('\n'))
Iustin Pop's avatar
Iustin Pop committed
1168
1169
1170
  return retcode


1171
def SetInstanceParams(opts, args):
Iustin Pop's avatar
Iustin Pop committed
1172
1173
1174
1175
  """Modifies an instance.

  All parameters take effect only at the next restart of the instance.

1176
1177
1178
1179
1180
  @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
1181
1182

  """
1183
  if not (opts.nics or opts.disks or
1184
          opts.hypervisor or opts.beparams):
1185
    ToStderr("Please give at least one of the parameters.")
Iustin Pop's avatar
Iustin Pop committed
1186
1187
    return 1

1188
  for param in opts.beparams:
1189
1190
1191
    if isinstance(opts.beparams[param], basestring):
      if opts.beparams[param].lower() == "default":
        opts.beparams[param] = constants.VALUE_DEFAULT
1192
1193
1194

  utils.ForceDictType(opts.beparams, constants.BES_PARAMETER_TYPES,
                      allowed_values=[constants.VALUE_DEFAULT])
1195
1196

  for param in opts.hypervisor:
1197
1198
1199
    if isinstance(opts.hypervisor[param], basestring):
      if opts.hypervisor[param].lower() == "default":
        opts.hypervisor[param] = constants.VALUE_DEFAULT
1200
1201
1202

  utils.ForceDictType(opts.hypervisor, constants.HVS_PARAMETER_TYPES,
                      allowed_values=[constants.VALUE_DEFAULT])
1203

1204
1205
1206
1207
1208
1209
1210
1211
1212