openstack-janitor 0.1.0__py3-none-any.whl

openstack_janitor/__init__.py

@@ -0,0 +1,3 @@
+"""openstack-janitor: audit an OpenStack cloud for orphaned and wasteful resources."""
+
+__version__ = "0.1.0"

openstack_janitor/age.py

@@ -0,0 +1,42 @@
+"""Shared timestamp-age helper.
+
+Used by age-based detectors (old snapshots, shutoff instances, ...) and will
+also back the future min-age safety rail that gates any destructive "clean"
+action behind a minimum resource age.
+"""
+
+from __future__ import annotations
+
+from datetime import UTC, datetime
+
+
+def age_in_days(timestamp: str | None, *, now: datetime | None = None) -> float | None:
+    """Return the age of an ISO 8601 ``timestamp`` in days, or ``None``.
+
+    ``timestamp`` is expected in the form openstacksdk returns resource
+    timestamps in, e.g. ``"2026-06-01T12:00:00Z"``, with or without
+    microseconds, or with a ``+00:00``-style offset. Naive timestamps (no
+    offset at all) are treated as UTC, since openstacksdk sometimes returns
+    naive UTC strings.
+
+    Returns ``None`` if ``timestamp`` is ``None`` or cannot be parsed. Never
+    raises.
+
+    :param timestamp: ISO 8601 timestamp string, or ``None``.
+    :param now: Reference time to compute age against. Defaults to the
+        current UTC time; injectable for tests.
+    """
+    if timestamp is None:
+        return None
+
+    try:
+        parsed = datetime.fromisoformat(timestamp.replace("Z", "+00:00"))
+    except ValueError:
+        return None
+
+    if parsed.tzinfo is None:
+        parsed = parsed.replace(tzinfo=UTC)
+
+    reference = now if now is not None else datetime.now(UTC)
+
+    return (reference - parsed).total_seconds() / 86400

openstack_janitor/cli.py

@@ -0,0 +1,106 @@
+"""Command-line interface for openstack-janitor."""
+
+from __future__ import annotations
+
+from enum import StrEnum
+
+import typer
+from openstack.exceptions import SDKException
+from rich.console import Console
+
+from openstack_janitor.connection import get_connection
+from openstack_janitor.detectors import get_detectors
+from openstack_janitor.reporting import print_findings, render_html, render_json
+
+app = typer.Typer(
+    help="Audit an OpenStack cloud for orphaned and wasteful resources.",
+    no_args_is_help=True,
+)
+console = Console()
+error_console = Console(stderr=True)
+
+
+class OutputFormat(StrEnum):
+    """Supported `--format` values for `janitor audit`."""
+
+    table = "table"
+    json = "json"
+    html = "html"
+
+
+@app.callback()
+def callback() -> None:
+    """Audit an OpenStack cloud for orphaned and wasteful resources.
+
+    A no-op callback: its only purpose is to keep Typer in "subcommand" mode
+    (`janitor audit ...`) instead of collapsing to a single implicit command,
+    since there is currently only one subcommand registered.
+    """
+
+
+@app.command()
+def audit(
+    cloud: str | None = typer.Option(
+        None,
+        "--cloud",
+        help="Named cloud from clouds.yaml (default: resolved from OS_CLOUD / OS_* env vars).",
+    ),
+    detector: list[str] | None = typer.Option(
+        None,
+        "--detector",
+        help="Run only this detector (repeatable). Default: run all registered detectors.",
+    ),
+    output_format: OutputFormat = typer.Option(
+        OutputFormat.table,
+        "--format",
+        help="Output format: table for humans, json/html for reports or piping.",
+    ),
+) -> None:
+    """Scan the cloud and report orphaned/wasteful resources.
+
+    Exit codes: 0 = no findings, 1 = findings were reported (useful for cron
+    jobs), 2 = an unknown --detector name was given, 3 = connection or
+    authentication to the cloud failed. Exit-code behavior is the same for
+    every --format.
+    """
+    all_detectors = get_detectors()
+    selected = all_detectors
+    if detector:
+        by_name = {d.name: d for d in all_detectors}
+        unknown = [name for name in detector if name not in by_name]
+        if unknown:
+            valid = ", ".join(sorted(by_name)) or "(none registered)"
+            error_console.print(
+                f"[red]Unknown detector(s): {', '.join(unknown)}. Valid detectors: {valid}[/red]"
+            )
+            raise typer.Exit(code=2)
+        selected = [by_name[name] for name in detector]
+
+    try:
+        conn = get_connection(cloud)
+        findings = []
+        for det in selected:
+            findings.extend(det.detect(conn))
+    except SDKException as exc:
+        error_console.print(f"[red]Failed to connect to OpenStack cloud: {exc}[/red]")
+        raise typer.Exit(code=3) from exc
+
+    if output_format is OutputFormat.json:
+        # Machine-readable: use plain print(), never the rich console -- rich
+        # would wrap lines and inject markup, corrupting the JSON output.
+        print(render_json(findings))
+    elif output_format is OutputFormat.html:
+        print(render_html(findings))
+    else:
+        print_findings(findings, console)
+
+    raise typer.Exit(code=1 if findings else 0)
+
+
+def main() -> None:
+    """Console-script entry point (typer's ``app`` is not itself callable-as-main)."""
+    app()
+
+
+if __name__ == "__main__":
+    main()

