runbooks 0.7.0__py3-none-any.whl → 0.7.6__py3-none-any.whl

runbooks/aws/ec2_copy_image_cross-region.py

@@ -1,195 +0,0 @@
-#!/usr/bin/env python3
-"""
-EC2 Image Creation and Cross-Region Copy Script.
-
-Author: nnthanh101@gmail.com
-Date: 2025-01-08
-Version: 2.0.0
-"""
-
-import json
-import logging
-import os
-from typing import List
-
-import boto3
-from botocore.exceptions import BotoCoreError, ClientError
-
-# ==============================
-# CONFIGURATIONS
-# ==============================
-SOURCE_REGION = os.getenv("SOURCE_REGION", "ap-southeast-2")  ## Source AWS region
-DEST_REGION = os.getenv("DEST_REGION", "us-east-1")  ## Destination AWS region
-INSTANCE_IDS = os.getenv("INSTANCE_IDS", "i-0067eeaab6c8188fd").split(",")  ## Comma-separated instance IDs
-IMAGE_NAME_PREFIX = os.getenv("IMAGE_NAME_PREFIX", "Demo-Boto")  ## Image name prefix
-DRY_RUN = os.getenv("DRY_RUN", "false").lower() == "true"  ## Dry-run mode
-
-# ==============================
-# LOGGING CONFIGURATION
-# ==============================
-logging.basicConfig(format="%(asctime)s - %(levelname)s - %(message)s", level=logging.INFO)
-logger = logging.getLogger(__name__)
-
-# ==============================
-# AWS CLIENT INITIALIZATION
-# ==============================
-source_ec2 = boto3.resource("ec2", region_name=SOURCE_REGION)
-source_client = boto3.client("ec2", region_name=SOURCE_REGION)
-dest_client = boto3.client("ec2", region_name=DEST_REGION)
-
-
-# ==============================
-# VALIDATION UTILITIES
-# ==============================
-def validate_regions(source_region: str, dest_region: str) -> None:
-    """
-    Validates AWS regions.
-
-    Args:
-        source_region (str): Source AWS region.
-        dest_region (str): Destination AWS region.
-
-    Raises:
-        ValueError: If regions are invalid.
-    """
-    session = boto3.session.Session()
-    valid_regions = session.get_available_regions("ec2")
-
-    if source_region not in valid_regions:
-        raise ValueError(f"Invalid source region: {source_region}")
-    if dest_region not in valid_regions:
-        raise ValueError(f"Invalid destination region: {dest_region}")
-    logger.info(f"Validated AWS regions: {source_region} -> {dest_region}")
-
-
-# ==============================
-# CREATE IMAGES
-# ==============================
-def create_images(instance_ids: List[str]) -> List[str]:
-    """
-    Creates AMI images for specified instances.
-
-    Args:
-        instance_ids (List[str]): List of EC2 instance IDs.
-
-    Returns:
-        List[str]: List of created image IDs.
-    """
-    image_ids = []
-    for instance_id in instance_ids:
-        try:
-            instance = source_ec2.Instance(instance_id)
-            image_name = f"{IMAGE_NAME_PREFIX}-{instance_id}"
-            logger.info(f"Creating image for instance {instance_id} with name '{image_name}' ...")
-
-            if DRY_RUN:
-                logger.info(f"[DRY-RUN] Image creation for {instance_id} skipped.")
-            else:
-                image = instance.create_image(Name=image_name, Description=f"Image for {instance_id}")
-                image_ids.append(image.id)
-                logger.info(f"Created image: {image.id}")
-
-        except ClientError as e:
-            logger.error(f"Failed to create image for instance {instance_id}: {e}")
-            continue
-
-    return image_ids
-
-
-# ==============================
-# WAIT FOR IMAGES
-# ==============================
-def wait_for_images(image_ids: List[str]) -> None:
-    """
-    Waits until the AMIs images to be available.
-
-    Args:
-        image_ids (List[str]): List of image IDs to monitor.
-    """
-    try:
-        logger.info("Waiting for images to be available...")
-        ## Get waiter for image_available
-        waiter = source_client.get_waiter("image_available")
-        waiter.wait(Filters=[{"Name": "image-id", "Values": image_ids}])
-        logger.info("All Images are now available.")
-    except ClientError as e:
-        logger.error(f"Error waiting for AMIs: {e}")
-        raise
-
-
-# ==============================
-# COPY IMAGES TO DESTINATION
-# ==============================
-def copy_images(image_ids: List[str]) -> None:
-    """
-    Copies AMIs Images to the destination region.
-
-    Args:
-        image_ids (List[str]): List of source image IDs.
-    """
-    for image_id in image_ids:
-        try:
-            copy_name = f"{IMAGE_NAME_PREFIX}-Copy-{image_id}"
-            logger.info(f"Copying image {image_id} to {DEST_REGION} with name '{copy_name}' ...")
-
-            if DRY_RUN:
-                logger.info(f"[DRY-RUN] Image copy for {image_id} skipped.")
-            else:
-                dest_client.copy_image(
-                    Name=copy_name,
-                    SourceImageId=image_id,
-                    SourceRegion=SOURCE_REGION,
-                    Description=f"Copy of {image_id} from {SOURCE_REGION}",
-                )
-                logger.info(f"Image {image_id} copied successfully.")
-        except ClientError as e:
-            logger.error(f"Failed to copy image {image_id}: {e}")
-            continue
-
-
-# ==============================
-# MAIN FUNCTION
-# ==============================
-def main():
-    """
-    CLI Entry Point.
-    """
-    try:
-        ## ✅ Validate regions
-        validate_regions(SOURCE_REGION, DEST_REGION)
-
-        ## ✅ Part 1. Create AMI Images
-        image_ids = create_images(INSTANCE_IDS)
-        if not image_ids:
-            logger.warning("No images created. Exiting.")
-            return
-
-        ## ✅ Part 2. Wait for AMI Images to be available
-        wait_for_images(image_ids)
-
-        ## ✅ Part 3. Copy images to destination region
-        copy_images(image_ids)
-
-    except Exception as e:
-        logger.error(f"Unexpected error: {e}")
-        exit(1)
-
-
-# ==============================
-# LAMBDA HANDLER
-# ==============================
-def lambda_handler(event, context):
-    """
-    AWS Lambda Entry Point.
-    """
-    try:
-        main()
-        return {"statusCode": 200, "body": "Process completed successfully."}
-
-    except Exception as e:
-        logger.error(f"Lambda Error: {e}")
-        return {"statusCode": 500, "body": str(e)}
-
-
-if __name__ == "__main__":
-    main()

