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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: osi-dump
-Version: 0.1.1
+Version: 0.1.2.1
 Summary: OpenStack instances information dump tool
 Author: TVKain
 License: Apache-2.0

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

@@ -1,6 +1,6 @@
 [project]
 name = "osi-dump"
-version = "0.1.1"
+version = "0.1.2.1"
 description = "OpenStack instances information dump tool"
 readme = "README.md"
 authors = [{ name = "TVKain" }]

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

@@ -0,0 +1,17 @@
+from openstack.connection import Connection
+from openstack.identity.v3.service import Service
+
+
+def get_amphorae(connection: Connection, load_balancer_id: str) -> str | None:
+
+    octavia_endpoint = connection.endpoint_for(
+        service_type="octavia", interface="public"
+    )
+
+    url = f"{octavia_endpoint}/v2/octavia/amphorae"
+
+    response = connection.session.get(url)
+
+    data = response.json()
+
+    return data["usages"]

osi_dump-0.1.2.1/src/osi_dump/api/placement.py

@@ -0,0 +1,17 @@
+from openstack.connection import Connection
+from openstack.identity.v3.service import Service
+
+
+def get_usage(connection: Connection, resource_provider_id: str):
+
+    placement_endpoint = connection.endpoint_for(
+        service_type="placement", interface="public"
+    )
+
+    url = f"{placement_endpoint}/resource_providers/{resource_provider_id}/usages"
+
+    response = connection.session.get(url)
+
+    data = response.json()
+
+    return data["usages"]

osi_dump-0.1.2.1/src/osi_dump/batch_handler/flavor_batch_handler.py

@@ -0,0 +1,51 @@
+import logging
+
+from openstack.connection import Connection
+
+from osi_dump.exporter.flavor.flavor_exporter import FlavorExporter
+from osi_dump.exporter.flavor.excel_flavor_exporter import (
+    ExcelFlavorExporter,
+)
+
+from osi_dump.importer.flavor.flavor_importer import FlavorImporter
+from osi_dump.importer.flavor.openstack_flavor_importer import (
+    OpenStackFlavorImporter,
+)
+
+
+from osi_dump import util
+
+logger = logging.getLogger(__name__)
+
+
+class FlavorBatchHandler:
+    def __init__(self):
+        self._importer_exporter_list: list[tuple[FlavorImporter, FlavorExporter]] = []
+
+    def add_importer_exporter_from_openstack_connections(
+        self, connections: list[Connection], output_file: str
+    ):
+        for connection in connections:
+            importer = OpenStackFlavorImporter(connection)
+
+            sheet_name = f"{util.extract_hostname(connection.auth['auth_url'])}-flavor"
+            exporter = ExcelFlavorExporter(
+                sheet_name=sheet_name, output_file=output_file
+            )
+
+            self.add_importer_exporter(importer=importer, exporter=exporter)
+
+    def add_importer_exporter(self, importer: FlavorImporter, exporter: FlavorExporter):
+        self._importer_exporter_list.append((importer, exporter))
+
+    def process(self):
+
+        for importer, exporter in self._importer_exporter_list:
+            try:
+
+                flavors = importer.import_flavors()
+
+                exporter.export_flavors(flavors=flavors)
+            except Exception as e:
+                logger.warning(e)
+                logger.warning("Skipping...")

osi_dump-0.1.2.1/src/osi_dump/batch_handler/image_batch_handler.py

@@ -0,0 +1,51 @@
+import logging
+
+from openstack.connection import Connection
+
+from osi_dump.exporter.image.image_exporter import ImageExporter
+from osi_dump.exporter.image.excel_image_exporter import (
+    ExcelImageExporter,
+)
+
+from osi_dump.importer.image.image_importer import ImageImporter
+from osi_dump.importer.image.openstack_image_importer import (
+    OpenStackImageImporter,
+)
+
+
+from osi_dump import util
+
+logger = logging.getLogger(__name__)
+
+
+class ImageBatchHandler:
+    def __init__(self):
+        self._importer_exporter_list: list[tuple[ImageImporter, ImageExporter]] = []
+
+    def add_importer_exporter_from_openstack_connections(
+        self, connections: list[Connection], output_file: str
+    ):
+        for connection in connections:
+            importer = OpenStackImageImporter(connection)
+
+            sheet_name = f"{util.extract_hostname(connection.auth['auth_url'])}-image"
+            exporter = ExcelImageExporter(
+                sheet_name=sheet_name, output_file=output_file
+            )
+
+            self.add_importer_exporter(importer=importer, exporter=exporter)
+
+    def add_importer_exporter(self, importer: ImageImporter, exporter: ImageExporter):
+        self._importer_exporter_list.append((importer, exporter))
+
+    def process(self):
+
+        for importer, exporter in self._importer_exporter_list:
+            try:
+
+                images = importer.import_images()
+
+                exporter.export_images(images=images)
+            except Exception as e:
+                logger.warning(e)
+                logger.warning("Skipping...")

