Move a function from backend to ssconf
[ganeti-local] / lib / bootstrap.py
1 #
2 #
3
4 # Copyright (C) 2006, 2007, 2008, 2010, 2011, 2012 Google Inc.
5 #
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
10 #
11 # This program is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 # General Public License for more details.
15 #
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19 # 02110-1301, USA.
20
21
22 """Functions to bootstrap a new cluster.
23
24 """
25
26 import os
27 import os.path
28 import re
29 import logging
30 import time
31
32 from ganeti import rpc
33 from ganeti import ssh
34 from ganeti import utils
35 from ganeti import errors
36 from ganeti import config
37 from ganeti import constants
38 from ganeti import objects
39 from ganeti import ssconf
40 from ganeti import serializer
41 from ganeti import hypervisor
42 from ganeti import bdev
43 from ganeti import netutils
44 from ganeti import luxi
45 from ganeti import jstore
46 from ganeti import pathutils
47
48
49 # ec_id for InitConfig's temporary reservation manager
50 _INITCONF_ECID = "initconfig-ecid"
51
52 #: After how many seconds daemon must be responsive
53 _DAEMON_READY_TIMEOUT = 10.0
54
55
56 def _InitSSHSetup():
57   """Setup the SSH configuration for the cluster.
58
59   This generates a dsa keypair for root, adds the pub key to the
60   permitted hosts and adds the hostkey to its own known hosts.
61
62   """
63   priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.SSH_LOGIN_USER)
64
65   for name in priv_key, pub_key:
66     if os.path.exists(name):
67       utils.CreateBackup(name)
68     utils.RemoveFile(name)
69
70   result = utils.RunCmd(["ssh-keygen", "-t", "dsa",
71                          "-f", priv_key,
72                          "-q", "-N", ""])
73   if result.failed:
74     raise errors.OpExecError("Could not generate ssh keypair, error %s" %
75                              result.output)
76
77   utils.AddAuthorizedKey(auth_keys, utils.ReadFile(pub_key))
78
79
80 def GenerateHmacKey(file_name):
81   """Writes a new HMAC key.
82
83   @type file_name: str
84   @param file_name: Path to output file
85
86   """
87   utils.WriteFile(file_name, data="%s\n" % utils.GenerateSecret(), mode=0400,
88                   backup=True)
89
90
91 def GenerateClusterCrypto(new_cluster_cert, new_rapi_cert, new_spice_cert,
92                           new_confd_hmac_key, new_cds,
93                           rapi_cert_pem=None, spice_cert_pem=None,
94                           spice_cacert_pem=None, cds=None,
95                           nodecert_file=pathutils.NODED_CERT_FILE,
96                           rapicert_file=pathutils.RAPI_CERT_FILE,
97                           spicecert_file=pathutils.SPICE_CERT_FILE,
98                           spicecacert_file=pathutils.SPICE_CACERT_FILE,
99                           hmackey_file=pathutils.CONFD_HMAC_KEY,
100                           cds_file=pathutils.CLUSTER_DOMAIN_SECRET_FILE):
101   """Updates the cluster certificates, keys and secrets.
102
103   @type new_cluster_cert: bool
104   @param new_cluster_cert: Whether to generate a new cluster certificate
105   @type new_rapi_cert: bool
106   @param new_rapi_cert: Whether to generate a new RAPI certificate
107   @type new_spice_cert: bool
108   @param new_spice_cert: Whether to generate a new SPICE certificate
109   @type new_confd_hmac_key: bool
110   @param new_confd_hmac_key: Whether to generate a new HMAC key
111   @type new_cds: bool
112   @param new_cds: Whether to generate a new cluster domain secret
113   @type rapi_cert_pem: string
114   @param rapi_cert_pem: New RAPI certificate in PEM format
115   @type spice_cert_pem: string
116   @param spice_cert_pem: New SPICE certificate in PEM format
117   @type spice_cacert_pem: string
118   @param spice_cacert_pem: Certificate of the CA that signed the SPICE
119                            certificate, in PEM format
120   @type cds: string
121   @param cds: New cluster domain secret
122   @type nodecert_file: string
123   @param nodecert_file: optional override of the node cert file path
124   @type rapicert_file: string
125   @param rapicert_file: optional override of the rapi cert file path
126   @type spicecert_file: string
127   @param spicecert_file: optional override of the spice cert file path
128   @type spicecacert_file: string
129   @param spicecacert_file: optional override of the spice CA cert file path
130   @type hmackey_file: string
131   @param hmackey_file: optional override of the hmac key file path
132
133   """
134   # noded SSL certificate
135   cluster_cert_exists = os.path.exists(nodecert_file)
136   if new_cluster_cert or not cluster_cert_exists:
137     if cluster_cert_exists:
138       utils.CreateBackup(nodecert_file)
139
140     logging.debug("Generating new cluster certificate at %s", nodecert_file)
141     utils.GenerateSelfSignedSslCert(nodecert_file)
142
143   # confd HMAC key
144   if new_confd_hmac_key or not os.path.exists(hmackey_file):
145     logging.debug("Writing new confd HMAC key to %s", hmackey_file)
146     GenerateHmacKey(hmackey_file)
147
148   # RAPI
149   rapi_cert_exists = os.path.exists(rapicert_file)
150
151   if rapi_cert_pem:
152     # Assume rapi_pem contains a valid PEM-formatted certificate and key
153     logging.debug("Writing RAPI certificate at %s", rapicert_file)
154     utils.WriteFile(rapicert_file, data=rapi_cert_pem, backup=True)
155
156   elif new_rapi_cert or not rapi_cert_exists:
157     if rapi_cert_exists:
158       utils.CreateBackup(rapicert_file)
159
160     logging.debug("Generating new RAPI certificate at %s", rapicert_file)
161     utils.GenerateSelfSignedSslCert(rapicert_file)
162
163   # SPICE
164   spice_cert_exists = os.path.exists(spicecert_file)
165   spice_cacert_exists = os.path.exists(spicecacert_file)
166   if spice_cert_pem:
167     # spice_cert_pem implies also spice_cacert_pem
168     logging.debug("Writing SPICE certificate at %s", spicecert_file)
169     utils.WriteFile(spicecert_file, data=spice_cert_pem, backup=True)
170     logging.debug("Writing SPICE CA certificate at %s", spicecacert_file)
171     utils.WriteFile(spicecacert_file, data=spice_cacert_pem, backup=True)
172   elif new_spice_cert or not spice_cert_exists:
173     if spice_cert_exists:
174       utils.CreateBackup(spicecert_file)
175     if spice_cacert_exists:
176       utils.CreateBackup(spicecacert_file)
177
178     logging.debug("Generating new self-signed SPICE certificate at %s",
179                   spicecert_file)
180     (_, cert_pem) = utils.GenerateSelfSignedSslCert(spicecert_file)
181
182     # Self-signed certificate -> the public certificate is also the CA public
183     # certificate
184     logging.debug("Writing the public certificate to %s",
185                   spicecert_file)
186     utils.io.WriteFile(spicecacert_file, mode=0400, data=cert_pem)
187
188   # Cluster domain secret
189   if cds:
190     logging.debug("Writing cluster domain secret to %s", cds_file)
191     utils.WriteFile(cds_file, data=cds, backup=True)
192
193   elif new_cds or not os.path.exists(cds_file):
194     logging.debug("Generating new cluster domain secret at %s", cds_file)
195     GenerateHmacKey(cds_file)
196
197
198 def _InitGanetiServerSetup(master_name):
199   """Setup the necessary configuration for the initial node daemon.
200
201   This creates the nodepass file containing the shared password for
202   the cluster, generates the SSL certificate and starts the node daemon.
203
204   @type master_name: str
205   @param master_name: Name of the master node
206
207   """
208   # Generate cluster secrets
209   GenerateClusterCrypto(True, False, False, False, False)
210
211   result = utils.RunCmd([pathutils.DAEMON_UTIL, "start", constants.NODED])
212   if result.failed:
213     raise errors.OpExecError("Could not start the node daemon, command %s"
214                              " had exitcode %s and error %s" %
215                              (result.cmd, result.exit_code, result.output))
216
217   _WaitForNodeDaemon(master_name)
218
219
220 def _WaitForNodeDaemon(node_name):
221   """Wait for node daemon to become responsive.
222
223   """
224   def _CheckNodeDaemon():
225     # Pylint bug <http://www.logilab.org/ticket/35642>
226     # pylint: disable=E1101
227     result = rpc.BootstrapRunner().call_version([node_name])[node_name]
228     if result.fail_msg:
229       raise utils.RetryAgain()
230
231   try:
232     utils.Retry(_CheckNodeDaemon, 1.0, _DAEMON_READY_TIMEOUT)
233   except utils.RetryTimeout:
234     raise errors.OpExecError("Node daemon on %s didn't answer queries within"
235                              " %s seconds" % (node_name, _DAEMON_READY_TIMEOUT))
236
237
238 def _WaitForMasterDaemon():
239   """Wait for master daemon to become responsive.
240
241   """
242   def _CheckMasterDaemon():
243     try:
244       cl = luxi.Client()
245       (cluster_name, ) = cl.QueryConfigValues(["cluster_name"])
246     except Exception:
247       raise utils.RetryAgain()
248
249     logging.debug("Received cluster name %s from master", cluster_name)
250
251   try:
252     utils.Retry(_CheckMasterDaemon, 1.0, _DAEMON_READY_TIMEOUT)
253   except utils.RetryTimeout:
254     raise errors.OpExecError("Master daemon didn't answer queries within"
255                              " %s seconds" % _DAEMON_READY_TIMEOUT)
256
257
258 def _InitFileStorage(file_storage_dir):
259   """Initialize if needed the file storage.
260
261   @param file_storage_dir: the user-supplied value
262   @return: either empty string (if file storage was disabled at build
263       time) or the normalized path to the storage directory
264
265   """
266   file_storage_dir = os.path.normpath(file_storage_dir)
267
268   if not os.path.isabs(file_storage_dir):
269     raise errors.OpPrereqError("File storage directory '%s' is not an absolute"
270                                " path" % file_storage_dir, errors.ECODE_INVAL)
271
272   if not os.path.exists(file_storage_dir):
273     try:
274       os.makedirs(file_storage_dir, 0750)
275     except OSError, err:
276       raise errors.OpPrereqError("Cannot create file storage directory"
277                                  " '%s': %s" % (file_storage_dir, err),
278                                  errors.ECODE_ENVIRON)
279
280   if not os.path.isdir(file_storage_dir):
281     raise errors.OpPrereqError("The file storage directory '%s' is not"
282                                " a directory." % file_storage_dir,
283                                errors.ECODE_ENVIRON)
284   return file_storage_dir
285
286
287 def InitCluster(cluster_name, mac_prefix, # pylint: disable=R0913, R0914
288                 master_netmask, master_netdev, file_storage_dir,
289                 shared_file_storage_dir, candidate_pool_size, secondary_ip=None,
290                 vg_name=None, beparams=None, nicparams=None, ndparams=None,
291                 hvparams=None, diskparams=None, enabled_hypervisors=None,
292                 modify_etc_hosts=True, modify_ssh_setup=True,
293                 maintain_node_health=False, drbd_helper=None, uid_pool=None,
294                 default_iallocator=None, primary_ip_version=None, ipolicy=None,
295                 prealloc_wipe_disks=False, use_external_mip_script=False,
296                 hv_state=None, disk_state=None):
297   """Initialise the cluster.
298
299   @type candidate_pool_size: int
300   @param candidate_pool_size: master candidate pool size
301
302   """
303   # TODO: complete the docstring
304   if config.ConfigWriter.IsCluster():
305     raise errors.OpPrereqError("Cluster is already initialised",
306                                errors.ECODE_STATE)
307
308   if not enabled_hypervisors:
309     raise errors.OpPrereqError("Enabled hypervisors list must contain at"
310                                " least one member", errors.ECODE_INVAL)
311   invalid_hvs = set(enabled_hypervisors) - constants.HYPER_TYPES
312   if invalid_hvs:
313     raise errors.OpPrereqError("Enabled hypervisors contains invalid"
314                                " entries: %s" % invalid_hvs,
315                                errors.ECODE_INVAL)
316
317   try:
318     ipcls = netutils.IPAddress.GetClassFromIpVersion(primary_ip_version)
319   except errors.ProgrammerError:
320     raise errors.OpPrereqError("Invalid primary ip version: %d." %
321                                primary_ip_version, errors.ECODE_INVAL)
322
323   hostname = netutils.GetHostname(family=ipcls.family)
324   if not ipcls.IsValid(hostname.ip):
325     raise errors.OpPrereqError("This host's IP (%s) is not a valid IPv%d"
326                                " address." % (hostname.ip, primary_ip_version),
327                                errors.ECODE_INVAL)
328
329   if ipcls.IsLoopback(hostname.ip):
330     raise errors.OpPrereqError("This host's IP (%s) resolves to a loopback"
331                                " address. Please fix DNS or %s." %
332                                (hostname.ip, constants.ETC_HOSTS),
333                                errors.ECODE_ENVIRON)
334
335   if not ipcls.Own(hostname.ip):
336     raise errors.OpPrereqError("Inconsistency: this host's name resolves"
337                                " to %s,\nbut this ip address does not"
338                                " belong to this host" %
339                                hostname.ip, errors.ECODE_ENVIRON)
340
341   clustername = netutils.GetHostname(name=cluster_name, family=ipcls.family)
342
343   if netutils.TcpPing(clustername.ip, constants.DEFAULT_NODED_PORT, timeout=5):
344     raise errors.OpPrereqError("Cluster IP already active",
345                                errors.ECODE_NOTUNIQUE)
346
347   if not secondary_ip:
348     if primary_ip_version == constants.IP6_VERSION:
349       raise errors.OpPrereqError("When using a IPv6 primary address, a valid"
350                                  " IPv4 address must be given as secondary",
351                                  errors.ECODE_INVAL)
352     secondary_ip = hostname.ip
353
354   if not netutils.IP4Address.IsValid(secondary_ip):
355     raise errors.OpPrereqError("Secondary IP address (%s) has to be a valid"
356                                " IPv4 address." % secondary_ip,
357                                errors.ECODE_INVAL)
358
359   if not netutils.IP4Address.Own(secondary_ip):
360     raise errors.OpPrereqError("You gave %s as secondary IP,"
361                                " but it does not belong to this host." %
362                                secondary_ip, errors.ECODE_ENVIRON)
363
364   if master_netmask is not None:
365     if not ipcls.ValidateNetmask(master_netmask):
366       raise errors.OpPrereqError("CIDR netmask (%s) not valid for IPv%s " %
367                                   (master_netmask, primary_ip_version),
368                                  errors.ECODE_INVAL)
369   else:
370     master_netmask = ipcls.iplen
371
372   if vg_name is not None:
373     # Check if volume group is valid
374     vgstatus = utils.CheckVolumeGroupSize(utils.ListVolumeGroups(), vg_name,
375                                           constants.MIN_VG_SIZE)
376     if vgstatus:
377       raise errors.OpPrereqError("Error: %s\nspecify --no-lvm-storage if"
378                                  " you are not using lvm" % vgstatus,
379                                  errors.ECODE_INVAL)
380
381   if drbd_helper is not None:
382     try:
383       curr_helper = bdev.BaseDRBD.GetUsermodeHelper()
384     except errors.BlockDeviceError, err:
385       raise errors.OpPrereqError("Error while checking drbd helper"
386                                  " (specify --no-drbd-storage if you are not"
387                                  " using drbd): %s" % str(err),
388                                  errors.ECODE_ENVIRON)
389     if drbd_helper != curr_helper:
390       raise errors.OpPrereqError("Error: requiring %s as drbd helper but %s"
391                                  " is the current helper" % (drbd_helper,
392                                                              curr_helper),
393                                  errors.ECODE_INVAL)
394
395   if constants.ENABLE_FILE_STORAGE:
396     file_storage_dir = _InitFileStorage(file_storage_dir)
397   else:
398     file_storage_dir = ""
399
400   if constants.ENABLE_SHARED_FILE_STORAGE:
401     shared_file_storage_dir = _InitFileStorage(shared_file_storage_dir)
402   else:
403     shared_file_storage_dir = ""
404
405   if not re.match("^[0-9a-z]{2}:[0-9a-z]{2}:[0-9a-z]{2}$", mac_prefix):
406     raise errors.OpPrereqError("Invalid mac prefix given '%s'" % mac_prefix,
407                                errors.ECODE_INVAL)
408
409   result = utils.RunCmd(["ip", "link", "show", "dev", master_netdev])
410   if result.failed:
411     raise errors.OpPrereqError("Invalid master netdev given (%s): '%s'" %
412                                (master_netdev,
413                                 result.output.strip()), errors.ECODE_INVAL)
414
415   dirs = [(pathutils.RUN_DIR, constants.RUN_DIRS_MODE)]
416   utils.EnsureDirs(dirs)
417
418   objects.UpgradeBeParams(beparams)
419   utils.ForceDictType(beparams, constants.BES_PARAMETER_TYPES)
420   utils.ForceDictType(nicparams, constants.NICS_PARAMETER_TYPES)
421
422   objects.NIC.CheckParameterSyntax(nicparams)
423
424   full_ipolicy = objects.FillIPolicy(constants.IPOLICY_DEFAULTS, ipolicy)
425
426   if ndparams is not None:
427     utils.ForceDictType(ndparams, constants.NDS_PARAMETER_TYPES)
428   else:
429     ndparams = dict(constants.NDC_DEFAULTS)
430
431   # This is ugly, as we modify the dict itself
432   # FIXME: Make utils.ForceDictType pure functional or write a wrapper
433   # around it
434   if hv_state:
435     for hvname, hvs_data in hv_state.items():
436       utils.ForceDictType(hvs_data, constants.HVSTS_PARAMETER_TYPES)
437       hv_state[hvname] = objects.Cluster.SimpleFillHvState(hvs_data)
438   else:
439     hv_state = dict((hvname, constants.HVST_DEFAULTS)
440                     for hvname in enabled_hypervisors)
441
442   # FIXME: disk_state has no default values yet
443   if disk_state:
444     for storage, ds_data in disk_state.items():
445       if storage not in constants.DS_VALID_TYPES:
446         raise errors.OpPrereqError("Invalid storage type in disk state: %s" %
447                                    storage, errors.ECODE_INVAL)
448       for ds_name, state in ds_data.items():
449         utils.ForceDictType(state, constants.DSS_PARAMETER_TYPES)
450         ds_data[ds_name] = objects.Cluster.SimpleFillDiskState(state)
451
452   # hvparams is a mapping of hypervisor->hvparams dict
453   for hv_name, hv_params in hvparams.iteritems():
454     utils.ForceDictType(hv_params, constants.HVS_PARAMETER_TYPES)
455     hv_class = hypervisor.GetHypervisor(hv_name)
456     hv_class.CheckParameterSyntax(hv_params)
457
458   # diskparams is a mapping of disk-template->diskparams dict
459   for template, dt_params in diskparams.items():
460     param_keys = set(dt_params.keys())
461     default_param_keys = set(constants.DISK_DT_DEFAULTS[template].keys())
462     if not (param_keys <= default_param_keys):
463       unknown_params = param_keys - default_param_keys
464       raise errors.OpPrereqError("Invalid parameters for disk template %s:"
465                                  " %s" % (template,
466                                           utils.CommaJoin(unknown_params)),
467                                  errors.ECODE_INVAL)
468     utils.ForceDictType(dt_params, constants.DISK_DT_TYPES)
469   try:
470     utils.VerifyDictOptions(diskparams, constants.DISK_DT_DEFAULTS)
471   except errors.OpPrereqError, err:
472     raise errors.OpPrereqError("While verify diskparam options: %s" % err,
473                                errors.ECODE_INVAL)
474
475   # set up ssh config and /etc/hosts
476   sshline = utils.ReadFile(pathutils.SSH_HOST_RSA_PUB)
477   sshkey = sshline.split(" ")[1]
478
479   if modify_etc_hosts:
480     utils.AddHostToEtcHosts(hostname.name, hostname.ip)
481
482   if modify_ssh_setup:
483     _InitSSHSetup()
484
485   if default_iallocator is not None:
486     alloc_script = utils.FindFile(default_iallocator,
487                                   constants.IALLOCATOR_SEARCH_PATH,
488                                   os.path.isfile)
489     if alloc_script is None:
490       raise errors.OpPrereqError("Invalid default iallocator script '%s'"
491                                  " specified" % default_iallocator,
492                                  errors.ECODE_INVAL)
493   elif constants.HTOOLS:
494     # htools was enabled at build-time, we default to it
495     if utils.FindFile(constants.IALLOC_HAIL,
496                       constants.IALLOCATOR_SEARCH_PATH,
497                       os.path.isfile):
498       default_iallocator = constants.IALLOC_HAIL
499
500   now = time.time()
501
502   # init of cluster config file
503   cluster_config = objects.Cluster(
504     serial_no=1,
505     rsahostkeypub=sshkey,
506     highest_used_port=(constants.FIRST_DRBD_PORT - 1),
507     mac_prefix=mac_prefix,
508     volume_group_name=vg_name,
509     tcpudp_port_pool=set(),
510     master_node=hostname.name,
511     master_ip=clustername.ip,
512     master_netmask=master_netmask,
513     master_netdev=master_netdev,
514     cluster_name=clustername.name,
515     file_storage_dir=file_storage_dir,
516     shared_file_storage_dir=shared_file_storage_dir,
517     enabled_hypervisors=enabled_hypervisors,
518     beparams={constants.PP_DEFAULT: beparams},
519     nicparams={constants.PP_DEFAULT: nicparams},
520     ndparams=ndparams,
521     hvparams=hvparams,
522     diskparams=diskparams,
523     candidate_pool_size=candidate_pool_size,
524     modify_etc_hosts=modify_etc_hosts,
525     modify_ssh_setup=modify_ssh_setup,
526     uid_pool=uid_pool,
527     ctime=now,
528     mtime=now,
529     maintain_node_health=maintain_node_health,
530     drbd_usermode_helper=drbd_helper,
531     default_iallocator=default_iallocator,
532     primary_ip_family=ipcls.family,
533     prealloc_wipe_disks=prealloc_wipe_disks,
534     use_external_mip_script=use_external_mip_script,
535     ipolicy=full_ipolicy,
536     hv_state_static=hv_state,
537     disk_state_static=disk_state,
538     )
539   master_node_config = objects.Node(name=hostname.name,
540                                     primary_ip=hostname.ip,
541                                     secondary_ip=secondary_ip,
542                                     serial_no=1,
543                                     master_candidate=True,
544                                     offline=False, drained=False,
545                                     ctime=now, mtime=now,
546                                     )
547   InitConfig(constants.CONFIG_VERSION, cluster_config, master_node_config)
548   cfg = config.ConfigWriter(offline=True)
549   ssh.WriteKnownHostsFile(cfg, pathutils.SSH_KNOWN_HOSTS_FILE)
550   cfg.Update(cfg.GetClusterInfo(), logging.error)
551   ssconf.WriteSsconfFiles(cfg.GetSsconfValues())
552
553   # set up the inter-node password and certificate
554   _InitGanetiServerSetup(hostname.name)
555
556   logging.debug("Starting daemons")
557   result = utils.RunCmd([pathutils.DAEMON_UTIL, "start-all"])
558   if result.failed:
559     raise errors.OpExecError("Could not start daemons, command %s"
560                              " had exitcode %s and error %s" %
561                              (result.cmd, result.exit_code, result.output))
562
563   _WaitForMasterDaemon()
564
565
566 def InitConfig(version, cluster_config, master_node_config,
567                cfg_file=pathutils.CLUSTER_CONF_FILE):
568   """Create the initial cluster configuration.
569
570   It will contain the current node, which will also be the master
571   node, and no instances.
572
573   @type version: int
574   @param version: configuration version
575   @type cluster_config: L{objects.Cluster}
576   @param cluster_config: cluster configuration
577   @type master_node_config: L{objects.Node}
578   @param master_node_config: master node configuration
579   @type cfg_file: string
580   @param cfg_file: configuration file path
581
582   """
583   uuid_generator = config.TemporaryReservationManager()
584   cluster_config.uuid = uuid_generator.Generate([], utils.NewUUID,
585                                                 _INITCONF_ECID)
586   master_node_config.uuid = uuid_generator.Generate([], utils.NewUUID,
587                                                     _INITCONF_ECID)
588   nodes = {
589     master_node_config.name: master_node_config,
590     }
591   default_nodegroup = objects.NodeGroup(
592     uuid=uuid_generator.Generate([], utils.NewUUID, _INITCONF_ECID),
593     name=constants.INITIAL_NODE_GROUP_NAME,
594     members=[master_node_config.name],
595     diskparams={},
596     )
597   nodegroups = {
598     default_nodegroup.uuid: default_nodegroup,
599     }
600   now = time.time()
601   config_data = objects.ConfigData(version=version,
602                                    cluster=cluster_config,
603                                    nodegroups=nodegroups,
604                                    nodes=nodes,
605                                    instances={},
606                                    serial_no=1,
607                                    ctime=now, mtime=now)
608   utils.WriteFile(cfg_file,
609                   data=serializer.Dump(config_data.ToDict()),
610                   mode=0600)
611
612
613 def FinalizeClusterDestroy(master):
614   """Execute the last steps of cluster destroy
615
616   This function shuts down all the daemons, completing the destroy
617   begun in cmdlib.LUDestroyOpcode.
618
619   """
620   cfg = config.ConfigWriter()
621   modify_ssh_setup = cfg.GetClusterInfo().modify_ssh_setup
622   runner = rpc.BootstrapRunner()
623
624   master_params = cfg.GetMasterNetworkParameters()
625   master_params.name = master
626   ems = cfg.GetUseExternalMipScript()
627   result = runner.call_node_deactivate_master_ip(master_params.name,
628                                                  master_params, ems)
629
630   msg = result.fail_msg
631   if msg:
632     logging.warning("Could not disable the master IP: %s", msg)
633
634   result = runner.call_node_stop_master(master)
635   msg = result.fail_msg
636   if msg:
637     logging.warning("Could not disable the master role: %s", msg)
638
639   result = runner.call_node_leave_cluster(master, modify_ssh_setup)
640   msg = result.fail_msg
641   if msg:
642     logging.warning("Could not shutdown the node daemon and cleanup"
643                     " the node: %s", msg)
644
645
646 def SetupNodeDaemon(cluster_name, node, ssh_key_check):
647   """Add a node to the cluster.
648
649   This function must be called before the actual opcode, and will ssh
650   to the remote node, copy the needed files, and start ganeti-noded,
651   allowing the master to do the rest via normal rpc calls.
652
653   @param cluster_name: the cluster name
654   @param node: the name of the new node
655   @param ssh_key_check: whether to do a strict key check
656
657   """
658   sstore = ssconf.SimpleStore()
659   family = sstore.GetPrimaryIPFamily()
660   sshrunner = ssh.SshRunner(cluster_name,
661                             ipv6=(family == netutils.IP6Address.family))
662
663   # set up inter-node password and certificate and restarts the node daemon
664   # and then connect with ssh to set password and start ganeti-noded
665   # note that all the below variables are sanitized at this point,
666   # either by being constants or by the checks above
667   sshrunner.CopyFileToNode(node, pathutils.NODED_CERT_FILE)
668   sshrunner.CopyFileToNode(node, pathutils.RAPI_CERT_FILE)
669   sshrunner.CopyFileToNode(node, pathutils.SPICE_CERT_FILE)
670   sshrunner.CopyFileToNode(node, pathutils.SPICE_CACERT_FILE)
671   sshrunner.CopyFileToNode(node, pathutils.CONFD_HMAC_KEY)
672   for filename in sstore.GetFileList():
673     sshrunner.CopyFileToNode(node, filename)
674   mycommand = ("%s stop-all; %s start %s" %
675                (pathutils.DAEMON_UTIL, pathutils.DAEMON_UTIL, constants.NODED))
676
677   result = sshrunner.Run(node, constants.SSH_LOGIN_USER, mycommand, batch=False,
678                          ask_key=ssh_key_check,
679                          use_cluster_key=True,
680                          strict_host_check=ssh_key_check)
681   if result.failed:
682     raise errors.OpExecError("Remote command on node %s, error: %s,"
683                              " output: %s" %
684                              (node, result.fail_reason, result.output))
685
686   _WaitForNodeDaemon(node)
687
688
689 def MasterFailover(no_voting=False):
690   """Failover the master node.
691
692   This checks that we are not already the master, and will cause the
693   current master to cease being master, and the non-master to become
694   new master.
695
696   @type no_voting: boolean
697   @param no_voting: force the operation without remote nodes agreement
698                       (dangerous)
699
700   """
701   sstore = ssconf.SimpleStore()
702
703   old_master, new_master = ssconf.GetMasterAndMyself(sstore)
704   node_list = sstore.GetNodeList()
705   mc_list = sstore.GetMasterCandidates()
706
707   if old_master == new_master:
708     raise errors.OpPrereqError("This commands must be run on the node"
709                                " where you want the new master to be."
710                                " %s is already the master" %
711                                old_master, errors.ECODE_INVAL)
712
713   if new_master not in mc_list:
714     mc_no_master = [name for name in mc_list if name != old_master]
715     raise errors.OpPrereqError("This node is not among the nodes marked"
716                                " as master candidates. Only these nodes"
717                                " can become masters. Current list of"
718                                " master candidates is:\n"
719                                "%s" % ("\n".join(mc_no_master)),
720                                errors.ECODE_STATE)
721
722   if not no_voting:
723     vote_list = GatherMasterVotes(node_list)
724
725     if vote_list:
726       voted_master = vote_list[0][0]
727       if voted_master is None:
728         raise errors.OpPrereqError("Cluster is inconsistent, most nodes did"
729                                    " not respond.", errors.ECODE_ENVIRON)
730       elif voted_master != old_master:
731         raise errors.OpPrereqError("I have a wrong configuration, I believe"
732                                    " the master is %s but the other nodes"
733                                    " voted %s. Please resync the configuration"
734                                    " of this node." %
735                                    (old_master, voted_master),
736                                    errors.ECODE_STATE)
737   # end checks
738
739   rcode = 0
740
741   logging.info("Setting master to %s, old master: %s", new_master, old_master)
742
743   try:
744     # instantiate a real config writer, as we now know we have the
745     # configuration data
746     cfg = config.ConfigWriter(accept_foreign=True)
747
748     cluster_info = cfg.GetClusterInfo()
749     cluster_info.master_node = new_master
750     # this will also regenerate the ssconf files, since we updated the
751     # cluster info
752     cfg.Update(cluster_info, logging.error)
753   except errors.ConfigurationError, err:
754     logging.error("Error while trying to set the new master: %s",
755                   str(err))
756     return 1
757
758   # if cfg.Update worked, then it means the old master daemon won't be
759   # able now to write its own config file (we rely on locking in both
760   # backend.UploadFile() and ConfigWriter._Write(); hence the next
761   # step is to kill the old master
762
763   logging.info("Stopping the master daemon on node %s", old_master)
764
765   runner = rpc.BootstrapRunner()
766   master_params = cfg.GetMasterNetworkParameters()
767   master_params.name = old_master
768   ems = cfg.GetUseExternalMipScript()
769   result = runner.call_node_deactivate_master_ip(master_params.name,
770                                                  master_params, ems)
771
772   msg = result.fail_msg
773   if msg:
774     logging.warning("Could not disable the master IP: %s", msg)
775
776   result = runner.call_node_stop_master(old_master)
777   msg = result.fail_msg
778   if msg:
779     logging.error("Could not disable the master role on the old master"
780                   " %s, please disable manually: %s", old_master, msg)
781
782   logging.info("Checking master IP non-reachability...")
783
784   master_ip = sstore.GetMasterIP()
785   total_timeout = 30
786
787   # Here we have a phase where no master should be running
788   def _check_ip():
789     if netutils.TcpPing(master_ip, constants.DEFAULT_NODED_PORT):
790       raise utils.RetryAgain()
791
792   try:
793     utils.Retry(_check_ip, (1, 1.5, 5), total_timeout)
794   except utils.RetryTimeout:
795     logging.warning("The master IP is still reachable after %s seconds,"
796                     " continuing but activating the master on the current"
797                     " node will probably fail", total_timeout)
798
799   if jstore.CheckDrainFlag():
800     logging.info("Undraining job queue")
801     jstore.SetDrainFlag(False)
802
803   logging.info("Starting the master daemons on the new master")
804
805   result = rpc.BootstrapRunner().call_node_start_master_daemons(new_master,
806                                                                 no_voting)
807   msg = result.fail_msg
808   if msg:
809     logging.error("Could not start the master role on the new master"
810                   " %s, please check: %s", new_master, msg)
811     rcode = 1
812
813   logging.info("Master failed over from %s to %s", old_master, new_master)
814   return rcode
815
816
817 def GetMaster():
818   """Returns the current master node.
819
820   This is a separate function in bootstrap since it's needed by
821   gnt-cluster, and instead of importing directly ssconf, it's better
822   to abstract it in bootstrap, where we do use ssconf in other
823   functions too.
824
825   """
826   sstore = ssconf.SimpleStore()
827
828   old_master, _ = ssconf.GetMasterAndMyself(sstore)
829
830   return old_master
831
832
833 def GatherMasterVotes(node_list):
834   """Check the agreement on who is the master.
835
836   This function will return a list of (node, number of votes), ordered
837   by the number of votes. Errors will be denoted by the key 'None'.
838
839   Note that the sum of votes is the number of nodes this machine
840   knows, whereas the number of entries in the list could be different
841   (if some nodes vote for another master).
842
843   We remove ourselves from the list since we know that (bugs aside)
844   since we use the same source for configuration information for both
845   backend and boostrap, we'll always vote for ourselves.
846
847   @type node_list: list
848   @param node_list: the list of nodes to query for master info; the current
849       node will be removed if it is in the list
850   @rtype: list
851   @return: list of (node, votes)
852
853   """
854   myself = netutils.Hostname.GetSysName()
855   try:
856     node_list.remove(myself)
857   except ValueError:
858     pass
859   if not node_list:
860     # no nodes left (eventually after removing myself)
861     return []
862   results = rpc.BootstrapRunner().call_master_info(node_list)
863   if not isinstance(results, dict):
864     # this should not happen (unless internal error in rpc)
865     logging.critical("Can't complete rpc call, aborting master startup")
866     return [(None, len(node_list))]
867   votes = {}
868   for node in results:
869     nres = results[node]
870     data = nres.payload
871     msg = nres.fail_msg
872     fail = False
873     if msg:
874       logging.warning("Error contacting node %s: %s", node, msg)
875       fail = True
876     # for now we accept both length 3, 4 and 5 (data[3] is primary ip version
877     # and data[4] is the master netmask)
878     elif not isinstance(data, (tuple, list)) or len(data) < 3:
879       logging.warning("Invalid data received from node %s: %s", node, data)
880       fail = True
881     if fail:
882       if None not in votes:
883         votes[None] = 0
884       votes[None] += 1
885       continue
886     master_node = data[2]
887     if master_node not in votes:
888       votes[master_node] = 0
889     votes[master_node] += 1
890
891   vote_list = [v for v in votes.items()]
892   # sort first on number of votes then on name, since we want None
893   # sorted later if we have the half of the nodes not responding, and
894   # half voting all for the same master
895   vote_list.sort(key=lambda x: (x[1], x[0]), reverse=True)
896
897   return vote_list