# Copyright 2017 Red Hat Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); you may # not use this file except in compliance with the License. You may obtain # a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the # License for the specific language governing permissions and limitations # under the License. import json import logging import netaddr import netifaces import os import subprocess import sys from osc_lib.i18n import _ from oslo_utils import netutils import psutil from oslo_config import cfg from tripleoclient import constants from tripleoclient import utils from validations_libs.validation_actions import ValidationActions class FailedValidation(Exception): pass CONF = cfg.CONF # We need 8 GB, leave a little room for variation in what 8 GB means on # different platforms. REQUIRED_MB = 7680 LOG = logging.getLogger(__name__ + ".UndercloudSetup") def _run_live_command(args, env=None, name=None, cwd=None, wait=True): """Run the command defined by args, env and cwd Either returns the process handler or runs the process asynchronously so the output can be logged while the process is still running. """ if name is None: name = args[0] process = subprocess.Popen(args, env=env, cwd=cwd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, universal_newlines=True) if not wait: return process while True: line = process.stdout.readline().decode('utf-8') if line: LOG.info(line.rstrip()) if line == '' and process.poll() is not None: break if process.returncode != 0: message = '%s failed. See log for details.' % name LOG.error(message) raise RuntimeError(message) def _check_diskspace(upgrade=False): """Check undercloud disk space This runs a simple ansible playbook located in tripleo-validations There are currently two playbooks: - undercloud-disk-space.yaml - undercloud-disk-space-pre-upgrade.yaml First one checks minimal disk space for a brand new deploy. Second one checks minimal disk space for an upgrade. """ if upgrade: playbook_args = constants.DEPLOY_ANSIBLE_ACTIONS['preflight-upgrade'] else: playbook_args = constants.DEPLOY_ANSIBLE_ACTIONS['preflight-deploy'] with utils.TempDirs() as tmp: actions = ValidationActions() actions.run_validations( inventory='undercloud', log_path=tmp, validations_dir=constants.ANSIBLE_VALIDATION_DIR, validation_name=playbook_args['playbook']) def _check_memory(): """Check system memory The undercloud will not run properly in less than 8 GB of memory. This function verifies that at least that much is available before proceeding with install. """ mem = psutil.virtual_memory() swap = psutil.swap_memory() total_mb = (mem.total + swap.total) / 1024 / 1024 if total_mb < REQUIRED_MB: LOG.error(_('At least {0} MB of memory is required for undercloud ' 'installation. A minimum of 8 GB is recommended. ' 'Only detected {1} MB').format(REQUIRED_MB, total_mb)) raise RuntimeError(_('Insufficient memory available')) def _check_ipv6_enabled(): """Test if IPv6 is enabled If /proc/net/if_inet6 exist ipv6 sysctl settings are available. """ return os.path.isfile('/proc/net/if_inet6') def _wrap_ipv6(ip): """Wrap a IP address in square brackets if IPv6 """ if netutils.is_valid_ipv6(ip): return "[%s]" % ip return ip def _check_sysctl(): """Check sysctl option availability The undercloud will not install properly if some of the expected sysctl values are not available to be set. """ options = ['net.ipv4.ip_forward', 'net.ipv4.ip_nonlocal_bind'] if _check_ipv6_enabled(): options.append('net.ipv6.ip_nonlocal_bind') not_available = [] for option in options: path = '/proc/sys/{opt}'.format(opt=option.replace('.', '/')) if not os.path.isfile(path): not_available.append(option) if not_available: LOG.error(_('Required sysctl options are not available. Check ' 'that your kernel is up to date. Missing: {options}') .format(options=", ".join(not_available))) raise RuntimeError(_('Missing sysctl options')) def _validate_ips(): def is_ip(value, param_name): try: netaddr.IPAddress(value) except netaddr.core.AddrFormatError: msg = (_('{0} "{1}" must be a valid IP address') .format(param_name, value)) LOG.error(msg) raise FailedValidation(msg) for ip in CONF.undercloud_nameservers: is_ip(ip, 'undercloud_nameservers') def _validate_value_formats(): """Validate format of some values Certain values have a specific format that must be maintained in order to work properly. For example, local_ip must be in CIDR form, and the hostname must be a FQDN. """ try: local_ip = netaddr.IPNetwork(CONF.local_ip) if local_ip.prefixlen == 32: LOG.error(_('Invalid netmask')) raise netaddr.AddrFormatError(_('Invalid netmask')) # If IPv6 the ctlplane network uses the EUI-64 address format, # which requires the prefix to be /64 if local_ip.version == 6 and local_ip.prefixlen != 64: LOG.error(_('Prefix must be 64 for IPv6')) raise netaddr.AddrFormatError(_('Prefix must be 64 for IPv6')) except netaddr.core.AddrFormatError as e: message = (_('local_ip "{0}" not valid: "{1}" ' 'Value must be in CIDR format.') .format(CONF.local_ip, str(e))) LOG.error(message) raise FailedValidation(message) hostname = CONF['undercloud_hostname'] if hostname is not None and '.' not in hostname: message = (_('Hostname "%s" is not fully qualified.') % hostname) LOG.error(message) raise FailedValidation(message) def _validate_in_cidr(subnet_props, subnet_name): cidr = netaddr.IPNetwork(subnet_props.cidr) def validate_addr_in_cidr(addr, pretty_name=None, require_ip=True, log_only=False): try: if netaddr.IPAddress(addr) not in cidr: message = (_('Config option {0} "{1}" not in defined ' 'CIDR "{2}"').format(pretty_name, addr, cidr)) if log_only: LOG.warning(message) else: LOG.error(message) raise FailedValidation(message) except netaddr.core.AddrFormatError: if require_ip: message = (_('Invalid IP address: %s') % addr) LOG.error(message) raise FailedValidation(message) validate_addr_in_cidr(subnet_props.gateway, 'gateway') # NOTE(hjensas): Ignore the default dhcp_start and dhcp_end if cidr is not # the default as well. I.e allow not specifying dhcp_start and dhcp_end. if not (subnet_props.cidr != constants.CTLPLANE_CIDR_DEFAULT and subnet_props.dhcp_start == constants.CTLPLANE_DHCP_START_DEFAULT and subnet_props.dhcp_end == constants.CTLPLANE_DHCP_END_DEFAULT): for start in subnet_props.dhcp_start: validate_addr_in_cidr(start, 'dhcp_start') for end in subnet_props.dhcp_end: validate_addr_in_cidr(end, 'dhcp_end') if subnet_name == CONF.local_subnet: validate_addr_in_cidr(str(netaddr.IPNetwork(CONF.local_ip).ip), 'local_ip') if (CONF.undercloud_service_certificate or CONF.generate_service_certificate): validate_addr_in_cidr(CONF['undercloud_public_host'], 'undercloud_public_host', require_ip=False, log_only=True) validate_addr_in_cidr(CONF['undercloud_admin_host'], 'undercloud_admin_host', require_ip=False) def _validate_dhcp_range(subnet_props, subnet_name): len_dhcp_start = len(subnet_props.dhcp_start) len_dhcp_end = len(subnet_props.dhcp_end) if (len_dhcp_start > 1 or len_dhcp_end > 1 and len_dhcp_start != len_dhcp_end): message = (_('Number of elements in dhcp_start and dhcp_end must be ' 'identical. Subnet "{0}" have "{1}" dhcp_start elements ' 'and "{2}" dhcp_end elements.').format(subnet_name, len_dhcp_start, len_dhcp_end)) LOG.error(message) raise FailedValidation(message) for a, b in zip(subnet_props.dhcp_start, subnet_props.dhcp_end): start = netaddr.IPAddress(a) end = netaddr.IPAddress(b) if start >= end: message = (_('Invalid dhcp range specified, dhcp_start "{0}" does ' 'not come before dhcp_end "{1}"').format(start, end)) LOG.error(message) raise FailedValidation(message) def _validate_inspection_range(subnet_props): start = netaddr.IPAddress(subnet_props.inspection_iprange.split(',')[0]) end = netaddr.IPAddress(subnet_props.inspection_iprange.split(',')[1]) if start >= end: message = (_('Invalid inspection range specified, inspection_iprange ' '"{0}" does not come before "{1}"').format(start, end)) LOG.error(message) raise FailedValidation(message) def _validate_interface_exists(config_var='local_interface'): """Validate the provided local interface exists""" if (not CONF.net_config_override and CONF.get(config_var) not in netifaces.interfaces()): message = (_('Invalid {0} specified. ' '{1} is not available.').format(config_var, CONF.get(config_var))) LOG.error(message) raise FailedValidation(message) def _validate_no_ip_change(): """Disallow provisioning interface IP changes Changing the provisioning network IP causes a number of issues, so we need to disallow it early in the install before configurations start to be changed. """ if CONF.net_config_override: os_net_config_file = CONF.net_config_override else: os_net_config_file = '/etc/os-net-config/config.json' # Nothing to do if we haven't already installed if not os.path.isfile( os.path.expanduser(os_net_config_file)): return try: with open(os_net_config_file) as f: network_config = json.loads(f.read()) ctlplane = [i for i in network_config.get('network_config', []) if i.get('name') == 'br-ctlplane'][0] except ValueError: # File was empty return except IndexError: # Nothing to check if br-ctlplane wasn't configured return existing_ip = ctlplane['addresses'][0]['ip_netmask'] if existing_ip != CONF.local_ip: message = _('Changing the local_ip is not allowed. Existing IP: ' '{0}, Configured IP: {1}').format( existing_ip, CONF.local_ip) LOG.error(message) raise FailedValidation(message) def _validate_passwords_file(): """Disallow updates if the passwords file is missing If the undercloud was already deployed, the passwords file needs to be present so passwords that can't be changed are persisted. If the file is missing it will break the undercloud, so we should fail-fast and let the user know about the problem. """ if not CONF.get('output_dir'): output_dir = os.path.join(constants.UNDERCLOUD_OUTPUT_DIR, 'tripleo-deploy', 'undercloud') else: output_dir = CONF['output_dir'] passwd_path = os.path.join(output_dir, 'undercloud-passwords.conf') if (os.path.isfile(os.path.join(constants.CLOUD_HOME_DIR, 'stackrc')) and not os.path.isfile(passwd_path)): message = (_('The %s file is missing. This will cause all service ' 'passwords to change and break the existing ' 'undercloud. ') % passwd_path) LOG.error(message) raise FailedValidation(message) def _validate_env_files_paths(): """Verify the non-matching templates path vs env files paths""" tht_path = CONF.get('templates') or constants.TRIPLEO_HEAT_TEMPLATES roles_file = utils.rel_or_abs_path( CONF.get('roles_file') or constants.UNDERCLOUD_ROLES_FILE, tht_path) # get the list of jinja templates normally rendered for UC installations LOG.debug(_("Using roles file {0} from {1}").format(roles_file, tht_path)) process_templates = os.path.join(tht_path, 'tools/process-templates.py') python_interpreter = "/usr/bin/python{}".format(sys.version_info[0]) p = _run_live_command( [python_interpreter, process_templates, '--roles-data', roles_file, '--dry-run'], name='process-templates-dry-run', cwd=tht_path, wait=False) # parse the list for the rendered from j2 file names result = p.communicate()[0] j2_files_list = [] for line in result.split("\n"): if ((line.startswith('dry run') or line.startswith('jinja2')) and line.endswith('.yaml')): bname = os.path.basename(line.split(' ')[-1]) if line.startswith('dry run'): j2_files_list.append(bname) if line.startswith('jinja2'): j2_files_list.append(bname.replace('.j2', '')) for env_file in CONF['custom_env_files']: env_file_abs = os.path.abspath(env_file) if (os.path.dirname(env_file_abs) != os.path.abspath(tht_path) and os.path.basename(env_file) in j2_files_list): msg = _( 'Heat environment external to the templates dir ' 'can not reference j2 processed file %s') % env_file_abs LOG.error(msg) raise FailedValidation(msg) def _run_yum_clean_all(instack_env): args = ['sudo', 'yum', 'clean', 'all'] LOG.info('Running yum clean all') _run_live_command(args, instack_env, 'yum-clean-all') LOG.info(_('yum-clean-all completed successfully')) def _run_yum_update(instack_env): args = ['sudo', 'yum', 'update', '-y'] LOG.info('Running yum update') _run_live_command(args, instack_env, 'yum-update') LOG.info(_('yum-update completed successfully')) def _validate_architecure_options(): def error_handler(message): LOG.error(_('Undercloud configuration validation failed: %s'), message) raise FailedValidation(message) def _validate_ppc64le_exclusive_opts(error_callback): if 'ipxe_enabled' in CONF and CONF['ipxe_enabled']: error_callback(_('Currently iPXE boot isn\'t supported with ' 'ppc64le systems but is enabled')) def _validate_additional_architectures(error_callback): for arch in CONF['additional_architectures']: if arch not in constants.ADDITIONAL_ARCHITECTURES: params = {'architecture': arch, 'all_architectures': ' '.join(constants.ADDITIONAL_ARCHITECTURES) } error_callback(_('additional_architectures "%(architecture)s" ' 'must be in the supported architecture list: ' '%(all_architectures)s') % params) _validate_additional_architectures(error_handler) if 'ppc64le' in CONF['additional_architectures']: _validate_ppc64le_exclusive_opts(error_handler) def _checking_status(item): LOG.info(_('Checking %s...') % item) def _check_routed_networks_enabled_if_multiple_subnets_defined(): if (len(CONF.subnets) > 1 and not CONF.enable_routed_networks): msg = _('Multiple subnets specified: %s but routed networks are not ' 'enabled.') % CONF.subnets LOG.error(msg) raise FailedValidation(msg) def _validate_deprecetad_now_invalid_parameters(): invalid_opts = [ 'masquerade_network', ] deprecate_conf = cfg.CONF invalid_opts_used = [] for invalid_opt in invalid_opts: deprecate_conf.register_opts([cfg.StrOpt(invalid_opt)]) if deprecate_conf.get(invalid_opt): invalid_opts_used.append(invalid_opt) if invalid_opts_used: msg = _('Options that has been deprecated and removed/replaced ' 'detected. Invalid options: %s') % invalid_opts_used LOG.error(msg) raise FailedValidation(msg) del deprecate_conf def _validate_dnsnameservers(s): ip_version = netaddr.IPNetwork(s['cidr']).version if s['dns_nameservers']: nameservers = s['dns_nameservers'] else: nameservers = CONF.undercloud_nameservers for nameserver in nameservers: if not netaddr.IPAddress(nameserver).version == ip_version: message = (_('IP version missmatch. Nameserver {0} is not valid ' 'for subnet {1}').format(nameserver, s['cidr'])) LOG.error(message) raise FailedValidation(message) def _check_all_or_no_subnets_use_dns_nameservers(): x = [CONF.get(s).get('dns_nameservers') for s in CONF.subnets] if any(([len(y) == 0 for y in x])) and any(([len(y) > 0 for y in x])): message = (_('Option dns_nameservers is defined for subnets: {0}. ' 'Option dns_nameservers is also required for subnets: ' '{1}.').format( ', '.join([s for s in CONF.subnets if CONF.get(s).get('dns_nameservers')]), ', '.join([s for s in CONF.subnets if not CONF.get(s).get('dns_nameservers')]))) LOG.error(message) raise FailedValidation(message) def check(verbose_level, upgrade=False): # Fetch configuration and use its log file param to add logging to a file utils.load_config(CONF, constants.UNDERCLOUD_CONF_PATH) utils.configure_logging(LOG, verbose_level, CONF['undercloud_log_file']) # data = {opt.name: CONF[opt.name] for opt in _opts} try: # Other validations _checking_status('Hostname') utils.check_hostname() _checking_status('Memory') _check_memory() _checking_status('Disk space') _check_diskspace(upgrade) _checking_status('Sysctl') _check_sysctl() _checking_status('Password file') _validate_passwords_file() _checking_status('Deprecated now invalid options') _validate_deprecetad_now_invalid_parameters() # Heat templates validations if CONF.get('custom_env_files'): _checking_status('Custom env file') _validate_env_files_paths() # Networking validations _checking_status('Networking values') _validate_value_formats() _check_routed_networks_enabled_if_multiple_subnets_defined() _check_all_or_no_subnets_use_dns_nameservers() for subnet in CONF.subnets: s = CONF.get(subnet) _checking_status('Subnet "%s" is in CIDR' % subnet) _validate_in_cidr(s, subnet) _checking_status('DHCP range is in subnet "%s"' % subnet) _validate_dhcp_range(s, subnet) _checking_status('Inspection range for subnet "%s"' % subnet) _validate_inspection_range(s) _validate_dnsnameservers(s) _checking_status('IP addresses') _validate_ips() _checking_status('Network interfaces') _validate_interface_exists() _checking_status('Provisioning IP change') _validate_no_ip_change() _checking_status('Architecture') _validate_architecure_options() except KeyError as e: LOG.error(_('Key error in configuration: {error}\n' 'Value is missing in configuration.').format(error=e)) sys.exit(1) except FailedValidation as e: LOG.error(_('An error occurred during configuration ' 'validation, please check your host ' 'configuration and try again.\nError ' 'message: {error}').format(error=e)) sys.exit(1) except RuntimeError as e: LOG.error(_('An error occurred during configuration ' 'validation, please check your host ' 'configuration and try again. Error ' 'message: {error}').format(error=e)) sys.exit(1) def minion_check(verbose_level, upgrade=False): utils.load_config(CONF, constants.MINION_CONF_PATH) utils.configure_logging(LOG, verbose_level, CONF['minion_log_file']) try: _checking_status('Hostname') utils.check_hostname() _checking_status('Sysctl') _check_sysctl() _checking_status('Network interfaces') _validate_interface_exists('minion_local_interface') _checking_status('Password file') _validate_passwords_file() # Heat templates validations if CONF.get('custom_env_files'): _checking_status('Custom env file') _validate_env_files_paths() except KeyError as e: LOG.error(_('Key error in configuration: {error}\n' 'Value is missing in configuration.').format(error=e)) sys.exit(1) except FailedValidation as e: LOG.error(_('An error occurred during configuration ' 'validation, please check your host ' 'configuration and try again.\nError ' 'message: {error}').format(error=e)) sys.exit(1) except RuntimeError as e: LOG.error(_('An error occurred during configuration ' 'validation, please check your host ' 'configuration and try again. Error ' 'message: {error}').format(error=e)) sys.exit(1)