osi_dump-0.1.2.1/src/osi_dump/batch_handler/load_balancer_batch_handler.py

@@ -0,0 +1,61 @@
+import logging
+
+from openstack.connection import Connection
+
+from osi_dump.exporter.load_balancer.load_balancer_exporter import (
+    LoadBalancerExporter,
+)
+from osi_dump.exporter.load_balancer.excel_load_balancer_exporter import (
+    ExcelLoadBalancerExporter,
+)
+
+from osi_dump.importer.load_balancer.load_balancer_importer import (
+    LoadBalancerImporter,
+)
+from osi_dump.importer.load_balancer.openstack_load_balancer_importer import (
+    OpenStackLoadBalancerImporter,
+)
+
+
+from osi_dump import util
+
+logger = logging.getLogger(__name__)
+
+
+class LoadBalancerBatchHandler:
+    def __init__(self):
+        self._importer_exporter_list: list[
+            tuple[LoadBalancerImporter, LoadBalancerExporter]
+        ] = []
+
+    def add_importer_exporter_from_openstack_connections(
+        self, connections: list[Connection], output_file: str
+    ):
+        for connection in connections:
+            importer = OpenStackLoadBalancerImporter(connection)
+
+            sheet_name = (
+                f"{util.extract_hostname(connection.auth['auth_url'])}-load_balancer"
+            )
+            exporter = ExcelLoadBalancerExporter(
+                sheet_name=sheet_name, output_file=output_file
+            )
+
+            self.add_importer_exporter(importer=importer, exporter=exporter)
+
+    def add_importer_exporter(
+        self, importer: LoadBalancerImporter, exporter: LoadBalancerExporter
+    ):
+        self._importer_exporter_list.append((importer, exporter))
+
+    def process(self):
+
+        for importer, exporter in self._importer_exporter_list:
+            try:
+
+                load_balancers = importer.import_load_balancers()
+
+                exporter.export_load_balancers(load_balancers=load_balancers)
+            except Exception as e:
+                logger.warning(e)
+                logger.warning("Skipping...")

osi_dump-0.1.2.1/src/osi_dump/batch_handler/role_assignment_batch_handler.py

@@ -0,0 +1,61 @@
+import logging
+
+from openstack.connection import Connection
+
+from osi_dump.exporter.role_assignment.role_assignment_exporter import (
+    RoleAssignmentExporter,
+)
+from osi_dump.exporter.role_assignment.excel_role_assignment_exporter import (
+    ExcelRoleAssignmentExporter,
+)
+
+from osi_dump.importer.role_assignment.role_assignment_importer import (
+    RoleAssignmentImporter,
+)
+from osi_dump.importer.role_assignment.openstack_role_assignment_importer import (
+    OpenStackRoleAssignmentImporter,
+)
+
+
+from osi_dump import util
+
+logger = logging.getLogger(__name__)
+
+
+class RoleAssignmentBatchHandler:
+    def __init__(self):
+        self._importer_exporter_list: list[
+            tuple[RoleAssignmentImporter, RoleAssignmentExporter]
+        ] = []
+
+    def add_importer_exporter_from_openstack_connections(
+        self, connections: list[Connection], output_file: str
+    ):
+        for connection in connections:
+            importer = OpenStackRoleAssignmentImporter(connection)
+
+            sheet_name = (
+                f"{util.extract_hostname(connection.auth['auth_url'])}-role_assignment"
+            )
+            exporter = ExcelRoleAssignmentExporter(
+                sheet_name=sheet_name, output_file=output_file
+            )
+
+            self.add_importer_exporter(importer=importer, exporter=exporter)
+
+    def add_importer_exporter(
+        self, importer: RoleAssignmentImporter, exporter: RoleAssignmentExporter
+    ):
+        self._importer_exporter_list.append((importer, exporter))
+
+    def process(self):
+
+        for importer, exporter in self._importer_exporter_list:
+            try:
+
+                role_assignments = importer.import_role_assignments()
+
+                exporter.export_role_assignments(role_assignments=role_assignments)
+            except Exception as e:
+                logger.warning(e)
+                logger.warning("Skipping...")

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

