Files

T

Jon Chery 553caf8f1d docs(P21): rewrite README + normalize modules terminology (REQ-52,55,56,57,58,59,60)

---ci---
project: acdl
phase: 21
milestone: v1.6
status: execute
---/ci---

README.md rewrite:
- Remove all .ciagent/ references (links + repository-layout row).
- Remove .gitea/workflows/ row from repository layout.
- Restate repository roles: consumer repo = app code + 1+ contracts +
  CI definitions (thin .github/workflows/*.yml uses:-ing the central
  workflow); platform repo owns modules/adapters/core/schemas/pipelines/
  scripts/workflows.
- Replace Status section with Features list (consumer + platform-engineer
  referenceable) + Roadmap (planned only, no version changelog, no
  internal CIAgent status). Includes the composition-redesign roadmap
  entry (dynamic module creation from a contract).
- Fix the mermaid flowchart: all node text visible (short multi-line
  labels via <br/>), add a security-checks stage before policy checks,
  do not name specific tools (security checks/policy checks/infrastructure
  plan via adapter), add infrastructure-apply stage (dev only, after
  evidence event).
- Remove the environments table (dev/qa/prod/dr) completely; point to
  docs/environments/ for platform-managed environments.
- Credentials section: remove go-gitea/gitea#36988 blocked mention +
  waivers D-039/D-047 language. State OIDC+ABAC default; alternative is a
  static AWS key (GitHub Secrets for platform-runner runs, .env.secrets
  locally) with daily rotation (platform-managed) or out-of-band rotation
  (consumer-managed for local .env.secrets).
- forge -> platform runners / platform-managed throughout.
- Links point to docs/ Pages paths, not .ciagent/.

modules/ terminology:
- modules/README.md: L1 primitives -> primitives, L2 compositions ->
  modules, composition -> pattern (prose); add roadmap note for the
  composition redesign.
- README-TEMPLATE.md: L1 primitive -> primitive.
- All 7 L1 READMEs: L1 primitive -> primitive.
- L2 static-asset + microservice READMEs: L2 composition -> module
  pattern, composition -> pattern, L1 -> primitive; bump stale @v1 ->
  @v1.4 in usage examples; fix CONSUMER_GUIDE.md -> consumer-guide.md
  link.

Verification: grep sweeps for .ciagent/.gitea/forge/go-gitea/waiver/
D-039/D-047/acdl_platform in docs/ README.md modules/ contracts/ all
return 0 hits. Tests: 166 pass. run_ci.sh green.

2026-07-22 18:26:00 +00:00

2.7 KiB

Raw Blame History

vpc — VPC with subnets and routing

Module kind: primitive | Version: 1.0.0

A VPC with one subnet per availability zone and a route table with a default route through an internet gateway. The networking foundation that other modules (ALB, ECS service) reference for subnet ids.

Resources

Resource	Type	Purpose
vpc	`aws_vpc`	The VPC itself
subnet	`aws_subnet`	One subnet per availability zone
route_table	`aws_route_table`	Route table with default route 0.0.0.0/0
internet_gateway	`aws_internet_gateway`	IGW for public internet access
route_table_association	`aws_route_table_association`	Binds subnet to route table

Inputs

Name	Type	Required	Default	Description
`cidr`	string	yes	—	VPC CIDR block, e.g. `10.0.0.0/16`
`azs`	string	yes	—	Comma-separated availability zones, e.g. `us-east-1a,us-east-1b`
`name`	string	yes	—	Name tag for the VPC and child resources
`region`	string	yes	—	AWS region the VPC is created in

Outputs

Name	Type	Description
`vpc_id`	string	The VPC id
`subnet_ids`	string	Comma-separated subnet ids

Usage

{
  "id": "vpc",
  "type": "aws:ec2:vpc",
  "module": "vpc@1.0.0",
  "inputs": {
    "cidr": "10.0.0.0/16",
    "azs": "us-east-1a,us-east-1b",
    "name": "acdl-microservice",
    "region": "us-east-1"
  }
}

The azs input is split on comma; one subnet is created per zone. The route table gets a default route 0.0.0.0/0 → internet gateway. Other modules reference subnet_ids for their network placement.

Compliance extension points

VPC Flow Logs — add aws_flow_log + CloudWatch Logs group / S3 destination (SOX ITGC, SOC2 CC7.2, HIPAA §164.312(b), DORA ICT risk logging).
Private subnets + NAT gateway — add private subnets with a NAT gateway so ECS tasks don't need public IPs (SOC2 CC6.6, PCI-DSS 1.3, HIPAA network isolation).
VPC endpoints — add S3, ECR, KMS, DynamoDB, CloudWatch interface/gateway endpoints to keep traffic off the public internet (SOC2 CC6.7, GDPR Art.32(1)(a), DORA ICT third-party risk).
Security groups — add aws_security_group as a first-class sub-resource (currently missing; needed for all regulated deployments) (SOC2 CC6.6, PCI-DSS 1.2).
Network ACLs — add aws_network_acl for subnet-level segmentation (PCI-DSS 1.3).

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.

2.7 KiB Raw Blame History