openstack_janitor/connection.py

@@ -0,0 +1,32 @@
+"""Connection helper: the single seam between openstack-janitor and openstacksdk.
+
+Kept intentionally tiny so tests and the CLI have one place to mock instead of
+reaching into openstacksdk internals.
+"""
+
+from __future__ import annotations
+
+import openstack
+from openstack.connection import Connection
+
+
+def get_connection(cloud: str | None = None) -> Connection:
+    """Return an authenticated openstacksdk Connection.
+
+    Resolution order follows openstacksdk's own rules:
+
+    1. If ``cloud`` is given, it is looked up by name in ``clouds.yaml``
+       (searched in the current directory, ``~/.config/openstack/`` and
+       ``/etc/openstack/``), optionally layered with ``secure.yaml``.
+    2. If ``cloud`` is ``None``, ``openstack.connect()`` is called with no
+       arguments and openstacksdk resolves the cloud itself: the ``OS_CLOUD``
+       environment variable (which behaves like passing ``cloud=...``), or
+       else the standard ``OS_*`` environment variables (``OS_AUTH_URL``,
+       ``OS_USERNAME``, ``OS_PASSWORD``, ``OS_PROJECT_NAME``, etc.).
+
+    No connection is made here -- openstacksdk connections are lazy, so this
+    only builds the ``Connection`` object.
+    """
+    if cloud is None:
+        return openstack.connect()
+    return openstack.connect(cloud=cloud)

openstack_janitor/detectors/__init__.py

@@ -0,0 +1,31 @@
+"""Detector registry.
+
+This list is deliberately explicit and boring: to add a detector, write the
+class and append it here. A config-driven enable/disable toggle (e.g. via
+``janitor.toml``) arrives in a later change.
+"""
+
+from openstack_janitor.detectors.base import Detector, Finding
+from openstack_janitor.detectors.floating_ips import UnassociatedFloatingIpsDetector
+from openstack_janitor.detectors.instances import ShutoffInstancesDetector
+from openstack_janitor.detectors.ports import OrphanedPortsDetector
+from openstack_janitor.detectors.security_groups import UnusedSecurityGroupsDetector
+from openstack_janitor.detectors.snapshots import OldSnapshotsDetector
+from openstack_janitor.detectors.volumes import UnattachedVolumesDetector
+
+ALL_DETECTORS: list[type[Detector]] = [
+    UnattachedVolumesDetector,
+    UnassociatedFloatingIpsDetector,
+    OrphanedPortsDetector,
+    OldSnapshotsDetector,
+    ShutoffInstancesDetector,
+    UnusedSecurityGroupsDetector,
+]
+
+
+def get_detectors() -> list[Detector]:
+    """Instantiate every registered detector."""
+    return [detector_cls() for detector_cls in ALL_DETECTORS]
+
+
+__all__ = ["ALL_DETECTORS", "Detector", "Finding", "get_detectors"]

