runbooks 0.2.3__py3-none-any.whl → 0.6.1__py3-none-any.whl

runbooks/finops/__init__.py

@@ -0,0 +1,88 @@
+"""
+AWS FinOps Dashboard - Cost and Resource Monitoring Tool
+
+This module provides terminal-based AWS cost monitoring with features including:
+- Multi-account cost summaries
+- Service-level cost breakdown
+- Budget monitoring
+- EC2 resource status
+- Cost trend analysis
+- Audit reporting for optimization opportunities
+
+Integrated as a submodule of CloudOps Runbooks for enterprise FinOps automation.
+"""
+
+__version__ = "0.7.0"
+
+# Core components
+# AWS client utilities
+from runbooks.finops.aws_client import (
+    ec2_summary,
+    get_accessible_regions,
+    get_account_id,
+    get_aws_profiles,
+    get_budgets,
+    get_stopped_instances,
+    get_untagged_resources,
+    get_unused_eips,
+    get_unused_volumes,
+)
+
+# Data processors
+from runbooks.finops.cost_processor import get_cost_data, get_trend
+from runbooks.finops.dashboard_runner import run_dashboard
+from runbooks.finops.helpers import (
+    export_audit_report_to_csv,
+    export_audit_report_to_json,
+    export_audit_report_to_pdf,
+    export_cost_dashboard_to_pdf,
+    export_to_csv,
+    export_to_json,
+    export_trend_data_to_json,
+    load_config_file,
+)
+from runbooks.finops.profile_processor import process_combined_profiles, process_single_profile
+
+# Type definitions
+from runbooks.finops.types import BudgetInfo, CostData, EC2Summary, ProfileData, RegionName
+
+# Visualization and export
+from runbooks.finops.visualisations import create_trend_bars
+
+__all__ = [
+    # Core functionality
+    "run_dashboard",
+    # Processors
+    "get_cost_data",
+    "get_trend",
+    "process_single_profile",
+    "process_combined_profiles",
+    # AWS utilities
+    "get_aws_profiles",
+    "get_account_id",
+    "get_accessible_regions",
+    "ec2_summary",
+    "get_stopped_instances",
+    "get_unused_volumes",
+    "get_unused_eips",
+    "get_untagged_resources",
+    "get_budgets",
+    # Visualization and export
+    "create_trend_bars",
+    "export_to_csv",
+    "export_to_json",
+    "export_audit_report_to_pdf",
+    "export_cost_dashboard_to_pdf",
+    "export_audit_report_to_csv",
+    "export_audit_report_to_json",
+    "export_trend_data_to_json",
+    "load_config_file",
+    # Types
+    "ProfileData",
+    "CostData",
+    "BudgetInfo",
+    "EC2Summary",
+    "RegionName",
+    # Metadata
+    "__version__",
+]

runbooks/finops/aws_client.py

