Skip to content

Commit 60ab682

Browse files
committed
Add test artifacts quick reference documentation
Add quick reference guide for multi-attachment test artifacts including installation instructions and resource summary. - Add MULTI_TEST_ARTIFACTS_README.md with quick start guide - Document all test policies and thing groups - Include installation/uninstallation instructions
1 parent f3447b9 commit 60ab682

File tree

1 file changed

+71
-0
lines changed

1 file changed

+71
-0
lines changed
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Multi-Attachment Test Artifacts - Quick Reference
2+
3+
## Files
4+
5+
**Policies (3):**
6+
- `multi-test-policy-base.json` - Base connectivity
7+
- `multi-test-policy-sensor.json` - Sensor telemetry
8+
- `multi-test-policy-admin.json` - Admin operations
9+
10+
**Thing Groups (3):**
11+
- `multi-test-thing-group-dept.json` - Department: Engineering
12+
- `multi-test-thing-group-location.json` - Location: Seattle
13+
- `multi-test-thing-group-product.json` - Product: Sensor
14+
15+
**Scripts:**
16+
- `../scripts/install-multi-test-artifacts.sh` - Install all resources
17+
- `../scripts/uninstall-multi-test-artifacts.sh` - Remove all resources
18+
19+
**Documentation:**
20+
- `multi-attachment-test-artifacts.md` - Full specification
21+
22+
## Quick Start
23+
24+
### Install Resources
25+
26+
```bash
27+
cd /path/to/thingpress
28+
./scripts/install-multi-test-artifacts.sh us-east-1
29+
```
30+
31+
### Uninstall Resources
32+
33+
```bash
34+
./scripts/uninstall-multi-test-artifacts.sh us-east-1
35+
```
36+
37+
## Resources Created
38+
39+
| Type | Name | Purpose |
40+
|------|------|---------|
41+
| Policy | MultiTestBasePolicy | Base connectivity |
42+
| Policy | MultiTestSensorPolicy | Sensor operations |
43+
| Policy | MultiTestAdminPolicy | Admin operations |
44+
| Thing Group | multi-test-dept-engineering | Department hierarchy |
45+
| Thing Group | multi-test-location-seattle | Location hierarchy |
46+
| Thing Group | multi-test-product-sensor | Product hierarchy |
47+
48+
## Test Configuration
49+
50+
Use in SAM config:
51+
52+
```toml
53+
parameter_overrides = "IoTPolicies=\"MultiTestBasePolicy,MultiTestSensorPolicy,MultiTestAdminPolicy\" IoTThingGroups=\"multi-test-dept-engineering,multi-test-location-seattle,multi-test-product-sensor\" ..."
54+
```
55+
56+
## Cleanup
57+
58+
The uninstall script handles cleanup, but if manual cleanup is needed:
59+
60+
```bash
61+
# Detach policies from certificates first
62+
aws iot list-targets-for-policy --policy-name MultiTestBasePolicy
63+
# Then detach each...
64+
65+
# Remove things from groups first
66+
aws iot list-things-in-thing-group --thing-group-name multi-test-dept-engineering
67+
# Then remove each...
68+
69+
# Then run uninstall script
70+
./scripts/uninstall-multi-test-artifacts.sh
71+
```

0 commit comments

Comments
 (0)