Jon Chery
895a2f3806
---ci--- project: acdl phase: 20 milestone: v1.5 status: specify ---/ci--- Add v1.5 milestone to ROADMAP.md + REQUIREMENTS.md. Phase 20 covers REQ-46 (README consumer model + mermaid + L3B/spike scrub), REQ-47 (generic CONSUMER_GUIDE.md + versioned uses: + consumer-scoped prereqs + run-time platform fetch), REQ-48 (zero-trust OIDC/ABAC credentials + static-key override + daily rotation), REQ-49 (reusable byte-identical deploy.yml Gitea+GitHub implementing pipelines/deploy.yaml), REQ-50 (contracts/static-asset.yaml @v1.4), REQ-51 (deploy-workflow conformance tests). Update config.json milestone to v1.5.
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. |