runbooks/aws/ec2_describe_instances.py

@@ -1,202 +0,0 @@
-#!/usr/bin/env python3
-"""
-AWS EC2 Describe Instances Tool.
-
-Lists EC2 instances based on optional filters. Supports Python CLI, Docker, and AWS Lambda.
-
-Author: nnthanh101@gmail.com
-Date: 2025-01-08
-Version: 1.0.0
-"""
-
-import json
-import os
-import sys
-from typing import Dict, List, Optional
-
-import boto3
-from botocore.exceptions import BotoCoreError, ClientError
-
-from runbooks.utils.logger import configure_logger
-
-## ✅ Configure Logger
-logger = configure_logger(__name__)
-
-# ==============================
-# CONFIGURATIONS
-# ==============================
-AWS_REGION = os.getenv("AWS_REGION", "ap-southeast-2")  # Default Region
-DEFAULT_TAG_KEY = os.getenv("DEFAULT_TAG_KEY", "Env")  # Default Tag Key
-DEFAULT_TAG_VALUE = os.getenv("DEFAULT_TAG_VALUE", "Prod")  # Default Tag Value
-
-# AWS Client
-ec2_client = boto3.client("ec2", region_name=AWS_REGION)
-
-
-# ==============================
-# EC2 UTILITIES
-# ==============================
-def describe_instances(filters: Optional[List[Dict[str, str]]] = None) -> List[Dict[str, str]]:
-    """
-    Describes EC2 instances based on the provided filters.
-
-    Args:
-        filters (List[Dict[str, str]], optional): List of filters for querying EC2 instances.
-
-    Returns:
-        List[Dict[str, str]]: List of EC2 instance details.
-    """
-    try:
-        ## ✅ Apply Default Filter if None Provided
-        filters = filters or [{"Name": f"tag:{DEFAULT_TAG_KEY}", "Values": [DEFAULT_TAG_VALUE]}]
-        logger.info(f"🔍 Querying EC2 instances with filters: {filters}")
-
-        instances = []
-        paginator = ec2_client.get_paginator("describe_instances")
-
-        ## ✅ Paginate Results
-        for page in paginator.paginate(Filters=filters):
-            for reservation in page["Reservations"]:
-                for instance in reservation["Instances"]:
-                    instances.append(
-                        {
-                            "InstanceId": instance["InstanceId"],
-                            "State": instance["State"]["Name"],
-                            "InstanceType": instance["InstanceType"],
-                            "LaunchTime": str(instance["LaunchTime"]),
-                            "Tags": instance.get("Tags", []),
-                        }
-                    )
-
-        ## ✅ Log Results
-        logger.info(f"✅ Found {len(instances)} instance(s).")
-        return instances
-
-    except ClientError as e:
-        logger.error(f"❌ AWS Client Error: {e}")
-        raise
-
-    except BotoCoreError as e:
-        logger.error(f"❌ BotoCore Error: {e}")
-        raise
-
-    except Exception as e:
-        logger.error(f"❌ Unexpected Error: {e}")
-        raise
-
-
-# ==============================
-# DISPLAY UTILITIES
-# ==============================
-def display_instances(instances: List[Dict[str, str]]) -> None:
-    """
-    Displays instance details in Markdown table format.
-
-    Args:
-        instances (List[Dict[str, str]]): List of EC2 instance details.
-    """
-    if not instances:
-        print("No instances found.")
-        return
-
-    ## ✅ Markdown Table Header
-    table_header = (
-        "| Instance ID     | State      | Type       | Launch Time             | Tags                           |"
-    )
-    table_divider = (
-        "|----------------|------------|------------|--------------------------|--------------------------------|"
-    )
-    print(table_header)
-    print(table_divider)
-
-    ## ✅ Print Each Instance Row
-    for instance in instances:
-        tags = ", ".join([f"{tag['Key']}={tag['Value']}" for tag in instance.get("Tags", [])])
-        print(
-            f"| {instance['InstanceId']:15} | {instance['State']:10} | {instance['InstanceType']:10} | "
-            f"{instance['LaunchTime']:24} | {tags:30} |"
-        )
-
-
-def display_instances_json(instances: List[Dict[str, str]]) -> None:
-    """
-    Displays instance details in JSON format for automation tools.
-
-    Args:
-        instances (List[Dict[str, str]]): List of EC2 instance details.
-    """
-    (print(json.dumps(instances, indent=4)) if instances else print("No instances found."))
-
-
-# ==============================
-# CLI HANDLER
-# ==============================
-def main():
-    """
-    Main function for CLI execution.
-    """
-    try:
-        ## ✅ Parse Command-Line Arguments
-        tag_key = sys.argv[1] if len(sys.argv) > 1 else DEFAULT_TAG_KEY
-        tag_value = sys.argv[2] if len(sys.argv) > 2 else DEFAULT_TAG_VALUE
-
-        ## ✅ Construct Filters
-        filters = [{"Name": f"tag:{tag_key}", "Values": [tag_value]}]
-
-        ## ✅ Fetch and Display Instances
-        instances = describe_instances(filters)
-        ## ✅ Display Instances: Default to markdown table format
-        # display_instances_json(instances)
-        display_instances(instances)
-
-    except Exception as e:
-        logger.error(f"❌ Fatal Error: {e}")
-        sys.exit(1)
-
-
-# ==============================
-# AWS LAMBDA HANDLER
-# ==============================
-def lambda_handler(event, context):
-    """
-    AWS Lambda Handler for describing EC2 instances.
-
-    Args:
-        event (dict): AWS event data.
-        context: AWS Lambda context.
-    """
-    try:
-        ## ✅ Extract Inputs from Event
-        tag_key = event.get("tag_key", DEFAULT_TAG_KEY)
-        tag_value = event.get("tag_value", DEFAULT_TAG_VALUE)
-        output_format = event.get("output_format", "table")  ## Supports 'table' or 'json'
-
-        ## ✅ Construct Filters
-        filters = [{"Name": f"tag:{tag_key}", "Values": [tag_value]}]
-
-        ## ✅ Fetch EC2 Instances
-        instances = describe_instances(filters)
-
-        ## ✅ Return Lambda Response: Generate Output
-        if output_format == "json":
-            return {"statusCode": 200, "body": json.dumps(instances, indent=4)}
-        else:
-            table_output = []
-            for instance in instances:
-                tags = ", ".join([f"{tag['Key']}={tag['Value']}" for tag in instance.get("Tags", [])])
-                table_output.append(
-                    f"| {instance['InstanceId']:15} | {instance['State']:10} | {instance['InstanceType']:10} | "
-                    f"{instance['LaunchTime']:24} | {tags:30} |"
-                )
-            return {"statusCode": 200, "body": "\n".join(table_output)}
-
-    except Exception as e:
-        logger.error(f"❌ Lambda Error: {e}")
-        return {"statusCode": 500, "body": json.dumps({"error": str(e)})}
-
-
-# ==============================
-# SCRIPT ENTRY POINT
-# ==============================
-if __name__ == "__main__":
-    main()

