osi-dump 0.1.2.1__tar.gz → 0.1.2.3__tar.gz

{osi_dump-0.1.2.1 → osi_dump-0.1.2.3}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: osi-dump
-Version: 0.1.2.1
-Summary: OpenStack instances information dump tool
+Version: 0.1.2.3
+Summary: OpenStack information dump tool
 Author: TVKain
 License: Apache-2.0
 Classifier: License :: OSI Approved :: Apache Software License
@@ -12,6 +12,7 @@ Requires-Dist: openstacksdk
 Requires-Dist: pydantic
 Requires-Dist: pandas
 Requires-Dist: openpyxl
+Requires-Dist: numpy
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 

{osi_dump-0.1.2.1 → osi_dump-0.1.2.3}/pyproject.toml

@@ -1,13 +1,20 @@
 [project]
 name = "osi-dump"
-version = "0.1.2.1"
-description = "OpenStack instances information dump tool"
+version = "0.1.2.3"
+description = "OpenStack information dump tool"
 readme = "README.md"
 authors = [{ name = "TVKain" }]
 license = { text = "Apache-2.0" }
 requires-python = ">=3.10"
 classifiers = ["License :: OSI Approved :: Apache Software License"]
-dependencies = ["typer", "openstacksdk", "pydantic", "pandas", "openpyxl"]
+dependencies = [
+    "typer",
+    "openstacksdk",
+    "pydantic",
+    "pandas",
+    "openpyxl",
+    "numpy",
+]
 
 
 [project.scripts]

osi_dump-0.1.2.3/src/osi_dump/api/octavia.py

@@ -0,0 +1,34 @@
+from openstack.connection import Connection
+from openstack.identity.v3.service import Service
+from openstack.load_balancer.v2.load_balancer import LoadBalancer
+
+
+def get_load_balancers(connection: Connection) -> list[LoadBalancer]:
+    octavia_endpoint = connection.endpoint_for(
+        service_type="load-balancer", interface="public"
+    )
+
+    url = f"{octavia_endpoint}/v2.0/lbaas/loadbalancers"
+
+    response = connection.session.get(url)
+
+    data = response.json()
+
+    return data["loadbalancers"]
+
+
+def get_amphoraes(connection: Connection, load_balancer_id: str) -> list[dict]:
+
+    octavia_endpoint = connection.endpoint_for(
+        service_type="load-balancer", interface="public"
+    )
+
+    url = f"{octavia_endpoint}/v2/octavia/amphorae?load_balancer_id={load_balancer_id}&fields=status&fields=compute_id"
+
+    response = connection.session.get(url)
+
+    data = response.json()
+
+    amphoraes = data["amphorae"]
+
+    return amphoraes

osi_dump-0.1.2.3/src/osi_dump/batch_handler/external_port_batch_handler.py

@@ -0,0 +1,57 @@
+import logging
+
+from openstack.connection import Connection
+
+from osi_dump.exporter.external_port.external_port_exporter import ExternalPortExporter
+from osi_dump.exporter.external_port.excel_external_port_exporter import (
+    ExcelExternalPortExporter,
+)
+
+from osi_dump.importer.external_port.external_port_importer import ExternalPortImporter
+from osi_dump.importer.external_port.openstack_external_port_importer import (
+    OpenStackExternalPortImporter,
+)
+
+
+from osi_dump import util
+
+logger = logging.getLogger(__name__)
+
+
+class ExternalPortBatchHandler:
+    def __init__(self):
+        self._importer_exporter_list: list[
+            tuple[ExternalPortImporter, ExternalPortExporter]
+        ] = []
+
+    def add_importer_exporter_from_openstack_connections(
+        self, connections: list[Connection], output_file: str
+    ):
+        for connection in connections:
+            importer = OpenStackExternalPortImporter(connection)
+
+            sheet_name = (
+                f"{util.extract_hostname(connection.auth['auth_url'])}-external_port"
+            )
+            exporter = ExcelExternalPortExporter(
+                sheet_name=sheet_name, output_file=output_file
+            )
+
+            self.add_importer_exporter(importer=importer, exporter=exporter)
+
+    def add_importer_exporter(
+        self, importer: ExternalPortImporter, exporter: ExternalPortExporter
+    ):
+        self._importer_exporter_list.append((importer, exporter))
+
+    def process(self):
+
+        for importer, exporter in self._importer_exporter_list:
+            try:
+
+                external_ports = importer.import_external_ports()
+
+                exporter.export_external_ports(external_ports=external_ports)
+            except Exception as e:
+                logger.warning(e)
+                logger.warning("Skipping...")

