decommission "data centers" in favor of "regions"

Author: qrkourier

netfoundry/ctl.py

@@ -523,17 +523,17 @@ def get(cli, echo: bool = True, spinner: object = None):
             else:
                 cli.log.error("need --network=ACMENet")
                 sysexit(1)
-            if cli.args.resource_type == "data-center":
+            if cli.args.resource_type == "region":
                 if 'id' in query_keys:
-                    cli.log.warn("data centers fetched by ID may not support this network's product version, try provider or locationCode params for safety")
+                    cli.log.warn("regions fetched by ID may not support this network's product version, try provider or locationCode params for safety")
                     if len(query_keys) > 1:
                         query_keys.remove('id')
                         cli.log.warn(f"using 'id' only, ignoring params: '{', '.join(query_keys)}'")
-                    match = network.get_data_center_by_id(id=cli.args.query['id'])
+                    match = network.get_region_by_id(id=cli.args.query['id'])
                 else:
-                    matches = network.find_edge_router_data_centers(**cli.args.query)
+                    matches = networks.find_regions(**cli.args.query)
                     if len(matches) == 1:
-                        match = network.get_data_center_by_id(id=matches[0]['id'])
+                        match = network.get_region_by_id(id=matches[0]['id'])
             else:
                 if 'id' in query_keys:
                     if len(query_keys) > 1:
@@ -618,7 +618,7 @@ def list(cli, echo: bool = True, spinner: object = None):
         cli.log.debug("got spinner as function param")
     if RESOURCE_ABBREV.get(cli.args.resource_type):
         cli.args.resource_type = RESOURCE_ABBREV[cli.args.resource_type].name
-    if cli.args.accept and not MUTABLE_NET_RESOURCES.get(cli.args.resource_type):  # mutable excludes data-centers
+    if cli.args.accept and not MUTABLE_NET_RESOURCES.get(cli.args.resource_type):
         cli.log.warn("the --as=ACCEPT param is not applicable to resources outside the network domain")
     if cli.args.query and cli.args.query.get('id'):
         cli.log.warn("try 'get' command to get by id")
@@ -676,10 +676,7 @@ def list(cli, echo: bool = True, spinner: object = None):
             else:
                 cli.log.error("first configure a network: '--network=ACMENet'")
                 sysexit(1)
-            if cli.args.resource_type == "data-centers":
-                matches = network.find_edge_router_data_centers(**cli.args.query)
-            else:
-                matches = network.find_resources(type=cli.args.resource_type, accept=cli.args.accept, params=cli.args.query)
+            matches = network.find_resources(type=cli.args.resource_type, accept=cli.args.accept, params=cli.args.query)
 
     if len(matches) == 0:
         spinner.fail(f"Found no {cli.args.resource_type} by '{', '.join(query_keys)}'")
@@ -978,8 +975,8 @@ def demo(cli):
     # a list of locations to place a hosted router
     fabric_placements = []
     for region in cli.config.demo.regions:
-        dc_matches = network.find_edge_router_data_centers(provider=cli.config.demo.provider, location_code=region)
-        if not len(dc_matches) == 1:
+        region_matches = networks.find_regions(provider=cli.config.demo.provider, location_code=region)
+        if not len(region_matches) == 1:
             raise RuntimeError(f"invalid region '{region}'")
         else:
             existing_count = len([er for er in hosted_edge_routers if er['provider'] == cli.config.demo.provider and er['region'] == region])

netfoundry/network.py

@@ -265,59 +265,25 @@ def validate_entity_roles(self, entities: list, type: str):
 
         return(valid_entities)
 
-    def get_data_center_by_id(self, id: str):
-        """Get data centers by UUIDv4.
+    def get_region_by_id(self, id: str):
+        """Get data center region by UUIDv4.
 
         :param id:        required UUIDv4 of data center
         """
-        url = self.audience+'core/v2/data-centers/'+id
-        headers = {"authorization": "Bearer " + self.token}
-        try:
-            data_center, status_symbol = get_generic_resource_by_url(url=url, headers=headers, proxies=self.proxies, verify=self.verify)
-        except Exception as e:
-            raise RuntimeError(f"failed to get data_center from url: '{url}', caught {e}")
-        else:
-            return(data_center)
+        url = self.audience+'core/v2/regions/'+id
+        data_center, status_symbol = get_generic_resource_by_url(setup=self, url=url)
+        return(data_center)
+    get_data_center_by_id = get_region_by_id
 
     @docstring_parameters(providers=str(DC_PROVIDERS))
-    def find_edge_router_data_centers(self, provider: str = None, location_code: str = None, **kwargs):
-        """Find data centers for hosting edge routers.
+    def find_regions(self, **kwargs):
+        """Find regions for hosted router placement.
 
-        :param provider:        optionally filter by data center provider, choices: {providers}
-        :param location_code:   provider-specific string identifying the data center location e.g. us-west-1
+        :param provider:        optionally filter by data-center region provider, choices: {providers}
         """
