gnt_cluster.py 46.4 KB
Newer Older
1
#
Iustin Pop's avatar
Iustin Pop committed
2
3
#

4
# Copyright (C) 2006, 2007, 2010, 2011 Google Inc.
Iustin Pop's avatar
Iustin Pop committed
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
#
# 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.

Iustin Pop's avatar
Iustin Pop committed
21
"""Cluster related commands"""
Iustin Pop's avatar
Iustin Pop committed
22

23
# pylint: disable=W0401,W0613,W0614,C0103
24
# W0401: Wildcard import ganeti.cli
25
# W0613: Unused argument, since all functions follow the same API
26
# W0614: Unused import %s from wildcard import (since we need cli)
Iustin Pop's avatar
Iustin Pop committed
27
# C0103: Invalid name gnt-cluster
28

29
import os.path
30
import time
31
import OpenSSL
René Nussbaumer's avatar
René Nussbaumer committed
32
import itertools
Iustin Pop's avatar
Iustin Pop committed
33
34
35

from ganeti.cli import *
from ganeti import opcodes
36
from ganeti import constants
37
from ganeti import errors
38
from ganeti import utils
39
from ganeti import bootstrap
40
from ganeti import ssh
41
from ganeti import objects
42
from ganeti import uidpool
43
from ganeti import compat
René Nussbaumer's avatar
René Nussbaumer committed
44
45
46
47
48
49
50
51
52
53
54
55
56
57
from ganeti import netutils


ON_OPT = cli_option("--on", default=False,
                    action="store_true", dest="on",
                    help="Recover from an EPO")

GROUPS_OPT = cli_option("--groups", default=False,
                    action="store_true", dest="groups",
                    help="Arguments are node groups instead of nodes")

_EPO_PING_INTERVAL = 30 # 30 seconds between pings
_EPO_PING_TIMEOUT = 1 # 1 second
_EPO_REACHABLE_TIMEOUT = 15 * 60 # 15 minutes
Iustin Pop's avatar
Iustin Pop committed
58
59


60
@UsesRPC
Iustin Pop's avatar
Iustin Pop committed
61
62
63
def InitCluster(opts, args):
  """Initialize the cluster.

64
65
66
67
68
69
  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain only one element, the desired
      cluster name
  @rtype: int
  @return: the desired exit code
Iustin Pop's avatar
Iustin Pop committed
70
71

  """
72
  if not opts.lvm_storage and opts.vg_name:
73
    ToStderr("Options --no-lvm-storage and --vg-name conflict.")
74
75
76
77
78
79
    return 1

  vg_name = opts.vg_name
  if opts.lvm_storage and not opts.vg_name:
    vg_name = constants.DEFAULT_VG

80
81
82
83
84
85
86
87
  if not opts.drbd_storage and opts.drbd_helper:
    ToStderr("Options --no-drbd-storage and --drbd-usermode-helper conflict.")
    return 1

  drbd_helper = opts.drbd_helper
  if opts.drbd_storage and not opts.drbd_helper:
    drbd_helper = constants.DEFAULT_DRBD_HELPER

88
89
90
91
  master_netdev = opts.master_netdev
  if master_netdev is None:
    master_netdev = constants.DEFAULT_BRIDGE

92
  hvlist = opts.enabled_hypervisors
93
94
  if hvlist is None:
    hvlist = constants.DEFAULT_ENABLED_HYPERVISOR
95
  hvlist = hvlist.split(",")
96

97
  hvparams = dict(opts.hvparams)
98
  beparams = opts.beparams
99
  nicparams = opts.nicparams
100
101

  # prepare beparams dict
102
  beparams = objects.FillDict(constants.BEC_DEFAULTS, beparams)
103
  utils.ForceDictType(beparams, constants.BES_PARAMETER_TYPES)
104

105
106
107
108
  # prepare nicparams dict
  nicparams = objects.FillDict(constants.NICC_DEFAULTS, nicparams)
  utils.ForceDictType(nicparams, constants.NICS_PARAMETER_TYPES)

109
110
111
112
113
114
115
  # prepare ndparams dict
  if opts.ndparams is None:
    ndparams = dict(constants.NDC_DEFAULTS)
  else:
    ndparams = objects.FillDict(constants.NDC_DEFAULTS, opts.ndparams)
    utils.ForceDictType(ndparams, constants.NDS_PARAMETER_TYPES)

116
117
118
119
  # prepare hvparams dict
  for hv in constants.HYPER_TYPES:
    if hv not in hvparams:
      hvparams[hv] = {}
120
    hvparams[hv] = objects.FillDict(constants.HVC_DEFAULTS[hv], hvparams[hv])
121
    utils.ForceDictType(hvparams[hv], constants.HVS_PARAMETER_TYPES)
122

123
124
125
  if opts.candidate_pool_size is None:
    opts.candidate_pool_size = constants.MASTER_POOL_SIZE_DEFAULT

126
127
128
  if opts.mac_prefix is None:
    opts.mac_prefix = constants.DEFAULT_MAC_PREFIX

129
130
131
132
  uid_pool = opts.uid_pool
  if uid_pool is not None:
    uid_pool = uidpool.ParseUidPool(uid_pool)

133
134
135
  if opts.prealloc_wipe_disks is None:
    opts.prealloc_wipe_disks = False

136
137
138
139
140
141
  try:
    primary_ip_version = int(opts.primary_ip_version)
  except (ValueError, TypeError), err:
    ToStderr("Invalid primary ip version value: %s" % str(err))
    return 1