@@ -8,9 +8,16 @@ import typer
 
 from typing_extensions import Annotated
 
+from osi_dump.batch_handler.load_balancer_batch_handler import LoadBalancerBatchHandler
+from osi_dump.batch_handler.role_assignment_batch_handler import (
+    RoleAssignmentBatchHandler,
+)
+
 app = typer.Typer()
 
 
+from osi_dump.batch_handler.flavor_batch_handler import FlavorBatchHandler
+from osi_dump.batch_handler.image_batch_handler import ImageBatchHandler
 from osi_dump.batch_handler.volume_batch_handler import VolumeBatchHandler
 from osi_dump.os_connection.get_connections import get_connections
 
@@ -76,6 +83,46 @@ def _hypervisor(connections, output_path: str):
     hypervisor_batch_handler.process()
 
 
+def _image(connections, output_path: str):
+    image_batch_handler = ImageBatchHandler()
+
+    image_batch_handler.add_importer_exporter_from_openstack_connections(
+        connections, output_file=output_path
+    )
+
+    image_batch_handler.process()
+
+
+def _flavor(connections, output_path: str):
+    flavor_batch_handler = FlavorBatchHandler()
+
+    flavor_batch_handler.add_importer_exporter_from_openstack_connections(
+        connections, output_file=output_path
+    )
+
+    flavor_batch_handler.process()
+
+
+def _role_assignment(connections, output_path: str):
+    _role_assignment_batch_handler = RoleAssignmentBatchHandler()
+
+    _role_assignment_batch_handler.add_importer_exporter_from_openstack_connections(
+        connections, output_file=output_path
+    )
+
+    _role_assignment_batch_handler.process()
+
+
+def _load_balancer(connections, output_path: str):
+    _load_balancer_batch_handler = LoadBalancerBatchHandler()
+
+    _load_balancer_batch_handler.add_importer_exporter_from_openstack_connections(
+        connections, output_file=output_path
+    )
+
+    _load_balancer_batch_handler.process()
+
+
 def inner_main(file_path: str, output_path: str):
 
     logger = logging.getLogger(__name__)
@@ -92,6 +139,13 @@ def inner_main(file_path: str, output_path: str):
 
     _project(connections=connections, output_path=output_path)
 
+    _image(connections=connections, output_path=output_path)
+
+    _flavor(connections=connections, output_path=output_path)
+
+    _role_assignment(connections=connections, output_path=output_path)
+
+    _load_balancer(connections=connections, output_path=output_path)
     util.excel_autosize_column(output_path)
 
     util.excel_sort_sheet(output_path)
@@ -141,6 +195,9 @@ Path of the output file, will override if file already exists
         level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s"
     )
 
+    # Suppress pool limit warning will investigate later
+    logging.getLogger("urllib3").propagate = False
+
     logger = logging.getLogger(__name__)
 
     if util.validate_dir_path(file_path=output_path) is False:

osi_dump-0.1.2.1/src/osi_dump/exporter/flavor/excel_flavor_exporter.py

@@ -0,0 +1,30 @@
+import logging
+
+
+import pandas as pd
+
+
+from osi_dump.exporter.flavor.flavor_exporter import FlavorExporter
+
+from osi_dump.model.flavor import Flavor
+
+from osi_dump import util
+
+logger = logging.getLogger(__name__)
+
+
+class ExcelFlavorExporter(FlavorExporter):
+    def __init__(self, sheet_name: str, output_file: str):
+        self.sheet_name = sheet_name
+        self.output_file = output_file
+
+    def export_flavors(self, flavors: list[Flavor]):
+        df = pd.json_normalize([flavor.model_dump() for flavor in flavors])
+
+        logger.info(f"Exporting flavors for {self.sheet_name}")
+        try:
+            util.export_data_excel(self.output_file, sheet_name=self.sheet_name, df=df)
+
+            logger.info(f"Exported flavors for {self.sheet_name}")
+        except Exception as e:
+            logger.warning(f"Exporting floating ips for {self.sheet_name} error: {e}")

osi_dump-0.1.2.1/src/osi_dump/exporter/flavor/flavor_exporter.py

@@ -0,0 +1,7 @@
+from abc import ABC, abstractmethod
+
+
+class FlavorExporter(ABC):
+    @abstractmethod
+    def export_flavors(self, flavors, output_file: str):
+        pass