runbooks/aws/ec2_ebs_snapshots_delete.py

@@ -1,186 +0,0 @@
-#!/usr/bin/env python3
-
-"""
-Script to delete EBS snapshots older than the specified retention period.
-
-Author: nnthanh101@gmail.com
-Date: 2025-01-09
-Version: 1.0.0
-"""
-
-import json
-import os
-import sys
-from datetime import datetime, timedelta, timezone
-from typing import Dict, List
-
-import boto3
-from botocore.exceptions import BotoCoreError, ClientError
-
-from runbooks.utils.logger import configure_logger
-
-## ✅ Configure Logger
-logger = configure_logger(__name__)
-
-# ==============================
-# CONFIGURATIONS
-# ==============================
-## ✅ Default Environment Variables
-RETENTION_DAYS = int(os.getenv("RETENTION_DAYS", 30))  ## Default retention: 30 days
-DRY_RUN = os.getenv("DRY_RUN", "false").lower() == "true"  ## Dry run mode
-OWNER_ID = os.getenv("OWNER_ID", "self")  ## Default Owner ID (current AWS account)
-
-
-# ==============================
-# AWS CLIENT INITIALIZATION
-# ==============================
-ec2 = boto3.resource("ec2")
-
-
-# ==============================
-# UTILITY FUNCTIONS
-# ==============================
-def get_old_snapshots(retention_days: int, owner_id: str) -> List[Dict[str, str]]:
-    """
-    Retrieves EBS snapshots older than the retention period.
-
-    Args:
-        retention_days (int): Number of days to retain snapshots.
-        owner_id (str): AWS account ID for snapshot filtering.
-
-    Returns:
-        List[Dict[str, str]]: List of snapshots metadata.
-    """
-    try:
-        logger.info(f"Retrieving snapshots owned by '{owner_id}' older than {retention_days} days ...")
-        cutoff_time = datetime.now(tz=timezone.utc) - timedelta(days=retention_days)
-
-        ## ✅ Fetch snapshots
-        snapshots = ec2.snapshots.filter(OwnerIds=[owner_id])
-
-        ## ✅ Filter old snapshots
-        old_snapshots = [
-            {
-                "SnapshotId": snap.snapshot_id,
-                "StartTime": str(snap.start_time),
-                "State": snap.state,
-                "VolumeId": snap.volume_id,
-                "Description": snap.description,
-            }
-            for snap in snapshots
-            if snap.start_time < cutoff_time
-        ]
-
-        logger.info(f"Found {len(old_snapshots)} snapshots older than {retention_days} days.")
-        return old_snapshots
-
-    except (BotoCoreError, ClientError) as e:
-        logger.error(f"AWS Error: {e}")
-        raise
-    except Exception as e:
-        logger.error(f"Unexpected error: {e}")
-        raise
-
-
-def delete_snapshots(snapshots: List[Dict[str, str]], dry_run: bool) -> None:
-    """
-    Deletes specified snapshots based on dry-run mode.
-
-    Args:
-        snapshots (List[Dict[str, str]]): List of snapshots to delete.
-        dry_run (bool): If true, no actual deletion will be performed.
-    """
-    for snap in snapshots:
-        try:
-            snapshot = ec2.Snapshot(snap["SnapshotId"])
-            if dry_run:
-                logger.info(f"[DRY-RUN] Snapshot {snap['SnapshotId']} would be deleted.")
-            else:
-                snapshot.delete()
-                logger.info(f"Deleted snapshot: {snap['SnapshotId']} - Created on {snap['StartTime']}")
-
-        except (BotoCoreError, ClientError) as e:
-            logger.error(f"Failed to delete snapshot {snap['SnapshotId']}: {e}")
-        except Exception as e:
-            logger.error(f"Unexpected error for snapshot {snap['SnapshotId']}: {e}")
-
-
-def output_snapshots(snapshots: List[Dict[str, str]], format_type: str = "table") -> None:
-    """
-    Displays snapshots in either markdown table or JSON format.
-
-    Args:
-        snapshots (List[Dict[str, str]]): Snapshots to display.
-        format_type (str): Output format ('table' or 'json').
-    """
-    if format_type == "json":
-        print(json.dumps(snapshots, indent=4))
-    else:
-        print(
-            "| Snapshot ID       | Volume ID        | Created At              | State      | Description              |"
-        )
-        print(
-            "|-------------------|------------------|-------------------------|------------|--------------------------|"
-        )
-        for snap in snapshots:
-            print(
-                f"| {snap['SnapshotId']:18} | {snap['VolumeId']:16} | {snap['StartTime']:23} "
-                f"| {snap['State']:10} | {snap['Description'][:25]:25} |"
-            )
-
-
-# ==============================
-# MAIN FUNCTION
-# ==============================
-def main():
-    """
-    Main function for CLI usage.
-    """
-    try:
-        ## ✅ Fetch Old Snapshots
-        old_snapshots = get_old_snapshots(RETENTION_DAYS, OWNER_ID)
-
-        ## ✅ Display Snapshots
-        output_format = sys.argv[1] if len(sys.argv) > 1 else "table"
-        output_snapshots(old_snapshots, format_type=output_format)
-
-        ## ✅ Delete Snapshots
-        delete_snapshots(old_snapshots, dry_run=DRY_RUN)
-
-    except Exception as e:
-        logger.error(f"Failed to execute script: {e}")
-        sys.exit(1)
-
-
-# ==============================
-# LAMBDA HANDLER
-# ==============================
-def lambda_handler(event, context):
-    """
-    AWS Lambda handler for deleting EBS snapshots.
-
-    Args:
-        event (dict): Input event data.
-        context: Lambda execution context.
-    """
-    try:
-        retention_days = int(event.get("retention_days", RETENTION_DAYS))
-        dry_run = event.get("dry_run", DRY_RUN)
-        output_format = event.get("output_format", "json")
-
-        ## ✅ Fetch and Display Snapshots
-        old_snapshots = get_old_snapshots(retention_days, OWNER_ID)
-        output_snapshots(old_snapshots, format_type=output_format)
-
-        ## ✅ Delete Snapshots
-        delete_snapshots(old_snapshots, dry_run=dry_run)
-
-        return {"statusCode": 200, "body": json.dumps({"deleted": len(old_snapshots)})}
-
-    except Exception as e:
-        logger.error(f"Lambda Error: {e}")
-        return {"statusCode": 500, "body": str(e)}
-
-
-if __name__ == "__main__":
-    main()