openstack_janitor/detectors/base.py

@@ -0,0 +1,36 @@
+"""Base types shared by all detectors."""
+
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from dataclasses import dataclass, field
+from typing import ClassVar
+
+from openstack.connection import Connection
+
+
+@dataclass(frozen=True)
+class Finding:
+    """A single flagged resource."""
+
+    resource_type: str
+    resource_id: str
+    resource_name: str
+    project_id: str
+    reason: str
+    extra: dict[str, str] = field(default_factory=dict)
+
+
+class Detector(ABC):
+    """A check that scans a cloud for one category of orphaned/wasteful resource."""
+
+    name: ClassVar[str]
+    """Kebab-case identifier, e.g. "unattached-volumes"."""
+
+    description: ClassVar[str]
+    """Short human-readable description of what this detector looks for."""
+
+    @abstractmethod
+    def detect(self, conn: Connection) -> list[Finding]:
+        """Scan the cloud reachable via ``conn`` and return any findings."""
+        raise NotImplementedError

openstack_janitor/detectors/floating_ips.py

@@ -0,0 +1,42 @@
+"""Detector for unassociated floating IPs."""
+
+from __future__ import annotations
+
+from typing import ClassVar
+
+from openstack.connection import Connection
+
+from openstack_janitor.detectors.base import Detector, Finding
+
+
+class UnassociatedFloatingIpsDetector(Detector):
+    """Flags floating IPs that are not associated with any port."""
+
+    name: ClassVar[str] = "unassociated-floating-ips"
+    description: ClassVar[str] = "Floating IPs not associated with any port"
+
+    def detect(self, conn: Connection) -> list[Finding]:
+        # Unlike block storage, Neutron scopes list results by policy automatically
+        # (admins see all projects, non-admins see only their own), so there is no
+        # all_projects kwarg here and no ForbiddenException fallback is needed.
+        ips = list(conn.network.ips())
+
+        findings: list[Finding] = []
+        for ip in ips:
+            if ip.port_id:
+                continue
+            extra = {}
+            status = getattr(ip, "status", None)
+            if status:
+                extra["status"] = str(status)
+            findings.append(
+                Finding(
+                    resource_type="floating-ip",
+                    resource_id=ip.id,
+                    resource_name=getattr(ip, "floating_ip_address", "") or "",
+                    project_id=getattr(ip, "project_id", "") or "",
+                    reason="floating IP is not associated with any port",
+                    extra=extra,
+                )
+            )
+        return findings

openstack_janitor/detectors/instances.py

