Skip to content

Commit 038288b

Browse files
committed
feat(infrastructure): update description and references for AWS/Azure infrastructure diagram
1 parent 7b53191 commit 038288b

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

.github/prompts/architecture.06-infrastructure-diagram.prompt.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
---
22
agent: agent
3-
description: Produce AWS infrastructure diagram from Terraform (evidence-first, consistent with C4 container naming)
3+
description: Produce AWS/Azure infrastructure diagram from Terraform (evidence-first, consistent with C4 container naming)
44
---
55

66
**Mandatory preparation:** read [architecture overview](../instructions/includes/architecture-baseline.include.md) instructions in full and follow strictly its rules before executing any step below.
77

88
## Goal 🎯
99

10-
Create (or update) the [AWS infrastructure page](../../docs/architecture/aws-infrastructure.md) and [AWS infrastructure diagram](../../docs/architecture/aws-infrastructure.drawio), then export the diagram to PNG once complete.
10+
Create (or update) the [AWS/Azure infrastructure page](../../docs/architecture/cloud-infrastructure.md) and [AWS/Azure infrastructure diagram](../../docs/architecture/cloud-infrastructure.drawio), then export the diagram to PNG once complete.
1111

1212
Also ensure this work is linked from: [architecture overview](../../docs/architecture/README.md) output.
1313

1414
Constraints:
1515

1616
- Derive every element from Terraform/IaC code (no speculation)
17-
- Use AWS architecture styling, icons, and colour palette as provided by the official AWS icon set packaged in Draw.io
17+
- Use AWS/Azure architecture styling, icons, and colour palette as provided by the official AWS/Azure icon sets packaged in Draw.io
1818
- Keep diagram layers/groups consistent (e.g. networking, compute, data stores)
19-
- Label AWS accounts/regions when known
19+
- Label AWS/Azure accounts/regions when known
2020
- Keep names consistent with the C4 Container diagram where possible (service/container names), without inventing mappings
2121

2222
---
@@ -33,7 +33,7 @@ Constraints:
3333

3434
For each Terraform root/module:
3535

36-
1. List AWS providers and aliases in use.
36+
1. List AWS/Azure providers and aliases in use.
3737
2. Capture declared resources/data sources grouped by capability:
3838
- Network & security (VPC, subnets, routing, security groups, Network ACLs, Load Balancers, API Gateway, WAF)
3939
- Compute & container (EC2, ASG, ECS, EKS, Lambda, Batch)
@@ -56,7 +56,7 @@ For each Terraform root/module:
5656

5757
### 1) Build the infrastructure inventory
5858

59-
1. Create a tabular summary (working notes) of every AWS service present, including:
59+
1. Create a tabular summary (working notes) of every AWS/Azure service present, including:
6060
- Resource name/id pattern
6161
- Module/source file path
6262
- Environment/region/account (if available)
@@ -70,7 +70,7 @@ For each Terraform root/module:
7070

7171
### 2) Define diagram layers and grouping rules
7272

73-
1. Use AWS architecture best practices:
73+
1. Use AWS/Azure architecture best practices:
7474
- Group resources inside VPC/availability-zone containers
7575
- Separate networking, compute, data, and shared services layers
7676
- Annotate security boundaries (public subnet, private subnet, on-prem, third-party)
@@ -79,33 +79,33 @@ For each Terraform root/module:
7979

8080
### 3) Create or update draw.io diagram
8181

82-
1. Open `aws-infrastructure.drawio`.
82+
1. Open `cloud-infrastructure.drawio`.
8383
2. Reproduce the infrastructure based on Terraform evidence:
84-
- Place AWS icons for each major resource (ALB, ECS Service, RDS, etc.)
84+
- Place AWS/Azure icons for each major resource (ALB, ECS Service, RDS, etc.)
8585
- Connect components to show traffic/data direction (ingress → compute → data)
8686
- Annotate connections with protocols/ports if Terraform security groups or listeners provide that info
8787
3. Use Draw.io layers or groups to represent environments if multiple share the same page; otherwise create duplicate pages per environment.
8888
4. Record unresolved items in a dedicated **Unknown from code** sticky note inside the diagram (non-exporting layer) to maintain transparency.
89-
5. Where you can map an AWS "compute" resource to a deployable unit in the repo (from `repository-map.md` / C4 container diagram), label it accordingly and include a short evidence pointer. If you cannot map it, keep the label Terraform-derived and record **Unknown from code – map resource to deployable**.
89+
5. Where you can map an AWS/Azure "compute" resource to a deployable unit in the repo (from `repository-map.md` / C4 container diagram), label it accordingly and include a short evidence pointer. If you cannot map it, keep the label Terraform-derived and record **Unknown from code – map resource to deployable**.
9090

9191
### 4) Document evidence and outputs
9292

