3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
17 from cmdatahandlers.api import configerror
18 from cmdatahandlers.api import config
19 from cmdatahandlers.api import utils
20 from serviceprofiles import profiles
22 VNF_EMBEDDED_RESERVED_MEMORY = "512Mi"
23 DUAL_VIM_CONTROLLER_RESERVED_MEMORY = "64Gi"
24 DUAL_VIM_DEFAULT_RESERVED_MEMORY = "32Gi"
25 MIDDLEWARE_RESERVED_MEMORY = "12Gi"
27 class Config(config.Config):
28 def __init__(self, confman):
29 super(Config, self).__init__(confman)
30 self.ROOT = 'cloud.hosts'
33 self.update_service_profiles()
43 hosts = self.get_hosts()
44 except configerror.ConfigError:
48 utils.validate_list_items_unique(hosts)
51 self._validate_host(host)
53 def mask_sensitive_data(self):
54 for hostname in self.config[self.ROOT].keys():
55 self.config[self.ROOT][hostname]['hwmgmt']['password'] = self.MASK
56 self.config[self.ROOT][hostname]['hwmgmt']['snmpv2_trap_community_string'] = self.MASK
57 self.config[self.ROOT][hostname]['hwmgmt']['snmpv3_authpass'] = self.MASK
58 self.config[self.ROOT][hostname]['hwmgmt']['snmpv3_privpass'] = self.MASK
60 def _validate_host(self, hostname):
61 self._validate_hwmgmt(hostname)
62 self._validate_service_profiles(hostname)
63 self._validate_network_profiles(hostname)
64 self._validate_performance_profiles(hostname)
65 self._validate_storage_profiles(hostname)
67 def _validate_hwmgmt(self, hostname):
68 ip = self.get_hwmgmt_ip(hostname)
69 utils.validate_ipv4_address(ip)
70 self.get_hwmgmt_user(hostname)
71 self.get_hwmgmt_password(hostname)
72 netconf = self.confman.get_networking_config_handler()
76 hwmgmtnet = netconf.get_hwmgmt_network_name()
77 except configerror.ConfigError:
81 domain = self.get_host_network_domain(hostname)
82 cidr = netconf.get_network_cidr(hwmgmtnet, domain)
83 utils.validate_ip_in_network(ip, cidr)
85 def get_hwmgmt_priv_level(self, hostname):
86 """get the hwmgmt IPMI privilege level. Defaults to ADMINISTRATOR
90 hostname: The name of the node
94 The prvilege level, or ADMINISTRATOR if unspecified
98 ConfigError in-case of an error
100 self._validate_hostname(hostname)
102 if 'hwmgmt' not in self.config[self.ROOT][hostname]:
103 raise configerror.ConfigError('No hwmgmt info defined for host')
105 return self.config[self.ROOT][hostname]['hwmgmt'].get('priv_level', 'ADMINISTRATOR')
107 def _validate_service_profiles(self, hostname):
108 node_profiles = self.get_service_profiles(hostname)
109 utils.validate_list_items_unique(node_profiles)
110 service_profiles_lib = profiles.Profiles()
111 serviceprofiles = service_profiles_lib.get_service_profiles()
112 for profile in node_profiles:
113 if profile not in serviceprofiles:
114 raise configerror.ConfigError('Invalid service profile %s specified for host %s' % (profile, hostname))
116 def _validate_network_profiles(self, hostname):
117 node_profiles = self.get_network_profiles(hostname)
118 utils.validate_list_items_unique(profiles)
119 netprofconf = self.confman.get_network_profiles_config_handler()
120 netprofiles = netprofconf.get_network_profiles()
121 for profile in node_profiles:
122 if profile not in netprofiles:
123 raise configerror.ConfigError('Invalid network profile %s specified for host %s' % (profile, hostname))
125 def _validate_performance_profiles(self, hostname):
126 node_performance_profiles = []
128 node_performance_profiles = self.get_performance_profiles(hostname)
129 except configerror.ConfigError:
132 if node_performance_profiles:
133 utils.validate_list_items_unique(node_performance_profiles)
134 perfprofconf = self.confman.get_performance_profiles_config_handler()
135 perfprofiles = perfprofconf.get_performance_profiles()
136 for profile in node_performance_profiles:
137 if profile not in perfprofiles:
138 raise configerror.ConfigError('Invalid performance profile %s specified for host %s' % (profile, hostname))
140 def _validate_storage_profiles(self, hostname):
141 node_storage_profiles = []
143 node_storage_profiles = self.get_storage_profiles(hostname)
144 except configerror.ConfigError:
147 if node_storage_profiles:
148 utils.validate_list_items_unique(node_storage_profiles)
149 storageprofconf = self.confman.get_storage_profiles_config_handler()
150 storageprofiles = storageprofconf.get_storage_profiles()
151 for profile in node_storage_profiles:
152 if profile not in storageprofiles:
153 raise configerror.ConfigError('Invalid storage profile %s specific for %s' % (profile, hostname))
156 """ get the list of hosts in the cloud
160 A sorted list of host names
164 ConfigError in-case of an error
168 return sorted(self.config[self.ROOT].keys())
170 def get_labels(self, hostname):
172 {"nodetype": self.get_nodetype(hostname),
173 "nodeindex": self.get_nodeindex(hostname),
174 "nodename": self.get_nodename(hostname)}
175 labels = self.config[self.ROOT][hostname].get('labels', {}).copy()
176 labels.update(mandatory_labels)
178 if self.is_sriov_enabled(hostname):
179 labels.update({"sriov": "enabled"})
181 black_list = ['name']
182 return {name: attributes
183 for name, attributes in labels.iteritems()
184 if name not in black_list}
186 def get_nodetype(self, hostname):
187 service_profiles_lib = profiles.Profiles()
188 service_profiles = self.get_service_profiles(hostname)
190 if service_profiles_lib.get_caasmaster_service_profile() in service_profiles:
191 return service_profiles_lib.get_caasmaster_service_profile()
192 if service_profiles_lib.get_caasworker_service_profile() in service_profiles:
193 return service_profiles_lib.get_caasworker_service_profile()
195 return service_profiles[0]
197 def set_nodeindex(self):
198 hostsconf = self.confman.get_hosts_config_handler()
199 install_host = utils.get_installation_host_name(hostsconf)
200 self.config[self.ROOT][install_host]['caas_nodeindex'] = 1
202 masters = self.get_service_profile_hosts('caas_master')
203 masters.remove(install_host)
204 self._set_nodeindexes(masters, 2)
205 self._set_nodeindexes(self.get_service_profile_hosts('caas_worker'), 1)
207 def _set_nodeindexes(self, hosts, base_index):
210 self.config[self.ROOT][host]['caas_nodeindex'] = index
213 def get_nodeindex(self, hostname):
214 return self.config[self.ROOT][hostname]['caas_nodeindex']
216 def get_nodename(self, hostname):
217 return "{}{}".format(self.get_nodetype(hostname), self.get_nodeindex(hostname))
219 def get_noderole(self, hostname):
220 service_profiles_lib = profiles.Profiles()
221 service_profiles = self.get_service_profiles(hostname)
223 if service_profiles_lib.get_caasmaster_service_profile() in service_profiles:
227 def is_sriov_enabled(self, hostname):
228 netprofs = self.get_network_profiles(hostname)
229 netprofconf = self.confman.get_network_profiles_config_handler()
230 for netprof in netprofs:
231 if 'sriov_provider_networks' in self.config[netprofconf.ROOT][netprof]:
235 def get_enabled_hosts(self):
236 """ get the list of enabled hosts in the cloud
244 ConfigError in-case of an error
247 hosts = self.get_hosts()
250 if self.is_host_enabled(host):
254 def get_hwmgmt_ip(self, hostname):
255 """get the hwmgmt ip address
259 hostname: The name of the node
263 The BMC ip address as a string
267 ConfigError in-case of an error
269 self._validate_hostname(hostname)
271 if 'hwmgmt' not in self.config[self.ROOT][hostname] or 'address' not in self.config[self.ROOT][hostname]['hwmgmt']:
272 raise configerror.ConfigError('No hwmgmt info defined for host')
274 return self.config[self.ROOT][hostname]['hwmgmt']['address']
276 def get_hwmgmt_user(self, hostname):
277 """get the hwmgmt user
281 hostname: The name of the node
289 ConfigError in-case of an error
291 self._validate_hostname(hostname)
293 if 'hwmgmt' not in self.config[self.ROOT][hostname] or 'user' not in self.config[self.ROOT][hostname]['hwmgmt']:
294 raise configerror.ConfigError('No hwmgmt info defined for host')
296 return self.config[self.ROOT][hostname]['hwmgmt']['user']
298 def get_hwmgmt_password(self, hostname):
299 """get the hwmgmt password
303 hostname: The name of the node
311 ConfigError in-case of an error
313 self._validate_hostname(hostname)
315 if 'hwmgmt' not in self.config[self.ROOT][hostname] or 'password' not in self.config[self.ROOT][hostname]['hwmgmt']:
316 raise configerror.ConfigError('No hwmgmt info defined for host')
318 return self.config[self.ROOT][hostname]['hwmgmt']['password']
320 def get_service_profiles(self, hostname):
321 """get the node service profiles
325 hostname: The name of the node
329 A list containing service profile names
333 ConfigError in-case of an error
335 self._validate_hostname(hostname)
337 if 'service_profiles' not in self.config[self.ROOT][hostname]:
338 raise configerror.ConfigError('No service profiles found')
340 return self.config[self.ROOT][hostname]['service_profiles']
342 def get_performance_profiles(self, hostname):
343 """ get the performance profiles
347 hostname: The name of the node
351 A list containing the perfromance profile names.
355 ConfigError in-case of an error
357 self._validate_hostname(hostname)
359 if 'performance_profiles' not in self.config[self.ROOT][hostname]:
360 raise configerror.ConfigError('No performance profiles found')
362 return self.config[self.ROOT][hostname]['performance_profiles']
364 def get_network_profiles(self, hostname):
365 """get the node network profiles
369 hostname: The name of the node
373 A list containing network profile names
377 ConfigError in-case of an error
379 self._validate_hostname(hostname)
381 if 'network_profiles' not in self.config[self.ROOT][hostname]:
382 raise configerror.ConfigError('No network profiles found')
384 return self.config[self.ROOT][hostname]['network_profiles']
386 def get_storage_profiles(self, hostname):
387 """get the node storage profiles
391 hostname: The name of the node
395 A list containing storage profile names
399 ConfigError in-case of an error
401 self._validate_hostname(hostname)
403 if 'storage_profiles' not in self.config[self.ROOT][hostname]:
404 raise configerror.ConfigError('No storage profiles found')
406 return self.config[self.ROOT][hostname]['storage_profiles']
408 def _validate_hostname(self, hostname):
409 if not self.is_valid_host(hostname):
410 raise configerror.ConfigError('Invalid hostname given %s' % hostname)
412 def is_valid_host(self, hostname):
413 """check if a host is valid
417 hostname: The name of the node
425 ConfigError in-case of an error
428 if hostname in self.config[self.ROOT]:
432 def get_service_profile_hosts(self, profile):
433 """ get hosts having some service profile
445 ConfigError in-case of an error
447 hosts = self.get_hosts()
450 node_profiles = self.get_service_profiles(host)
451 if profile in node_profiles:
456 def get_network_profile_hosts(self, profile):
457 """ get hosts having some network profile
469 ConfigError in-case of an error
471 hosts = self.get_hosts()
474 node_network_profiles = self.get_network_profiles(host)
475 if profile in node_network_profiles:
478 raise configerror.ConfigError('No hosts found for profile %s' % profile)
482 def get_performance_profile_hosts(self, profile):
483 """ get hosts having some performance profile
487 performance profile name
495 ConfigError in-case of an error
497 hosts = self.get_hosts()
500 node_performance_profiles = self.get_performance_profiles(host)
501 if profile in node_performance_profiles:
504 raise configerror.ConfigError('No hosts found for profile %s' % profile)
508 def get_storage_profile_hosts(self, profile):
509 """ get hosts having some storage profile
521 ConfigError in-case of an error
523 hosts = self.get_hosts()
527 node_storage_profiles = self.get_storage_profiles(host)
528 if profile in node_storage_profiles:
530 except configerror.ConfigError:
534 raise configerror.ConfigError('No hosts found for profile %s' % profile)
538 def get_host_network_interface(self, host, network):
539 """ get the host interface used for some network
553 ConfigError in-case of an error
555 node_network_profiles = self.get_network_profiles(host)
556 netprofconf = self.confman.get_network_profiles_config_handler()
557 for profile in node_network_profiles:
558 interfaces = netprofconf.get_profile_network_mapped_interfaces(profile)
559 for interface in interfaces:
560 networks = netprofconf.get_profile_interface_mapped_networks(profile, interface)
561 if network in networks:
564 raise configerror.ConfigError('No interfaces found for network %s in host %s' % (network, host))
566 def get_host_network_ip_holding_interface(self, host, network):
567 """ get the host ip holding interface some network
581 ConfigError in-case of an error
583 networkingconf = self.confman.get_networking_config_handler()
586 domain = self.get_host_network_domain(host)
587 vlan = networkingconf.get_network_vlan_id(network, domain)
588 except configerror.ConfigError as exp:
592 return 'vlan'+str(vlan)
594 return self.get_host_network_interface(host, network)
596 def get_host_networks(self, hostname):
597 """ get the host networks
605 A list of network names
609 ConfigError in-case of an error
611 node_network_profiles = self.get_network_profiles(hostname)
612 netprofconf = self.confman.get_network_profiles_config_handler()
614 for profile in node_network_profiles:
615 interfaces = netprofconf.get_profile_network_mapped_interfaces(profile)
616 for interface in interfaces:
617 networks = netprofconf.get_profile_interface_mapped_networks(profile, interface)
618 for network in networks:
619 if network not in result:
620 result.append(network)
622 raise configerror.ConfigError('No networks found for host %s' % hostname)
626 def get_host_having_hwmgmt_address(self, hwmgmtips):
627 """ get the node name matching an ipmi address
639 ConfigError in-case of an error
642 hosts = self.get_hosts()
644 ip = self.get_hwmgmt_ip(host)
645 for hwmgtip in hwmgmtips:
646 addr=ipaddress.ip_address(unicode(hwmgtip))
647 if addr.version == 6:
648 hwmgtip=addr.compressed
649 ip=ipaddress.ip_address(unicode(ip))
653 raise configerror.ConfigError('No hosts are matching the provided hw address %s' % hwmgmtips)
655 def set_installation_host(self, name):
656 """ set the installation node
660 The installation node name
664 ConfigError in-case of an error
666 self._validate_hostname(name)
668 self.config[self.ROOT][name]['installation_host'] = True
670 def is_installation_host(self, name):
671 """ get if the node is an installation node
679 True if installation node
683 ConfigError in-case of an error
685 self._validate_hostname(name)
687 if 'installation_host' in self.config[self.ROOT][name]:
688 return self.config[self.ROOT][name]['installation_host']
692 def get_installation_host(self):
693 """ get the name of the node used for installation
701 ConfigError in-case of an error
703 hosts = self.get_hosts()
705 if self.is_installation_host(host):
708 raise configerror.ConfigError('No installation host found')
710 def disable_host(self, host):
711 """ disable the hosts visible via configuration.
712 This can be used in bootstrapping phase.
720 ConfigError in-case if provided host is not valid
722 self._validate_hostname(host)
724 self.config[self.ROOT][host]['disabled'] = True
726 def enable_host(self, host):
727 """ enable the hosts visible via configuration.
728 This can be used in bootstrapping phase.
736 ConfigError in-case if provided host is not valid
738 self._validate_hostname(host)
740 self.config[self.ROOT][host]['disabled'] = False
742 def is_host_enabled(self, host):
743 """ is the host enabled
747 the host to be checked
751 ConfigError in-case if provided host is not valid
753 self._validate_hostname(host)
755 if 'disabled' in self.config[self.ROOT][host]:
756 return not self.config[self.ROOT][host]['disabled']
760 def get_mgmt_mac(self, host):
761 self._validate_hostname(host)
763 if 'mgmt_mac' in self.config[self.ROOT][host]:
764 return self.config[self.ROOT][host]['mgmt_mac']
767 def get_host_network_domain(self, host):
768 self._validate_hostname(host)
769 if 'network_domain' not in self.config[self.ROOT][host]:
770 raise configerror.ConfigError('Missing network domain for host %s' % host)
771 return self.config[self.ROOT][host]['network_domain']
773 def get_controllers_network_domain(self):
774 controllers = self.get_service_profile_hosts('controller')
776 for controller in controllers:
777 domains.add(self.get_host_network_domain(controller))
779 if len(domains) != 1:
780 raise configerror.ConfigError('Controllers in different networking domains not supported')
783 def get_managements_network_domain(self):
784 managements = self.get_service_profile_hosts('management')
786 for management in managements:
787 domains.add(self.get_host_network_domain(management))
788 if len(domains) != 1:
789 raise configerror.ConfigError('Management in different networking domains not supported')
792 def update_service_profiles(self):
793 profs = profiles.Profiles()
794 hosts = self.get_hosts()
797 current_profiles = self.config[self.ROOT][host]['service_profiles']
798 new_profiles = current_profiles
799 for profile in current_profiles:
800 included_profiles = profs.get_included_profiles(profile)
801 new_profiles = utils.add_lists(new_profiles, included_profiles)
802 self.config[self.ROOT][host]['service_profiles'] = new_profiles
804 def get_pre_allocated_ips(self, host, network):
805 ips_field = "pre_allocated_ips"
806 self._validate_hostname(host)
807 if (ips_field not in self.config[self.ROOT][host]
808 or network not in self.config[self.ROOT][host][ips_field]):
810 return self.config[self.ROOT][host][ips_field][network]
812 def allocate_port(self, host, base, name):
814 hosts = self.get_hosts()
816 if name in self.config[self.ROOT][node]:
817 used_ports.append(self.config[self.ROOT][node][name])
821 for port in range(base, base+1000):
822 if port not in used_ports:
827 raise configerror.ConfigError('No free ports available')
829 self.config[self.ROOT][host][name] = free_port
831 def add_vbmc_port(self, host):
832 base_vbmc_port = 61600
834 self._validate_hostname(host)
835 if name not in self.config[self.ROOT][host]:
836 self.allocate_port(host, base_vbmc_port, name)
838 def add_ipmi_terminal_port(self, host):
839 base_console_port = 61401
840 name = 'ipmi_terminal_port'
841 self._validate_hostname(host)
842 if name not in self.config[self.ROOT][host]:
843 self.allocate_port(host, base_console_port, name)
845 def get_ceph_osd_disks(self, host):
846 self._validate_hostname(host)
847 caas_disks = self.config[self.ROOT][host].get('caas_disks', [])
848 osd_disks = filter(lambda disk: disk.get('osd_disk', False), caas_disks)
849 return map(lambda disk: _get_path_for_virtio_id(disk), osd_disks)
851 def get_system_reserved_memory(self, hostname):
852 caasconf = self.confman.get_caas_config_handler()
853 if caasconf.is_vnf_embedded_deployment():
854 return VNF_EMBEDDED_RESERVED_MEMORY
856 profiles = self.get_service_profiles(hostname)
857 if 'controller' in profiles:
858 return DUAL_VIM_CONTROLLER_RESERVED_MEMORY
859 if 'compute' in profiles:
860 return DUAL_VIM_DEFAULT_RESERVED_MEMORY
862 return self.config.get(self.ROOT, {}).get('middleware_reserved_memory',
863 MIDDLEWARE_RESERVED_MEMORY)
865 def set_default_reserved_memory_to_all_hosts(self, def_memory):
866 for host in self.get_hosts():
867 self.config[self.ROOT][host]['middleware_reserved_memory'] = def_memory
869 def set_default_ipmi_priv_level_to_all_hosts(self, def_priv):
870 for host in self.get_hosts():
871 if 'hwmgmt' not in self.config[self.ROOT][host]:
872 self.config[self.ROOT][host]['hwmgmt'] = {'priv_level': def_priv}
873 elif 'priv_level' not in self.config[self.ROOT][host]['hwmgmt']:
874 self.config[self.ROOT][host]['hwmgmt']['priv_level'] = def_priv
877 def _get_path_for_virtio_id(disk):
878 disk_id = disk.get('id', '')
880 return "/dev/disk/by-id/virtio-{}".format(disk_id[:20])