142
143
144
145
  bootstrap.InitCluster(cluster_name=args[0],
                        secondary_ip=opts.secondary_ip,
                        vg_name=vg_name,
                        mac_prefix=opts.mac_prefix,
146
                        master_netdev=master_netdev,
147
                        file_storage_dir=opts.file_storage_dir,
148
                        shared_file_storage_dir=opts.shared_file_storage_dir,
149
150
                        enabled_hypervisors=hvlist,
                        hvparams=hvparams,
151
                        beparams=beparams,
152
                        nicparams=nicparams,
153
                        ndparams=ndparams,
154
                        candidate_pool_size=opts.candidate_pool_size,
155
                        modify_etc_hosts=opts.modify_etc_hosts,
156
                        modify_ssh_setup=opts.modify_ssh_setup,
157
                        maintain_node_health=opts.maintain_node_health,
158
                        drbd_helper=drbd_helper,
159
                        uid_pool=uid_pool,
160
                        default_iallocator=opts.default_iallocator,
161
                        primary_ip_version=primary_ip_version,
162
                        prealloc_wipe_disks=opts.prealloc_wipe_disks,
163
                        )
164
  op = opcodes.OpClusterPostInit()
165
  SubmitOpCode(op, opts=opts)
Iustin Pop's avatar
Iustin Pop committed
166
167
168
  return 0


169
@UsesRPC
Iustin Pop's avatar
Iustin Pop committed
170
171
172
def DestroyCluster(opts, args):
  """Destroy the cluster.

173
174
175
176
177
  @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
178

Iustin Pop's avatar
Iustin Pop committed
179
180
  """
  if not opts.yes_do_it:
181
182
    ToStderr("Destroying a cluster is irreversible. If you really want"
             " destroy this cluster, supply the --yes-do-it option.")
Iustin Pop's avatar
Iustin Pop committed
183
184
    return 1

185
  op = opcodes.OpClusterDestroy()
186
  master = SubmitOpCode(op, opts=opts)
Iustin Pop's avatar
Iustin Pop committed
187
188
189
  # if we reached this, the opcode didn't fail; we can proceed to
  # shutdown all the daemons
  bootstrap.FinalizeClusterDestroy(master)
Iustin Pop's avatar
Iustin Pop committed
190
191
192
  return 0


193
194
195
def RenameCluster(opts, args):
  """Rename the cluster.

196
197
198
199
200
  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain only one element, the new cluster name
  @rtype: int
  @return: the desired exit code
201
202

  """
203
204
205
206
207
  cl = GetClient()

  (cluster_name, ) = cl.QueryConfigValues(["cluster_name"])

  new_name = args[0]
208
  if not opts.force:
209
210
211
212
213
    usertext = ("This will rename the cluster from '%s' to '%s'. If you are"
                " connected over the network to the cluster name, the"
                " operation is very dangerous as the IP address will be"
                " removed from the node and the change may not go through."
                " Continue?") % (cluster_name, new_name)
214
    if not AskUser(usertext):
215
216
      return 1

217
  op = opcodes.OpClusterRename(name=new_name)
218
219
  result = SubmitOpCode(op, opts=opts, cl=cl)

220
221
  if result:
    ToStdout("Cluster renamed from '%s' to '%s'", cluster_name, result)
222

223
224
225
  return 0


226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
def ActivateMasterIp(opts, args):
  """Activates the master IP.

  """
  op = opcodes.OpClusterActivateMasterIp()
  SubmitOpCode(op)
  return 0


def DeactivateMasterIp(opts, args):
  """Deactivates the master IP.

  """
  if not opts.confirm:
    usertext = ("This will disable the master IP. All the open connections to"
                " the master IP will be closed. To reach the master you will"
                " need to use its node IP."
                " Continue?")
    if not AskUser(usertext):
      return 1

  op = opcodes.OpClusterDeactivateMasterIp()
  SubmitOpCode(op)
  return 0


252
253
254
255
256
257
258
259
260
261
def RedistributeConfig(opts, args):
  """Forces push of the cluster configuration.

  @param opts: the command line options selected by the user
  @type args: list
  @param args: empty list
  @rtype: int
  @return: the desired exit code

  """
262
  op = opcodes.OpClusterRedistConf()
263
264
265
266
  SubmitOrSend(op, opts)
  return 0


Iustin Pop's avatar
Iustin Pop committed
267
268
269
def ShowClusterVersion(opts, args):
  """Write version of ganeti software to the standard output.

270
271
272
273
274
  @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
275
276

  """
277
278
  cl = GetClient()
  result = cl.QueryClusterInfo()
279
280
281
282
283
  ToStdout("Software version: %s", result["software_version"])
  ToStdout("Internode protocol: %s", result["protocol_version"])
  ToStdout("Configuration format: %s", result["config_version"])
  ToStdout("OS api version: %s", result["os_api_version"])
  ToStdout("Export interface: %s", result["export_version"])
Iustin Pop's avatar
Iustin Pop committed
284
285
286
287
288
289
  return 0


def ShowClusterMaster(opts, args):
  """Write name of master node to the standard output.

290
291
292
293
294
  @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
295
296

  """
297
298
  master = bootstrap.GetMaster()
  ToStdout(master)
Iustin Pop's avatar
Iustin Pop committed
299
300
  return 0

301

Guido Trotter's avatar
Guido Trotter committed
302
def _PrintGroupedParams(paramsdict, level=1, roman=False):
303
304
305
306
  """Print Grouped parameters (be, nic, disk) by group.

  @type paramsdict: dict of dicts
  @param paramsdict: {group: {param: value, ...}, ...}
307
308
  @type level: int
  @param level: Level of indention
309
310

  """