-        params = dict()
-        for param in kwargs.keys():
-            if param == 'region':
-                location_code = kwargs[param]
-            else:
-                params[param] = kwargs[param]
-        if not params.get('productVersion'):
-            params["productVersion"] = self.product_version
-        if not params.get('hostType'):
-            params["hostType"] = "ER"
-
-        if location_code:
-            params["locationCode"] = location_code
-        elif params.get('locationCode'):
-            location_code = params['locationCode']  # query param not yet implemented in API so store it in function to filter the list in response
-        elif params.get('region'):
-            location_code = params['region']        # alternatively, get the location_code from a 'region' query param
-        if provider is not None:
-            if provider in DC_PROVIDERS:
-                params['provider'] = provider
-            else:
-                raise RuntimeError(f"unknown cloud provider '{provider}'. Need one of {str(DC_PROVIDERS)}")
-
-        url = self.audience+'core/v2/data-centers'
-        data_centers = list()
-        for i in find_generic_resources(setup=self, url=url, embedded=NET_RESOURCES['data-centers']._embedded, **params):
-            data_centers.extend(i)
-        if location_code:
-            return [dc for dc in data_centers if dc['locationCode'] == location_code]
-        else:
-            return data_centers
-    get_edge_router_data_centers = find_edge_router_data_centers
+        return self.Networks.find_regions(**kwargs)
+    get_edge_router_data_centers = find_regions
+    find_edge_router_data_centers = find_regions
 
     def share_endpoint(self, recipient, endpoint_id):
         """
@@ -1687,12 +1653,11 @@ def find_regions(self, **kwargs):
         for param in kwargs.keys():
             params[param] = kwargs[param]
 
+        if params.get('provider') and not params['provider'] in DC_PROVIDERS:
+                raise RuntimeError(f"unknown cloud provider '{params['provider']}'. Need one of {str(DC_PROVIDERS)}")
+
         url = self.audience+NET_RESOURCES['regions'].find_url
-        try:
-            regions = list()
-            for i in find_generic_resources(setup=self, url=url, embedded=NET_RESOURCES['data-centers']._embedded, **params):
-                regions.extend(i)
-        except Exception as e:
-            raise RuntimeError(f"failed to get data-centers from url: '{url}', caught {e}")
-        else:
-            return(regions)
+        regions = list()
+        for i in find_generic_resources(setup=self, url=url, embedded=NET_RESOURCES['regions']._embedded, **params):
+            regions.extend(i)
+        return(regions)

netfoundry/network_group.py

@@ -13,7 +13,6 @@ class NetworkGroup:
     def __init__(self, Organization: object, network_group_id: str = None, network_group_name: str = None, group: str = None):
         """Initialize the network group class with a group name or ID."""
         self.logger = Organization.logger
-        self.Networks = Networks(Organization)
         self.network_groups = Organization.find_network_groups_by_organization()
         if (not network_group_id and not network_group_name) and group:
             self.logger.debug(f"got 'group' = '{group}' which could be a short name or id")
@@ -70,13 +69,14 @@ def __init__(self, Organization: object, network_group_id: str = None, network_g
         for net in Organization.get_networks_by_group(network_group_id=self.network_group_id):
             self.network_ids_by_normal_name[normalize_caseless(net['name'])] = net['id']
 
-    def nc_data_centers_by_location(self):
-        """Get a controller data center by locationCode."""
-        my_nc_data_centers_by_location = dict()
-        for dc in self.get_controller_data_centers():
-            my_nc_data_centers_by_location[dc['locationCode']] = dc['id']
+    def map_region_id_by_location_code(self):
+        """Map all region ids by their location code e.g. us-west-1: id."""
+        region_map = dict()
+        for region in Networks.find_regions(provider='OCP') + Networks.find_regions(provider='AWS'):
+            region_map[region['locationCode']] = region['id']
             # e.g. { us-east-1: 02f0eb51-fb7a-4d2e-8463-32bd9f6fa4d7 }
-        return(my_nc_data_centers_by_location)
+        return(region_map)
+    nc_data_centers_by_location = map_region_id_by_location_code
 
     # resolve network UUIDs by name
     def network_id_by_normal_name(self, name):
@@ -101,26 +101,10 @@ def network_exists(self, name: str, deleted: bool = False):
         else:
             return(False)
 
-    def nc_data_centers(self, **kwargs):
-        """Find network controller data centers."""
-        # data centers returns a list of dicts (data center objects)
-        params = dict()
-        for param in kwargs.keys():
-            params[param] = kwargs[param]
-        params["productVersion"] = self.find_latest_network_version(is_active=True)
-        params["hostType"] = "NC"
-        params["provider"] = "AWS"
-
-        url = self.audience+'core/v2/data-centers'
-        headers = {"authorization": "Bearer " + self.token}
-        try:
-            data_centers = list()
-            for i in find_generic_resources(setup=self, url=url, embedded=NET_RESOURCES['data-centers']._embedded, **params):
-                data_centers.extend(i)
-        except Exception as e:
-            raise RuntimeError(f"failed to get data-centers from url: '{url}', caught {e}")
-        else:
-            return(data_centers)
+    def find_regions(self, **kwargs):
+        """Find network controller data center regions."""
+        return(Networks.find_regions(**kwargs))
+    nc_data_centers = find_regions
 
     # provide a compatible alias
     get_controller_data_centers = nc_data_centers
@@ -133,19 +117,15 @@ def get_product_metadata(self, is_active: bool = True):
         :param product_version: semver string of a single version to get, default is all versions
         """
         url = self.audience+'product-metadata/v2/download-urls.json'
