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 API_RESOURCES = {'OS::TripleO::Network::InternalApi': None,
  24                     'OS::TripleO::Network::Ports::InternalApiVipPort': PORTS,
  25                     'OS::TripleO::Controller::Ports::InternalApiPort': PORTS,
  26                     'OS::TripleO::Compute::Ports::InternalApiPort': PORTS}
  27
  28
  29 class NetworkEnvironment:
  30     """
  31     This class creates a Network Environment to be used in TripleO Heat
  32     Templates.
  33
  34     The class builds upon an existing network-environment file and modifies
  35     based on a NetworkSettings object.
  36     """
  37     def __init__(self, net_settings, filename):
  38         with open(filename, 'r') as net_env_fh:
  39             self.netenv_obj = yaml.load(net_env_fh)
  40             if net_settings:
  41                 settings_obj = net_settings.get_network_settings()
  42                 enabled_networks = net_settings.get_enabled_networks()
  43                 self.netenv_obj = \
  44                     self._update_net_environment(settings_obj,
  45                                                  enabled_networks)
  46             else:
  47                 raise NetworkEnvException("Network Settings does not exist")
  48
  49     def _update_net_environment(self, net_settings, enabled_networks):
  50         """
  51         Updates Network Environment according to Network Settings
  52         :param: network settings dictionary
  53         :param: enabled network list
  54         :return:  None
  55         """
  56         param_def = 'parameter_defaults'
  57         reg = 'resource_registry'
  58         for key, prefix in TENANT_RESOURCES.items():
  59             if prefix is None:
  60                 prefix = ''
  61             m = re.split('%s/\w+\.yaml' % prefix, self.netenv_obj[reg][key])
  62             if m is not None:
  63                 tht_dir = m[0]
  64                 break
  65         if not tht_dir:
  66             raise NetworkEnvException('Unable to parse THT Directory')
  67         admin_cidr = net_settings[constants.ADMIN_NETWORK]['cidr']
  68         admin_prefix = str(admin_cidr.prefixlen)
  69         self.netenv_obj[param_def]['ControlPlaneSubnetCidr'] = admin_prefix
  70         self.netenv_obj[param_def]['ControlPlaneDefaultRoute'] = \
  71             net_settings[constants.ADMIN_NETWORK]['provisioner_ip']
  72         public_cidr = net_settings[constants.PUBLIC_NETWORK]['cidr']
  73         self.netenv_obj[param_def]['ExternalNetCidr'] = str(public_cidr)
  74         public_range = net_settings[constants.PUBLIC_NETWORK][
  75                                          'usable_ip_range'].split(',')
  76         self.netenv_obj[param_def]['ExternalAllocationPools'] = \
  77             [{'start':
  78               public_range[0],
  79               'end': public_range[1]
  80               }]
  81         self.netenv_obj[param_def]['ExternalInterfaceDefaultRoute'] = \
  82             net_settings[constants.PUBLIC_NETWORK]['gateway']
  83         self.netenv_obj[param_def]['EC2MetadataIp'] = \
  84             net_settings[constants.ADMIN_NETWORK]['provisioner_ip']
  85
  86         if constants.PRIVATE_NETWORK in enabled_networks:
  87             priv_range = net_settings[constants.PRIVATE_NETWORK][
  88                 'usable_ip_range'].split(',')
  89             self.netenv_obj[param_def]['TenantAllocationPools'] = \
  90                 [{'start':
  91                   priv_range[0],
  92                   'end': priv_range[1]
  93                   }]
  94             priv_cidr = net_settings[constants.PRIVATE_NETWORK]['cidr']
  95             self.netenv_obj[param_def]['TenantNetCidr'] = str(priv_cidr)
  96             postfix = '/tenant.yaml'
  97         else:
  98             postfix = '/noop.yaml'
  99
 100         for key, prefix in TENANT_RESOURCES.items():
 101             if prefix is None:
 102                 prefix = ''
 103             self.netenv_obj[reg][key] = tht_dir + prefix + postfix
 104
 105         if constants.STORAGE_NETWORK in enabled_networks:
 106             storage_range = net_settings[constants.STORAGE_NETWORK][
 107                 'usable_ip_range'].split(',')
 108             self.netenv_obj[param_def]['StorageAllocationPools'] = \
 109                 [{'start':
 110                   storage_range[0],
 111                   'end':
 112                   storage_range[1]
 113                   }]
 114             storage_cidr = net_settings[constants.STORAGE_NETWORK]['cidr']
 115             self.netenv_obj[param_def]['StorageNetCidr'] = str(storage_cidr)
 116             postfix = '/storage.yaml'
 117         else:
 118             postfix = '/noop.yaml'
 119
 120         for key, prefix in STORAGE_RESOURCES.items():
 121             if prefix is None:
 122                 prefix = ''
 123             self.netenv_obj[reg][key] = tht_dir + prefix + postfix
 124
 125         if constants.API_NETWORK in enabled_networks:
 126             api_range = net_settings[constants.API_NETWORK][
 127                 'usable_ip_range'].split(',')
 128             self.netenv_obj[param_def]['InternalApiAllocationPools'] = \
 129                 [{'start':
 130                       api_range[0],
 131                   'end':
 132                       api_range[1]
 133                   }]
 134             api_cidr = net_settings[constants.API_NETWORK]['cidr']
 135             self.netenv_obj[param_def]['InternalApiNetCidr'] = str(api_cidr)
 136             postfix = '/internal_api.yaml'
 137         else:
 138             postfix = '/noop.yaml'
 139
 140         for key, prefix in API_RESOURCES.items():
 141             if prefix is None:
 142                 prefix = ''
 143             self.netenv_obj[reg][key] = tht_dir + prefix + postfix
 144
 145         return self.netenv_obj
 146
 147     def get_netenv_settings(self):
 148         """
 149         Getter for netenv settings
 150         :return: Dictionary of network environment settings
 151         """
 152         return self.netenv_obj
 153
 154
 155 class NetworkEnvException(Exception):
 156     def __init__(self, value):
 157         self.value = value
 158
 159     def __str__(self):
 160             return self.value