@@ -0,0 +1,71 @@
+"""Detector for long-shutoff instances."""
+
+from __future__ import annotations
+
+from datetime import datetime
+from typing import ClassVar
+
+from openstack.connection import Connection
+from openstack.exceptions import ForbiddenException
+
+from openstack_janitor.age import age_in_days
+from openstack_janitor.detectors.base import Detector, Finding
+
+
+class ShutoffInstancesDetector(Detector):
+    """Flags instances that have been SHUTOFF for longer than a threshold.
+
+    There is no direct "shutoff since" field in the Compute API. Any status
+    transition bumps ``updated_at``, so an ``updated_at`` older than N days
+    on a currently-SHUTOFF server proves it has been off for at least N
+    days -- a conservative lower bound, not an exact shutoff duration.
+    Non-status mutations (metadata edits, resizes) also bump ``updated_at``,
+    which can reset the apparent age and hide a genuinely old instance: this
+    detector may under-report but never over-reports.
+    """
+
+    name: ClassVar[str] = "shutoff-instances"
+    description: ClassVar[str] = "Instances that have been SHUTOFF for longer than a threshold"
+
+    def __init__(self, max_age_days: float = 30.0, *, now: datetime | None = None) -> None:
+        self.max_age_days = max_age_days
+        self.now = now
+
+    def detect(self, conn: Connection) -> list[Finding]:
+        try:
+            servers = list(conn.compute.servers(details=True, all_projects=True))
+        except ForbiddenException:
+            # all_projects=True requires admin; fall back to the caller's own project.
+            servers = list(conn.compute.servers(details=True))
+
+        findings: list[Finding] = []
+        for server in servers:
+            if server.status != "SHUTOFF":
+                continue
+
+            age = age_in_days(getattr(server, "updated_at", None), now=self.now)
+            if age is None or age <= self.max_age_days:
+                continue
+
+            extra = {}
+            updated_at = getattr(server, "updated_at", None)
+            if updated_at:
+                extra["updated_at"] = str(updated_at)
+            status = getattr(server, "status", None)
+            if status:
+                extra["status"] = str(status)
+
+            findings.append(
+                Finding(
+                    resource_type="instance",
+                    resource_id=server.id,
+                    resource_name=getattr(server, "name", "") or "",
+                    project_id=getattr(server, "project_id", "") or "",
+                    reason=(
+                        f"instance has been shutoff for at least {age:.0f} days "
+                        f"(threshold {self.max_age_days:.0f})"
+                    ),
+                    extra=extra,
+                )
+            )
+        return findings

openstack_janitor/detectors/ports.py

@@ -0,0 +1,46 @@
+"""Detector for orphaned ports."""
+
+from __future__ import annotations
+
+from typing import ClassVar
+
+from openstack.connection import Connection
+
+from openstack_janitor.detectors.base import Detector, Finding
+
+
+class OrphanedPortsDetector(Detector):
+    """Flags ports that have no device owner and no device id.
+
+    Infrastructure ports (DHCP, router interfaces, Octavia VIPs) always carry
+    a device owner or device id, so they are never flagged. Known false
+    positive: a manually pre-created port awaiting later attachment also has
+    both fields empty. That is fine for a read-only audit, but any future
+    clean action on ports must be gated behind age/tag safety rails rather
+    than this signal alone.
+    """
+
+    name: ClassVar[str] = "orphaned-ports"
+    description: ClassVar[str] = "Ports with no device owner and no device id"
+
+    def detect(self, conn: Connection) -> list[Finding]:
+        ports = list(conn.network.ports())
+
+        findings: list[Finding] = []
+        for port in ports:
+            if port.device_owner or port.device_id:
+                continue
+            extra = {}
+            if getattr(port, "network_id", None):
+                extra["network_id"] = str(port.network_id)
+            findings.append(
+                Finding(
+                    resource_type="port",
+                    resource_id=port.id,
+                    resource_name=port.name or "",
+                    project_id=getattr(port, "project_id", "") or "",
+                    reason="port has no device owner or device id",
+                    extra=extra,
+                )
+            )
+        return findings

openstack_janitor/detectors/security_groups.py

