Jon Chery
3508671377
The L2 thin-composition layer (composition.json + contract_resolver.py + contract schema + sample contracts) has been removed completely. The implementation was unsatisfactory and is deferred for a later redesign. - Delete: composition.json x2, contract_resolver.py, contracts/ x2, contract.schema.json - Patch: run_platform.sh now loads a pre-existing IR instance instead of resolving a contract (the downstream adapter/checkov/confidence/outbox pipeline is unchanged) - Prune: L2 entries removed from registry.json (L1 entries unchanged) - Rewrite: all 7 L1 module READMEs in plain language (no jargon), each with Resources/Inputs/Outputs/Usage/Compliance-extension-points/Versioning sections derived from interface.json - Add: 2 L2 placeholder READMEs noting the composition is under redesign - Add: modules-ir/README.md catalog index + README-TEMPLATE.md ---ci--- project: acdl phase: 17 milestone: v1.3 status: execute ---/ci---
48 lines
1.3 KiB
Markdown
48 lines
1.3 KiB
Markdown
# <module-name> — <plain-language description>
|
|
|
|
> **Module kind:** L1 primitive | **Version:** 1.0.0
|
|
|
|
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. |