Skip to content

Commit f4a111b

Browse files
committed
docs(weathertop): add quick-start checklist and troubleshooting notes
1 parent 6c0d61d commit f4a111b

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

.tools/test/README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,3 +69,41 @@ See [CDK stack](stacks/plugin).
6969
There are several options for deploying this stack.
7070

7171
See [DEPLOYMENT.md](DEPLOYMENT.md) for more information.
72+
73+
## Quick start (operator checklist)
74+
75+
Use this quick path when setting up Weathertop test infrastructure in a new account.
76+
77+
1. **Install prerequisites**
78+
- AWS CLI v2 configured for the target account(s)
79+
- Node.js + npm
80+
- AWS CDK v2
81+
- Docker (for image build/push workflows)
82+
2. **Bootstrap CDK environment** (if not already bootstrapped):
83+
- `cdk bootstrap`
84+
3. **Deploy stacks in this order**
85+
- `Images` (creates ECR repos)
86+
- `Admin` (creates scheduled publisher)
87+
- `Plugin` (consumes queue events and runs tests)
88+
4. **Verify image availability**
89+
- Confirm language images exist in ECR before expecting jobs to run.
90+
5. **Validate event flow**
91+
- Confirm scheduled event -> SNS -> SQS subscription -> Plugin Lambda invocation.
92+
6. **Validate batch execution**
93+
- Confirm AWS Batch jobs start and write expected logs/results.
94+
95+
## Common setup pitfalls
96+
97+
- **No images in ECR**: Plugin jobs fail because runtime images do not exist yet.
98+
- **Cross-account subscription gaps**: SNS topic policy/SQS subscription not fully configured.
99+
- **Missing IAM permissions**: Lambda cannot submit Batch jobs or read required resources.
100+
- **Region mismatch**: resources deployed in one region while eventing/config expects another.
101+
102+
## Operational success signals
103+
104+
A healthy setup should show:
105+
106+
- Scheduled or manual event publishes successfully.
107+
- Plugin Lambda receives and processes queue messages.
108+
- Batch jobs transition through `SUBMITTED` -> `RUNNING` -> `SUCCEEDED`.
109+
- Result artifacts/logs are generated for expected SDK targets.

0 commit comments

Comments
 (0)