@@ -0,0 +1,71 @@
+"""Detector for unused security groups."""
+
+from __future__ import annotations
+
+from typing import ClassVar
+
+from openstack.connection import Connection
+
+from openstack_janitor.detectors.base import Detector, Finding
+
+
+class UnusedSecurityGroupsDetector(Detector):
+    """Flags security groups that are not in use.
+
+    A group is considered "in use" from two sources: it is attached to at
+    least one port (via that port's ``security_group_ids``), or it is named
+    as the ``remote_group_id`` of a rule on *any* security group -- a group
+    referenced that way is in use even if it has zero ports, because
+    deleting it would break the referencing rule. The auto-created "default"
+    group present in every project is undeletable and always skipped, since
+    flagging it would just be noise.
+
+    A self-referencing rule (remote_group_id pointing at its own group)
+    marks the group in-use — an under-report in the delete-safe direction.
+    Known false positive: a freshly created group awaiting its first port is
+    flagged. Fine for a read-only audit, but any future clean action must be
+    gated behind age/tag safety rails rather than this signal alone.
+    """
+
+    name: ClassVar[str] = "unused-security-groups"
+    description: ClassVar[str] = "Security groups not attached to any port or referenced by a rule"
+
+    def detect(self, conn: Connection) -> list[Finding]:
+        security_groups = list(conn.network.security_groups())
+        ports = list(conn.network.ports())
+
+        in_use_ids: set[str] = set()
+        for port in ports:
+            in_use_ids.update(getattr(port, "security_group_ids", []) or [])
+        for group in security_groups:
+            for rule in getattr(group, "security_group_rules", []) or []:
+                if isinstance(rule, dict):
+                    remote_group_id = rule.get("remote_group_id")
+                else:
+                    remote_group_id = getattr(rule, "remote_group_id", None)
+                if remote_group_id:
+                    in_use_ids.add(remote_group_id)
+
+        findings: list[Finding] = []
+        for group in security_groups:
+            if group.id in in_use_ids:
+                continue
+            if (getattr(group, "name", None) or "") == "default":
+                continue
+
+            extra = {}
+            rules = getattr(group, "security_group_rules", None)
+            if rules is not None:
+                extra["rules_count"] = str(len(rules))
+
+            findings.append(
+                Finding(
+                    resource_type="security-group",
+                    resource_id=group.id,
+                    resource_name=getattr(group, "name", "") or "",
+                    project_id=getattr(group, "project_id", "") or "",
+                    reason="security group is not attached to any port or referenced by any rule",
+                    extra=extra,
+                )
+            )
+        return findings

openstack_janitor/detectors/snapshots.py

@@ -0,0 +1,58 @@
+"""Detector for old block storage snapshots."""
+
+from __future__ import annotations
+
+from datetime import datetime
+from typing import ClassVar
+
+from openstack.connection import Connection
+from openstack.exceptions import ForbiddenException
+
+from openstack_janitor.age import age_in_days
+from openstack_janitor.detectors.base import Detector, Finding
+
+
+class OldSnapshotsDetector(Detector):
+    """Flags snapshots older than a configurable age threshold."""
+
+    name: ClassVar[str] = "old-snapshots"
+    description: ClassVar[str] = "Snapshots older than a configurable age threshold"
+
+    def __init__(self, max_age_days: float = 90.0, *, now: datetime | None = None) -> None:
+        self.max_age_days = max_age_days
+        self.now = now
+
+    def detect(self, conn: Connection) -> list[Finding]:
+        try:
+            snapshots = list(conn.block_storage.snapshots(details=True, all_projects=True))
+        except ForbiddenException:
+            # all_projects=True requires admin; fall back to the caller's own project.
+            snapshots = list(conn.block_storage.snapshots(details=True))
+
+        findings: list[Finding] = []
+        for snap in snapshots:
+            # Never flag what we can't date -- a missing/unparsable created_at
+            # is skipped silently rather than guessed at.
+            age = age_in_days(getattr(snap, "created_at", None), now=self.now)
+            if age is None or age <= self.max_age_days:
+                continue
+
+            extra = {}
+            created_at = getattr(snap, "created_at", None)
+            if created_at:
+                extra["created_at"] = str(created_at)
+            volume_id = getattr(snap, "volume_id", None)
+            if volume_id:
+                extra["volume_id"] = str(volume_id)
+
+            findings.append(
+                Finding(
+                    resource_type="snapshot",
+                    resource_id=snap.id,
+                    resource_name=getattr(snap, "name", "") or "",
+                    project_id=getattr(snap, "project_id", "") or "",
+                    reason=(f"snapshot is {age:.0f} days old (threshold {self.max_age_days:.0f})"),
+                    extra=extra,
+                )
+            )
+        return findings

openstack_janitor/detectors/volumes.py

