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

runbooks/__init__.py

@@ -1,13 +1,62 @@
 """
-CloudOps Runbooks - Enterprise CloudOps Automation Toolkit
-
-Provides comprehensive AWS automation capabilities including:
-- Cloud Foundations Assessment Tool (CFAT)
-- Multi-account resource inventory
-- Organization management
-- Control Tower automation
-- Identity and access management
-- Centralized logging setup
+CloudOps Runbooks - Enterprise AWS Automation & Cloud Foundations Toolkit
+
+A comprehensive enterprise-grade automation platform for AWS cloud operations,
+designed for CloudOps, DevOps, and SRE teams managing multi-account environments.
+
+## Core Capabilities
+
+### 🔍 Discovery & Assessment
+- **Cloud Foundations Assessment Tool (CFAT)**: Automated AWS environment discovery
+  and best practices assessment with actionable remediation guidance
+- **Multi-Account Inventory**: Comprehensive resource discovery across AWS Organizations
+- **Security Baseline Assessment**: Automated security posture evaluation
+- **Cost & Financial Operations**: Resource utilization and cost optimization analysis
+
+### ⚙️ Operations & Automation
+- **AWS Resource Operations**: Enterprise-grade EC2, S3, DynamoDB management
+- **Organization Management**: AWS Organizations structure and account automation
+- **Identity & Access Management**: Cross-account IAM role and policy management
+- **Infrastructure Automation**: CloudFormation, networking, and compliance operations
+
+### 🏛️ Enterprise Features
+- **Multi-Deployment Support**: CLI, Docker, AWS Lambda, Kubernetes ready
+- **Environment Configuration**: Comprehensive environment variable support
+- **Monitoring & Notifications**: SNS integration and operational awareness
+- **KISS Architecture**: Simple, maintainable, no-legacy-complexity design
+
+## Documentation
+
+For comprehensive documentation, examples, and best practices:
+https://cloudops.oceansoft.io/cloud-foundation/cfat-assessment-tool.html
+
+## Quick Start
+
+```python
+# Assessment and Discovery
+from runbooks.cfat import AssessmentRunner
+from runbooks.inventory import InventoryCollector
+from runbooks.security import SecurityBaselineTester
+
+# Operations and Automation
+from runbooks.operate import EC2Operations, S3Operations, DynamoDBOperations
+
+# Assessment
+runner = AssessmentRunner()
+results = runner.run_assessment()
+
+# Resource Operations
+ec2_ops = EC2Operations()
+s3_ops = S3Operations()
+```
+
+## Target Audience
+
+- **CloudOps Engineers**: Multi-account AWS environment management
+- **DevOps Teams**: Infrastructure automation and CI/CD integration
+- **Site Reliability Engineers (SRE)**: Operational excellence and monitoring
+- **Security Engineers**: Compliance assessment and remediation
+- **FinOps Practitioners**: Cost optimization and resource governance
 """
 
 from importlib.metadata import PackageNotFoundError
@@ -18,58 +67,59 @@ try:
     __version__ = _pkg_version("runbooks")
 except Exception:
     # Fallback if metadata is unavailable during editable installs
-    __version__ = "0.6.2"
+    __version__ = "0.7.6"
 
 # Core module exports
 from runbooks.config import RunbooksConfig, load_config, save_config
 from runbooks.utils import ensure_directory, setup_logging, validate_aws_profile
 
-# Cloud Foundations exports - using direct structure
+# Enterprise module exports with graceful degradation
 try:
+    # Assessment and Discovery
     from runbooks.cfat.runner import AssessmentRunner
+    from runbooks.inventory.collectors.aws_management import OrganizationsManager
     from runbooks.inventory.core.collector import InventoryCollector
