lib/python/apex/network_environment.py

   1 ##############################################################################
   2 # Copyright (c) 2016 Tim Rozet (trozet@redhat.com) and others.
   3 #
   4 # All rights reserved. This program and the accompanying materials
   5 # are made available under the terms of the Apache License, Version 2.0
   6 # which accompanies this distribution, and is available at
   7 # http://www.apache.org/licenses/LICENSE-2.0
   8 ##############################################################################
   9
  10 import yaml
  11 import re
  12 from .common import constants
  13
  14 PORTS = '/ports'
  15 # Resources defined by <resource name>: <prefix>
  16 TENANT_RESOURCES = {'OS::TripleO::Network::Tenant': None,
  17                     'OS::TripleO::Controller::Ports::TenantPort': PORTS,
  18                     'OS::TripleO::Compute::Ports::TenantPort': PORTS}
  19 STORAGE_RESOURCES = {'OS::TripleO::Network::Storage': None,
  20                      'OS::TripleO::Network::Ports::StorageVipPort': PORTS,
  21                      'OS::TripleO::Controller::Ports::StoragePort': PORTS,
  22                      'OS::TripleO::Compute::Ports::StoragePort': PORTS}
  23
  24
  25 class NetworkEnvironment:
  26     """
  27     This class creates a Network Environment to be used in TripleO Heat
  28     Templates.
  29
  30     The class builds upon an existing network-environment file and modifies
  31     based on a NetworkSettings object.
  32     """
  33     def __init__(self, net_settings, filename):
  34         with open(filename, 'r') as net_env_fh:
  35             self.netenv_obj = yaml.load(net_env_fh)
  36             if net_settings:
  37                 settings_obj = net_settings.get_network_settings()
  38                 enabled_networks = net_settings.get_enabled_networks()
  39                 self.netenv_obj = \
  40                     self._update_net_environment(settings_obj,
  41                                                  enabled_networks)
  42             else:
  43                 raise NetworkEnvException("Network Settings does not exist")
  44
  45     def _update_net_environment(self, net_settings, enabled_networks):
  46         """
  47         Updates Network Environment according to Network Settings
  48         :param: network settings dictionary
  49         :param: enabled network list
  50         :return:  None
  51         """
  52         param_def = 'parameter_defaults'
  53         reg = 'resource_registry'
  54         for key, prefix in TENANT_RESOURCES.items():
  55             if prefix is None:
  56                 prefix = ''
  57             m = re.split('%s/\w+\.yaml' % prefix, self.netenv_obj[reg][key])
  58             if m is not None:
  59                 tht_dir = m[0]
  60                 break
  61         if not tht_dir:
  62             raise NetworkEnvException('Unable to parse THT Directory')
  63         admin_cidr = net_settings[constants.ADMIN_NETWORK]['cidr']
  64         admin_prefix = str(admin_cidr.prefixlen)
  65         self.netenv_obj[param_def]['ControlPlaneSubnetCidr'] = admin_prefix
  66         self.netenv_obj[param_def]['ControlPlaneDefaultRoute'] = \
  67             net_settings[constants.ADMIN_NETWORK]['provisioner_ip']
  68         public_cidr = net_settings[constants.PUBLIC_NETWORK]['cidr']
  69         self.netenv_obj[param_def]['ExternalNetCidr'] = str(public_cidr)
  70         public_range = net_settings[constants.PUBLIC_NETWORK][
  71                                          'usable_ip_range'].split(',')
  72         self.netenv_obj[param_def]['ExternalAllocationPools'] = \
  73             [{'start':
  74               public_range[0],
  75               'end': public_range[1]
  76               }]
  77         self.netenv_obj[param_def]['ExternalInterfaceDefaultRoute'] = \
  78             net_settings[constants.PUBLIC_NETWORK]['gateway']
  79         self.netenv_obj[param_def]['EC2MetadataIp'] = \
  80             net_settings[constants.ADMIN_NETWORK]['provisioner_ip']
  81
  82         if constants.PRIVATE_NETWORK in enabled_networks:
  83             priv_range = net_settings[constants.PRIVATE_NETWORK][
  84                 'usable_ip_range'].split(',')
  85             self.netenv_obj[param_def]['TenantAllocationPools'] = \
  86                 [{'start':
  87                   priv_range[0],
  88                   'end': priv_range[1]
  89                   }]
  90             priv_cidr = net_settings[constants.PRIVATE_NETWORK]['cidr']
  91             self.netenv_obj[param_def]['TenantNetCidr'] = str(priv_cidr)
  92             postfix = '/tenant.yaml'
  93         else:
  94             postfix = '/noop.yaml'
  95
  96         for key, prefix in TENANT_RESOURCES.items():
  97             if prefix is None:
  98                 prefix = ''
  99             self.netenv_obj[reg][key] = tht_dir + prefix + postfix
 100
 101         if constants.STORAGE_NETWORK in enabled_networks:
 102             storage_range = net_settings[constants.STORAGE_NETWORK][
 103                 'usable_ip_range'].split(',')
 104             self.netenv_obj[param_def]['StorageAllocationPools'] = \
 105                 [{'start':
 106                   storage_range[0],
 107                   'end':
 108                   storage_range[1]
 109                   }]
 110             storage_cidr = net_settings[constants.STORAGE_NETWORK]['cidr']
 111             self.netenv_obj[param_def]['StorageNetCidr'] = str(storage_cidr)
 112             postfix = '/storage.yaml'
 113         else:
 114             postfix = '/noop.yaml'
 115
 116         for key, prefix in STORAGE_RESOURCES.items():
 117             if prefix is None:
 118                 prefix = ''
 119             self.netenv_obj[reg][key] = tht_dir + prefix + postfix
 120         return self.netenv_obj
 121
 122     def get_netenv_settings(self):
 123         """
 124         Getter for netenv settings
 125         :return: Dictionary of network environment settings
 126         """
 127         return self.netenv_obj
 128
 129
 130 class NetworkEnvException(Exception):
 131     def __init__(self, value):
 132         self.value = value
 133
 134     def __str__(self):
 135             return self.value