Jon Chery
431341a0ab
Four-layer verification: structural, behavioral, security, quality all pass. One P1 (AWS account ID in l1-ecs-service README usage example) deferred to post-hoc review — same account ID already in terraform/microservice/main.tf. Fixed: README template missing ## Overview header. ---ci--- project: acdl phase: 17 milestone: v1.3 status: verify ---/ci---
50 lines
1.3 KiB
Markdown
50 lines
1.3 KiB
Markdown
# <module-name> — <plain-language description>
|
|
|
|
> **Module kind:** L1 primitive | **Version:** 1.0.0
|
|
|
|
## Overview
|
|
|
|
One or two sentences describing what this module provisions, in plain
|
|
language. No jargon. A reader should know after this paragraph whether
|
|
this module is what they need.
|
|
|
|
## Resources
|
|
|
|
Terraform resources this module creates:
|
|
|
|
| Resource | Type | Purpose |
|
|
|----------|------|---------|
|
|
| `<name>` | `aws_<type>` | what it does |
|
|
|
|
## Inputs
|
|
|
|
| Name | Type | Required | Default | Description |
|
|
|------|------|----------|---------|-------------|
|
|
| `<name>` | string | yes | — | description |
|
|
|
|
## Outputs
|
|
|
|
| Name | Type | Description |
|
|
|------|------|-------------|
|
|
| `<name>` | string | description |
|
|
|
|
## Usage
|
|
|
|
```
|
|
# A concrete snippet showing how to reference this module or what a
|
|
# consumer writes to use it.
|
|
```
|
|
|
|
## Compliance extension points
|
|
|
|
Resources this module could be extended with for the future compliance
|
|
milestone (GDPR, SOX, SOC2, HIPAA, DORA). Not implemented yet — listed
|
|
so the redesign can plan for them.
|
|
|
|
- **<area>** — <what could be added, e.g. KMS key for encryption>
|
|
|
|
## Versioning
|
|
|
|
`1.0.0` — interface MAJOR, behavior MINOR, lifecycle PATCH. MAJOR
|
|
bumps require a new registry entry (immutable publication); old entries
|
|
enter a 12-month deprecation window. |