snaps/openstack/utils/settings_utils.py

   1 # Copyright (c) 2017 Cable Television Laboratories, Inc. ("CableLabs")
   2 #                    and others.  All rights reserved.
   3 #
   4 # Licensed under the Apache License, Version 2.0 (the "License");
   5 # you may not use this file except in compliance with the License.
   6 # You may obtain a copy of the License at:
   7 #
   8 #     http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 # Unless required by applicable law or agreed to in writing, software
  11 # distributed under the License is distributed on an "AS IS" BASIS,
  12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15 import uuid
  16
  17 from snaps import file_utils
  18 from snaps.config.flavor import FlavorConfig
  19 from snaps.config.keypair import KeypairConfig
  20 from snaps.config.network import SubnetConfig, PortConfig, NetworkConfig
  21 from snaps.config.router import RouterConfig
  22 from snaps.config.vm_inst import VmInstanceConfig, FloatingIpConfig
  23 from snaps.config.volume import VolumeConfig
  24 from snaps.config.volume_type import (
  25     ControlLocation,  VolumeTypeEncryptionConfig, VolumeTypeConfig)
  26 from snaps.openstack.create_security_group import (
  27     SecurityGroupSettings, SecurityGroupRuleSettings)
  28 from snaps.openstack.utils import (
  29     neutron_utils, nova_utils, heat_utils, glance_utils)
  30
  31
  32 def create_network_config(neutron, network):
  33     """
  34     Returns a NetworkConfig object
  35     :param neutron: the neutron client
  36     :param network: a SNAPS-OO Network domain object
  37     :return:
  38     """
  39     return NetworkConfig(
  40         name=network.name, network_type=network.type,
  41         subnet_settings=create_subnet_config(neutron, network))
  42
  43
  44 def create_security_group_settings(neutron, security_group):
  45     """
  46     Returns a NetworkConfig object
  47     :param neutron: the neutron client
  48     :param security_group: a SNAPS-OO SecurityGroup domain object
  49     :return:
  50     """
  51     rules = neutron_utils.get_rules_by_security_group(neutron, security_group)
  52
  53     rule_settings = list()
  54     for rule in rules:
  55         rule_settings.append(SecurityGroupRuleSettings(
  56             sec_grp_name=security_group.name, description=rule.description,
  57             direction=rule.direction, ethertype=rule.ethertype,
  58             port_range_min=rule.port_range_min,
  59             port_range_max=rule.port_range_max, protocol=rule.protocol,
  60             remote_group_id=rule.remote_group_id,
  61             remote_ip_prefix=rule.remote_ip_prefix))
  62
  63     return SecurityGroupSettings(
  64         name=security_group.name, description=security_group.description,
  65         rule_settings=rule_settings)
  66
  67
  68 def create_subnet_config(neutron, network):
  69     """
  70     Returns a list of SubnetConfig objects for a given network
  71     :param neutron: the OpenStack neutron client
  72     :param network: the SNAPS-OO Network domain object
  73     :return: a list
  74     """
  75     out = list()
  76
  77     subnets = neutron_utils.get_subnets_by_network(neutron, network)
  78     for subnet in subnets:
  79         kwargs = dict()
  80         kwargs['cidr'] = subnet.cidr
  81         kwargs['ip_version'] = subnet.ip_version
  82         kwargs['name'] = subnet.name
  83         kwargs['start'] = subnet.start
  84         kwargs['end'] = subnet.end
  85         kwargs['gateway_ip'] = subnet.gateway_ip
  86         kwargs['enable_dhcp'] = subnet.enable_dhcp
  87         kwargs['dns_nameservers'] = subnet.dns_nameservers
  88         kwargs['host_routes'] = subnet.host_routes
  89         kwargs['ipv6_ra_mode'] = subnet.ipv6_ra_mode
  90         kwargs['ipv6_address_mode'] = subnet.ipv6_address_mode
  91         out.append(SubnetConfig(**kwargs))
  92     return out
  93
  94
  95 def create_router_config(neutron, router):
  96     """
  97     Returns a RouterConfig object
  98     :param neutron: the neutron client
  99     :param router: a SNAPS-OO Router domain object
 100     :return:
 101     """
 102     ext_net_name = None
 103
 104     if router.external_network_id:
 105         network = neutron_utils.get_network_by_id(
 106             neutron, router.external_network_id)
 107         if network:
 108             ext_net_name = network.name
 109
 110     ports_tuple_list = list()
 111     if router.port_subnets:
 112         for port, subnets in router.port_subnets:
 113             network = neutron_utils.get_network_by_id(
 114                 neutron, port.network_id)
 115
 116             ip_addrs = list()
 117             if network and router.external_fixed_ips:
 118                 for ext_fixed_ips in router.external_fixed_ips:
 119                     for subnet in subnets:
 120                         if ext_fixed_ips['subnet_id'] == subnet.id:
 121                             ip_addrs.append(ext_fixed_ips['ip_address'])
 122             else:
 123                 for ip in port.ips:
 124                     ip_addrs.append(ip)
 125
 126             ip_list = list()
 127             if len(ip_addrs) > 0:
 128                 for ip_addr in ip_addrs:
 129                     if isinstance(ip_addr, dict):
 130                         ip_list.append(ip_addr['ip_address'])
 131                     else:
 132                         ip_list.append(ip_addr)
 133
 134             ports_tuple_list.append((network, ip_list))
 135
 136     port_settings = __create_port_config(neutron, ports_tuple_list)
 137
 138     filtered_settings = list()
 139     for port_setting in port_settings:
 140         if port_setting.network_name != ext_net_name:
 141             filtered_settings.append(port_setting)
 142
 143     return RouterConfig(
 144         name=router.name, external_gateway=ext_net_name,
 145         admin_state_up=router.admin_state_up,
 146         port_settings=filtered_settings)
 147
 148
 149 def create_volume_config(volume):
 150     """
 151     Returns a VolumeSettings object
 152     :param volume: a SNAPS-OO Volume object
 153     """
 154
 155     return VolumeConfig(
 156         name=volume.name, description=volume.description,
 157         size=volume.size, type_name=volume.type,
 158         availability_zone=volume.availability_zone,
 159         multi_attach=volume.multi_attach)
 160
 161
 162 def create_volume_type_config(volume_type):
 163     """
 164     Returns a VolumeTypeSettings object
 165     :param volume_type: a SNAPS-OO VolumeType object
 166     """
 167
 168     control = None
 169     if volume_type.encryption:
 170         if (volume_type.encryption.control_location
 171                 == ControlLocation.front_end.value):
 172             control = ControlLocation.front_end
 173         else:
 174             control = ControlLocation.back_end
 175
 176     encrypt_settings = VolumeTypeEncryptionConfig(
 177         name=volume_type.encryption.__class__,
 178         provider_class=volume_type.encryption.provider,
 179         control_location=control,
 180         cipher=volume_type.encryption.cipher,
 181         key_size=volume_type.encryption.key_size)
 182
 183     qos_spec_name = None
 184     if volume_type.qos_spec:
 185         qos_spec_name = volume_type.qos_spec.name
 186
 187     return VolumeTypeConfig(
 188         name=volume_type.name, encryption=encrypt_settings,
 189         qos_spec_name=qos_spec_name, public=volume_type.public)
 190
 191
 192 def create_flavor_config(flavor):
 193     """
 194     Returns a VolumeSettings object
 195     :param flavor: a SNAPS-OO Volume object
 196     """
 197     return FlavorConfig(
 198         name=flavor.name, flavor_id=flavor.id, ram=flavor.ram,
 199         disk=flavor.disk, vcpus=flavor.vcpus, ephemeral=flavor.ephemeral,
 200         swap=flavor.swap, rxtx_factor=flavor.rxtx_factor,
 201         is_public=flavor.is_public)
 202
 203
 204 def create_keypair_config(heat_cli, stack, keypair, pk_output_key):
 205     """
 206     Instantiates a KeypairConfig object from a Keypair domain objects
 207     :param heat_cli: the heat client
 208     :param stack: the Stack domain object
 209     :param keypair: the Keypair SNAPS domain object
 210     :param pk_output_key: the key to the heat template's outputs for retrieval
 211                           of the private key file
 212     :return: a KeypairConfig object
 213     """
 214     if pk_output_key:
 215         outputs = heat_utils.get_outputs(heat_cli, stack)
 216         for output in outputs:
 217             if output.key == pk_output_key:
 218                 # Save to file
 219                 guid = uuid.uuid4()
 220                 key_file = file_utils.save_string_to_file(
 221                     output.value, str(guid), 0o400)
 222
 223                 # Use outputs, file and resources for the KeypairConfig
 224                 return KeypairConfig(
 225                     name=keypair.name, private_filepath=key_file.name)
 226
 227     return KeypairConfig(name=keypair.name)
 228
 229
 230 def create_vm_inst_config(nova, neutron, server):
 231     """
 232     Returns a NetworkConfig object
 233     :param nova: the nova client
 234     :param neutron: the neutron client
 235     :param server: a SNAPS-OO VmInst domain object
 236     :return:
 237     """
 238
 239     flavor_name = nova_utils.get_flavor_by_id(nova, server.flavor_id)
 240
 241     kwargs = dict()
 242     kwargs['name'] = server.name
 243     kwargs['flavor'] = flavor_name
 244
 245     net_tuples = list()
 246     for net_name, ips in server.networks.items():
 247         network = neutron_utils.get_network(neutron, network_name=net_name)
 248         if network:
 249             net_tuples.append((network, ips))
 250
 251     kwargs['port_settings'] = __create_port_config(
 252         neutron, net_tuples)
 253     kwargs['security_group_names'] = server.sec_grp_names
 254     kwargs['floating_ip_settings'] = __create_floatingip_config(
 255         neutron, kwargs['port_settings'])
 256
 257     return VmInstanceConfig(**kwargs)
 258
 259
 260 def __create_port_config(neutron, networks):
 261     """
 262     Returns a list of port settings based on the networks parameter
 263     :param neutron: the neutron client
 264     :param networks: a list of tuples where #1 is the SNAPS Network domain
 265                      object and #2 is a list of IP addresses
 266     :return:
 267     """
 268     out = list()
 269
 270     for network, ips in networks:
 271         ports = neutron_utils.get_ports(neutron, network, ips)
 272         for port in ports:
 273             if port.device_owner != 'network:dhcp':
 274                 ip_addrs = list()
 275                 for ip_dict in port.ips:
 276                     subnet = neutron_utils.get_subnet_by_id(
 277                         neutron, ip_dict['subnet_id'])
 278                     ip_addrs.append({'subnet_name': subnet.name,
 279                                      'ip': ip_dict['ip_address']})
 280
 281                 kwargs = dict()
 282                 if port.name:
 283                     kwargs['name'] = port.name
 284                 kwargs['network_name'] = network.name
 285                 kwargs['mac_address'] = port.mac_address
 286                 kwargs['allowed_address_pairs'] = port.allowed_address_pairs
 287                 kwargs['admin_state_up'] = port.admin_state_up
 288                 kwargs['ip_addrs'] = ip_addrs
 289                 out.append(PortConfig(**kwargs))
 290
 291     return out
 292
 293
 294 def __create_floatingip_config(neutron, port_settings):
 295     """
 296     Returns a list of FloatingIpConfig objects as they pertain to an
 297     existing deployed server instance
 298     :param neutron: the neutron client
 299     :param port_settings: list of SNAPS-OO PortConfig objects
 300     :return: a list of FloatingIpConfig objects or an empty list if no
 301              floating IPs have been created
 302     """
 303     base_fip_name = 'fip-'
 304     fip_ctr = 1
 305     out = list()
 306
 307     fip_ports = list()
 308     for port_setting in port_settings:
 309         setting_port = neutron_utils.get_port(neutron, port_setting)
 310         if setting_port:
 311             network = neutron_utils.get_network(
 312                 neutron, network_name=port_setting.network_name)
 313             network_ports = neutron_utils.get_ports(neutron, network)
 314             if network_ports:
 315                 for setting_port in network_ports:
 316                     if port_setting.mac_address == setting_port.mac_address:
 317                         fip_ports.append((port_setting.name, setting_port))
 318                         break
 319
 320     floating_ips = neutron_utils.get_floating_ips(neutron, fip_ports)
 321
 322     for port_id, floating_ip in floating_ips:
 323         router = neutron_utils.get_router_by_id(neutron, floating_ip.router_id)
 324         setting_port = neutron_utils.get_port_by_id(
 325             neutron, floating_ip.port_id)
 326         kwargs = dict()
 327         kwargs['name'] = base_fip_name + str(fip_ctr)
 328         kwargs['port_name'] = setting_port.name
 329         kwargs['port_id'] = setting_port.id
 330         kwargs['router_name'] = router.name
 331
 332         if setting_port:
 333             for ip_dict in setting_port.ips:
 334                 if ('ip_address' in ip_dict and
 335                         'subnet_id' in ip_dict and
 336                         ip_dict['ip_address'] == floating_ip.fixed_ip_address):
 337                     subnet = neutron_utils.get_subnet_by_id(
 338                         neutron, ip_dict['subnet_id'])
 339                     if subnet:
 340                         kwargs['subnet_name'] = subnet.name
 341
 342         out.append(FloatingIpConfig(**kwargs))
 343
 344         fip_ctr += 1
 345
 346     return out
 347
 348
 349 def determine_image_config(glance, server, image_settings):
 350     """
 351     Returns a ImageConfig object from the list that matches the name in one
 352     of the image_settings parameter
 353     :param glance: the glance client
 354     :param server: a SNAPS-OO VmInst domain object
 355     :param image_settings: list of ImageConfig objects
 356     :return: ImageConfig or None
 357     """
 358     if image_settings:
 359         for image_setting in image_settings:
 360             image = glance_utils.get_image_by_id(glance, server.image_id)
 361             if image and image.name == image_setting.name:
 362                 return image_setting
 363
 364
 365 def determine_keypair_config(heat_cli, stack, server, keypair_settings=None,
 366                              priv_key_key=None):
 367     """
 368     Returns a KeypairConfig object from the list that matches the
 369     server.keypair_name value in the keypair_settings parameter if not None,
 370     else if the output_key is not None, the output's value when contains the
 371     string 'BEGIN RSA PRIVATE KEY', this value will be stored into a file and
 372     encoded into the KeypairConfig object returned
 373     :param heat_cli: the OpenStack heat client
 374     :param stack: a SNAPS-OO Stack domain object
 375     :param server: a SNAPS-OO VmInst domain object
 376     :param keypair_settings: list of KeypairConfig objects
 377     :param priv_key_key: the stack options that holds the private key value
 378     :return: KeypairConfig or None
 379     """
 380     # Existing keypair being used by Heat Template
 381     if keypair_settings:
 382         for keypair_setting in keypair_settings:
 383             if server.keypair_name == keypair_setting.name:
 384                 return keypair_setting
 385
 386     # Keypair created by Heat template
 387     if priv_key_key:
 388         outputs = heat_utils.get_outputs(heat_cli, stack)
 389         for output in outputs:
 390             if output.key == priv_key_key:
 391                 # Save to file
 392                 guid = uuid.uuid4()
 393                 key_file = file_utils.save_string_to_file(
 394                     output.value, str(guid), 0o400)
 395
 396                 # Use outputs, file and resources for the KeypairConfig
 397                 return KeypairConfig(
 398                     name=server.keypair_name, private_filepath=key_file.name)