-        try:
-            all_product_metadata, status_symbol = get_generic_resource_by_url(setup=self, url=url)
-        except Exception as e:
-            raise RuntimeError(f"failed to get product-metadata from url: '{url}', caught {e}")
+        all_product_metadata, status_symbol = get_generic_resource_by_url(setup=self, url=url)
+        if is_active:
+            filtered_product_metadata = dict()
+            for product in all_product_metadata.keys():
+                if all_product_metadata[product]['active']:
+                    filtered_product_metadata[product] = all_product_metadata[product]
+            return (filtered_product_metadata)
         else:
-            if is_active:
-                filtered_product_metadata = dict()
-                for product in all_product_metadata.keys():
-                    if all_product_metadata[product]['active']:
-                        filtered_product_metadata[product] = all_product_metadata[product]
-                return (filtered_product_metadata)
-            else:
-                return (all_product_metadata)
+            return (all_product_metadata)
 
     def find_network_versions(self, is_active: bool = True):
         """Find active network versions."""

netfoundry/utility.py

@@ -687,13 +687,6 @@ def __post_init__(self):
         status_symbols=PROCESS_STATUS_SYMBOLS,
         abbreviation='ex',
     ),
-    # 'processes': ResourceType(  # not a fully-fledged resource type because there is no "find processes" operation at this time
-    #     name='processes',
-    #     domain='network',
-    #     mutable=False,
-    #     embeddable=False,
-    #     status_symbols=PROCESS_STATUS_SYMBOLS,
-    # ),
     'regions': ResourceType(
         name='regions',
         domain='network',
@@ -708,13 +701,6 @@ def __post_init__(self):
         embeddable=False,
         _embedded='network-versions',
     ),
-    'data-centers': ResourceType(
-        name='data-centers',
-        domain='network',
-        _embedded='dataCenters',
-        mutable=False,
-        embeddable=False,
-    ),
     'organizations': ResourceType(
         name='organizations',
         domain='identity',
@@ -729,13 +715,6 @@ def __post_init__(self):
         embeddable=False,
         find_url='rest/v1/network-groups',
     ),
-    # 'download-urls': ResourceType(
-    #     name='download-urls',
-    #     domain='network-group',
-    #     mutable=False,
-    #     embeddable=False,
-    #     find_url='product-metadata/v2',
-    # ),
     'networks': ResourceType(
         name='networks',
         domain='network',