311
  indent = "  " * level
312
  for item, val in sorted(paramsdict.items()):
313
314
    if isinstance(val, dict):
      ToStdout("%s- %s:", indent, item)
Guido Trotter's avatar
Guido Trotter committed
315
316
317
      _PrintGroupedParams(val, level=level + 1, roman=roman)
    elif roman and isinstance(val, int):
      ToStdout("%s  %s: %s", indent, item, compat.TryToRoman(val))
318
319
    else:
      ToStdout("%s  %s: %s", indent, item, val)
Iustin Pop's avatar
Iustin Pop committed
320

321

Iustin Pop's avatar
Iustin Pop committed
322
323
324
def ShowClusterConfig(opts, args):
  """Shows cluster information.

325
326
327
328
329
330
  @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
331
  """
332
333
  cl = GetClient()
  result = cl.QueryClusterInfo()
Iustin Pop's avatar
Iustin Pop committed
334

335
  ToStdout("Cluster name: %s", result["name"])
336
  ToStdout("Cluster UUID: %s", result["uuid"])
Iustin Pop's avatar
Iustin Pop committed
337

338
339
340
  ToStdout("Creation time: %s", utils.FormatTime(result["ctime"]))
  ToStdout("Modification time: %s", utils.FormatTime(result["mtime"]))

341
  ToStdout("Master node: %s", result["master"])
Iustin Pop's avatar
Iustin Pop committed
342

343
344
  ToStdout("Architecture (this node): %s (%s)",
           result["architecture"][0], result["architecture"][1])
Iustin Pop's avatar
Iustin Pop committed
345

346
  if result["tags"]:
347
    tags = utils.CommaJoin(utils.NiceSort(result["tags"]))
348
349
350
351
352
  else:
    tags = "(none)"

  ToStdout("Tags: %s", tags)

353
  ToStdout("Default hypervisor: %s", result["default_hypervisor"])
354
355
  ToStdout("Enabled hypervisors: %s",
           utils.CommaJoin(result["enabled_hypervisors"]))
356

357
  ToStdout("Hypervisor parameters:")
358
  _PrintGroupedParams(result["hvparams"])
359

360
  ToStdout("OS-specific hypervisor parameters:")
361
362
  _PrintGroupedParams(result["os_hvp"])

363
364
365
  ToStdout("OS parameters:")
  _PrintGroupedParams(result["osparams"])

366
367
368
  ToStdout("Hidden OSes: %s", utils.CommaJoin(result["hidden_os"]))
  ToStdout("Blacklisted OSes: %s", utils.CommaJoin(result["blacklisted_os"]))

369
  ToStdout("Cluster parameters:")
Guido Trotter's avatar
Guido Trotter committed
370
371
372
  ToStdout("  - candidate pool size: %s",
            compat.TryToRoman(result["candidate_pool_size"],
                              convert=opts.roman_integers))
373
374
  ToStdout("  - master netdev: %s", result["master_netdev"])
  ToStdout("  - lvm volume group: %s", result["volume_group_name"])
375
376
377
378
379
  if result["reserved_lvs"]:
    reserved_lvs = utils.CommaJoin(result["reserved_lvs"])
  else:
    reserved_lvs = "(none)"
  ToStdout("  - lvm reserved volumes: %s", reserved_lvs)
380
  ToStdout("  - drbd usermode helper: %s", result["drbd_usermode_helper"])
381
  ToStdout("  - file storage path: %s", result["file_storage_dir"])
382
383
  ToStdout("  - shared file storage path: %s",
           result["shared_file_storage_dir"])
384
385
  ToStdout("  - maintenance of node health: %s",
           result["maintain_node_health"])
Guido Trotter's avatar
Guido Trotter committed
386
387
388
  ToStdout("  - uid pool: %s",
            uidpool.FormatUidPool(result["uid_pool"],
                                  roman=opts.roman_integers))
389
  ToStdout("  - default instance allocator: %s", result["default_iallocator"])
390
  ToStdout("  - primary ip version: %d", result["primary_ip_version"])
391
  ToStdout("  - preallocation wipe disks: %s", result["prealloc_wipe_disks"])
392
  ToStdout("  - OS search path: %s", utils.CommaJoin(constants.OS_SEARCH_PATH))
393

394
395
396
  ToStdout("Default node parameters:")
  _PrintGroupedParams(result["ndparams"], roman=opts.roman_integers)

397
  ToStdout("Default instance parameters:")
Guido Trotter's avatar
Guido Trotter committed
398
  _PrintGroupedParams(result["beparams"], roman=opts.roman_integers)
399
400

  ToStdout("Default nic parameters:")
Guido Trotter's avatar
Guido Trotter committed
401
  _PrintGroupedParams(result["nicparams"], roman=opts.roman_integers)
402

Iustin Pop's avatar
Iustin Pop committed
403
404
405
406
407
408
  return 0


def ClusterCopyFile(opts, args):
  """Copy a file from master to some nodes.

409
410
411
412
413
414
  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain only one element, the path of
      the file to be copied
  @rtype: int
  @return: the desired exit code
Iustin Pop's avatar
Iustin Pop committed
415
416

  """
417
418
  filename = args[0]
  if not os.path.exists(filename):
419
420
    raise errors.OpPrereqError("No such filename '%s'" % filename,
                               errors.ECODE_INVAL)
421

Iustin Pop's avatar
Iustin Pop committed
422
423
424
425
  cl = GetClient()

  cluster_name = cl.QueryConfigValues(["cluster_name"])[0]