@@ -0,0 +1,39 @@
+"""Detector for unattached (orphaned) block storage volumes."""
+
+from __future__ import annotations
+
+from typing import ClassVar
+
+from openstack.connection import Connection
+from openstack.exceptions import ForbiddenException
+
+from openstack_janitor.detectors.base import Detector, Finding
+
+
+class UnattachedVolumesDetector(Detector):
+    """Flags volumes that are "available" (i.e. not attached to any server)."""
+
+    name: ClassVar[str] = "unattached-volumes"
+    description: ClassVar[str] = "Volumes in 'available' state with no attachments"
+
+    def detect(self, conn: Connection) -> list[Finding]:
+        try:
+            volumes = list(conn.block_storage.volumes(details=True, all_projects=True))
+        except ForbiddenException:
+            # all_projects=True requires admin; fall back to the caller's own project.
+            volumes = list(conn.block_storage.volumes(details=True))
+
+        findings: list[Finding] = []
+        for vol in volumes:
+            if vol.status != "available" or vol.attachments:
+                continue
+            findings.append(
+                Finding(
+                    resource_type="volume",
+                    resource_id=vol.id,
+                    resource_name=vol.name or "",
+                    project_id=getattr(vol, "project_id", "") or "",
+                    reason="volume is unattached (status=available)",
+                )
+            )
+        return findings

openstack_janitor/reporting.py

@@ -0,0 +1,97 @@
+"""Rendering findings to the terminal, JSON, or HTML."""
+
+from __future__ import annotations
+
+import dataclasses
+import html
+import json
+
+from rich.console import Console
+from rich.table import Table
+
+from openstack_janitor.detectors.base import Finding
+
+
+def render_table(findings: list[Finding]) -> Table:
+    """Build a rich Table summarizing the given findings."""
+    table = Table(title="openstack-janitor findings")
+    table.add_column("Type", style="cyan")
+    table.add_column("ID", style="dim")
+    table.add_column("Name")
+    table.add_column("Project")
+    table.add_column("Reason")
+
+    for finding in findings:
+        table.add_row(
+            finding.resource_type,
+            finding.resource_id,
+            finding.resource_name,
+            finding.project_id,
+            finding.reason,
+        )
+    return table
+
+
+def print_findings(findings: list[Finding], console: Console) -> None:
+    """Print findings as a table, or a clean-cloud message if there are none."""
+    if not findings:
+        console.print("[green]No findings — cloud looks clean.[/green]")
+        return
+    console.print(render_table(findings))
+
+
+def render_json(findings: list[Finding]) -> str:
+    """Render findings as an indented JSON array, for reports/piping."""
+    return json.dumps([dataclasses.asdict(f) for f in findings], indent=2, sort_keys=True)
+
+
+def render_html(findings: list[Finding]) -> str:
+    """Render findings as a fully self-contained HTML document.
+
+    Every dynamic value is passed through ``html.escape`` -- findings come
+    from cloud-controlled resource names, which must never be trusted enough
+    to interpolate into HTML unescaped.
+    """
+    summary = f"{len(findings)} finding{'s' if len(findings) != 1 else ''}"
+
+    if not findings:
+        body = "<p>No findings — cloud looks clean.</p>"
+    else:
+        rows = []
+        for finding in findings:
+            extra = ", ".join(f"{k}={v}" for k, v in finding.extra.items())
+            cells = [
+                finding.resource_type,
+                finding.resource_id,
+                finding.resource_name,
+                finding.project_id,
+                finding.reason,
+                extra,
+            ]
+            row = "".join(f"<td>{html.escape(cell)}</td>" for cell in cells)
+            rows.append(f"<tr>{row}</tr>")
+        body = (
+            "<table>\n"
+            "<tr><th>Type</th><th>ID</th><th>Name</th><th>Project</th>"
+            "<th>Reason</th><th>Extra</th></tr>\n" + "\n".join(rows) + "\n</table>"
+        )
+
+    return f"""<!DOCTYPE html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<title>openstack-janitor report</title>
+<style>
+body {{ font-family: sans-serif; margin: 2rem; }}
+table {{ border-collapse: collapse; width: 100%; }}
+th, td {{ border: 1px solid #ccc; padding: 0.4rem 0.6rem; text-align: left; }}
+th {{ background: #eee; }}
+</style>
+</head>
+<body>
+<h1>openstack-janitor report</h1>
+<p>{html.escape(summary)}</p>
+{body}
+</body>
+</html>
+"""

