gnt-instance 34.9 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
22
23
#!/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.


import sys
import os
24
import itertools
Iustin Pop's avatar
Iustin Pop committed
25
26
27
28
29
30
31
32
from optparse import make_option
from cStringIO import StringIO

from ganeti.cli import *
from ganeti import opcodes
from ganeti import logger
from ganeti import constants
from ganeti import utils
33
34
35
36
37
38
39
40
41
from ganeti import errors


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

42

43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
def _ExpandMultiNames(mode, names):
  """Expand the given names using the passed mode.

  Args:
    - mode, which can be one of _SHUTDOWN_CLUSTER, _SHUTDOWN_NODES_BOTH,
      _SHUTDOWN_NODES_PRI, _SHUTDOWN_NODES_SEC or _SHUTDOWN_INSTANCES
    - names, which is 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)

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

  """
  if mode == _SHUTDOWN_CLUSTER:
    if names:
      raise errors.OpPrereqError("Cluster filter mode takes no arguments")
    op = opcodes.OpQueryInstances(output_fields=["name"], names=[])
    idata = SubmitOpCode(op)
    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")
    op = opcodes.OpQueryNodes(output_fields=["name", "pinst_list",
                                             "sinst_list"], names=names)
    ndata = SubmitOpCode(op)
    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")
    op = opcodes.OpQueryInstances(output_fields=["name"], names=names)
    idata = SubmitOpCode(op)
    inames = [row[0] for row in idata]

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

  return inames
Iustin Pop's avatar
Iustin Pop committed
101
102


103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
def _ConfirmOperation(inames, text):
  """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.

  The inames argument is what the selection algorithm computed, and
  the text argument is the operation we should tell the user to
  confirm (e.g. 'shutdown' or 'startup').

  Returns: boolean depending on user's confirmation.

  """
  count = len(inames)
  msg = ("The %s will operate on %d instances.\n"
         "Do you want to continue?" % (text, count))
  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)
    choice = AskUser(choices, msg + affected)
  return choice


138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
def _TransformPath(user_input):
  """Transform a user path into a canonical value.

  This function transforms the a path passed as textual information
  into the constants that the LU code expects.

  """
  if user_input:
    if user_input.lower() == "default":
      result_path = constants.VALUE_DEFAULT
    elif user_input.lower() == "none":
      result_path = constants.VALUE_NONE
    else:
      if not os.path.isabs(user_input):
        raise errors.OpPrereqError("Path '%s' is not an absolute filename" %
                                   user_input)
      result_path = user_input
  else:
    result_path = constants.VALUE_DEFAULT

  return result_path


Iustin Pop's avatar
Iustin Pop committed
161
def ListInstances(opts, args):
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
162
  """List instances and their properties.
Iustin Pop's avatar
Iustin Pop committed
163
164
165

  """
  if opts.output is None:
166
    selected_fields = ["name", "os", "pnode", "status", "oper_ram"]
Iustin Pop's avatar
Iustin Pop committed
167
168
169
  else:
    selected_fields = opts.output.split(",")

170
  op = opcodes.OpQueryInstances(output_fields=selected_fields, names=[])
Iustin Pop's avatar
Iustin Pop committed
171
172
173
  output = SubmitOpCode(op)

  if not opts.no_headers:
174
175
176
177
178
179
180
181
182
183
    headers = {
      "name": "Instance", "os": "OS", "pnode": "Primary_node",
      "snodes": "Secondary_Nodes", "admin_state": "Autostart",
      "oper_state": "Running", "admin_ram": "Configured_memory",
      "oper_ram": "Memory", "disk_template": "Disk_template",
      "ip": "IP Address", "mac": "MAC Address",
      "bridge": "Bridge", "vcpus": "VCPUs",
      "sda_size": "Disk/0", "sdb_size": "Disk/1",
      "status": "Status",
      }
184
185
186
187
  else:
    headers = None

  if opts.human_readable:
188
    unitfields = ["admin_ram", "oper_ram", "sda_size", "sdb_size"]
189
190
191
  else:
    unitfields = None

192
  numfields = ["admin_ram", "oper_ram", "sda_size", "sdb_size", "vcpus"]
193

194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
  # 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"
      row[idx] = str(val)

220
221
222
223
224
225
  data = GenerateTable(separator=opts.separator, headers=headers,
                       fields=selected_fields, unitfields=unitfields,
                       numfields=numfields, data=output)

  for line in data:
    logger.ToStdout(line)