426
  results = GetOnlineNodes(nodes=opts.nodes, cl=cl, filter_master=True,
427
428
                           secondary_ips=opts.use_replication_network,
                           nodegroup=opts.nodegroup)
Michael Hanselmann's avatar
Michael Hanselmann committed
429

Iustin Pop's avatar
Iustin Pop committed
430
  srun = ssh.SshRunner(cluster_name=cluster_name)
431
432
  for node in results:
    if not srun.CopyFileToNode(node, filename):
433
      ToStderr("Copy of file %s to node %s failed", filename, node)
434

Iustin Pop's avatar
Iustin Pop committed
435
436
437
438
439
440
  return 0


def RunClusterCommand(opts, args):
  """Run a command on some nodes.

441
442
443
444
445
  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain the command to be run and its arguments
  @rtype: int
  @return: the desired exit code
Iustin Pop's avatar
Iustin Pop committed
446
447

  """
Iustin Pop's avatar
Iustin Pop committed
448
  cl = GetClient()
Michael Hanselmann's avatar
Michael Hanselmann committed
449

Iustin Pop's avatar
Iustin Pop committed
450
  command = " ".join(args)
451

452
  nodes = GetOnlineNodes(nodes=opts.nodes, cl=cl, nodegroup=opts.nodegroup)
Iustin Pop's avatar
Iustin Pop committed
453
454
455

  cluster_name, master_node = cl.QueryConfigValues(["cluster_name",
                                                    "master_node"])
456

Iustin Pop's avatar
Iustin Pop committed
457
  srun = ssh.SshRunner(cluster_name=cluster_name)
458

Michael Hanselmann's avatar
Michael Hanselmann committed
459
  # Make sure master node is at list end
460
461
462
463
464
465
  if master_node in nodes:
    nodes.remove(master_node)
    nodes.append(master_node)

  for name in nodes:
    result = srun.Run(name, "root", command)
466
467
468
469
    ToStdout("------------------------------------------------")
    ToStdout("node: %s", name)
    ToStdout("%s", result.output)
    ToStdout("return code = %s", result.exit_code)
470
471

  return 0
Iustin Pop's avatar
Iustin Pop committed
472
473
474
475
476


def VerifyCluster(opts, args):
  """Verify integrity of cluster, performing various test on nodes.

477
478
479
480
481
  @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
482
483

  """
Iustin Pop's avatar
Iustin Pop committed
484
  skip_checks = []
485

486
487
  if opts.skip_nplusone_mem:
    skip_checks.append(constants.VERIFY_NPLUSONE_MEM)
488

489
  cl = GetClient()
490

491
492
493
494
495
496
  op = opcodes.OpClusterVerify(verbose=opts.verbose,
                               error_codes=opts.error_codes,
                               debug_simulate_errors=opts.simulate_errors,
                               skip_checks=skip_checks,
                               group_name=opts.nodegroup)
  result = SubmitOpCode(op, cl=cl, opts=opts)
497

498
499
500
501
502
  # Keep track of submitted jobs
  jex = JobExecutor(cl=cl, opts=opts)

  for (status, job_id) in result[constants.JOB_IDS_KEY]:
    jex.AddJobId(None, status, job_id)
503

504
  results = jex.GetResults()
505
506
507
508
509
510
511
512
513
514
515
516

  (bad_jobs, bad_results) = \
    map(len,
        # Convert iterators to lists
        map(list,
            # Count errors
            map(compat.partial(itertools.ifilterfalse, bool),
                # Convert result to booleans in a tuple
                zip(*((job_success, len(op_results) == 1 and op_results[0])
                      for (job_success, op_results) in results)))))

  if bad_jobs == 0 and bad_results == 0:
517
    rcode = constants.EXIT_SUCCESS
Guido Trotter's avatar
Guido Trotter committed
518
  else:
519
    rcode = constants.EXIT_FAILURE
520
521
    if bad_jobs > 0:
      ToStdout("%s job(s) failed while verifying the cluster.", bad_jobs)
522
523

  return rcode
Iustin Pop's avatar
Iustin Pop committed
524
525


526
527
528
def VerifyDisks(opts, args):
  """Verify integrity of cluster disks.

529
530
531
532
533
  @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
534
535

  """
536
537
  cl = GetClient()

538
  op = opcodes.OpClusterVerifyDisks()
539

540
541
542
543
544
545
546
  result = SubmitOpCode(op, cl=cl, opts=opts)

  # Keep track of submitted jobs
  jex = JobExecutor(cl=cl, opts=opts)

  for (status, job_id) in result[constants.JOB_IDS_KEY]:
    jex.AddJobId(None, status, job_id)
547

548
  retcode = constants.EXIT_SUCCESS
549

550
551
552
553
554
555
556
  for (status, result) in jex.GetResults():
    if not status:
      ToStdout("Job failed: %s", result)
      continue

    ((bad_nodes, instances, missing), ) = result

557
558
    for node, text in bad_nodes.items():
      ToStdout("Error gathering data on node %s: %s",
559
               node, utils.SafeEncode(text[-400:]))
560
      retcode = constants.EXIT_FAILURE
561
      ToStdout("You need to fix these nodes first before fixing instances")
562

563
    for iname in instances:
564
565
      if iname in missing:
        continue
566
      op = opcodes.OpInstanceActivateDisks(instance_name=iname)
567
      try:
568
        ToStdout("Activating disks for instance '%s'", iname)
569
        SubmitOpCode(op, opts=opts, cl=cl)
570
571
572
      except errors.GenericError, err:
        nret, msg = FormatError(err)
        retcode |= nret