9393
1. Update [architecture overview](../../docs/architecture/README.md) with:
9494
- Link to the draw.io file (and PNG/SVG if exported)
9595
- Short summary of what the diagram covers (environments, date of last refresh)
96-
- Instructions to regenerate (e.g. "Open in draw.io desktop/web and refresh AWS icons from Terraform module XYZ")
97-
2. Add an **Evidence** section to `aws-infrastructure.md`, referencing Terraform files for each major diagram element.
96+
- Instructions to regenerate (e.g. "Open in draw.io desktop/web and refresh AWS/Azure icons from Terraform module XYZ")
97+
2. Add an **Evidence** section to `cloud-infrastructure.md`, referencing Terraform files for each major diagram element.
9898
3. If automation or scripts exist for exporting diagrams, document usage (command, output path) or record **Unknown from code – locate diagram export tooling**.
9999

100100
---
101101

102102
## Diagram style requirements
103103

104-
- Use the official AWS 2024 icon set within Draw.io (available via _Arrange → Insert → Advanced → AWS Architecture_ if not already loaded).
104+
- Use the official AWS/Azure 2024 icon set within Draw.io (available via _Arrange → Insert → Advanced → AWS/Azure Architecture_ if not already loaded).
105105
- Maintain consistent sizing and spacing; align elements using Draw.io guides.
106106
- Label subnets, route tables, and security zones directly on the canvas.
107107
- Use muted background colours for groups (VPC, AZ) to keep icons readable.
108-
- For external systems or SaaS providers not in AWS, use generic grey boxes with clear labels.
108+
- For external systems or SaaS providers not in AWS/Azure, use generic grey boxes with clear labels.
109109

110110
### Mandatory naming and labelling conventions
111111

@@ -114,7 +114,7 @@ Every infrastructure diagram must follow these naming rules verbatim (update exi
114114
1. **Resource nodes:** Use lowercase kebab-case `{service}-{role}-{scope}`, e.g. `alb-public-edge`, `ecs-task-api`, `rds-primary-app`. Names must map to Terraform modules, resource blocks, or tags so reviewers can trace them back.
115115
2. **Environment overlays:** Prefix or suffix with the environment name when multiple environments appear on the same page, e.g. `vpc-app-prod`, `ecs-service-orders-stg`.
116116
3. **Subnet and security groups:** Name subnets and zones as `{visibility}-subnet-{az}` (`public-subnet-a`, `private-subnet-b`) and security zones as `{zone}-security-zone`.
117-
4. **Accounts and regions:** Label AWS accounts with friendly name plus account ID (`acct-core (123456789012)`) and regions as `region-<code>` (`region-eu-west-2`). Place these labels on grouping containers.
117+
4. **Accounts and regions:** Label AWS/Azure accounts with friendly name plus account ID (`acct-core (123456789012)`) and regions as `region-<code>` (`region-eu-west-2`). Place these labels on grouping containers.
118118
5. **Arrow titles:** Label every arrow with `{protocol}/{port}` or `{action}` (e.g. `HTTPS/443`, `Publish events`, `Read replicas`). If both apply, prefer `HTTPS/443 – public ingress`.
119119
6. **Legend:** Include a small legend per diagram page describing arrow colours, border styles, and environment colouring (e.g. "orange arrows = ingress traffic", "blue arrows = data writes").
120120
7. **Unknowns:** Any placeholder or dotted element must be suffixed with `-pending` and accompanied by an **Unknown from code** sticky note referencing the missing evidence.
@@ -123,7 +123,7 @@ Every infrastructure diagram must follow these naming rules verbatim (update exi
123123

124124
## Quality gates
125125

126-
1. Validate the Draw.io file opens without errors (use the Draw.io desktop/web validator) and retains AWS icon library references.
126+
1. Validate the Draw.io file opens without errors (use the Draw.io desktop/web validator) and retains AWS/Azure icon library references.
127127
2. If a PNG/SVG export is stored, ensure it updates after modifications.
128128
3. Confirm Terraform formatting via `terraform fmt -check` in any touched directories when the prompt automation makes code changes (if part of its workflow).
129129
4. Ensure README links render correctly in Markdown (relative paths).
@@ -144,7 +144,7 @@ For every logical cluster (networking, compute, data, integration):
144144
Example evidence snippet:
145145

146146
```markdown
147-
### AWS Infrastructure
147+
### Cloud Infrastructure
148148

149149
## Diagram
150150

@@ -162,5 +162,5 @@ Example evidence snippet:
162162

163163
---
164164

165-
> **Version**: 1.1.3
166-
> **Last Amended**: 2026-01-17
165+
> **Version**: 1.1.4
166+
> **Last Amended**: 2026-02-19

0 commit comments

Comments
 (0)