Iustin Pop's avatar
Iustin Pop committed
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244

  return 0


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

  Args:
    opts - class with options as members
    args - list with a single element, the instance name
  Opts used:
    mem - amount of memory to allocate to instance (MiB)
    size - amount of disk space to allocate to instance (MiB)
    os - which OS to run on instance
    node - node to run new instance on

  """
  instance = args[0]

245
246
  (pnode, snode) = SplitNodeOption(opts.node)

247
248
249
  kernel_path = _TransformPath(opts.kernel_path)
  initrd_path = _TransformPath(opts.initrd_path)

Iustin Pop's avatar
Iustin Pop committed
250
251
252
253
  op = opcodes.OpCreateInstance(instance_name=instance, mem_size=opts.mem,
                                disk_size=opts.size, swap_size=opts.swap,
                                disk_template=opts.disk_template,
                                mode=constants.INSTANCE_CREATE,
254
255
                                os_type=opts.os, pnode=pnode,
                                snode=snode, vcpus=opts.vcpus,
256
257
                                ip=opts.ip, bridge=opts.bridge,
                                start=opts.start, ip_check=opts.ip_check,
258
259
260
                                wait_for_sync=opts.wait_for_sync,
                                mac=opts.mac,
                                kernel_path=kernel_path,
261
262
                                initrd_path=initrd_path,
                                hvm_boot_order=opts.hvm_boot_order)
Iustin Pop's avatar
Iustin Pop committed
263
264
265
266
  SubmitOpCode(op)
  return 0


267
268
269
270
271
272
273
274
275
276
277
def ReinstallInstance(opts, args):
  """Reinstall an instance.

  Args:
    opts - class with options as members
    args - list containing a single element, the instance name

  """
  instance_name = args[0]

  if not opts.force:
278
279
    usertext = ("This will reinstall the instance %s and remove"
                " all data. Continue?") % instance_name
280
    if not AskUser(usertext):
281
282
      return 1

283
284
  op = opcodes.OpReinstallInstance(instance_name=instance_name,
                                   os_type=opts.os)
285
286
287
288
289
  SubmitOpCode(op)

  return 0


Iustin Pop's avatar
Iustin Pop committed
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
def RemoveInstance(opts, args):
  """Remove an instance.

  Args:
    opts - class with options as members
    args - list containing a single element, the instance name

  """
  instance_name = args[0]
  force = opts.force

  if not force:
    usertext = ("This will remove the volumes of the instance %s"
                " (including mirrors), thus removing all the data"
                " of the instance. Continue?") % instance_name
305
    if not AskUser(usertext):
Iustin Pop's avatar
Iustin Pop committed
306
307
      return 1

Iustin Pop's avatar
Iustin Pop committed
308
309
  op = opcodes.OpRemoveInstance(instance_name=instance_name,
                                ignore_failures=opts.ignore_failures)
Iustin Pop's avatar
Iustin Pop committed
310
311
312
313
  SubmitOpCode(op)
  return 0


314
def RenameInstance(opts, args):
Guido Trotter's avatar
Guido Trotter committed
315
  """Rename an instance.
316
317
318
319
320
321
322
323
324
325
326
327
328
329

  Args:
    opts - class with options as members
    args - list containing two elements, the instance name and the new name

  """
  op = opcodes.OpRenameInstance(instance_name=args[0],
                                new_name=args[1],
                                ignore_ip=opts.ignore_ip)
  SubmitOpCode(op)

  return 0


Iustin Pop's avatar
Iustin Pop committed
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
def ActivateDisks(opts, args):
  """Activate an instance's disks.

  This serves two purposes:
    - it allows one (as long as the instance is not running) to mount
    the disks and modify them from the node
    - it repairs inactive secondary drbds

  """
  instance_name = args[0]
  op = opcodes.OpActivateInstanceDisks(instance_name=instance_name)
  disks_info = SubmitOpCode(op)
  for host, iname, nname in disks_info:
    print "%s:%s:%s" % (host, iname, nname)
  return 0


def DeactivateDisks(opts, args):
  """Command-line interface for _ShutdownInstanceBlockDevices.

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

  """
  instance_name = args[0]
  op = opcodes.OpDeactivateInstanceDisks(instance_name=instance_name)
  SubmitOpCode(op)
  return 0


def StartupInstance(opts, args):
361
  """Startup an instance.