@@ -0,0 +1,245 @@
+from collections import defaultdict
+from typing import Dict, List, Optional
+
+import boto3
+from boto3.session import Session
+from botocore.exceptions import ClientError
+from rich.console import Console
+
+from runbooks.finops.types import BudgetInfo, EC2Summary, RegionName
+
+console = Console()
+
+
+def get_aws_profiles() -> List[str]:
+    """Get all configured AWS profiles from the AWS CLI configuration."""
+    try:
+        session = boto3.Session()
+        return session.available_profiles
+    except Exception as e:
+        console.print(f"[bold red]Error getting AWS profiles: {str(e)}[/]")
+        return []
+
+
+def get_account_id(session: Session) -> Optional[str]:
+    """Get the AWS account ID for a session."""
+    try:
+        account_id = session.client("sts").get_caller_identity().get("Account")
+        return str(account_id) if account_id is not None else None
+    except Exception as e:
+        console.log(f"[yellow]Warning: Could not get account ID: {str(e)}[/]")
+        return None
+
+
+def get_all_regions(session: Session) -> List[RegionName]:
+    """
+    Get all available AWS regions.
+    Using us-east-1 as a default region to get the list of all regions.
+
+    If the call fails, it will return a hardcoded list of common regions.
+    """
+    try:
+        ec2_client = session.client("ec2", region_name="us-east-1")
+        regions = [region["RegionName"] for region in ec2_client.describe_regions()["Regions"]]
+        return regions
+    except Exception as e:
+        console.log(f"[yellow]Warning: Could not get all regions: {str(e)}[/]")
+        return [
+            "us-east-1",
+            "us-east-2",
+            "us-west-1",
+            "us-west-2",
+            "ap-southeast-1",
+            "ap-south-1",
+            "eu-west-1",
+            "eu-west-2",
+            "eu-central-1",
+        ]
+
+
+def get_accessible_regions(session: Session) -> List[RegionName]:
+    """Get regions that are accessible with the current credentials."""
+    all_regions = get_all_regions(session)
+    accessible_regions = []
+
+    for region in all_regions:
+        try:
+            ec2_client = session.client("ec2", region_name=region)
+            ec2_client.describe_instances(MaxResults=5)
+            accessible_regions.append(region)
+        except Exception:
+            console.log(f"[yellow]Region {region} is not accessible with the current credentials[/]")
+
+    if not accessible_regions:
+        console.log("[yellow]No accessible regions found. Using default regions.[/]")
+        return ["us-east-1", "us-east-2", "us-west-1", "us-west-2"]
+
+    return accessible_regions
+
+
+def ec2_summary(session: Session, regions: Optional[List[RegionName]] = None) -> EC2Summary:
+    """Get EC2 instance summary across specified regions or all regions."""
+    if regions is None:
+        regions = [
+            "us-east-1",
+            "us-east-2",
+            "us-west-1",
+            "us-west-2",
+            "ap-southeast-1",
+            "ap-south-1",
+            "eu-central-1",
+            "eu-west-1",
+            "eu-west-2",
+        ]
+
+    instance_summary: EC2Summary = defaultdict(int)
+
+    for region in regions:
+        try:
+            ec2_regional = session.client("ec2", region_name=region)
+            instances = ec2_regional.describe_instances()
+            for reservation in instances["Reservations"]:
+                for instance in reservation["Instances"]:
+                    state = instance["State"]["Name"]
+                    instance_summary[state] += 1
+        except Exception as e:
+            console.log(f"[yellow]Warning: Could not access EC2 in region {region}: {str(e)}[/]")
+
+    if "running" not in instance_summary:
+        instance_summary["running"] = 0
+    if "stopped" not in instance_summary:
+        instance_summary["stopped"] = 0
+
+    return instance_summary
+
+
+def get_stopped_instances(session: Session, regions: List[RegionName]) -> Dict[RegionName, List[str]]:
+    """Get stopped EC2 instances per region."""
+    stopped = {}
+    for region in regions:
+        try:
+            ec2 = session.client("ec2", region_name=region)
+            response = ec2.describe_instances(Filters=[{"Name": "instance-state-name", "Values": ["stopped"]}])
+            ids = [inst["InstanceId"] for res in response["Reservations"] for inst in res["Instances"]]
+            if ids:
+                stopped[region] = ids
+        except Exception as e:
+            console.log(f"[yellow]Warning: Could not fetch stopped instances in {region}: {str(e)}[/]")
+    return stopped
+
+
+def get_unused_volumes(session: Session, regions: List[RegionName]) -> Dict[RegionName, List[str]]:
+    """Get unattached EBS volumes per region."""
+    unused = {}
+    for region in regions:
+        try:
+            ec2 = session.client("ec2", region_name=region)
+            response = ec2.describe_volumes(Filters=[{"Name": "status", "Values": ["available"]}])
+            vols = [vol["VolumeId"] for vol in response["Volumes"]]
+            if vols:
+                unused[region] = vols
+        except Exception as e:
+            console.log(f"[yellow]Warning: Could not fetch unused volumes in {region}: {str(e)}[/]")
+    return unused
+
+
+def get_unused_eips(session: Session, regions: List[RegionName]) -> Dict[RegionName, List[str]]:
+    """Get unused Elastic IPs per region."""
+    eips = {}
+    for region in regions:
+        try:
+            ec2 = session.client("ec2", region_name=region)
+            response = ec2.describe_addresses()
+            free = [addr["PublicIp"] for addr in response["Addresses"] if not addr.get("AssociationId")]
+            if free:
+                eips[region] = free
+        except Exception as e:
+            console.log(f"[yellow]Warning: Could not fetch EIPs in {region}: {str(e)}[/]")
+    return eips
+
+
+def get_untagged_resources(session: Session, regions: List[str]) -> Dict[str, Dict[str, List[str]]]:
+    result: Dict[str, Dict[str, List[str]]] = {
+        "EC2": {},
+        "RDS": {},
+        "Lambda": {},
+        "ELBv2": {},
+    }
+
+    for region in regions:
+        # EC2
+        try:
+            ec2 = session.client("ec2", region_name=region)
+            response = ec2.describe_instances()
+            for reservation in response["Reservations"]:
+                for instance in reservation["Instances"]:
+                    if not instance.get("Tags"):
+                        result["EC2"].setdefault(region, []).append(instance["InstanceId"])
+        except Exception as e:
+            console.log(f"[yellow]Warning: Could not fetch EC2 instances in {region}: {str(e)}[/]")
+
+        # RDS
+        try:
+            rds = session.client("rds", region_name=region)
+            response = rds.describe_db_instances()
+            for db_instance in response["DBInstances"]:
+                arn = db_instance["DBInstanceArn"]
+                tags = rds.list_tags_for_resource(ResourceName=arn).get("TagList", [])
+                if not tags:
+                    result["RDS"].setdefault(region, []).append(db_instance["DBInstanceIdentifier"])
+        except Exception as e:
+            console.log(f"[yellow]Warning: Could not fetch RDS instances in {region}: {str(e)}[/]")
+
+        # Lambda
+        try:
+            lambda_client = session.client("lambda", region_name=region)
+            response = lambda_client.list_functions()
+            for function in response["Functions"]:
+                arn = function["FunctionArn"]
+                tags = lambda_client.list_tags(Resource=arn).get("Tags", {})
+                if not tags:
+                    result["Lambda"].setdefault(region, []).append(function["FunctionName"])
+        except Exception as e:
+            console.log(f"[yellow]Warning: Could not fetch Lambda functions in {region}: {str(e)}[/]")
+
+        # ELBv2
+        try:
+            elbv2 = session.client("elbv2", region_name=region)
+            lbs = elbv2.describe_load_balancers().get("LoadBalancers", [])
+
+            if lbs:
+                arn_to_name = {lb["LoadBalancerArn"]: lb["LoadBalancerName"] for lb in lbs}
+                arns = list(arn_to_name.keys())
+
+                tags_response = elbv2.describe_tags(ResourceArns=arns)
+                for desc in tags_response["TagDescriptions"]:
+                    arn = desc["ResourceArn"]
+                    if not desc.get("Tags"):
+                        lb_name = arn_to_name.get(arn, arn)
+                        result["ELBv2"].setdefault(region, []).append(lb_name)
+        except Exception as e:
+            console.log(f"[yellow]Warning: Could not fetch ELBv2 load balancers in {region}: {str(e)}[/]")
+
+    return result
+
+
+def get_budgets(session: Session) -> List[BudgetInfo]:
+    account_id = get_account_id(session)
+    budgets = session.client("budgets", region_name="us-east-1")
+
+    budgets_data: List[BudgetInfo] = []
+    try:
+        response = budgets.describe_budgets(AccountId=account_id)
+        for budget in response["Budgets"]:
+            budgets_data.append(
+                {
+                    "name": budget["BudgetName"],
+                    "limit": float(budget["BudgetLimit"]["Amount"]),
+                    "actual": float(budget["CalculatedSpend"]["ActualSpend"]["Amount"]),
+                    "forecast": float(budget["CalculatedSpend"].get("ForecastedSpend", {}).get("Amount", 0.0)) or None,
+                }
+            )
+    except Exception as e:
+        pass
+
+    return budgets_data