{osi_dump-0.1.2.1 → osi_dump-0.1.2.3}/src/osi_dump/batch_handler/load_balancer_batch_handler.py

@@ -34,9 +34,7 @@ class LoadBalancerBatchHandler:
         for connection in connections:
             importer = OpenStackLoadBalancerImporter(connection)
 
-            sheet_name = (
-                f"{util.extract_hostname(connection.auth['auth_url'])}-load_balancer"
-            )
+            sheet_name = f"{util.extract_hostname(connection.auth['auth_url'])}-lb"
             exporter = ExcelLoadBalancerExporter(
                 sheet_name=sheet_name, output_file=output_file
             )

{osi_dump-0.1.2.1 → osi_dump-0.1.2.3}/src/osi_dump/batch_handler/role_assignment_batch_handler.py

@@ -35,7 +35,7 @@ class RoleAssignmentBatchHandler:
             importer = OpenStackRoleAssignmentImporter(connection)
 
             sheet_name = (
-                f"{util.extract_hostname(connection.auth['auth_url'])}-role_assignment"
+                f"{util.extract_hostname(connection.auth['auth_url'])}-role_ass"
             )
             exporter = ExcelRoleAssignmentExporter(
                 sheet_name=sheet_name, output_file=output_file

osi_dump-0.1.2.3/src/osi_dump/batch_handler/router_batch_handler.py

@@ -0,0 +1,49 @@
+import logging
+
+from openstack.connection import Connection
+
+from osi_dump.exporter.router.router_exporter import (
+    RouterExporter,
+)
+from osi_dump.exporter.router.excel_router_exporter import ExcelRouterExporter
+
+from osi_dump.importer.router.router_importer import RouterImporter
+from osi_dump.importer.router.openstack_router_importer import (
+    OpenStackRouterImporter,
+)
+
+
+from osi_dump import util
+
+logger = logging.getLogger(__name__)
+
+
+class RouterBatchHandler:
+    def __init__(self):
+        self._importer_exporter_list: list[tuple[RouterImporter, RouterExporter]] = []
+
+    def add_importer_exporter_from_openstack_connections(
+        self, connections: list[Connection], output_file: str
+    ):
+        for connection in connections:
+            importer = OpenStackRouterImporter(connection)
+
+            sheet_name = f"{util.extract_hostname(connection.auth['auth_url'])}-router"
+            exporter = ExcelRouterExporter(
+                sheet_name=sheet_name, output_file=output_file
+            )
+
+            self.add_importer_exporter(importer=importer, exporter=exporter)
+
+    def add_importer_exporter(self, importer: RouterImporter, exporter: RouterExporter):
+        self._importer_exporter_list.append((importer, exporter))
+
+    def process(self):
+        for importer, exporter in self._importer_exporter_list:
+            try:
+                routers = importer.import_routers()
+
+                exporter.export_routers(routers=routers)
+            except Exception as e:
+                logger.warning(e)
+                logger.warning("Skipping...")

{osi_dump-0.1.2.1 → osi_dump-0.1.2.3}/src/osi_dump/cli.py

@@ -8,10 +8,12 @@ import typer
 
 from typing_extensions import Annotated
 
+from osi_dump.batch_handler.external_port_batch_handler import ExternalPortBatchHandler
 from osi_dump.batch_handler.load_balancer_batch_handler import LoadBalancerBatchHandler
 from osi_dump.batch_handler.role_assignment_batch_handler import (
     RoleAssignmentBatchHandler,
 )
+from osi_dump.batch_handler.router_batch_handler import RouterBatchHandler
 
 app = typer.Typer()
 
@@ -30,6 +32,11 @@ from osi_dump.batch_handler import (
 )
 
 
+from osi_dump.importer.external_port.openstack_external_port_importer import (
+    OpenStackExternalPortImporter,
+)
+
+
 from osi_dump import util
 
 
@@ -123,6 +130,26 @@ def _load_balancer(connections, output_path: str):
     _load_balancer_batch_handler.process()
 
 
+def _router(connections, output_path: str):
+    _router_batch_handler = RouterBatchHandler()
+
+    _router_batch_handler.add_importer_exporter_from_openstack_connections(
+        connections, output_file=output_path
+    )
+
+    _router_batch_handler.process()
+
+
+def _external_port(connections, output_path: str):
+    _external_batch_handler = ExternalPortBatchHandler()
+
+    _external_batch_handler.add_importer_exporter_from_openstack_connections(
+        connections, output_file=output_path
+    )
+
+    _external_batch_handler.process()
+
+
 def inner_main(file_path: str, output_path: str):
 
     logger = logging.getLogger(__name__)
@@ -146,6 +173,11 @@ def inner_main(file_path: str, output_path: str):
     _role_assignment(connections=connections, output_path=output_path)
 
     _load_balancer(connections=connections, output_path=output_path)
+
+    _router(connections=connections, output_path=output_path)
+
+    _external_port(connections=connections, output_path=output_path)
+
     util.excel_autosize_column(output_path)
 
     util.excel_sort_sheet(output_path)

osi_dump-0.1.2.3/src/osi_dump/exporter/external_port/excel_external_port_exporter.py

@@ -0,0 +1,34 @@
+import pandas as pd
+
+import logging
+
+from openpyxl import load_workbook
+
+from osi_dump import util
+from osi_dump.exporter.external_port.external_port_exporter import ExternalPortExporter
+
+from osi_dump.model.external_port import ExternalPort
+
+logger = logging.getLogger(__name__)
+
+
+class ExcelExternalPortExporter(ExternalPortExporter):
+    def __init__(self, sheet_name: str, output_file: str):
+        self.sheet_name = sheet_name
+        self.output_file = output_file
+
+    def export_external_ports(self, external_ports: list[ExternalPort]):
+
+        df = pd.DataFrame(
+            [external_port.model_dump() for external_port in external_ports]
+        )
+
+        df = util.panda_excel.expand_list_column(df, "allowed_address_pairs")
+
+        logger.info(f"Exporting external_ports for {self.sheet_name}")
+        try:
+            util.export_data_excel(self.output_file, sheet_name=self.sheet_name, df=df)
+
+            logger.info(f"Exported external_ports for {self.sheet_name}")
+        except Exception as e:
+            logger.warning(f"Exporting external_ports for {self.sheet_name} error: {e}")

osi_dump-0.1.2.3/src/osi_dump/exporter/external_port/external_port_exporter.py

@@ -0,0 +1,7 @@
+from abc import ABC, abstractmethod
+
+
+class ExternalPortExporter(ABC):
+    @abstractmethod
+    def export_external_ports(self, projects, output_file: str):
+        pass

{osi_dump-0.1.2.1 → osi_dump-0.1.2.3}/src/osi_dump/exporter/load_balancer/excel_load_balancer_exporter.py

@@ -24,6 +24,8 @@ class ExcelLoadBalancerExporter(LoadBalancerExporter):
             [load_balancer.model_dump() for load_balancer in load_balancers]
         )
 