Iustin Pop's avatar
Iustin Pop committed
362
363
364
365
366
367

  Args:
    opts - class with options as members
    args - list containing a single element, the instance name

  """
368
369
370
  if opts.multi_mode is None:
    opts.multi_mode = _SHUTDOWN_INSTANCES
  inames = _ExpandMultiNames(opts.multi_mode, args)
371
372
  if not inames:
    raise errors.OpPrereqError("Selection filter does not match any instances")
373
374
375
376
  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
377
378
379
380
381
382
383
  for name in inames:
    op = opcodes.OpStartupInstance(instance_name=name,
                                   force=opts.force,
                                   extra_args=opts.extra_args)
    if multi_on:
      logger.ToStdout("Starting up %s" % name)
    SubmitOpCode(op)
Iustin Pop's avatar
Iustin Pop committed
384
385
  return 0

386

387
388
389
390
391
392
393
394
395
396
397
def RebootInstance(opts, args):
  """Reboot an instance

  Args:
    opts - class with options as members
    args - list containing a single element, the instance name

  """
  if opts.multi_mode is None:
    opts.multi_mode = _SHUTDOWN_INSTANCES
  inames = _ExpandMultiNames(opts.multi_mode, args)
398
399
  if not inames:
    raise errors.OpPrereqError("Selection filter does not match any instances")
400
401
402
403
404
405
406
407
408
409
410
  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
  for name in inames:
    op = opcodes.OpRebootInstance(instance_name=name,
                                  reboot_type=opts.reboot_type,
                                  ignore_secondaries=opts.ignore_secondaries)

    SubmitOpCode(op)
  return 0
Iustin Pop's avatar
Iustin Pop committed
411

412

Iustin Pop's avatar
Iustin Pop committed
413
414
415
416
417
418
419
420
def ShutdownInstance(opts, args):
  """Shutdown an instance.

  Args:
    opts - class with options as members
    args - list containing a single element, the instance name

  """
421
422
423
  if opts.multi_mode is None:
    opts.multi_mode = _SHUTDOWN_INSTANCES
  inames = _ExpandMultiNames(opts.multi_mode, args)
424
425
  if not inames:
    raise errors.OpPrereqError("Selection filter does not match any instances")
426
427
428
429
  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
430
431
432
433
434
  for name in inames:
    op = opcodes.OpShutdownInstance(instance_name=name)
    if multi_on:
      logger.ToStdout("Shutting down %s" % name)
    SubmitOpCode(op)
Iustin Pop's avatar
Iustin Pop committed
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
  return 0


def AddMDDRBDComponent(opts, args):
  """Add a new component to a remote_raid1 disk.

  Args:
    opts - class with options as members
    args - list with a single element, the instance name

  """
  op = opcodes.OpAddMDDRBDComponent(instance_name=args[0],
                                    disk_name=opts.disk,
                                    remote_node=opts.node)
  SubmitOpCode(op)
  return 0


def RemoveMDDRBDComponent(opts, args):
Guido Trotter's avatar
Guido Trotter committed
454
  """Remove a component from a remote_raid1 disk.
Iustin Pop's avatar
Iustin Pop committed
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476

  Args:
    opts - class with options as members
    args - list with a single element, the instance name

  """
  op = opcodes.OpRemoveMDDRBDComponent(instance_name=args[0],
                                       disk_name=opts.disk,
                                       disk_id=opts.port)
  SubmitOpCode(op)
  return 0


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

  Args:
    opts - class with options as members
    args - list with a single element, the instance name

  """
  instance_name = args[0]
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
  new_2ndary = opts.new_secondary
  if opts.disks is None:
    disks = ["sda", "sdb"]
  else:
    disks = opts.disks.split(",")
  if opts.on_primary == opts.on_secondary: # no -p or -s passed, or both passed
    mode = constants.REPLACE_DISK_ALL
  elif opts.on_primary: # only on primary:
    mode = constants.REPLACE_DISK_PRI
    if new_2ndary is not None:
      raise errors.OpPrereqError("Can't change secondary node on primary disk"
                                 " replacement")
  elif opts.on_secondary is not None: # only on secondary
    mode = constants.REPLACE_DISK_SEC

  op = opcodes.OpReplaceDisks(instance_name=args[0], disks=disks,
                              remote_node=new_2ndary, mode=mode)