runbooks/finops/cli.py

@@ -0,0 +1,151 @@
+import argparse
+import sys
+from typing import Any, Dict, Optional
+
+import requests
+from packaging import version
+from rich.console import Console
+
+from runbooks.finops.helpers import load_config_file
+
+console = Console()
+
+__version__ = "0.7.0"
+
+
+def welcome_banner() -> None:
+    banner = rf"""
+[bold red]
+  /$$$$$$  /$$      /$$  /$$$$$$        /$$$$$$$$ /$$            /$$$$$$                     
+ /$$__  $$| $$  /$ | $$ /$$__  $$      | $$_____/|__/           /$$__  $$                    
+| $$  \ $$| $$ /$$$| $$| $$  \__/      | $$       /$$ /$$$$$$$ | $$  \ $$  /$$$$$$   /$$$$$$$
+| $$$$$$$$| $$/$$ $$ $$|  $$$$$$       | $$$$$   | $$| $$__  $$| $$  | $$ /$$__  $$ /$$_____/
+| $$__  $$| $$$$_  $$$$ \____  $$      | $$__/   | $$| $$  \ $$| $$  | $$| $$  \ $$|  $$$$$$ 
+| $$  | $$| $$$/ \  $$$ /$$  \ $$      | $$      | $$| $$  | $$| $$  | $$| $$  | $$ \____  $$
+| $$  | $$| $$/   \  $$|  $$$$$$/      | $$      | $$| $$  | $$|  $$$$$$/| $$$$$$$/ /$$$$$$$/
+|__/  |__/|__/     \__/ \______/       |__/      |__/|__/  |__/ \______/ | $$____/ |_______/ 
+                                                                         | $$                
+                                                                         | $$                
+                                                                         |__/                
+[/]
+[bold bright_blue]AWS FinOps Dashboard CLI (v{__version__})[/]                                                                         
+"""
+    console.print(banner)
+
+
+def check_latest_version() -> None:
+    """Check for the latest version of the AWS FinOps Dashboard (CLI)."""
+    try:
+        response = requests.get("https://pypi.org/pypi/aws-finops-dashboard/json", timeout=3)
+        latest = response.json()["info"]["version"]
+        if version.parse(latest) > version.parse(__version__):
+            console.print(f"[bold red]A new version of AWS FinOps Dashboard is available: {latest}[/]")
+            console.print(
+                "[bold bright_yellow]Please update using:\npipx upgrade aws-finops-dashboard\nor\npip install --upgrade aws-finops-dashboard\n[/]"
+            )
+    except Exception:
+        pass
+
+
+def main() -> int:
+    """Command-line interface entry point."""
+    welcome_banner()
+    check_latest_version()
+    from runbooks.finops.dashboard_runner import run_dashboard
+
+    # Create the parser instance to be accessible for get_default
+    parser = argparse.ArgumentParser(description="AWS FinOps Dashboard CLI")
+
+    parser.add_argument(
+        "--config-file",
+        "-C",
+        help="Path to a TOML, YAML, or JSON configuration file.",
+        type=str,
+    )
+    parser.add_argument(
+        "--profiles",
+        "-p",
+        nargs="+",
+        help="Specific AWS profiles to use (space-separated)",
+        type=str,
+    )
+    parser.add_argument(
+        "--regions",
+        "-r",
+        nargs="+",
+        help="AWS regions to check for EC2 instances (space-separated)",
+        type=str,
+    )
+    parser.add_argument("--all", "-a", action="store_true", help="Use all available AWS profiles")
+    parser.add_argument(
+        "--combine",
+        "-c",
+        action="store_true",
+        help="Combine profiles from the same AWS account",
+    )
+    parser.add_argument(
+        "--report-name",
+        "-n",
+        help="Specify the base name for the report file (without extension)",
+        default=None,
+        type=str,
+    )
+    parser.add_argument(
+        "--report-type",
+        "-y",
+        nargs="+",
+        choices=["csv", "json", "pdf"],
+        help="Specify one or more report types: csv and/or json and/or pdf (space-separated)",
+        type=str,
+        default=["csv"],
+    )
+    parser.add_argument(
+        "--dir",
+        "-d",
+        help="Directory to save the report files (default: current directory)",
+        type=str,
+    )
+    parser.add_argument(
+        "--time-range",
+        "-t",
+        help="Time range for cost data in days (default: current month). Examples: 7, 30, 90",
+        type=int,
+    )
+    parser.add_argument(
+        "--tag",
+        "-g",
+        nargs="+",
+        help="Cost allocation tag to filter resources, e.g., --tag Team=DevOps",
+        type=str,
+    )
+    parser.add_argument(
+        "--trend",
+        action="store_true",
+        help="Display a trend report as bars for the past 6 months time range",
+    )
+    parser.add_argument(
+        "--audit",
+        action="store_true",
+        help="Display an audit report with cost anomalies, stopped EC2 instances, unused EBS columes, budget alerts, and more",
+    )
+
+    args = parser.parse_args()
+
+    config_data: Optional[Dict[str, Any]] = None
+    if args.config_file:
+        config_data = load_config_file(args.config_file)
+        if config_data is None:
+            return 1  # Exit if config file loading failed
+
+    # Override args with config_data if present and arg is not set via CLI
+    if config_data:
+        for key, value in config_data.items():
+            if hasattr(args, key) and getattr(args, key) == parser.get_default(key):
+                setattr(args, key, value)
+
+    result = run_dashboard(args)
+    return 0 if result == 0 else 1
+
+
+if __name__ == "__main__":
+    sys.exit(main())