openstack_janitor-0.1.0.dist-info/METADATA

@@ -0,0 +1,109 @@
+Metadata-Version: 2.4
+Name: openstack-janitor
+Version: 0.1.0
+Summary: Audit an OpenStack cloud for orphaned and wasteful resources
+Author-email: Mohammad AbuNemeh <mabunemeh@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: openstacksdk>=3.0
+Requires-Dist: rich>=13
+Requires-Dist: typer>=0.12
+Provides-Extra: dev
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# openstack-janitor
+
+[![CI](https://github.com/mabunemeh/openstack-janitor/actions/workflows/ci.yml/badge.svg)](https://github.com/mabunemeh/openstack-janitor/actions/workflows/ci.yml)
+
+A CLI that audits an OpenStack cloud for orphaned and wasteful resources.
+
+**Status: early development.** Six detectors are working — see
+[Detectors](#detectors); more detectors and a `clean` command are coming — see
+[Roadmap](#roadmap).
+
+## Install
+
+From source:
+
+```sh
+git clone <this repo>
+cd openstack-janitor
+pip install -e .
+```
+
+Publishing to PyPI (`pip install openstack-janitor`) and a `pipx`-friendly
+release are planned once there's more than one detector.
+
+## Usage
+
+```sh
+janitor audit
+janitor audit --cloud my-cloud
+janitor audit --detector unattached-volumes --detector orphaned-ports
+janitor audit --format json > findings.json
+janitor audit --format html > report.html
+```
+
+`--format table` (the default) prints a rich table; `json` and `html` write
+machine-readable / shareable reports to stdout.
+
+Example output when orphaned volumes are found:
+
+```
+$ janitor audit --cloud my-cloud
+              openstack-janitor findings
+┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃ Type          ┃ ID        ┃ Name    ┃ Project ┃ Reason                       ┃
+┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
+│ volume        │ a1b2c3d4… │ old-db  │ proj-1  │ volume is unattached         │
+│               │           │         │         │ (status=available)          │
+└───────────────┴───────────┴─────────┴─────────┴──────────────────────────────┘
+$ echo $?
+1
+```
+
+`janitor audit` exits `0` when nothing is found, `1` when findings were
+reported (so it's safe to wire into a cron job or CI check), `2` if an
+unknown `--detector` name is given, and `3` if connecting to the cloud
+fails.
+
+## Detectors
+
+| Name | Flags |
+| --- | --- |
+| `unattached-volumes` | Volumes in `available` status with no attachments. |
+| `unassociated-floating-ips` | Floating IPs not associated with any port. |
+| `orphaned-ports` | Ports with no device owner and no device id. Infrastructure ports (DHCP, routers, load balancer VIPs) always carry one of these, so they are never flagged; a pre-created port awaiting attachment will be. |
+| `old-snapshots` | Volume snapshots older than a threshold (default 90 days). |
+| `shutoff-instances` | Instances in `SHUTOFF` status whose last update is older than a threshold (default 30 days). There is no "shutoff since" field in the Compute API, so the age is a conservative lower bound — the detector may under-report but never over-reports. |
+| `unused-security-groups` | Security groups not attached to any port and not referenced as a `remote_group_id` by any rule. The per-project `default` group is always skipped. |
+
+All detectors are read-only. Resources without a parseable timestamp are never
+flagged by the age-based detectors. Thresholds become configurable once
+`janitor.toml` support lands (see [Roadmap](#roadmap)).
+
+## Authentication
+
+`openstack-janitor` uses [openstacksdk](https://docs.openstack.org/openstacksdk/latest/)
+for authentication, so anything openstacksdk understands works here too:
+
+- A named cloud from `clouds.yaml` via `--cloud my-cloud` (or the `OS_CLOUD`
+  environment variable).
+- The standard `OS_*` environment variables (`OS_AUTH_URL`, `OS_USERNAME`,
+  `OS_PASSWORD`, `OS_PROJECT_NAME`, etc.) if no cloud is specified.
+
+See the openstacksdk
+[configuration documentation](https://docs.openstack.org/openstacksdk/latest/user/config/configuration.html)
+for the full resolution order and file locations.
+
+## Roadmap
+
+- A `clean` command with a `--dry-run` default and explicit `--yes` to act.
+- `janitor.toml` for per-cloud configuration (which detectors run, age
+  thresholds, exclusions).
+- Safety rails: tagging/exclusion lists so resources can be marked "do not
+  touch" before `clean` ever deletes anything.

openstack_janitor-0.1.0.dist-info/RECORD

@@ -0,0 +1,18 @@
+openstack_janitor/__init__.py,sha256=kBHapuL47sp1X-379YfqWxixUKYIlQjWwv_O6nFIhTs,110
+openstack_janitor/age.py,sha256=AST-4kXMjBSaGHt-LMKFj66szmi_yFOM3i9XJy8F2b8,1425
+openstack_janitor/cli.py,sha256=gsBvn3RRlSLD_Hpugm67c_gClGQWytnjHZ1L10ssWi4,3367
+openstack_janitor/connection.py,sha256=jgI1OwTnLm8Lxpj_5ED6jw8NA5xH1OzOpg3Y-FP6u4s,1291
+openstack_janitor/reporting.py,sha256=QCZzaX-PDV1jBF9pCVOITO7sBKDA53_uB0Pr0txueGQ,2992
+openstack_janitor/detectors/__init__.py,sha256=egS-J4NMR13srWDNZB88UjPSPIWNiLKPVyRvKXuPY1Q,1194
+openstack_janitor/detectors/base.py,sha256=1Bly8F8BYnbSZJjGccTZKX5Cavu2Y1w17BKcyKypUSg,957
+openstack_janitor/detectors/floating_ips.py,sha256=r1fPMysSYVeHlibHvBA1faOrEf_AFQBOenszKFZOETM,1522
+openstack_janitor/detectors/instances.py,sha256=Psz3i6kQ2YLTUc5AyCOCOzcnc6ob3PxIhmZBzWDYhbQ,2773
+openstack_janitor/detectors/ports.py,sha256=8WpAi-W50N-q_dlzGCbGZDeuBBXK6qovdOvSGRqxbWE,1639
+openstack_janitor/detectors/security_groups.py,sha256=3eSf_j8xn4DmwFx1ZbLBTK3fTZark2Y8aCenBX0w8VA,2933
+openstack_janitor/detectors/snapshots.py,sha256=hXKnWkcK-VQEn7NN5ly47snS3dcbJKRZndjQ0q0O2Bw,2233
+openstack_janitor/detectors/volumes.py,sha256=kVCtALXDBIk7bN96dED2WCyCLYe623ZENfjBh8TdBL0,1432
+openstack_janitor-0.1.0.dist-info/METADATA,sha256=ycQ9HVOCO8JygF34Fetr8IZ_sc0xTzwvnIwXCYm-2kM,4982
+openstack_janitor-0.1.0.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
+openstack_janitor-0.1.0.dist-info/entry_points.txt,sha256=170MubAK5jENHIhjbKdlvefNl7AAI_d9vAGTZBGVLQE,55
+openstack_janitor-0.1.0.dist-info/licenses/LICENSE,sha256=8qKQIlk_rsPJMoEo65z56KU2Njo98LuTfB-SFwSel4c,11347
+openstack_janitor-0.1.0.dist-info/RECORD,,

openstack_janitor-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.31.0
+Root-Is-Purelib: true
+Tag: py3-none-any

openstack_janitor-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+janitor = openstack_janitor.cli:main

openstack_janitor-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing
+      the origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Mohammad AbuNemeh
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.