Iustin Pop's avatar
Iustin Pop committed
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
  SubmitOpCode(op)
  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.

  Args:
    opts - class with options as members
    args - list with a single element, the instance name
  Opts used:
    force - whether to failover without asking questions.

  """
511
512
  instance_name = args[0]
  force = opts.force
Iustin Pop's avatar
Iustin Pop committed
513

514
515
516
517
518
519
  if not force:
    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
520

521
522
523
524
  op = opcodes.OpFailoverInstance(instance_name=instance_name,
                                  ignore_consistency=opts.ignore_consistency)
  SubmitOpCode(op)
  return 0
Iustin Pop's avatar
Iustin Pop committed
525
526
527
528
529
530
531
532
533
534
535
536
537


def ConnectToInstanceConsole(opts, args):
  """Connect to the console of an instance.

  Args:
    opts - class with options as members
    args - list with a single element, the instance name

  """
  instance_name = args[0]

  op = opcodes.OpConnectConsole(instance_name=instance_name)
Iustin Pop's avatar
Iustin Pop committed
538
  cmd, argv = SubmitOpCode(op)
Iustin Pop's avatar
Iustin Pop committed
539
540
541
  # drop lock and exec so other commands can run while we have console
  utils.Unlock("cmd")
  try:
Iustin Pop's avatar
Iustin Pop committed
542
    os.execvp(cmd, argv)
Iustin Pop's avatar
Iustin Pop committed
543
  finally:
Iustin Pop's avatar
Iustin Pop committed
544
545
    sys.stderr.write("Can't run console command %s with arguments:\n'%s'" %
                     (cmd, " ".join(argv)))
Iustin Pop's avatar
Iustin Pop committed
546
547
548
549
550
551
552
553
554
555
556
    os._exit(1)


def _FormatBlockDevInfo(buf, dev, indent_level):
  """Show block device information.

  This is only used by ShowInstanceConfig(), but it's too big to be
  left for an inline definition.

  """
  def helper(buf, dtype, status):
Alexander Schreiber's avatar
Alexander Schreiber committed
557
    """Format one line for physical device status."""
Iustin Pop's avatar
Iustin Pop committed
558
559
560
    if not status:
      buf.write("not active\n")
    else:
561
      (path, major, minor, syncp, estt, degr, ldisk) = status
Iustin Pop's avatar
Iustin Pop committed
562
      buf.write("%s (%d:%d)" % (path, major, minor))
563
      if dtype in (constants.LD_MD_R1, constants.LD_DRBD7, constants.LD_DRBD8):
Iustin Pop's avatar
Iustin Pop committed
564
565
566
567
568
569
570
571
572
573
574
575
        if syncp is not None:
          sync_text = "*RECOVERING* %5.2f%%," % syncp
          if estt:
            sync_text += " ETA %ds" % estt
          else:
            sync_text += " ETA unknown"
        else:
          sync_text = "in sync"
        if degr:
          degr_text = "*DEGRADED*"
        else:
          degr_text = "ok"
576
577
578
579
580
        if ldisk:
          ldisk_text = " *MISSING DISK*"
        else:
          ldisk_text = ""
        buf.write(" %s, status %s%s" % (sync_text, degr_text, ldisk_text))
581
      elif dtype == constants.LD_LV:
582
583
        if ldisk:
          ldisk_text = " *FAILED* (failed drive?)"
584
        else:
585
586
          ldisk_text = ""
        buf.write(ldisk_text)
Iustin Pop's avatar
Iustin Pop committed
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
      buf.write("\n")

  if dev["iv_name"] is not None:
    data = "  - %s, " % dev["iv_name"]
  else:
    data = "  - "
  data += "type: %s" % dev["dev_type"]
  if dev["logical_id"] is not None:
    data += ", logical_id: %s" % (dev["logical_id"],)
  elif dev["physical_id"] is not None:
    data += ", physical_id: %s" % (dev["physical_id"],)
  buf.write("%*s%s\n" % (2*indent_level, "", data))
  buf.write("%*s    primary:   " % (2*indent_level, ""))
  helper(buf, dev["dev_type"], dev["pstatus"])

  if dev["sstatus"]:
    buf.write("%*s    secondary: " % (2*indent_level, ""))
    helper(buf, dev["dev_type"], dev["sstatus"])

  if dev["children"]:
    for child in dev["children"]:
      _FormatBlockDevInfo(buf, child, indent_level+1)


def ShowInstanceConfig(opts, args):
  """Compute instance run-time status.

  """
  retcode = 0
  op = opcodes.OpQueryInstanceData(instances=args)
  result = SubmitOpCode(op)

  if not result:
    logger.ToStdout("No instances.")
    return 1

  buf = StringIO()
  retcode = 0
  for instance_name in result:
    instance = result[instance_name]
    buf.write("Instance name: %s\n" % instance["name"])
    buf.write("State: configured to be %s, actual state is %s\n" %
              (instance["config_state"], instance["run_state"]))
    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"])
634
    buf.write("  Allocated network port: %s\n" % instance["network_port"])
635
636
637
638
639
640
641
642
643
644
645
646
    if instance["kernel_path"] in (None, constants.VALUE_DEFAULT):
      kpath = "(default: %s)" % constants.XEN_KERNEL
    else:
      kpath = instance["kernel_path"]
    buf.write("  Kernel path: %s\n" % kpath)
    if instance["initrd_path"] in (None, constants.VALUE_DEFAULT):
      initrd = "(default: %s)" % constants.XEN_INITRD
    elif instance["initrd_path"] == constants.VALUE_NONE:
      initrd = "(none)"
    else:
      initrd = instance["initrd_path"]
    buf.write("       initrd: %s\n" % initrd)
647
    buf.write("  HVM boot order: %s\n" % instance["hvm_boot_order"])
Iustin Pop's avatar
Iustin Pop committed
648
    buf.write("  Hardware:\n")
649
    buf.write("    - VCPUs: %d\n" % instance["vcpus"])
Iustin Pop's avatar
Iustin Pop committed
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
    buf.write("    - memory: %dMiB\n" % instance["memory"])
    buf.write("    - NICs: %s\n" %
        ", ".join(["{MAC: %s, IP: %s, bridge: %s}" %
                   (mac, ip, bridge)
                     for mac, ip, bridge in instance["nics"]]))
    buf.write("  Block devices:\n")

    for device in instance["disks"]:
      _FormatBlockDevInfo(buf, device, 1)

  logger.ToStdout(buf.getvalue().rstrip('\n'))
  return retcode


def SetInstanceParms(opts, args):
  """Modifies an instance.

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

  Args:
    opts - class with options as members
    args - list with a single element, the instance name
  Opts used:
    memory - the new memory size
    vcpus - the new number of cpus