osi_dump-0.1.2.1/src/osi_dump/exporter/image/excel_image_exporter.py

@@ -0,0 +1,28 @@
+import pandas as pd
+
+import logging
+
+
+from osi_dump import util
+from osi_dump.exporter.image.image_exporter import ImageExporter
+
+from osi_dump.model.image import Image
+
+logger = logging.getLogger(__name__)
+
+
+class ExcelImageExporter(ImageExporter):
+    def __init__(self, sheet_name: str, output_file: str):
+        self.sheet_name = sheet_name
+        self.output_file = output_file
+
+    def export_images(self, images: list[Image]):
+        df = pd.json_normalize([image.model_dump() for image in images])
+
+        logger.info(f"Exporting images for {self.sheet_name}")
+        try:
+            util.export_data_excel(self.output_file, sheet_name=self.sheet_name, df=df)
+
+            logger.info(f"Exported images for {self.sheet_name}")
+        except Exception as e:
+            logger.warning(f"Exporting images for {self.sheet_name} error: {e}")

osi_dump-0.1.2.1/src/osi_dump/exporter/image/image_exporter.py

@@ -0,0 +1,7 @@
+from abc import ABC, abstractmethod
+
+
+class ImageExporter(ABC):
+    @abstractmethod
+    def export_images(self, images, output_file: str):
+        pass

osi_dump-0.1.2.1/src/osi_dump/exporter/load_balancer/excel_load_balancer_exporter.py

@@ -0,0 +1,33 @@
+import pandas as pd
+
+import logging
+
+
+from osi_dump import util
+
+from osi_dump.exporter.load_balancer.load_balancer_exporter import (
+    LoadBalancerExporter,
+)
+
+from osi_dump.model.load_balancer import LoadBalancer
+
+logger = logging.getLogger(__name__)
+
+
+class ExcelLoadBalancerExporter(LoadBalancerExporter):
+    def __init__(self, sheet_name: str, output_file: str):
+        self.sheet_name = sheet_name
+        self.output_file = output_file
+
+    def export_load_balancers(self, load_balancers: list[LoadBalancer]):
+        df = pd.json_normalize(
+            [load_balancer.model_dump() for load_balancer in load_balancers]
+        )
+
+        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)
+
+            logger.info(f"Exported load_balancers for {self.sheet_name}")
+        except Exception as e:
+            logger.warning(f"Exporting load_balancers for {self.sheet_name} error: {e}")

osi_dump-0.1.2.1/src/osi_dump/exporter/load_balancer/load_balancer_exporter.py

@@ -0,0 +1,7 @@
+from abc import ABC, abstractmethod
+
+
+class LoadBalancerExporter(ABC):
+    @abstractmethod
+    def export_load_balancers(self, load_balancers, output_file: str):
+        pass

osi_dump-0.1.2.1/src/osi_dump/exporter/role_assignment/excel_role_assignment_exporter.py

@@ -0,0 +1,35 @@
+import pandas as pd
+
+import logging
+
+
+from osi_dump import util
+
+from osi_dump.exporter.role_assignment.role_assignment_exporter import (
+    RoleAssignmentExporter,
+)
+
+from osi_dump.model.role_assignment import RoleAssignment
+
+logger = logging.getLogger(__name__)
+
+
+class ExcelRoleAssignmentExporter(RoleAssignmentExporter):
+    def __init__(self, sheet_name: str, output_file: str):
+        self.sheet_name = sheet_name
+        self.output_file = output_file
+
+    def export_role_assignments(self, role_assignments: list[RoleAssignment]):
+        df = pd.json_normalize(
+            [role_assignment.model_dump() for role_assignment in role_assignments]
+        )
+
+        logger.info(f"Exporting role_assignments for {self.sheet_name}")
+        try:
+            util.export_data_excel(self.output_file, sheet_name=self.sheet_name, df=df)
+
+            logger.info(f"Exported role_assignments for {self.sheet_name}")
+        except Exception as e:
+            logger.warning(
+                f"Exporting role_assignments for {self.sheet_name} error: {e}"
+            )

osi_dump-0.1.2.1/src/osi_dump/exporter/role_assignment/role_assignment_exporter.py

@@ -0,0 +1,7 @@
+from abc import ABC, abstractmethod
+
+
+class RoleAssignmentExporter(ABC):
+    @abstractmethod
+    def export_role_assignments(self, role_assignments, output_file: str):
+        pass