573
        ToStderr("Error activating disks for instance %s: %s", iname, msg)
574

575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
    if missing:
      for iname, ival in missing.iteritems():
        all_missing = compat.all(x[0] in bad_nodes for x in ival)
        if all_missing:
          ToStdout("Instance %s cannot be verified as it lives on"
                   " broken nodes", iname)
        else:
          ToStdout("Instance %s has missing logical volumes:", iname)
          ival.sort()
          for node, vol in ival:
            if node in bad_nodes:
              ToStdout("\tbroken node %s /dev/%s", node, vol)
            else:
              ToStdout("\t%s /dev/%s", node, vol)

      ToStdout("You need to replace or recreate disks for all the above"
               " instances if this message persists after fixing broken nodes.")
      retcode = constants.EXIT_FAILURE
593
594
595
596

  return retcode


597
598
599
600
601
602
603
604
605
606
def RepairDiskSizes(opts, args):
  """Verify sizes of cluster disks.

  @param opts: the command line options selected by the user
  @type args: list
  @param args: optional list of instances to restrict check to
  @rtype: int
  @return: the desired exit code

  """
607
  op = opcodes.OpClusterRepairDiskSizes(instances=args)
608
  SubmitOpCode(op, opts=opts)
609
610


611
@UsesRPC
Iustin Pop's avatar
Iustin Pop committed
612
613
614
615
616
617
618
def MasterFailover(opts, args):
  """Failover the master node.

  This command, when run on a non-master node, will cause the current
  master to cease being master, and the non-master to become new
  master.

619
620
621
622
623
624
  @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
625
  """
626
627
628
629
630
631
632
633
634
  if opts.no_voting:
    usertext = ("This will perform the failover even if most other nodes"
                " are down, or if this node is outdated. This is dangerous"
                " as it can lead to a non-consistent cluster. Check the"
                " gnt-cluster(8) man page before proceeding. Continue?")
    if not AskUser(usertext):
      return 1

  return bootstrap.MasterFailover(no_voting=opts.no_voting)
Iustin Pop's avatar
Iustin Pop committed
635
636


Iustin Pop's avatar
Iustin Pop committed
637
638
639
640
641
642
643
644
645
646
647
648
649
650
def MasterPing(opts, args):
  """Checks if the master is alive.

  @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

  """
  try:
    cl = GetClient()
    cl.QueryClusterInfo()
    return 0
651
  except Exception: # pylint: disable=W0703
Iustin Pop's avatar
Iustin Pop committed
652
653
654
    return 1


Iustin Pop's avatar
Iustin Pop committed
655
656
657
def SearchTags(opts, args):
  """Searches the tags on all the cluster.

658
659
660
661
662
663
  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain only one element, the tag pattern
  @rtype: int
  @return: the desired exit code

Iustin Pop's avatar
Iustin Pop committed
664
  """
665
  op = opcodes.OpTagsSearch(pattern=args[0])
666
  result = SubmitOpCode(op, opts=opts)
Iustin Pop's avatar
Iustin Pop committed
667
668
669
670
671
  if not result:
    return 1
  result = list(result)
  result.sort()
  for path, tag in result:
672
    ToStdout("%s %s", path, tag)
Iustin Pop's avatar
Iustin Pop committed
673
674


675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
def _ReadAndVerifyCert(cert_filename, verify_private_key=False):
  """Reads and verifies an X509 certificate.

  @type cert_filename: string
  @param cert_filename: the path of the file containing the certificate to
                        verify encoded in PEM format
  @type verify_private_key: bool
  @param verify_private_key: whether to verify the private key in addition to
                             the public certificate
  @rtype: string
  @return: a string containing the PEM-encoded certificate.

  """
  try:
    pem = utils.ReadFile(cert_filename)
  except IOError, err:
    raise errors.X509CertError(cert_filename,
                               "Unable to read certificate: %s" % str(err))

  try:
    OpenSSL.crypto.load_certificate(OpenSSL.crypto.FILETYPE_PEM, pem)
  except Exception, err:
    raise errors.X509CertError(cert_filename,
                               "Unable to load certificate: %s" % str(err))

  if verify_private_key:
    try:
      OpenSSL.crypto.load_privatekey(OpenSSL.crypto.FILETYPE_PEM, pem)
    except Exception, err:
      raise errors.X509CertError(cert_filename,
                                 "Unable to load private key: %s" % str(err))

  return pem


def _RenewCrypto(new_cluster_cert, new_rapi_cert, #pylint: disable=R0911
                 rapi_cert_filename, new_spice_cert, spice_cert_filename,
                 spice_cacert_filename, new_confd_hmac_key, new_cds,
                 cds_filename, force):
714
715
716
717
718
719
720
721
  """Renews cluster certificates, keys and secrets.

  @type new_cluster_cert: bool
  @param new_cluster_cert: Whether to generate a new cluster certificate
  @type new_rapi_cert: bool
  @param new_rapi_cert: Whether to generate a new RAPI certificate
  @type rapi_cert_filename: string
  @param rapi_cert_filename: Path to file containing new RAPI certificate
722
723
724
725
726
727
728
  @type new_spice_cert: bool
  @param new_spice_cert: Whether to generate a new SPICE certificate
  @type spice_cert_filename: string
  @param spice_cert_filename: Path to file containing new SPICE certificate
  @type spice_cacert_filename: string
  @param spice_cacert_filename: Path to file containing the certificate of the
                                CA that signed the SPICE certificate
729
730
  @type new_confd_hmac_key: bool
  @param new_confd_hmac_key: Whether to generate a new HMAC key
Michael Hanselmann's avatar
Michael Hanselmann committed
731
732
733
734
  @type new_cds: bool
  @param new_cds: Whether to generate a new cluster domain secret
  @type cds_filename: string
  @param cds_filename: Path to file containing new cluster domain secret
735
736
737
738
739
  @type force: bool
  @param force: Whether to ask user for confirmation

  """
  if new_rapi_cert and rapi_cert_filename:
740
    ToStderr("Only one of the --new-rapi-certificate and --rapi-certificate"
741
742
743
             " options can be specified at the same time.")
    return 1

Michael Hanselmann's avatar
Michael Hanselmann committed
744
745
746
747
748
749
  if new_cds and cds_filename:
    ToStderr("Only one of the --new-cluster-domain-secret and"
             " --cluster-domain-secret options can be specified at"
             " the same time.")
    return 1

750
751
752
753
  if new_spice_cert and (spice_cert_filename or spice_cacert_filename):
    ToStderr("When using --new-spice-certificate, the --spice-certificate"
             " and --spice-ca-certificate must not be used.")
    return 1
754

755
756
757
758
  if bool(spice_cacert_filename) ^ bool(spice_cert_filename):
    ToStderr("Both --spice-certificate and --spice-ca-certificate must be"
             " specified.")
    return 1
759

760
761
762
763
764
765
766
767
768
769
  rapi_cert_pem, spice_cert_pem, spice_cacert_pem = (None, None, None)
  try:
    if rapi_cert_filename:
      rapi_cert_pem = _ReadAndVerifyCert(rapi_cert_filename, True)
    if spice_cert_filename:
      spice_cert_pem = _ReadAndVerifyCert(spice_cert_filename, True)
      spice_cacert_pem = _ReadAndVerifyCert(spice_cacert_filename)
  except errors.X509CertError, err:
    ToStderr("Unable to load X509 certificate from %s: %s", err[0], err[1])
    return 1
770

Michael Hanselmann's avatar
Michael Hanselmann committed
771
772
773
  if cds_filename:
    try:
      cds = utils.ReadFile(cds_filename)
774
    except Exception, err: # pylint: disable=W0703
Michael Hanselmann's avatar
Michael Hanselmann committed
775
776
777
778
779
780
      ToStderr("Can't load new cluster domain secret from %s: %s" %
               (cds_filename, str(err)))
      return 1
  else:
    cds = None

781
782
783
784
785
786
787
788
  if not force:
    usertext = ("This requires all daemons on all nodes to be restarted and"
                " may take some time. Continue?")
    if not AskUser(usertext):
      return 1

  def _RenewCryptoInner(ctx):
    ctx.feedback_fn("Updating certificates and keys")
789
790
791
    bootstrap.GenerateClusterCrypto(new_cluster_cert,
                                    new_rapi_cert,
                                    new_spice_cert,
792
                                    new_confd_hmac_key,
Michael Hanselmann's avatar
Michael Hanselmann committed
793
794
                                    new_cds,
                                    rapi_cert_pem=rapi_cert_pem,
795
796
                                    spice_cert_pem=spice_cert_pem,
                                    spice_cacert_pem=spice_cacert_pem,
Michael Hanselmann's avatar
Michael Hanselmann committed
797
                                    cds=cds)
798
799
800
801

    files_to_copy = []

    if new_cluster_cert:
802
      files_to_copy.append(constants.NODED_CERT_FILE)
803
804
805
806

    if new_rapi_cert or rapi_cert_pem:
      files_to_copy.append(constants.RAPI_CERT_FILE)

807
808
809
810
    if new_spice_cert or spice_cert_pem:
      files_to_copy.append(constants.SPICE_CERT_FILE)
      files_to_copy.append(constants.SPICE_CACERT_FILE)

811
812
    if new_confd_hmac_key:
      files_to_copy.append(constants.CONFD_HMAC_KEY)
813

Michael Hanselmann's avatar
Michael Hanselmann committed
814
815
816
    if new_cds or cds:
      files_to_copy.append(constants.CLUSTER_DOMAIN_SECRET_FILE)

817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
    if files_to_copy:
      for node_name in ctx.nonmaster_nodes:
        ctx.feedback_fn("Copying %s to %s" %
                        (", ".join(files_to_copy), node_name))
        for file_name in files_to_copy:
          ctx.ssh.CopyFileToNode(node_name, file_name)

  RunWhileClusterStopped(ToStdout, _RenewCryptoInner)

  ToStdout("All requested certificates and keys have been replaced."
           " Running \"gnt-cluster verify\" now is recommended.")

  return 0


def RenewCrypto(opts, args):
  """Renews cluster certificates, keys and secrets.

  """
  return _RenewCrypto(opts.new_cluster_cert,
                      opts.new_rapi_cert,
                      opts.rapi_cert,
839
840
841
                      opts.new_spice_cert,
                      opts.spice_cert,
                      opts.spice_cacert,
842
                      opts.new_confd_hmac_key,
Michael Hanselmann's avatar
Michael Hanselmann committed
843
844
                      opts.new_cluster_domain_secret,
                      opts.cluster_domain_secret,
845
846
847
                      opts.force)


848
849
850
def SetClusterParams(opts, args):
  """Modify the cluster.

851
852
853
854
855
  @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
856
857

  """