-    from runbooks.organizations.manager import OUManager
-
-    __all__ = [
-        "__version__",
-        "setup_logging",
-        "load_config",
-        "save_config",
-        "RunbooksConfig",
+    from runbooks.operate.cloudformation_operations import CloudFormationOperations
+    from runbooks.operate.cloudwatch_operations import CloudWatchOperations
+    from runbooks.operate.dynamodb_operations import DynamoDBOperations
+
+    # Operations and Automation
+    from runbooks.operate.ec2_operations import EC2Operations
+    from runbooks.operate.iam_operations import IAMOperations
+    from runbooks.operate.s3_operations import S3Operations
+    from runbooks.security.security_baseline_tester import SecurityBaselineTester
+
+    _enterprise_exports = [
         "AssessmentRunner",
         "InventoryCollector",
-        "OUManager",
-        "ensure_directory",
-        "validate_aws_profile",
+        "OrganizationsManager",
+        "SecurityBaselineTester",
+        "EC2Operations",
+        "S3Operations",
+        "DynamoDBOperations",
+        "CloudFormationOperations",
+        "IAMOperations",
+        "CloudWatchOperations",
     ]
 except ImportError as e:
-    # Graceful degradation if dependencies aren't available
-    __all__ = [
-        "__version__",
-        "setup_logging",
-        "load_config",
-        "save_config",
-        "RunbooksConfig",
-        "ensure_directory",
-        "validate_aws_profile",
-    ]
+    # Graceful degradation if enterprise dependencies aren't available
+    _enterprise_exports = []
 
 # FinOps exports
 from runbooks.finops import get_cost_data, get_trend, run_dashboard
 
+# Consolidated exports for enterprise CloudOps platform
 __all__ = [
+    # Core utilities
     "__version__",
     "setup_logging",
     "load_config",
     "save_config",
     "RunbooksConfig",
-    "AssessmentRunner",
-    "InventoryCollector",
-    "OUManager",
     "ensure_directory",
     "validate_aws_profile",
-    # FinOps
+    # FinOps capabilities
     "run_dashboard",
     "get_cost_data",
     "get_trend",
-]
+] + _enterprise_exports

runbooks/cfat/README.md

