AWS Well-Architected Labs
repository·main·Indexed 24 days ago
https://github.com/awslabs/aws-well-architected-labsA collection of workshops and hands-on labs designed to help users learn, measure, and build infrastructure using architectural best practices based on the six pillars of the AWS Well-Architected Framework. Includes documentation on Cloud Intelligence Dashboards, AppResiliency for testing EC2, RDS, and S3, and guides for configuring AWS credentials.
What's inside aws-well-architected-labs
- The AWS Well-Architected Labs site provides a collection of workshops and hands-on labs designed to help users learn, measure, and build infrastructure using architectural best practices. The labs are organized according to the six pillars of the AWS Well-Architected Framework.
Overview of Cloud Intelligence Dashboards
mainCloud Intelligence Dashboards is an open-source framework designed to provide actionable insights and optimization opportunities at scale. It is supported by the AWS Well-Architected framework and helps organizations drive financial accountability, optimize costs, track usage goals, implement governance best practices, and achieve operational excellence.
Dashboards can be deployed using:
- CloudFormation templates
- Command-line tools in your local environment.
Overview of Hugo Learn Theme features
mainThe Hugo Learn Theme provides several built-in features for documentation sites, including:
- Navigation: Unlimited menu levels and automatic next/prev buttons for navigating menu entries.
- Search: Automatic search functionality.
- Content Elements: Mermaid diagrams (flowcharts, sequence, gantt), Tip/Note/Info/Warning boxes, Expandable sections, and Buttons.
- Media: Image resizing and shadows, and support for attachment files.
- Localization: Multilingual mode.
- Customization: Customizable look, feel, and theme variants.
Automating Serverless Best Practices with Dashbird
mainThis lab demonstrates how to use Dashbird to continuously run best practice checks against serverless workloads. It provides actionable advice to improve applications in alignment with AWS Well-Architected best practices by monitoring logs, metrics, and configurations at scale.
Architecture Overview
The lab uses a serverless web application composed of:
- AWS Amplify: Static Web Hosting.
- AWS Cognito: Authentication to secure the backend API.
- Amazon API Gateway: Securing the REST API.
- AWS Lambda: Running code without provisioning infrastructure.
- Amazon DynamoDB: Fully managed NoSQL database.
Lab Workflow
- Deploy Blue Car application: Use the provided deployment script to set up the environment.
- Dashbird Well-Architected Insights: Connect your AWS account to Dashbird to discover insights based on best practices.
- Modern Load Test: Perform a load test to trigger further observability insights.
- Tear down: Remove resources to avoid unnecessary costs.
Key features of the Learn theme
mainThe Learn theme provides several built-in features for documentation sites:
- Automatic Search: Integrated search functionality.
- Multi-language Support: Built-in i18n capabilities.
- Infinite Menu Nesting: Support for deeply nested navigation structures.
- Automatic Pagination: 'Next' and 'Previous' buttons for menu items.
- Mermaid Diagrams: Support for flowcharts, sequence diagrams, and gantt charts via Mermaid.
- Shortcodes: Includes shortcodes for buttons, attachments, listing child pages, expand/collapse sections, and notice messages (Tip, Note, Info, Attention).
Use the AWS CUR Query Library for cost analysis
mainThe AWS CUR Query Library provides a collection of curated SQL queries designed to help you analyze Cost and Usage Report (CUR) data.
Key usage notes:
- Customization Required: Because cost analysis is unique to every business, these queries are intended to be modified to suit your specific organizational needs.
- Validation Recommended: Queries are provided "as is". Before making any financial decisions, you should validate the query results by comparing them against your monthly AWS bill and AWS Cost Explorer.
- Accessing the Library: The library is hosted on AWS Workshop Studio.
Understand the Well-Architected Labs structure
mainThe labs in this repository are designed as hands-on exercises to teach how to learn, measure, and build using architectural best practices. The content is organized into difficulty levels:
- 100 Series: Introductory labs.
- 200/300 Series: Intermediate labs.
- 400 Series: Advanced labs.
Main features of the Hugo Learn theme
mainThe Hugo Learn theme is designed specifically for documentation and includes the following features:
- Automatic Search: Built-in search functionality.
- Multilingual mode: Support for multiple languages.
- Navigation: Unlimited menu levels and automatic next/prev buttons for menu entries.
- Media & Diagrams: Image resizing/shadows, attachment files, and Mermaid diagram support (flowchart, sequence, gantt).
- Content Organization: Ability to list child pages.
- UI Components: Buttons, Tip/Note/Info/Warning boxes (via
noticeshortcode), and Expandable sections. - Customization: Customizable look, feel, and theme variants.
How the Hugo Learn theme organizes content
mainThe Learn theme uses a page tree structure to organize documentation. In this model, all content items are treated as pages, and pages are organized hierarchically where one page belongs to another (parent/child relationship). This structure enables features like unlimited menu levels and automatic next/prev navigation through menu entries.How tags behave in the Learn theme
mainWhen tags are added to a page, they appear at the top of the content. Each tag acts as a link to a Taxonomy page, which automatically lists all articles associated with that specific tag.Use Hugo shortcodes to extend Markdown functionality
mainHugo uses Markdown for content, but Markdown has limitations regarding complex layouts or features. Instead of using raw HTML—which can make source files difficult to read—you should use shortcodes.
A shortcode is a simple snippet inserted into a page that Hugo expands into more complex HTML during rendering. The
Hugo-theme-learntheme provides several custom shortcodes on top of the standard Hugo shortcodes to enhance content presentation.How the Learn Theme organizes content
mainThe Learn theme for Hugo uses a tree-like page structure to organize documentation. Content is structured such that pages belong to other pages, creating a hierarchical menu. This allows for infinite nesting levels in the navigation menu and automatic generation of 'Next' and 'Previous' buttons to navigate between menu items.