osi_dump-0.1.2.1/src/osi_dump/importer/flavor/flavor_importer.py

@@ -0,0 +1,9 @@
+from abc import ABC, abstractmethod
+
+from osi_dump.model.flavor import Flavor
+
+
+class FlavorImporter(ABC):
+    @abstractmethod
+    def import_flavors(self) -> list[Flavor]:
+        pass

osi_dump-0.1.2.1/src/osi_dump/importer/flavor/openstack_flavor_importer.py

@@ -0,0 +1,64 @@
+import logging
+
+import concurrent
+
+from openstack.connection import Connection
+from openstack.compute.v2.flavor import Flavor as OSFlavor
+
+from osi_dump.importer.flavor.flavor_importer import FlavorImporter
+from osi_dump.model.flavor import Flavor
+
+logger = logging.getLogger(__name__)
+
+
+class OpenStackFlavorImporter(FlavorImporter):
+    def __init__(self, connection: Connection):
+        self.connection = connection
+
+    def import_flavors(self) -> list[Flavor]:
+        """Import flavors information from Openstack
+
+        Raises:
+            Exception: Raises exception if fetching flavor failed
+
+        Returns:
+            list[Instance]: _description_
+        """
+
+        logger.info(f"Importing flavors for {self.connection.auth['auth_url']}")
+
+        try:
+            osflavors: list[OSFlavor] = list(self.connection.list_flavors())
+        except Exception as e:
+            raise Exception(
+                f"Can not fetch flavors for {self.connection.auth['auth_url']}"
+            ) from e
+
+        flavors: list[Flavor] = []
+
+        with concurrent.futures.ThreadPoolExecutor() as executor:
+            futures = [
+                executor.submit(self._get_flavor_info, osflavor)
+                for osflavor in osflavors
+            ]
+            for future in concurrent.futures.as_completed(futures):
+                flavors.append(future.result())
+
+        logger.info(f"Imported flavors for {self.connection.auth['auth_url']}")
+
+        return flavors
+
+    def _get_flavor_info(self, flavor: OSFlavor) -> Flavor:
+
+        ret_flavor = Flavor(
+            flavor_id=flavor.id,
+            flavor_name=flavor.name,
+            ram=flavor.ram,
+            vcpus=flavor.vcpus,
+            disk=flavor.disk,
+            swap=flavor.swap,
+            public=flavor.is_public,
+            properties=flavor.extra_specs,
+        )
+
+        return ret_flavor

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

@@ -11,6 +11,8 @@ from openstack.placement.v1.resource_provider_inventory import ResourceProviderI
 from osi_dump.importer.hypervisor.hypervisor_importer import HypervisorImporter
 from osi_dump.model.hypervisor import Hypervisor
 
+from osi_dump.api.placement import get_usage
+
 logger = logging.getLogger(__name__)
 
 
@@ -31,7 +33,9 @@ class OpenStackHypervisorImporter(HypervisorImporter):
         logger.info(f"Importing hypervisors for {self.connection.auth['auth_url']}")
 
         try:
-            oshypervisors: list[OSHypervisor] = list(self.connection.list_hypervisors())
+            oshypervisors: list[OSHypervisor] = list(
+                self.connection.compute.hypervisors(details=True)
+            )
         except Exception as e:
             raise Exception(
                 f"Can not fetch hypervisor for {self.connection.auth['auth_url']}"
@@ -61,6 +65,14 @@ 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]
         memory = rpi[1]
         disk = rpi[2]
@@ -73,7 +85,11 @@ class OpenStackHypervisorImporter(HypervisorImporter):
             status=hypervisor.status,
             local_disk_size=disk["max_unit"],
             memory_size=memory["max_unit"] + memory["reserved"],
-            vpus=vcpu["max_unit"],
+            vcpus=vcpu["max_unit"],
+            vcpus_usage=usage_data["VCPU"],
+            memory_usage=usage_data["MEMORY_MB"],
+            local_disk_usage=usage_data["DISK_GB"],
+            vm_count=len(servers),
         )
 
         return ret_hypervisor

osi_dump-0.1.2.1/src/osi_dump/importer/image/image_importer.py

@@ -0,0 +1,9 @@
+from abc import ABC, abstractmethod
+
+from osi_dump.model.image import Image
+
+
+class ImageImporter(ABC):
+    @abstractmethod
+    def import_images(self) -> list[Image]:
+        pass