@@ -1,49 +1,300 @@
-# Cloud Foundation Assessment Tool (CFAT)
-
-CFAT is an open-source solution designed to provide automated discovery of an AWS environment and its multi-account architecture. Additionally, CFAT will review the environment, checking for common configurations and best practices for your AWS Organization. The tool will produce a backlog of tasks to complete, along with remediation guidance. CFAT is simple to execute, requiring only that it be executed within the AWS Management Account in the AWS CloudShell.
-
->**Note:** CFAT can operate with `READONLY` permissions **plus CloudShell permissions** to the AWS account, and does not make any changes to the AWS environment. All information generated from the tool is outputted to your local AWS CloudShell environment.
-
-## How to Use
-
-1. Go into an AWS account which is a `Management Account` and open CloudShell terminal.
-![Find CloudShell](./docs/open-cloudshell.png)
-2. Ensure you have right now admin permissions or the proper *READONLY* permissions that include ability to use AWS CloudShell
-    * For least privilege readonly, leverage the IAM Managed Policies:
-        - `arn:aws:iam::aws:policy/ReadOnlyAccess`
-        - `arn:aws:iam::aws:policy/AWSCloudShellFullAccess`
-3. Within AWS CloudShell the following command: `curl -sSL https://raw.githubusercontent.com/cloud-foundations-on-aws/cloud-foundations-templates/main/cfat/run-assessment.sh | sh`
-![Run CloudShell](./docs/cloudshell-console-run.png)
-4. Watch screen scroll through output looking for any errors.
-<br/><img src="./docs/cloudshell-output.png" alt="drawing" width="50%" height="50%"/>
-5. Once done you will see the tool created a directory called ./cfat
-    * verify by running `ls` in the current working directory you are in
-6. The CFAT creates a zip archive containing several artifacts (see [Generated Documentation and Artifacts](#generated-documentation-and-artifacts))
-7. Within the CloudShell window, go to top right of the page and click on `Actions` button and click on `Download File`
-<br/><img src="./docs/cloudshell-download.png" alt="drawing" width="30%" height="30%"/>
-8. In the download file enter `./cfat/assessment.zip`
-<br/><img src="./docs/downloadfile.png" alt="drawing" width="50%" height="50%"/>
-9. File is download which you can unzip and view the generated documentation and artifacts.
-
-## Generated Documentation and Artifacts
-
-Running the CFAT produces an archive assessments folder `./cfat/assessment.zip` in the current working directory you run the program from. Unzipping the archive will enable you to access 4 files which were generated during the assessment:
-
-1. **cfat.txt** - file contains a detailed text report of the assessment. Use this file to determine work needed to be completed. An example of a generated report can be found at [./docs/cfat.txt](./docs/cfat.txt). As illustrated below, the header in the report will give you a quick status and an estimated level of effort (loe) to complete the requirements.
-![report header](./docs/report-header.png)
-2. **cfat-checks.csv** - output file of the table result which is located in the detailed report (cfat.txt). The csv output is to let you organize and sort the findings. An example of a generated report can be found at [./docs/cfat-checks.csv](./docs/cfat-checks.csv)
-![check output](./docs/checks-output.png)
-3. **asana-import.csv** - all tasks created in a csv file format that allow you to easily import the items into your Asana managed backlog. An example of a generated import can be found at [./docs/asana-import.csv](./docs/asana-import.csv)
-4. **jira-import.csv** - all tasks created in a csv file format that allow you to easily import the items into your Jira managed backlog. An example of a generated import can be found at[./docs/jira-import.csv](./docs/jira-import.csv)
-
-## Features
-
-* **Automated Discovery:** CFAT automates the discovery process, minimizing the need for manual checks and providing a quick overview of the environment.
-* **READONLY Access:** The tool operates with READONLY access (**plus CloudShell permissions**) to the AWS account, ensuring that it does not make any modifications or interfere with the existing setup.
-* **Importable Backlog:** The tool creates common project management software importable file allowing you to import CFAT findings into services like Jira and Asana.
-* **AWS CloudShell Compatibility:** CFAT is designed to be executed within AWS CloudShell, providing a convenient and secure environment for running discovery.
-* **Developed in JavaScript and AWS-SDK v3:** CFAT is implemented using JavaScript and relies on the latest AWS-SDK v3 for seamless interaction with AWS services.
-
-## Security Considerations
-
-* The tool is designed to operate with `READONLY` access (**plus permissions to run CloudShell**), minimizing the risk of unintended changes to your environment. All data is outputted into your local CloudShell environment.
+# Cloud Foundations Assessment Tool (CFAT)
+
+**CFAT** is an enterprise-grade, open-source solution designed to provide automated discovery and assessment of AWS environments and multi-account architectures. **Fully integrated with the CloudOps Runbooks CLI**, CFAT offers comprehensive evaluation against Cloud Foundations best practices with advanced enterprise features.
+
+CFAT reviews your environment, checking for common configurations and security best practices across your AWS Organization. The tool produces actionable findings with detailed remediation guidance, exportable to popular project management platforms.
+
+**Key Enterprise Features:**
+- 🚀 **Integrated CLI Experience**: Seamlessly integrated with `runbooks cfat` commands
+- 📊 **Multi-Format Reporting**: HTML, CSV, JSON, Markdown, and interactive web reports
+- ⚡ **Parallel Execution**: Configurable worker pools for fast assessment
+- 🎯 **Compliance Frameworks**: SOC2, PCI-DSS, HIPAA alignment support
+- 🔗 **Project Management Integration**: Direct export to Jira, Asana, ServiceNow
+- 🌐 **Interactive Web Reports**: Built-in web server for live report viewing
+- 🎚️ **Advanced Configuration**: Category filtering, severity thresholds, check customization
+
+>**Note:** CFAT operates with `READONLY` permissions to ensure security and compliance. The tool does not make any changes to your AWS environment - all outputs are generated locally for your analysis.
+
+## 🚀 Quick Start
+
+> **⚡ Enterprise Installation**: `pip install runbooks && runbooks cfat assess`
+
+### **Option 1: Install via PyPI (Recommended)**
+
+1. **Install the Package**:
+   ```bash
+   pip install runbooks
+   ```
+
+2. **Run Cloud Foundations Assessment**:
+   ```bash
+   # Basic comprehensive assessment
+   runbooks cfat assess
+   
+   # Assessment with HTML report
+   runbooks cfat assess --output html --output-file cfat_report.html
+   
+   # Target specific categories with critical severity
+   runbooks cfat assess --categories iam,cloudtrail --severity CRITICAL
+   ```
+
+3. **Advanced Usage Examples**:
+   ```bash
+   # Parallel execution with multiple output formats
+   runbooks cfat assess --parallel --max-workers 8 --output all
+   
+   # Compliance framework assessment
+   runbooks cfat assess --compliance-framework SOC2 --output json
+   
+   # Export to project management tools
+   runbooks cfat assess --export-jira findings.csv --export-asana tasks.csv
+   
+   # Interactive web report
+   runbooks cfat assess --serve-web --web-port 8080
+   ```
+
+---
+
+### **Option 2: Development Installation**
+
+1. **Clone and Setup**:
+   ```bash
+   git clone https://github.com/1xOps/CloudOps-Runbooks.git
+   cd CloudOps-Runbooks
+   
+   # Install with UV (Rust-based package manager)
+   curl -LsSf https://astral.sh/uv/install.sh | sh
+   uv sync --all-extras
+   ```
+
+2. **Run Assessment**:
+   ```bash
+   uv run python -m runbooks cfat assess --profile production
+   ```
+
+---
+
+### **Option 3: AWS CloudShell (Zero Setup)**
+
+1. **Open AWS CloudShell** in your Management Account
+2. **Install and Run**:
+   ```bash
+   pip install runbooks
+   runbooks cfat assess --output html
+   ```
+3. **Download Results** using CloudShell's download feature
+
+---
+
+### **CLI Command Reference**
+
+```bash
+# Main CFAT commands
+runbooks cfat --help                           # Show CFAT help
+runbooks cfat assess                           # Run comprehensive assessment
+runbooks cfat assess --output all              # Generate all report formats
+runbooks cfat assess --categories iam,vpc      # Assess specific categories
+runbooks cfat assess --severity CRITICAL       # Show only critical findings
+
+# Advanced features
+runbooks cfat assess --parallel --max-workers 10    # Fast parallel execution
+runbooks cfat assess --compliance-framework SOC2    # Compliance alignment
+runbooks cfat assess --export-jira jira.csv         # Export to Jira
+runbooks cfat assess --serve-web --web-port 8080    # Interactive web report
+```
+
+### **Prerequisites**
+
+For least privilege readonly access, leverage these IAM Managed Policies:
+- `arn:aws:iam::aws:policy/ReadOnlyAccess`
+- `arn:aws:iam::aws:policy/AWSCloudShellFullAccess` (if using CloudShell)
+
+**Supported Authentication Methods:**
+- AWS Profiles (recommended)
+- IAM Roles
+- AWS SSO
+- Environment Variables
+- Instance Profiles
+- AWS CloudShell (automatic)
+
+## 📊 Generated Reports and Artifacts
+
+CFAT generates comprehensive, multi-format reports designed for different audiences and use cases. The modern integrated CLI provides multiple output options for maximum flexibility.
+
+### **Output Formats**
+
+1. **📋 HTML Reports** (Default)
+   - Interactive, styled reports with charts and filtering
+   - Remediation links directly to AWS documentation
+   - Executive summary with compliance scoring
+   - Technical details with step-by-step guidance
+   ```bash
+   runbooks cfat assess --output html --output-file assessment_report.html
+   ```
+
+2. **📈 JSON Output** (Programmatic Integration)
+   - Structured data for CI/CD pipelines
+   - API integration and automation workflows
+   - Custom dashboard development
+   ```bash
+   runbooks cfat assess --output json --output-file findings.json
+   ```
+
+3. **📊 CSV Export** (Data Analysis)
+   - Spreadsheet-compatible format
+   - Sorting and filtering capabilities
+   - Project tracking and progress monitoring
+   ```bash
+   runbooks cfat assess --output csv --output-file assessment_data.csv
+   ```
+
+4. **📝 Markdown Reports** (Documentation)
+   - Documentation-friendly format
+   - GitHub/GitLab integration
+   - Wiki and knowledge base publishing
+   ```bash
+   runbooks cfat assess --output markdown --output-file assessment.md
+   ```
+
+5. **🌐 Interactive Web Reports**
+   - Live web server with real-time filtering
+   - Collaborative review and discussion
+   - Professional presentation format
+   ```bash
+   runbooks cfat assess --serve-web --web-port 8080
+   ```
+
+### **Project Management Integration**
+
+**Direct Export to Popular Platforms:**
+
+1. **Jira Integration**
+   ```bash
+   runbooks cfat assess --export-jira jira_backlog.csv
+   ```
+   - Pre-formatted for Jira import
+   - Issue types and priorities mapped
+   - Sprint planning ready
+
+2. **Asana Integration**
+   ```bash
+   runbooks cfat assess --export-asana asana_tasks.csv
+   ```
+   - Task hierarchy and dependencies
+   - Team assignment capabilities
+   - Progress tracking features
+
+3. **ServiceNow Integration**
+   ```bash
+   runbooks cfat assess --export-servicenow snow_incidents.json
+   ```
+   - Enterprise ITSM compatibility
+   - Incident and change management
+   - SLA and priority mapping
+
+### **All-in-One Export**
+
+Generate all formats simultaneously:
+```bash
+runbooks cfat assess --output all
+```
+
+This creates:
+- `cfat_report_TIMESTAMP.html` - Interactive HTML report
+- `cfat_report_TIMESTAMP.json` - Structured data export
+- `cfat_report_TIMESTAMP.csv` - Spreadsheet-compatible data
+- `cfat_report_TIMESTAMP.md` - Documentation format
+
+## 🎯 Assessment Capabilities
+
+### **Multi-Account Architecture Discovery**
+- **Organization Mapping**: Automatic discovery of AWS Organizations structure
+- **Account Inventory**: Comprehensive multi-account resource discovery  
+- **Cross-Account Analysis**: Consolidated findings across organizational units
+- **Resource Relationships**: Dependency mapping and service interconnections
+
+### **Security & Compliance Assessment**
+- **Cloud Foundations Alignment**: AWS best practices validation
+- **Security Posture Evaluation**: IAM, network, data protection analysis
+- **Compliance Framework Support**: SOC2, PCI-DSS, HIPAA alignment
+- **Risk Scoring**: Weighted risk assessment with remediation prioritization
+
+### **Operational Excellence**
+- **Configuration Drift Detection**: Identification of non-compliant configurations
+- **Performance Optimization**: Resource utilization and cost efficiency analysis
+- **Automation Readiness**: Infrastructure as Code (IaC) compatibility assessment
+- **Monitoring Coverage**: CloudTrail, CloudWatch, and logging evaluation
+
+### **Enterprise Integration**
+- **CI/CD Pipeline Ready**: JSON output for automated workflows
+- **Project Management Export**: Native integration with Jira, Asana, ServiceNow
+- **Dashboard Compatible**: Structured data for custom visualization
+- **API Integration**: Programmatic access for enterprise tooling
+
+### **Modern Technology Stack**
+- **Python & AWS SDK**: Built with latest boto3 and enterprise Python patterns
+- **Parallel Processing**: Configurable worker pools for optimal performance
+- **Pydantic Models**: Type-safe data validation and serialization
+- **UV Package Management**: Rust-based dependency management for speed
+- **Ruff Formatting**: Modern code quality and formatting standards
+
+## 🔒 Security Considerations
+
+### **Least Privilege Principle**
+- **Read-Only Access**: CFAT operates exclusively with `ReadOnlyAccess` permissions
+- **No Modifications**: Zero-write operations ensure your environment remains unchanged
+- **Audit Compliance**: All activities are logged through standard AWS CloudTrail
+- **Local Data Processing**: Assessment data is processed locally without external transmission
+
+### **Authentication & Authorization**
+- **Multiple Auth Methods**: Support for AWS profiles, IAM roles, SSO, CloudShell
+- **MFA Compatible**: Full support for multi-factor authentication requirements
+- **Cross-Account Roles**: Secure assessment across multiple AWS accounts
+- **Session Management**: Automatic credential refresh and secure session handling
+
+### **Data Protection**
+- **Local Storage Only**: All reports generated and stored locally
+- **No External Dependencies**: Assessment runs entirely within your AWS environment
+- **Encryption in Transit**: All AWS API calls use HTTPS/TLS encryption
+- **Temporary Credentials**: Support for temporary credential mechanisms
+
+### **Enterprise Security Features**
+- **Access Logging**: Comprehensive logging of all assessment activities
+- **Configuration Validation**: Security configuration assessment without exposure
+- **Compliance Reporting**: Security findings aligned with industry frameworks
+- **Audit Trail**: Complete audit trail for security and compliance teams
+
+### **Required IAM Permissions**
+
+**Minimum Required Policy** (Read-Only):
+```json
+{
+    "Version": "2012-10-17",
+    "Statement": [
+        {
+            "Effect": "Allow",
+            "Action": [
+                "iam:Get*",
+                "iam:List*",
+                "iam:GenerateCredentialReport",
+                "organizations:List*",
+                "organizations:Describe*",
+                "cloudtrail:Get*",
+                "cloudtrail:Describe*",
+                "config:Get*",
+                "config:Describe*",
+                "ec2:Describe*",
+                "s3:GetBucket*",
+                "s3:ListAllMyBuckets",
+                "cloudwatch:Describe*",
+                "cloudwatch:Get*"
+            ],
+            "Resource": "*"
+        }
+    ]
+}
+```
+
+**Recommended Managed Policies:**
+- `arn:aws:iam::aws:policy/ReadOnlyAccess`
+- `arn:aws:iam::aws:policy/AWSCloudShellFullAccess` (if using CloudShell)

runbooks/cfat/__init__.py

@@ -34,7 +34,7 @@ Example:
     print(f"Critical Issues: {report.summary.critical_issues}")
     ```
 
-Version: 0.5.0 (Enhanced with enterprise features)
+Version: 0.7.6 (Latest with enhanced CLI integration, rust tooling, and modern dependency stack)
 """
 
 # Core assessment engine
@@ -53,7 +53,7 @@ from runbooks.cfat.models import (
 from runbooks.cfat.runner import AssessmentRunner
 
 # Version info
-__version__ = "0.5.0"
+__version__ = "0.7.6"
 __author__ = "CloudOps Runbooks Team"
 
 # Public API exports

runbooks/finops/__init__.py

@@ -12,7 +12,7 @@ This module provides terminal-based AWS cost monitoring with features including:
 Integrated as a submodule of CloudOps Runbooks for enterprise FinOps automation.
 """
 
-__version__ = "0.7.0"
+__version__ = "0.7.6"
 
 # Core components
 # AWS client utilities

runbooks/finops/cli.py

@@ -10,7 +10,7 @@ from runbooks.finops.helpers import load_config_file
 
 console = Console()
 
-__version__ = "0.7.0"
+__version__ = "0.7.6"
 
 
 def welcome_banner() -> None:

runbooks/inventory/collectors/__init__.py

@@ -13,8 +13,16 @@ Categories:
     - aws_management: CloudFormation, Organizations, Control Tower, SSM
 """
 
+from runbooks.inventory.collectors.aws_compute import ComputeResourceCollector
+from runbooks.inventory.collectors.aws_management import ManagementResourceCollector, OrganizationsManager
+from runbooks.inventory.collectors.aws_networking import SubnetCollector, VPCCollector
 from runbooks.inventory.collectors.base import BaseResourceCollector
 
 __all__ = [
     "BaseResourceCollector",
+    "ComputeResourceCollector",
+    "VPCCollector",
+    "SubnetCollector",
+    "ManagementResourceCollector",
+    "OrganizationsManager",
 ]