+        df = util.expand_list_column(df, "amphoraes")
+
         logger.info(f"Exporting load_balancers for {self.sheet_name}")
         try:
             util.export_data_excel(self.output_file, sheet_name=self.sheet_name, df=df)

osi_dump-0.1.2.3/src/osi_dump/exporter/router/excel_router_exporter.py

@@ -0,0 +1,30 @@
+import pandas as pd
+
+import logging
+
+from openpyxl import load_workbook
+
+from osi_dump import util
+from osi_dump.exporter.router.router_exporter import RouterExporter
+
+from osi_dump.model.router import Router
+
+logger = logging.getLogger(__name__)
+
+
+class ExcelRouterExporter(RouterExporter):
+    def __init__(self, sheet_name: str, output_file: str):
+        self.sheet_name = sheet_name
+        self.output_file = output_file
+
+    def export_routers(self, routers: list[Router]):
+
+        df = pd.DataFrame([router.model_dump() for router in routers])
+
+        logger.info(f"Exporting routers for {self.sheet_name}")
+        try:
+            util.export_data_excel(self.output_file, sheet_name=self.sheet_name, df=df)
+
+            logger.info(f"Exported routers for {self.sheet_name}")
+        except Exception as e:
+            logger.warning(f"Exporting routers for {self.sheet_name} error: {e}")