858
  if not (not opts.lvm_storage or opts.vg_name or
859
          not opts.drbd_storage or opts.drbd_helper or
860
          opts.enabled_hypervisors or opts.hvparams or
861
          opts.beparams or opts.nicparams or opts.ndparams or
862
          opts.candidate_pool_size is not None or
863
          opts.uid_pool is not None or
864
865
          opts.maintain_node_health is not None or
          opts.add_uids is not None or
866
          opts.remove_uids is not None or
867
          opts.default_iallocator is not None or
868
          opts.reserved_lvs is not None or
869
          opts.master_netdev is not None or
870
          opts.prealloc_wipe_disks is not None):
871
    ToStderr("Please give at least one of the parameters.")
872
873
874
875
    return 1

  vg_name = opts.vg_name
  if not opts.lvm_storage and opts.vg_name:
876
    ToStderr("Options --no-lvm-storage and --vg-name conflict.")
877
    return 1
878
879
880

  if not opts.lvm_storage:
    vg_name = ""
881

882
883
884
885
886
887
888
889
  drbd_helper = opts.drbd_helper
  if not opts.drbd_storage and opts.drbd_helper:
    ToStderr("Options --no-drbd-storage and --drbd-usermode-helper conflict.")
    return 1

  if not opts.drbd_storage:
    drbd_helper = ""

890
891
892
893
  hvlist = opts.enabled_hypervisors
  if hvlist is not None:
    hvlist = hvlist.split(",")

894
895
  # a list of (name, dict) we can pass directly to dict() (or [])
  hvparams = dict(opts.hvparams)
Iustin Pop's avatar
Iustin Pop committed
896
  for hv_params in hvparams.values():
897
    utils.ForceDictType(hv_params, constants.HVS_PARAMETER_TYPES)
898
899

  beparams = opts.beparams
900
  utils.ForceDictType(beparams, constants.BES_PARAMETER_TYPES)
901

902
903
904
  nicparams = opts.nicparams
  utils.ForceDictType(nicparams, constants.NICS_PARAMETER_TYPES)

905
906
907
  ndparams = opts.ndparams
  if ndparams is not None:
    utils.ForceDictType(ndparams, constants.NDS_PARAMETER_TYPES)
908

909
910
  mnh = opts.maintain_node_health

911
912
913
914
  uid_pool = opts.uid_pool
  if uid_pool is not None:
    uid_pool = uidpool.ParseUidPool(uid_pool)

915
916
917
918
919
920
921
922
  add_uids = opts.add_uids
  if add_uids is not None:
    add_uids = uidpool.ParseUidPool(add_uids)

  remove_uids = opts.remove_uids
  if remove_uids is not None:
    remove_uids = uidpool.ParseUidPool(remove_uids)

923
924
925
926
927
928
  if opts.reserved_lvs is not None:
    if opts.reserved_lvs == "":
      opts.reserved_lvs = []
    else:
      opts.reserved_lvs = utils.UnescapeAndSplit(opts.reserved_lvs, sep=",")

929
  op = opcodes.OpClusterSetParams(vg_name=vg_name,
930
                                  drbd_helper=drbd_helper,
931
932
                                  enabled_hypervisors=hvlist,
                                  hvparams=hvparams,
933
                                  os_hvp=None,
934
                                  beparams=beparams,
935
                                  nicparams=nicparams,
936
                                  ndparams=ndparams,
937
                                  candidate_pool_size=opts.candidate_pool_size,
938
                                  maintain_node_health=mnh,
939
940
                                  uid_pool=uid_pool,
                                  add_uids=add_uids,
941
                                  remove_uids=remove_uids,
942
                                  default_iallocator=opts.default_iallocator,
943
                                  prealloc_wipe_disks=opts.prealloc_wipe_disks,
944
                                  master_netdev=opts.master_netdev,
945
                                  reserved_lvs=opts.reserved_lvs)
946
  SubmitOpCode(op, opts=opts)
947
948
949
  return 0


950
951
952
def QueueOps(opts, args):
  """Queue operations.

953
954
955
956
957
958
  @param opts: the command line options selected by the user
  @type args: list
  @param args: should contain only one element, the subcommand
  @rtype: int
  @return: the desired exit code

959
960
961
962
963
964
965
966
967
  """
  command = args[0]
  client = GetClient()
  if command in ("drain", "undrain"):
    drain_flag = command == "drain"
    client.SetQueueDrainFlag(drain_flag)
  elif command == "info":
    result = client.QueryConfigValues(["drain_flag"])
    if result[0]:
968
      val = "set"
969
    else:
970
971
      val = "unset"
    ToStdout("The drain flag is %s" % val)
972
  else:
973
974
    raise errors.OpPrereqError("Command '%s' is not valid." % command,
                               errors.ECODE_INVAL)
975

976
977
  return 0

978

979
980
981
982
983
984
985
def _ShowWatcherPause(until):
  if until is None or until < time.time():
    ToStdout("The watcher is not paused.")
  else:
    ToStdout("The watcher is paused until %s.", time.ctime(until))


986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
def WatcherOps(opts, args):
  """Watcher operations.

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

  """
  command = args[0]
  client = GetClient()

  if command == "continue":
    client.SetWatcherPause(None)
1001
    ToStdout("The watcher is no longer paused.")
1002
1003
1004

  elif command == "pause":
    if len(args) < 2:
1005
      raise errors.OpPrereqError("Missing pause duration", errors.ECODE_INVAL)
1006

1007
1008
    result = client.SetWatcherPause(time.time() + ParseTimespec(args[1]))
    _ShowWatcherPause(result)
1009
1010
1011

  elif command == "info":
    result = client.QueryConfigValues(["watcher_pause"])
1012
    _ShowWatcherPause(result[0])
1013
1014

  else:
1015
1016
    raise errors.OpPrereqError("Command '%s' is not valid." % command,
                               errors.ECODE_INVAL)
1017
1018
1019
1020

  return 0


René Nussbaumer's avatar
René Nussbaumer committed
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
def _OobPower(opts, node_list, power):
  """Puts the node in the list to desired power state.

  @param opts: The command line options selected by the user
  @param node_list: The list of nodes to operate on
  @param power: True if they should be powered on, False otherwise
  @return: The success of the operation (none failed)

  """
  if power:
    command = constants.OOB_POWER_ON
  else:
    command = constants.OOB_POWER_OFF

  op = opcodes.OpOobCommand(node_names=node_list,
                            command=command,
                            ignore_status=True,
1038
1039
                            timeout=opts.oob_timeout,
                            power_delay=opts.power_delay)
René Nussbaumer's avatar
René Nussbaumer committed
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
  result = SubmitOpCode(op, opts=opts)
  errs = 0
  for node_result in result:
    (node_tuple, data_tuple) = node_result
    (_, node_name) = node_tuple
    (data_status, _) = data_tuple
    if data_status != constants.RS_NORMAL:
      assert data_status != constants.RS_UNAVAIL
      errs += 1
      ToStderr("There was a problem changing power for %s, please investigate",
               node_name)

  if errs > 0:
    return False

  return True


def _InstanceStart(opts, inst_list, start):
  """Puts the instances in the list to desired state.

  @param opts: The command line options selected by the user
  @param inst_list: The list of instances to operate on
  @param start: True if they should be started, False for shutdown
  @return: The success of the operation (none failed)

  """
  if start:
    opcls = opcodes.OpInstanceStartup
    text_submit, text_success, text_failed = ("startup", "started", "starting")
  else:
1071
1072
    opcls = compat.partial(opcodes.OpInstanceShutdown,
                           timeout=opts.shutdown_timeout)
René Nussbaumer's avatar
René Nussbaumer committed
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
    text_submit, text_success, text_failed = ("shutdown", "stopped", "stopping")

  jex = JobExecutor(opts=opts)

  for inst in inst_list:
    ToStdout("Submit %s of instance %s", text_submit, inst)
    op = opcls(instance_name=inst)
    jex.QueueJob(inst, op)

  results = jex.GetResults()
  bad_cnt = len([1 for (success, _) in results if not success])

  if bad_cnt == 0:
    ToStdout("All instances have been %s successfully", text_success)
  else:
    ToStderr("There were errors while %s instances:\n"
             "%d error(s) out of %d instance(s)", text_failed, bad_cnt,
             len(results))
    return False

  return True


class _RunWhenNodesReachableHelper:
  """Helper class to make shared internal state sharing easier.

  @ivar success: Indicates if all action_cb calls were successful

  """
René Nussbaumer's avatar
René Nussbaumer committed
1102
  def __init__(self, node_list, action_cb, node2ip, port, feedback_fn,
René Nussbaumer's avatar
René Nussbaumer committed
1103
1104
1105
1106
1107
1108
1109
1110
               _ping_fn=netutils.TcpPing, _sleep_fn=time.sleep):
    """Init the object.

    @param node_list: The list of nodes to be reachable
    @param action_cb: Callback called when a new host is reachable
    @type node2ip: dict
    @param node2ip: Node to ip mapping
    @param port: The port to use for the TCP ping
René Nussbaumer's avatar
René Nussbaumer committed
1111
    @param feedback_fn: The function used for feedback
René Nussbaumer's avatar
René Nussbaumer committed
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
    @param _ping_fn: Function to check reachabilty (for unittest use only)
    @param _sleep_fn: Function to sleep (for unittest use only)

    """
    self.down = set(node_list)
    self.up = set()
    self.node2ip = node2ip
    self.success = True
    self.action_cb = action_cb
    self.port = port
René Nussbaumer's avatar
René Nussbaumer committed
1122
    self.feedback_fn = feedback_fn
René Nussbaumer's avatar
René Nussbaumer committed
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
    self._ping_fn = _ping_fn
    self._sleep_fn = _sleep_fn

  def __call__(self):
    """When called we run action_cb.

    @raises utils.RetryAgain: When there are still down nodes

    """
    if not self.action_cb(self.up):
      self.success = False

    if self.down:
      raise utils.RetryAgain()
    else:
      return self.success

  def Wait(self, secs):
    """Checks if a host is up or waits remaining seconds.

    @param secs: The secs remaining

    """
    start = time.time()
    for node in self.down:
      if self._ping_fn(self.node2ip[node], self.port, timeout=_EPO_PING_TIMEOUT,
                       live_port_needed=True):
René Nussbaumer's avatar
René Nussbaumer committed
1150
        self.feedback_fn("Node %s became available" % node)
René Nussbaumer's avatar
René Nussbaumer committed
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
        self.up.add(node)
        self.down -= self.up
        # If we have a node available there is the possibility to run the
        # action callback successfully, therefore we don't wait and return
        return

    self._sleep_fn(max(0.0, start + secs - time.time()))


def _RunWhenNodesReachable(node_list, action_cb, interval):
  """Run action_cb when nodes become reachable.

  @param node_list: The list of nodes to be reachable
  @param action_cb: Callback called when a new host is reachable
  @param interval: The earliest time to retry

  """
  client = GetClient()
  cluster_info = client.QueryClusterInfo()
  if cluster_info["primary_ip_version"] == constants.IP4_VERSION:
    family = netutils.IPAddress.family
  else:
    family = netutils.IP6Address.family

  node2ip = dict((node, netutils.GetHostname(node,