675
    mac - the new MAC address of the instance
Iustin Pop's avatar
Iustin Pop committed
676
677

  """
678
  if not (opts.mem or opts.vcpus or opts.ip or opts.bridge or opts.mac or
679
          opts.kernel_path or opts.initrd_path or opts.hvm_boot_order):
Iustin Pop's avatar
Iustin Pop committed
680
681
682
    logger.ToStdout("Please give at least one of the parameters.")
    return 1

683
684
  kernel_path = _TransformPath(opts.kernel_path)
  initrd_path = _TransformPath(opts.initrd_path)
685
  if opts.hvm_boot_order == 'default':
686
687
688
    hvm_boot_order = constants.VALUE_DEFAULT
  else:
    hvm_boot_order = opts.hvm_boot_order
689

Iustin Pop's avatar
Iustin Pop committed
690
691
  op = opcodes.OpSetInstanceParms(instance_name=args[0], mem=opts.mem,
                                  vcpus=opts.vcpus, ip=opts.ip,
692
693
                                  bridge=opts.bridge, mac=opts.mac,
                                  kernel_path=opts.kernel_path,
694
695
                                  initrd_path=opts.initrd_path,
                                  hvm_boot_order=hvm_boot_order)
Iustin Pop's avatar
Iustin Pop committed
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
  result = SubmitOpCode(op)

  if result:
    logger.ToStdout("Modified instance %s" % args[0])
    for param, data in result:
      logger.ToStdout(" - %-5s -> %s" % (param, data))
    logger.ToStdout("Please don't forget that these parameters take effect"
                    " only at the next start of the instance.")
  return 0


# options used in more than one cmd
node_opt = make_option("-n", "--node", dest="node", help="Target node",
                       metavar="<node>")

711
os_opt = cli_option("-o", "--os-type", dest="os", help="What OS to run",
Michael Hanselmann's avatar
Michael Hanselmann committed
712
                    metavar="<os>")
713

714
# multi-instance selection options
715
716
717
718
719
m_force_multi = make_option("--force-multiple", dest="force_multi",
                            help="Do not ask for confirmation when more than"
                            " one instance is affected",
                            action="store_true", default=False)

720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
m_pri_node_opt = make_option("--primary", dest="multi_mode",
                             help="Filter by nodes (primary only)",
                             const=_SHUTDOWN_NODES_PRI, action="store_const")

m_sec_node_opt = make_option("--secondary", dest="multi_mode",
                             help="Filter by nodes (secondary only)",
                             const=_SHUTDOWN_NODES_SEC, action="store_const")

m_node_opt = make_option("--node", dest="multi_mode",
                         help="Filter by nodes (primary and secondary)",
                         const=_SHUTDOWN_NODES_BOTH, action="store_const")

m_clust_opt = make_option("--all", dest="multi_mode",
                          help="Select all instances in the cluster",
                          const=_SHUTDOWN_CLUSTER, action="store_const")

m_inst_opt = make_option("--instance", dest="multi_mode",
                         help="Filter by instance name [default]",
                         const=_SHUTDOWN_INSTANCES, action="store_const")


Iustin Pop's avatar
Iustin Pop committed
741
742
743
# this is defined separately due to readability only
add_opts = [
  DEBUG_OPT,
744
745
746
  make_option("-n", "--node", dest="node",
              help="Target node and optional secondary node",
              metavar="<pnode>[:<snode>]"),
747
748
  cli_option("-s", "--os-size", dest="size", help="Disk size, in MiB unless"
             " a suffix is used",
Iustin Pop's avatar
Iustin Pop committed
749
             default=20 * 1024, type="unit", metavar="<size>"),
750
751
  cli_option("--swap-size", dest="swap", help="Swap size, in MiB unless a"
             " suffix is used",
Iustin Pop's avatar
Iustin Pop committed
752
             default=4 * 1024, type="unit", metavar="<size>"),
753
  os_opt,
754
  cli_option("-m", "--memory", dest="mem", help="Memory size (in MiB)",
Iustin Pop's avatar
Iustin Pop committed
755
756
757
758
              default=128, type="unit", metavar="<mem>"),
  make_option("-p", "--cpu", dest="vcpus", help="Number of virtual CPUs",
              default=1, type="int", metavar="<PROC>"),
  make_option("-t", "--disk-template", dest="disk_template",
759
760
              help="Custom disk setup (diskless, plain, local_raid1,"
              " remote_raid1 or drbd)", default=None, metavar="TEMPL"),
Iustin Pop's avatar
Iustin Pop committed
761
762
763
  make_option("-i", "--ip", dest="ip",
              help="IP address ('none' [default], 'auto', or specify address)",
              default='none', type="string", metavar="<ADDRESS>"),
764
765
766
  make_option("--mac", dest="mac",
              help="MAC address ('auto' [default], or specify address)",
              default='auto', type="string", metavar="<MACADDRESS>"),
Iustin Pop's avatar
Iustin Pop committed
767
768
769
770
  make_option("--no-wait-for-sync", dest="wait_for_sync", default=True,
              action="store_false", help="Don't wait for sync (DANGEROUS!)"),
  make_option("-b", "--bridge", dest="bridge",
              help="Bridge to connect this instance to",
771
772
773
774
775
776
777
              default=None, metavar="<bridge>"),
  make_option("--no-start", dest="start", default=True,
              action="store_false", help="Don't start the instance after"
              " creation"),
  make_option("--no-ip-check", dest="ip_check", default=True,
              action="store_false", help="Don't check that the instance's IP"
              " is alive (only valid with --no-start)"),
778
779
780
781
782
783
784
785
  make_option("--kernel", dest="kernel_path",
              help="Path to the instances' kernel (or 'default')",
              default=None,
              type="string", metavar="<FILENAME>"),
  make_option("--initrd", dest="initrd_path",
              help="Path to the instances' initrd (or 'none', or 'default')",
              default=None,
              type="string", metavar="<FILENAME>"),
786
787
788
  make_option("--hvm-boot-order", dest="hvm_boot_order",
              help="boot device order for HVM (one or more of [acdn])",
              default=None, type="string", metavar="<BOOTORDER>"),
Iustin Pop's avatar
Iustin Pop committed
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
  ]

commands = {
  'add': (AddInstance, ARGS_ONE, add_opts,
          "[opts...] <name>",
          "Creates and adds a new instance to the cluster"),
  'add-mirror': (AddMDDRBDComponent, ARGS_ONE,
                [DEBUG_OPT, node_opt,
                 make_option("-b", "--disk", dest="disk", metavar="sdX",
                             help=("The name of the instance disk for which to"
                                   " add the mirror"))],
                "-n node -b disk <instance>",
                "Creates a new mirror for the instance"),
  'console': (ConnectToInstanceConsole, ARGS_ONE, [DEBUG_OPT],
              "<instance>",
              "Opens a console on the specified instance"),
805
  'failover': (FailoverInstance, ARGS_ONE,
806
               [DEBUG_OPT, FORCE_OPT,
Iustin Pop's avatar
Iustin Pop committed
807
808
809
810
811
812
813
814
815
816
817
                make_option("--ignore-consistency", dest="ignore_consistency",
                            action="store_true", default=False,
                            help="Ignore the consistency of the disks on"
                            " the secondary"),
                ],
               "[-f] <instance>",
               "Stops the instance and starts it on the backup node, using"
               " the remote mirror (only for instances of type remote_raid1)"),
  'info': (ShowInstanceConfig, ARGS_ANY, [DEBUG_OPT], "[<instance>...]",
           "Show information on the specified instance"),
  'list': (ListInstances, ARGS_NONE,
818
819
820
           [DEBUG_OPT, NOHDR_OPT, SEP_OPT, USEUNITS_OPT, FIELDS_OPT], "",
           "Lists the instances and their status. The available fields are"
           " (see the man page for details): status, oper_state, oper_ram,"
821
822
           " name, os, pnode, snodes, admin_state, admin_ram, disk_template,"
           " ip, mac, bridge, sda_size, sdb_size, vcpus. The default field"
823
           " list is (in order): name, os, pnode, status,"
824
           " oper_ram."),
825
  'reinstall': (ReinstallInstance, ARGS_ONE, [DEBUG_OPT, FORCE_OPT, os_opt],
826
                "[-f] <instance>", "Reinstall a stopped instance"),
Iustin Pop's avatar
Iustin Pop committed
827
828
829
830
831
832
833
834
  'remove': (RemoveInstance, ARGS_ONE,
             [DEBUG_OPT, FORCE_OPT,
              make_option("--ignore-failures", dest="ignore_failures",
                          action="store_true", default=False,
                          help=("Remove the instance from the cluster even"
                                " if there are failures during the removal"
                                " process (shutdown, disk removal, etc.)")),
              ],
Iustin Pop's avatar
Iustin Pop committed
835
836
837
838
839
840
841
842
843
844
845
846
847
             "[-f] <instance>", "Shuts down the instance and removes it"),
  'remove-mirror': (RemoveMDDRBDComponent, ARGS_ONE,
                   [DEBUG_OPT, node_opt,
                    make_option("-b", "--disk", dest="disk", metavar="sdX",
                                help=("The name of the instance disk"
                                      " for which to add the mirror")),
                    make_option("-p", "--port", dest="port", metavar="PORT",
                                help=("The port of the drbd device"
                                      " which to remove from the mirror"),
                                type="int"),
                    ],
                   "-b disk -p port <instance>",
                   "Removes a mirror from the instance"),
848
849
850
851
852
853
854
855
  'rename': (RenameInstance, ARGS_FIXED(2),
             [DEBUG_OPT,
              make_option("--no-ip-check", dest="ignore_ip",
                          help="Do not check that the IP of the new name"
                          " is alive",
                          default=False, action="store_true"),
              ],
             "<instance> <new_name>", "Rename the instance"),
Iustin Pop's avatar
Iustin Pop committed
856
857
858
  'replace-disks': (ReplaceDisks, ARGS_ONE,
                    [DEBUG_OPT,
                     make_option("-n", "--new-secondary", dest="new_secondary",
859
860
861
862
863
                                 help=("New secondary node (for secondary"
                                       " node change)"), metavar="NODE"),
                     make_option("-p", "--on-primary", dest="on_primary",
                                 default=False, action="store_true",
                                 help=("Replace the disk(s) on the primary"
864
                                       " node (only for the drbd template)")),
865
866
867
                     make_option("-s", "--on-secondary", dest="on_secondary",
                                 default=False, action="store_true",
                                 help=("Replace the disk(s) on the secondary"
868
                                       " node (only for the drbd template)")),
869
870
871
872
873
                     make_option("--disks", dest="disks", default=None,
                                 help=("Comma-separated list of disks"
                                       " to replace (e.g. sda) (optional,"
                                       " defaults to all disks")),
                     ],
Iustin Pop's avatar
Iustin Pop committed
874
875
876
                    "[-n NODE] <instance>",
                    "Replaces all disks for the instance"),
  'modify': (SetInstanceParms, ARGS_ONE,
877
             [DEBUG_OPT, FORCE_OPT,
Iustin Pop's avatar
Iustin Pop committed
878
879
880
881
882
883
884
885
886
887
888
              cli_option("-m", "--memory", dest="mem",
                         help="Memory size",
                         default=None, type="unit", metavar="<mem>"),
              make_option("-p", "--cpu", dest="vcpus",
                          help="Number of virtual CPUs",
                          default=None, type="int", metavar="<PROC>"),
              make_option("-i", "--ip", dest="ip",
                          help="IP address ('none' or numeric IP)",
                          default=None, type="string", metavar="<ADDRESS>"),
              make_option("-b", "--bridge", dest="bridge",
                          help="Bridge to connect this instance to",
889
                          default=None, type="string", metavar="<bridge>"),
890
891
892
              make_option("--mac", dest="mac",
                          help="MAC address", default=None,
                          type="string", metavar="<MACADDRESS>"),
893
894
895
896
897
898
899
900
              make_option("--kernel", dest="kernel_path",
                          help="Path to the instances' kernel (or"
                          " 'default')", default=None,
                          type="string", metavar="<FILENAME>"),
              make_option("--initrd", dest="initrd_path",
                          help="Path to the instances' initrd (or 'none', or"
                          " 'default')", default=None,
                          type="string", metavar="<FILENAME>"),
901
902
903
904
              make_option("--hvm-boot-order", dest="hvm_boot_order",
                          help="boot device order for HVM"
                          "(either one or more of [acdn] or 'default')",
                          default=None, type="string", metavar="<BOOTORDER>"),
Iustin Pop's avatar
Iustin Pop committed
905
906
              ],
             "<instance>", "Alters the parameters of an instance"),
907
908
  'shutdown': (ShutdownInstance, ARGS_ANY,
               [DEBUG_OPT, m_node_opt, m_pri_node_opt, m_sec_node_opt,
909
                m_clust_opt, m_inst_opt, m_force_multi],
Iustin Pop's avatar
Iustin Pop committed
910
               "<instance>", "Stops an instance"),
911
  'startup': (StartupInstance, ARGS_ANY,
912
              [DEBUG_OPT, FORCE_OPT, m_force_multi,
Iustin Pop's avatar
Iustin Pop committed
913
914
915
               make_option("-e", "--extra", dest="extra_args",
                           help="Extra arguments for the instance's kernel",
                           default=None, type="string", metavar="<PARAMS>"),
916
917
               m_node_opt, m_pri_node_opt, m_sec_node_opt,
               m_clust_opt, m_inst_opt,
Iustin Pop's avatar
Iustin Pop committed
918
919
               ],
            "<instance>", "Starts an instance"),
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936

  'reboot': (RebootInstance, ARGS_ANY,
              [DEBUG_OPT, m_force_multi,
               make_option("-e", "--extra", dest="extra_args",
                           help="Extra arguments for the instance's kernel",
                           default=None, type="string", metavar="<PARAMS>"),
               make_option("-t", "--type", dest="reboot_type",
                           help="Type of reboot: soft/hard/full",
                           default=constants.INSTANCE_REBOOT_SOFT,
                           type="string", metavar="<REBOOT>"),
               make_option("--ignore-secondaries", dest="ignore_secondaries",
                           default=False, action="store_true",
                           help="Ignore errors from secondaries"),
               m_node_opt, m_pri_node_opt, m_sec_node_opt,
               m_clust_opt, m_inst_opt,
               ],
            "<instance>", "Reboots an instance"),
Iustin Pop's avatar
Iustin Pop committed
937
938
939
940
941
942
  'activate-disks': (ActivateDisks, ARGS_ONE, [DEBUG_OPT],
                     "<instance>",
                     "Activate an instance's disks"),
  'deactivate-disks': (DeactivateDisks, ARGS_ONE, [DEBUG_OPT],
                       "<instance>",
                       "Deactivate an instance's disks"),
943
944
  'list-tags': (ListTags, ARGS_ONE, [DEBUG_OPT],
                "<node_name>", "List the tags of the given instance"),
945
  'add-tags': (AddTags, ARGS_ATLEAST(1), [DEBUG_OPT, TAG_SRC_OPT],
946
               "<node_name> tag...", "Add tags to the given instance"),
947
  'remove-tags': (RemoveTags, ARGS_ATLEAST(1), [DEBUG_OPT, TAG_SRC_OPT],
948
                  "<node_name> tag...", "Remove tags from given instance"),
Iustin Pop's avatar
Iustin Pop committed
949
950
  }

Guido Trotter's avatar
Guido Trotter committed
951
952
aliases = {
  'activate_block_devs': 'activate-disks',
953
  'replace_disks': 'replace-disks',
954
955
  'start': 'startup',
  'stop': 'shutdown',
Guido Trotter's avatar
Guido Trotter committed
956
957
  }

Iustin Pop's avatar
Iustin Pop committed
958
if __name__ == '__main__':
Guido Trotter's avatar
Guido Trotter committed
959
  sys.exit(GenericMain(commands, aliases=aliases,
960
                       override={"tag_type": constants.TAG_INSTANCE}))