continuous-intelligence/acdl
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 128 Wiki Activity

feat(P27): add Examples section to every module README (D-058)

Browse Source 
Each module README (10 primitives + 2 patterns) now has a ## Examples
section before ## Versioning, referencing and excerpting the validated
simple.yaml + complex.yaml (+ mysql.yaml for RDS) example contracts. The
RDS README includes a Multi-engine variation subsection (D-059).

---ci---
project: acdl
phase: 27
milestone: v1.7
status: execute
---/ci---
This commit is contained in:
Jon Chery
2026-07-22 20:23:48 +00:00
parent 4bd07a4fae
commit 94065a4fbc
12 changed files with 498 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
modules/l2/microservice/README.md
+42
View File
@@ -63,6 +63,48 @@ compliance milestone (GDPR, SOX, SOC2, HIPAA, DORA) lands:
See each primitive's README for per-module compliance extension points.
## Examples
Validated example contracts are in [`examples/`](examples/). The platform-test
pipeline validates them against `schemas/contract.schema.json`.
### Simple
A minimal deployment (minimal Fargate, no ALB):
[`examples/simple.yaml`](examples/simple.yaml)
```yaml
# Simple microservice deployment (minimal Fargate, no ALB)
uses: acdl/pipelines/deploy.yaml@v1.6
module: microservice
environment: dev
inputs:
bucket_name: my-microservice-demo
region: us-east-1
image: public.ecr.aws/docker/library/nginx:latest
port: 80
```
### Complex
A production deployment with optional inputs (ALB + env vars + health check):
[`examples/complex.yaml`](examples/complex.yaml)
```yaml
# Complex microservice with ALB + env vars + health check
uses: acdl/pipelines/deploy.yaml@v1.6
module: microservice
environment: dev
inputs:
bucket_name: my-production-microservice
region: us-east-1
image: public.ecr.aws/docker/library/nginx:latest
port: 8080
env:
LOG_LEVEL: info
ENVIRONMENT: production
```
## Versioning
`1.0.0` — interface MAJOR, behavior MINOR, lifecycle PATCH. MAJOR bumps
modules/l2/static-assets/README.md
+42
View File
@@ -93,6 +93,48 @@ milestone (GDPR, SOX, SOC2, HIPAA, DORA) lands:
See the per-primitive READMEs for the per-module compliance extension
points.
## Examples
Validated example contracts are in [`examples/`](examples/). The platform-test
pipeline validates them against `schemas/contract.schema.json`.
### Simple
A minimal deployment (S3 bucket only — no CloudFront/WAF):
[`examples/simple.yaml`](examples/simple.yaml)
```yaml
# Simple static-assets deployment (S3 bucket only — no CloudFront/WAF)
# This is the simplest way to deploy a static site: just an S3 bucket.
uses: acdl/pipelines/deploy.yaml@v1.6
module: static-assets
environment: dev
inputs:
bucket_name: my-static-site
region: us-east-1
```
### Complex
A production deployment with optional inputs (S3 + CloudFront + WAF):
[`examples/complex.yaml`](examples/complex.yaml)
```yaml
# Complex static-assets deployment (S3 + CloudFront + WAF)
# The full production stack: S3 origin + CloudFront CDN edge + WAF protection.
uses: acdl/pipelines/deploy.yaml@v1.6
module: static-assets
environment: dev
inputs:
bucket_name: my-production-static-site
region: us-east-1
price_class: PriceClass_100
viewer_protocol_policy: redirect-to-https
default_ttl: 3600
max_ttl: 86400
waf_enabled: true
```
## Versioning
`1.0.0` — interface MAJOR, behavior MINOR, lifecycle PATCH. MAJOR bumps