Skip to content

README.md

Latest commit

 

History

History
133 lines (97 loc) · 5.47 KB

README.md

File metadata and controls

133 lines (97 loc) · 5.47 KB

Well-Architected Framework Friendly Enhanced Layout (WAFFEL)

WAFFEL is an example that demonstrates how to transform AWS Well-Architected Framework data into clear, actionable insights. It supports both PDF reports and direct API access to the AWS Well-Architected Tool, reorganizing findings into an intuitive, user-friendly Excel format or executive PowerPoint presentations that highlight critical issues, prioritize recommendations, and present architectural improvements in a digestible manner.

Whether you're presenting to stakeholders, tracking remediation progress, or conducting regular architecture reviews, WAFFEL cuts through the complexity to deliver the information that matters most—turning architectural assessments from overwhelming documentation into a strategic roadmap for cloud excellence.

Input PDF Output Excel Output PowerPoint
AWS Well-Architected PDF Input Excel Output Example PowerPoint Output Example

See detailed output structure below for complete format descriptions.

Installation

pip3 install -U git+https://github.com/aws-samples/sample-waffel.git  #--break-system-packages

Usage

# Interactive mode - select from available PDFs or API
python3 -m waffel

PDF Input

# Direct file specification
python3 -m waffel assessment.pdf

# Custom output file
python3 -m waffel assessment.pdf -o custom_report.xlsx

# Generate PowerPoint presentation
python3 -m waffel assessment.pdf --pptx

API Input

# Interactive mode - select workload and lens
python3 -m waffel --api

# Specify workload ID, interactive lens selection
python3 -m waffel --api -w 12345678-1234-1234-1234-123456789012

# Specify both workload and lens
python3 -m waffel --api -w 12345678-1234-1234-1234-123456789012 -l wellarchitected

# Generate PowerPoint from API data
python3 -m waffel --api --pptx

Features

📊 Dual Input Support

  • PDF Processing: Parse Well-Architected Framework review reports
  • API Integration: Direct access to AWS Well-Architected Tool data
  • Interactive Selection: Choose workloads and lenses when parameters aren't specified
  • Unified Output: Same Excel/PowerPoint structure regardless of input source

📈 Multiple Output Formats

  • Excel Reports: Comprehensive analysis with multiple sheets and detailed breakdowns
  • PowerPoint Presentations: Executive-friendly improvement item cards with prioritization framework
  • Consistent Data: Same underlying data structure for both formats

🎯 Smart Organization

  • Multi-Sheet Structure: Summary, individual pillar tabs, improvement plan, workload properties
  • Expandable Grouping: Drill-down capability for detailed question analysis
  • Professional Formatting: Enterprise-ready output with proper styling
  • Risk Prioritization: Visual indicators (🔴 High, 🟡 Medium, 🟢 Low risk)

🎨 PowerPoint Features

  • Colored Cards: Small 3x1cm improvement item cards colored by pillar
  • Clickable Question IDs: Direct links to AWS documentation
  • Eisenhower Matrix: Full-height prioritization framework
  • Priority Planning: Empty slide for workshop sessions
  • Pastel Design: Professional, print-friendly color scheme

🔗 Intelligent URL Matching (PDF only)

  • Clickable Hyperlinks: Direct links to AWS documentation in improvement plans
  • Smart Association: AI-powered matching of improvement items to relevant URLs
  • Comprehensive Coverage: Links to Well-Architected best practices and implementation guides

📋 Executive Reporting

  • Summary Dashboard: High-level overview of assessment status across all pillars
  • Risk Prioritization: Clear identification of high-priority items requiring attention
  • Progress Tracking: Visual representation of assessment completion and remediation status

Output Structure

Excel Workbook

  1. Summary Sheet: Overview of all pillars with completion status and risk distribution
  2. Pillar Sheets: Detailed questions, choices, and risk levels for each pillar
  3. Improvement Plan: Actionable recommendations with clickable AWS documentation links (PDF only)
  4. Workload Properties: Extracted metadata including workload name, ARN, description, and environment

PowerPoint Presentation

  1. Title Slide: Workload overview and assessment summary
  2. Improvement Items: Compact colored cards showing all improvement actions
  3. Prioritization Framework: Full-height Eisenhower matrix for decision-making
  4. Priority Planning: Empty slide for workshop sessions and action planning

Supported Input Sources

  • PDF Reports: AWS Well-Architected Framework review PDF reports
  • API Access: Direct connection to AWS Well-Architected Tool via AWS APIs
  • Interactive Mode: Guided selection when parameters are missing

AWS Configuration

For API access, ensure your AWS credentials are configured:

# Via AWS CLI
aws configure

# Via environment variables
export AWS_ACCESS_KEY_ID=your_key
export AWS_SECRET_ACCESS_KEY=your_secret
export AWS_DEFAULT_REGION=us-east-1

# Via IAM roles (recommended for EC2/Lambda)

Required permissions:

  • wellarchitected:ListWorkloads
  • wellarchitected:GetWorkload
  • wellarchitected:ListLensReviews
  • wellarchitected:ListAnswers
  • wellarchitected:GetAnswer