localstack/localstack-docs

[📑 Docs]: Expand page: Chaos Serverless Multi-Region Failover

Open

#230 opened on Sep 25, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)MDX (37 forks)github user discovery
awsdocumentationgood first issuehacktoberfest

Repository metrics

Stars
 (13 stars)
PR merge metrics
 (Avg merge 8d 13h) (87 merged PRs in 30d)

Description

What docs changes are you proposing?

Source: https://github.com/localstack-samples/sample-chaos-serverless-multi-region-failover

Problem

Currently this sample app is only linked as a GitHub repo. Users must leave the docs to understand it.

Proposal

  • Create a dedicated doc page with:
    • Introduction (purpose: simulate regional outages + failover)
    • Prerequisites (LocalStack Pro, Docker, SAM/CDK runtime, Node.js)
    • Architecture diagram (Region A + Region B, API Gateway/Lambda + Route 53 failover)
    • Steps (clone repo, deploy stacks, simulate outage)
    • Testing the application (invoke API in failover, verify Route 53 health checks)
    • Conclusion (resiliency testing patterns)

Acceptance Criteria

  • Page matches tutorial format with diagram and explicit Testing the application section.

Code of Conduct

  • I agree to follow this project's Code of Conduct

Contributor guide

Research direction
Review the sample repository at https://github.com/localstack samples/sample chaos serverless multi region failover and create a documentation page following the tutorial format with an architecture diagram and explicit testing section.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75