osi_dump-0.1.2.3/src/osi_dump/exporter/router/router_exporter.py

@@ -0,0 +1,7 @@
+from abc import ABC, abstractmethod
+
+
+class RouterExporter(ABC):
+    @abstractmethod
+    def export_routers(self, routers, output_file: str):
+        pass

osi_dump-0.1.2.3/src/osi_dump/importer/external_port/external_port_importer.py

@@ -0,0 +1,9 @@
+from abc import ABC, abstractmethod
+
+from osi_dump.model.external_port import ExternalPort
+
+
+class ExternalPortImporter(ABC):
+    @abstractmethod
+    def import_external_ports(self) -> list[ExternalPort]:
+        pass

osi_dump-0.1.2.3/src/osi_dump/importer/external_port/openstack_external_port_importer.py

@@ -0,0 +1,129 @@
+import logging
+
+import ipaddress
+
+import concurrent
+
+import numpy as np
+
+from openstack.connection import Connection
+from openstack.network.v2.port import Port as OSPort
+from openstack.network.v2.subnet import Subnet as OSSubnet
+
+from osi_dump.importer.external_port.external_port_importer import ExternalPortImporter
+from osi_dump.model.external_port import ExternalPort
+
+logger = logging.getLogger(__name__)
+
+
+class OpenStackExternalPortImporter(ExternalPortImporter):
+    def __init__(self, connection: Connection):
+        self.connection = connection
+
+    def _get_external_ports(self) -> list[OSPort]:
+
+        self.connection.list_networks()
+        # Get all external networks
+        networks = self.connection.network.networks(
+            is_router_external=True,
+        )
+
+        external_ports = []
+
+        for network in networks:
+            ex_ports = list(self.connection.network.ports(network_id=network.id))
+
+            for ex_port in ex_ports:
+                ex_port["segmentation_id"] = network.provider_segmentation_id
+
+            external_ports.append(ex_ports)
+
+        # Get all port on those networks
+
+        external_ports = list(np.array(external_ports).flatten())
+
+        return external_ports
+
+    def import_external_ports(self) -> list[ExternalPort]:
+        """Import external_ports information from Openstack
+
+
+        Raises:
+            Exception: Raises exception if fetching external_port failed
+
+        Returns:
+            list[Instance]: _description_
+        """
+
+        logger.info(f"Importing external_ports for {self.connection.auth['auth_url']}")
+
+        try:
+            os_ports: list[OSPort] = self._get_external_ports()
+        except Exception as e:
+            raise Exception(
+                f"Can not fetch external_ports for {self.connection.auth['auth_url']}"
+            ) from e
+
+        external_ports: list[ExternalPort] = []
+
+        with concurrent.futures.ThreadPoolExecutor() as executor:
+            futures = [
+                executor.submit(self._get_external_port_info, external_port)
+                for external_port in os_ports
+            ]
+            for future in concurrent.futures.as_completed(futures):
+                external_ports.append(future.result())
+
+        logger.info(f"Imported external_ports for {self.connection.auth['auth_url']}")
+
+        external_ports = sorted(
+            external_ports,
+            key=lambda external_port: (
+                external_port.network_id,
+                (
+                    ipaddress.ip_address(external_port.ip_address)
+                    if external_port.ip_address
+                    else ipaddress.ip_address("0.0.0.0")
+                ),
+            ),
+        )
+
+        return external_ports
+
+    def _get_external_port_info(self, external_port: OSPort) -> ExternalPort:
+
+        subnet_id = None
+        ip_address = None
+        subnet_cidr = None
+
+        try:
+            ip_address = external_port.fixed_ips[0]["ip_address"]
+        except Exception as e:
+            logger.warning(f"No IP address found for port {external_port.id}")
+
+        try:
+            subnet_id = external_port.fixed_ips[0]["subnet_id"]
+        except Exception as e:
+            logger.warning(f"No subnet ID found for {external_port.id}")
+
+        try:
+            subnet: OSSubnet = self.connection.get_subnet_by_id(subnet_id)
+
+            subnet_cidr = subnet.cidr
+        except Exception as e:
+            logger.warning(f"No subnet cidr found for port {external_port.id}")
+
+        external_port_ret = ExternalPort(
+            port_id=external_port.id,
+            project_id=external_port.project_id,
+            network_id=external_port.network_id,
+            subnet_id=subnet_id,
+            subnet_cidr=subnet_cidr,
+            ip_address=ip_address,
+            allowed_address_pairs=external_port.allowed_address_pairs,
+            device_id=external_port.device_id,
+            device_owner=external_port.device_owner,
+            status=external_port.status,
+        )
+
+        return external_port_ret

