nutanix-shim-server 0.0.1__tar.gz

nutanix_shim_server-0.0.1/.gitignore

@@ -0,0 +1,177 @@
+# Env files
+**/*.env.*
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# vscode settings
+.vscode
+
+# local mlflow tracking
+mlruns/
+mlartifacts/
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+NORCE_CAChain.crt
+
+# argus files
+.argus

nutanix_shim_server-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,12 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.8
+    hooks:
+      - id: ruff
+        name: lint
+        args: [ --fix ]
+      - id: ruff-format
+        name: format
+      - id: ruff
+        name: sort imports
+        args: [ --select, I, --fix]

nutanix_shim_server-0.0.1/.python-version

@@ -0,0 +1 @@
+3.12

nutanix_shim_server-0.0.1/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 NORCE Research
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

nutanix_shim_server-0.0.1/PKG-INFO

@@ -0,0 +1,12 @@
+Metadata-Version: 2.4
+Name: nutanix-shim-server
+Version: 0.0.1
+Summary: Server for the Foreman Nutanix shim plugin
+Author-email: Miles Granger <mgra@norceresearch.no>
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: fastapi[standard]>=0.118.0
+Requires-Dist: ntnx-clustermgmt-py-client~=4.0.0
+Requires-Dist: ntnx-networking-py-client~=4.0.0
+Requires-Dist: ntnx-prism-py-client~=4.0.0
+Requires-Dist: ntnx-vmm-py-client~=4.0.0

nutanix_shim_server-0.0.1/pyproject.toml

@@ -0,0 +1,36 @@
+[project]
+name = "nutanix-shim-server"
+version = "0.0.1"
+description = "Server for the Foreman Nutanix shim plugin"
+readme = "README.md"
+authors = [
+    { name = "Miles Granger", email = "mgra@norceresearch.no" }
+]
+requires-python = ">=3.12"
+dependencies = [
+    "fastapi[standard]>=0.118.0",
+    "ntnx-clustermgmt-py-client~=4.0.0",
+    "ntnx-networking-py-client~=4.0.0",
+    "ntnx-prism-py-client~=4.0.0",
+    "ntnx-vmm-py-client~=4.0.0",
+]
+
+[project.scripts]
+nutanix-shim-server = "nutanix_shim_server:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[dependency-groups]
+dev = [
+    "ipython>=8.34.0",
+    "pre-commit>=4.1.0",
+    "pyright>=1.1.396",
+    "pytest-mock>=3.14.0",
+    "pytest>=8.3.5",
+    "ruff>=0.13.2",
+]
+
+[tool.pytest.init_options]
+addopts = "-v"

nutanix_shim_server-0.0.1/src/nutanix_shim_server/__init__.py

@@ -0,0 +1,15 @@
+import sys
+
+from fastapi_cli.cli import main as fastapi_main
+
+
+def main() -> None:
+    """Entry point that wraps fastapi-cli with the app path pre-configured."""
+    # Insert 'run' command and app path, then append any user-provided args
+    sys.argv = [
+        "fastapi",
+        "run",
+        "nutanix_shim_server.server:app",
+        *sys.argv[1:],
+    ]
+    fastapi_main()

nutanix_shim_server-0.0.1/src/nutanix_shim_server/clustermgmt.py

@@ -0,0 +1,283 @@
+from __future__ import annotations
+
+import os
+import dataclasses
+from typing import Self, cast
+import ntnx_clustermgmt_py_client as cm
+
+try:
+    from IPython.terminal.embed import embed
+except ImportError:
+
+    def embed():
+        pass
+
+
+class ClusterMgmt:
+    config: cm.Configuration
+
+    def __init__(self):
+        self.config = cm.Configuration()
+        self.config.host = os.environ["NUTANIX_HOST"]
+        self.config.scheme = "https"
+        self.config.set_api_key(os.environ["NUTANIX_API_KEY"])
+        self.config.max_retry_attempts = 3
+        self.config.backoff_factor = 3
+        self.config.verify_ssl = False  # TODO: True
+        self.config.port = os.environ.get("NUTANIX_PORT", 9440)
+
+    @property
+    def client(self) -> cm.ApiClient:
+        if not hasattr(self, "_client"):
+            self._client = cm.ApiClient(self.config)
+            self._client.add_default_header(
+                header_name="Accept-Encoding", header_value="gzip, deflate, br"
+            )
+        return self._client
+
+    @property
+    def storage_containers_api(self) -> cm.StorageContainersApi:
+        if not hasattr(self, "_storage_containers_api"):
+            self._storage_containers_api = cm.StorageContainersApi(
+                api_client=self.client
+            )
+        return self._storage_containers_api
+
+    def list_storage_containers(self) -> list[StorageContainerMetadata]:
+        """Return list of storage containers"""
+        resp: cm.ListStorageContainersApiResponse = self.storage_containers_api.list_storage_containers()
+        containers: None | list[cm.StorageContainer] = resp.data
+        if containers:
+            return [
+                StorageContainerMetadata.from_nutanix_storage_container(container)
+                for container in containers
+            ]
+        return []
+
+    @property
+    def clusters_api(self) -> cm.ClustersApi:
+        if not hasattr(self, "_clusters_api"):
+            self._clusters_api = cm.ClustersApi(api_client=self.client)
+        return self._clusters_api
+
+    def list_clusters(self) -> list[ClusterMetadata]:
+        """Return list of clusters"""
+        resp: cm.ListClustersApiResponse = self.clusters_api.list_clusters()
+        clusters: None | list[cm.Cluster] = resp.data
+        if clusters:
+            return [
+                ClusterMetadata.from_nutanix_cluster(cluster) for cluster in clusters
+            ]
+        return []
+
+    def get_cluster_stats(self, cluster_ext_id: str) -> ClusterResourceStats:
+        """Get resource usage statistics for a specific cluster
+
+        Gets CPU/memory capacity by aggregating from cluster hosts, and usage
+        stats from the cluster stats API.
+        """
+        import datetime
+
+        # Get cluster stats for usage metrics
+        end_time = datetime.datetime.now(datetime.timezone.utc)
+        start_time = end_time - datetime.timedelta(hours=1)
+
+        stats_resp: cm.ClusterStatsApiResponse = self.clusters_api.get_cluster_stats(
+            extId=cluster_ext_id,
+            _startTime=start_time,
+            _endTime=end_time,
+        )
+        stats: cm.ClusterStats = stats_resp.data  # type: ignore
+
+        # Get hosts to aggregate CPU and memory capacity
+        hosts_resp = self.clusters_api.list_hosts_by_cluster_id(clusterExtId=cluster_ext_id)
+        hosts: None | list[cm.Host] = hosts_resp.data  # type: ignore
+
+        # Aggregate capacity from all hosts in the cluster
+        total_cpu_capacity_hz = 0
+        total_memory_capacity_bytes = 0
+        total_cpu_cores = 0
+
+        if hosts:
+            for host in hosts:
+                # Try cpu_capacity_hz first, fall back to calculating from frequency and cores
+                if host.cpu_capacity_hz:
+                    total_cpu_capacity_hz += host.cpu_capacity_hz
+                elif host.cpu_frequency_hz and host.number_of_cpu_cores:
+                    # Calculate capacity: frequency * number of cores
+                    total_cpu_capacity_hz += host.cpu_frequency_hz * host.number_of_cpu_cores
+
+                if host.memory_size_bytes:
+                    total_memory_capacity_bytes += host.memory_size_bytes
+
+                if host.number_of_cpu_cores:
+                    total_cpu_cores += host.number_of_cpu_cores
+
+        return ClusterResourceStats.from_nutanix_cluster_stats(
+            stats, total_cpu_capacity_hz, total_memory_capacity_bytes, total_cpu_cores
+        )
+
+
+@dataclasses.dataclass(frozen=True)
+class ClusterMetadata:
+    name: str
+    ext_id: str
+    n_nodes: int
+    arch: str
+    vm_count: int
+    is_available: bool
+
+    @classmethod
+    def from_nutanix_cluster(cls, cluster: cm.Cluster) -> Self:
+        # nutanix typing is almost always "Unknown | None" - hence the casting
+        nodes = cast(cm.NodeReference, cluster.nodes)
+        config = cast(cm.ClusterConfigReference, cluster.config)
+        return cls(
+            name=cast(str, cluster.name),
+            n_nodes=cast(int, nodes.number_of_nodes),
+            ext_id=cast(str, cluster.ext_id),
+            arch=cast(str, config.cluster_arch),
+            vm_count=cast(int, cluster.vm_count),
+            is_available=cast(bool, config.is_available),
+        )
+
+
+@dataclasses.dataclass(frozen=True)
+class StorageContainerMetadata:
+    """
+    Metadata about a storage container.
+
+    Includes container ID, name, capacity information, and storage features.
+    """
+
+    ext_id: str
+    name: str
+    cluster_name: None | str
+    cluster_ext_id: None | str
+    max_capacity_bytes: None | int
+    logical_advertised_capacity_bytes: None | int
+    replication_factor: None | int
+    is_compression_enabled: None | bool
+    is_encrypted: None | bool
+    is_marked_for_removal: None | bool
+
+    @classmethod
+    def from_nutanix_storage_container(cls, container: cm.StorageContainer) -> Self:
+        """Convert Nutanix SDK StorageContainer to our response model"""
+        return cls(
+            ext_id=cast(str, container.container_ext_id),  # Note: SDK uses container_ext_id, not ext_id
+            name=cast(str, container.name),
+            cluster_name=container.cluster_name,
+            cluster_ext_id=container.cluster_ext_id,
+            max_capacity_bytes=container.max_capacity_bytes,
+            logical_advertised_capacity_bytes=container.logical_advertised_capacity_bytes,
+            replication_factor=container.replication_factor,
+            is_compression_enabled=container.is_compression_enabled,
+            is_encrypted=container.is_encrypted,
+            is_marked_for_removal=container.is_marked_for_removal,
+        )
+
+
+@dataclasses.dataclass(frozen=True)
+class ClusterResourceStats:
+    """
+    Resource usage statistics for a cluster.
+
+    Includes CPU, memory, and storage capacity and usage information.
+    """
+
+    ext_id: str
+    # CPU stats
+    cpu_capacity_hz: int
+    cpu_usage_hz: int
+    cpu_usage_percent: float
+    cpu_cores_total: int
+    cpu_cores_usage: int
+    # Memory stats
+    memory_capacity_bytes: int
+    memory_usage_bytes: int
+    memory_usage_percent: float
+    # Storage stats
+    storage_capacity_bytes: int
+    storage_usage_bytes: int
+    storage_usage_percent: float
+
+    @classmethod
+    def from_nutanix_cluster_stats(
+        cls,
+        stats: cm.ClusterStats,
+        cpu_capacity_hz: int = 0,
+        memory_capacity_bytes: int = 0,
+        cpu_cores_total: int = 0,
+    ) -> Self:
+        """Convert Nutanix SDK ClusterStats to our response model
+
+        Note: Stats from Nutanix API can be time-series (lists) or scalar values.
+        We extract the latest/last value from lists if needed.
+
+        CPU and memory capacity, and CPU cores are passed in separately since
+        they must be aggregated from cluster hosts (not available in ClusterStats).
+        """
+
+        def extract_value(val, field_name="unknown"):
+            """Extract scalar value from either a list or scalar
+
+            Handles:
+            - None -> 0
+            - Scalar values -> value
+            - Lists of TimeValuePair -> extract value from last pair
+            - Empty lists -> 0
+            """
+            if val is None:
+                return 0
+            if isinstance(val, list):
+                if not val:
+                    return 0
+                # Take the last value from time series
+                last_item = val[-1]
+                # If it's a TimeValuePair object, extract the value
+                if hasattr(last_item, 'value'):
+                    return last_item.value if last_item.value is not None else 0
+                return last_item
+            # Handle TimeValuePair objects directly
+            if hasattr(val, 'value'):
+                return val.value if val.value is not None else 0
+            return val
+
+        # Extract usage values from stats (storage includes capacity too)
+        # CPU: Use hypervisor_cpu_usage_ppm to calculate usage from capacity
+        cpu_usage_ppm = extract_value(stats.hypervisor_cpu_usage_ppm, "hypervisor_cpu_usage_ppm")
+        cpu_usage_hz = int(cpu_capacity_hz * (cpu_usage_ppm / 1_000_000)) if cpu_capacity_hz else 0
+        cpu_usage_pct = (cpu_usage_hz / cpu_capacity_hz * 100) if cpu_capacity_hz else 0
+
+        # Estimate cores in use based on usage percentage
+        cpu_cores_usage = int(cpu_cores_total * (cpu_usage_pct / 100)) if cpu_cores_total else 0
+
+        # Memory: overall_memory_usage_bytes from stats, capacity from aggregated hosts
+        memory_usage = extract_value(stats.overall_memory_usage_bytes, "overall_memory_usage_bytes")
+        memory_usage_pct = (memory_usage / memory_capacity_bytes * 100) if memory_capacity_bytes else 0
+
+        # Storage: both capacity and usage from stats
+        storage_capacity = extract_value(stats.storage_capacity_bytes, "storage_capacity_bytes")
+        storage_usage = extract_value(stats.storage_usage_bytes, "storage_usage_bytes")
+        storage_usage_pct = (storage_usage / storage_capacity * 100) if storage_capacity else 0
+
+        return cls(
+            ext_id=cast(str, stats.ext_id),
+            cpu_capacity_hz=int(cpu_capacity_hz),
+            cpu_usage_hz=int(cpu_usage_hz),
+            cpu_usage_percent=round(cpu_usage_pct, 2),
+            cpu_cores_total=int(cpu_cores_total),
+            cpu_cores_usage=int(cpu_cores_usage),
+            memory_capacity_bytes=int(memory_capacity_bytes),
+            memory_usage_bytes=int(memory_usage),
+            memory_usage_percent=round(memory_usage_pct, 2),
+            storage_capacity_bytes=int(storage_capacity),
+            storage_usage_bytes=int(storage_usage),
+            storage_usage_percent=round(storage_usage_pct, 2),
+        )
+
+
+if __name__ == "__main__":
+    mgmt = ClusterMgmt()
+    mgmt.list_clusters()