{osi_dump-0.1.2.1 → osi_dump-0.1.2.3}/src/osi_dump/importer/hypervisor/openstack_hypervisor_importer.py

@@ -30,12 +30,11 @@ class OpenStackHypervisorImporter(HypervisorImporter):
             list[Hypervisor]: _description_
         """
 
-        logger.info(f"Importing hypervisors for {self.connection.auth['auth_url']}")
-
         try:
             oshypervisors: list[OSHypervisor] = list(
-                self.connection.compute.hypervisors(details=True)
+                self.connection.compute.hypervisors(details=True, with_servers=True)
             )
+
         except Exception as e:
             raise Exception(
                 f"Can not fetch hypervisor for {self.connection.auth['auth_url']}"
@@ -65,12 +64,6 @@ class OpenStackHypervisorImporter(HypervisorImporter):
             )
         )
 
-        servers = list(
-            self.connection.compute.servers(
-                details=False, all_project=True, hypervisor=hypervisor.id
-            )
-        )
-
         usage_data = get_usage(self.connection, resource_provider_id=hypervisor.id)
 
         vcpu = rpi[0]
@@ -89,7 +82,7 @@ class OpenStackHypervisorImporter(HypervisorImporter):
             vcpus_usage=usage_data["VCPU"],
             memory_usage=usage_data["MEMORY_MB"],
             local_disk_usage=usage_data["DISK_GB"],
-            vm_count=len(servers),
+            vm_count=len(hypervisor.servers),
         )
 
         return ret_hypervisor

{osi_dump-0.1.2.1 → osi_dump-0.1.2.3}/src/osi_dump/importer/instance/openstack_instance_importer.py

@@ -96,6 +96,7 @@ class OpenStackInstanceImporter(InstanceImporter):
             private_v4_ips=private_v4_ips,
             floating_ip=floating_ip,
             status=server.status,
+            hypervisor=server.hypervisor_hostname,
             ram=server.flavor["ram"],
             vcpus=server.flavor["vcpus"],
             created_at=server.created_at,

{osi_dump-0.1.2.1 → osi_dump-0.1.2.3}/src/osi_dump/importer/load_balancer/openstack_load_balancer_importer.py

@@ -11,6 +11,8 @@ from osi_dump.importer.load_balancer.load_balancer_importer import (
 )
 from osi_dump.model.load_balancer import LoadBalancer
 
+import osi_dump.api.octavia as octavia_api
+
 logger = logging.getLogger(__name__)
 
 
@@ -31,12 +33,12 @@ class OpenStackLoadBalancerImporter(LoadBalancerImporter):
         logger.info(f"Importing load_balancers for {self.connection.auth['auth_url']}")
 
         try:
-            osload_balancers: list[OSLoadBalancer] = list(
-                self.connection.network.load_balancers()
+            osload_balancers: list[OSLoadBalancer] = octavia_api.get_load_balancers(
+                connection=self.connection
             )
         except Exception as e:
             raise Exception(
-                f"Can not fetch load_balancers for {self.connection.auth['auth_url']}"
+                f"Can not fetch load_balancers for {self.connection.auth['auth_url']} {e}"
             ) from e
 
         load_balancers: list[LoadBalancer] = []
@@ -55,11 +57,17 @@ class OpenStackLoadBalancerImporter(LoadBalancerImporter):
 
     def _get_load_balancer_info(self, load_balancer: OSLoadBalancer) -> LoadBalancer:
 
+        amphoraes = octavia_api.get_amphoraes(
+            connection=self.connection, load_balancer_id=load_balancer["id"]
+        )
+
         load_balancer_ret = LoadBalancer(
-            id=load_balancer.id,
-            load_balancer_name=load_balancer.name,
-            status=load_balancer.operating_status,
-            project_id=load_balancer.project_id,
+            id=load_balancer["id"],
+            load_balancer_name=load_balancer["name"],
+            operating_status=load_balancer["operating_status"],
+            project_id=load_balancer["project_id"],
+            provisioning_status=load_balancer["provisioning_status"],
+            amphoraes=amphoraes,
         )
 
         return load_balancer_ret

{osi_dump-0.1.2.1 → osi_dump-0.1.2.3}/src/osi_dump/importer/role_assignment/openstack_role_assignment_importer.py

@@ -58,6 +58,19 @@ class OpenStackRoleAssignmentImporter(RoleAssignmentImporter):
         self, role_assignment: OSRoleAssignment
     ) -> RoleAssignment:
 
+        user_id = None
+        role_id = None
+
+        try:
+            user_id = role_assignment.user["id"]
+        except Exception as e:
+            logger.warning(f"Can not get user id: {e}")
+
+        try:
+            role_id = role_assignment.role["id"]
+        except Exception as e:
+            logger.warning(f"Can not get role id: {e}")
+
         user_name = None
         role_name = None
 
@@ -65,17 +78,21 @@ class OpenStackRoleAssignmentImporter(RoleAssignmentImporter):
             role_name = self.connection.identity.get_role(
                 role_assignment.role["id"]
             ).name
+
+        except Exception as e:
+            logger.warning(f"Can not get role name: {e}")
+
+        try:
             user_name = self.connection.identity.get_user(
                 role_assignment.user["id"]
             ).name
-
         except Exception as e:
-            logger.warning("Can not get role name or user name")
+            logger.warning(f"Can not get user name: {e}")
 
         role_assignment_ret = RoleAssignment(
-            user_id=role_assignment.user["id"],
+            user_id=user_id,
             user_name=user_name,
-            role_id=role_assignment.role["id"],
+            role_id=role_id,
             role_name=role_name,
             scope=role_assignment.scope,
         )