name: c4-container
description: Expert C4 Container-level documentation specialist. Synthesizes
tags: [ai, architecture]
C4 Container Level: System Deployment
Use this skill when
- Working on c4 container level: system deployment tasks or workflows
- Needing guidance, best practices, or checklists for c4 container level: system deployment
Do not use this skill when
- The task is unrelated to c4 container level: system deployment
- You need a different domain or tool outside this scope
Instructions
- Clarify goals, constraints, and required inputs.
- Apply relevant best practices and validate outcomes.
- Provide actionable steps and verification.
Containers
[Container Name]
- Name: [Container name]
- Description: [Short description of container purpose and deployment]
- Type: [Web Application, API, Database, Message Queue, etc.]
- Technology: [Primary technologies: Node.js, Python, PostgreSQL, Redis, etc.]
- Deployment: [Docker, Kubernetes, Cloud Service, etc.]
Purpose
[Detailed description of what this container does and how it's deployed]
Components
This container deploys the following components:
Interfaces
[API/Interface Name]
- Protocol: [REST/GraphQL/gRPC/Events/etc.]
- Description: [What this interface provides]
- Specification: [Link to OpenAPI/Swagger/API Spec file]
- Endpoints:
GET /api/resource - [Description]
POST /api/resource - [Description]
Dependencies
Containers Used
- [Container Name]: [How it's used, communication protocol]
External Systems
- [External System]: [How it's used, integration type]
Infrastructure
- Deployment Config: [Link to Dockerfile, K8s manifest, etc.]
- Scaling: [Horizontal/vertical scaling strategy]
- Resources: [CPU, memory, storage requirements]
Container Diagram
Use proper Mermaid C4Container syntax:
C4Container
title Container Diagram for [System Name]
Person(user, "User", "Uses the system")
System_Boundary(system, "System Name") {
Container(webApp, "Web Application", "Spring Boot, Java", "Provides web interface")
Container(api, "API Application", "Node.js, Express", "Provides REST API")
ContainerDb(database, "Database", "PostgreSQL", "Stores data")
Container_Queue(messageQueue, "Message Queue", "RabbitMQ", "Handles async messaging")
}
System_Ext(external, "External System", "Third-party service")
Rel(user, webApp, "Uses", "HTTPS")
Rel(webApp, api, "Makes API calls to", "JSON/HTTPS")
Rel(api, database, "Reads from and writes to", "SQL")
Rel(api, messageQueue, "Publishes messages to")
Rel(api, external, "Uses", "API")
**Key Principles** (from [c4model.com](https://c4model.com/diagrams/container)):
- Show **high-level technology choices** (this is where technology details belong)
- Show how **responsibilities are distributed** across containers
- Include **container types**: Applications, Databases, Message Queues, File Systems, etc.
- Show **communication protocols** between containers
- Include **external systems** that containers interact with
API Specification Template
For each container API, create an OpenAPI/Swagger specification:
openapi: 3.1.0
info:
title: [Container Name] API
description: [API description]
version: 1.0.0
servers:
- url: https://api.example.com
description: Production server
paths:
/api/resource:
get:
summary: [Operation summary]
description: [Operation description]
parameters:
- name: param1
in: query
schema:
type: string
responses:
'200':
description: [Response description]
content:
application/json:
schema:
type: object
Example Interactions
- "Synthesize all components into containers based on deployment definitions"
- "Map the API components to containers and document their APIs as OpenAPI specs"
- "Create container-level documentation for the microservices architecture"
- "Document container interfaces as Swagger/OpenAPI specifications"
- "Analyze Kubernetes manifests and create container documentation"
Key Distinctions
- vs C4-Component agent: Maps components to deployment units; Component agent focuses on logical grouping
- vs C4-Context agent: Provides container-level detail; Context agent creates high-level system diagrams
- vs C4-Code agent: Focuses on deployment architecture; Code agent documents individual code elements
Output Examples
When synthesizing containers, provide:
- Clear container boundaries with deployment rationale
- Descriptive container names and deployment characteristics
- Complete API documentation with OpenAPI/Swagger specifications
- Links to all contained components
- Mermaid container diagrams showing deployment architecture
- Links to deployment configurations (Dockerfiles, K8s manifests, etc.)
- Infrastructure requirements and scaling considerations
- Consistent documentation format across all containers
1---2name: c4-container3description: <!-- AUTO-GENERATED by export-skills.py — DO NOT EDIT -->4---5<!-- AUTO-GENERATED by export-skills.py — DO NOT EDIT -->6---7name: c4-container8description: Expert C4 Container-level documentation specialist. Synthesizes9tags: [ai, architecture]10---1112# C4 Container Level: System Deployment1314## Use this skill when1516- Working on c4 container level: system deployment tasks or workflows17- Needing guidance, best practices, or checklists for c4 container level: system deployment1819## Do not use this skill when2021- The task is unrelated to c4 container level: system deployment22- You need a different domain or tool outside this scope2324## Instructions2526- Clarify goals, constraints, and required inputs.27- Apply relevant best practices and validate outcomes.28- Provide actionable steps and verification.2930## Containers3132### [Container Name]3334- **Name**: [Container name]35- **Description**: [Short description of container purpose and deployment]36- **Type**: [Web Application, API, Database, Message Queue, etc.]37- **Technology**: [Primary technologies: Node.js, Python, PostgreSQL, Redis, etc.]38- **Deployment**: [Docker, Kubernetes, Cloud Service, etc.]3940## Purpose4142[Detailed description of what this container does and how it's deployed]4344## Components4546This container deploys the following components:4748- [Component Name]: [Description]49 - Documentation: [c4-component-name.md](./c4-component-name.md)5051## Interfaces5253### [API/Interface Name]5455- **Protocol**: [REST/GraphQL/gRPC/Events/etc.]56- **Description**: [What this interface provides]57- **Specification**: [Link to OpenAPI/Swagger/API Spec file]58- **Endpoints**:59 - `GET /api/resource` - [Description]60 - `POST /api/resource` - [Description]6162## Dependencies6364### Containers Used6566- [Container Name]: [How it's used, communication protocol]6768### External Systems6970- [External System]: [How it's used, integration type]7172## Infrastructure7374- **Deployment Config**: [Link to Dockerfile, K8s manifest, etc.]75- **Scaling**: [Horizontal/vertical scaling strategy]76- **Resources**: [CPU, memory, storage requirements]7778## Container Diagram7980Use proper Mermaid C4Container syntax:8182```mermaid83C4Container84 title Container Diagram for [System Name]8586 Person(user, "User", "Uses the system")87 System_Boundary(system, "System Name") {88 Container(webApp, "Web Application", "Spring Boot, Java", "Provides web interface")89 Container(api, "API Application", "Node.js, Express", "Provides REST API")90 ContainerDb(database, "Database", "PostgreSQL", "Stores data")91 Container_Queue(messageQueue, "Message Queue", "RabbitMQ", "Handles async messaging")92 }93 System_Ext(external, "External System", "Third-party service")9495 Rel(user, webApp, "Uses", "HTTPS")96 Rel(webApp, api, "Makes API calls to", "JSON/HTTPS")97 Rel(api, database, "Reads from and writes to", "SQL")98 Rel(api, messageQueue, "Publishes messages to")99 Rel(api, external, "Uses", "API")100```101````102103**Key Principles** (from [c4model.com](https://c4model.com/diagrams/container)):104105- Show **high-level technology choices** (this is where technology details belong)106- Show how **responsibilities are distributed** across containers107- Include **container types**: Applications, Databases, Message Queues, File Systems, etc.108- Show **communication protocols** between containers109- Include **external systems** that containers interact with110111````112113## API Specification Template114115For each container API, create an OpenAPI/Swagger specification:116117```yaml118openapi: 3.1.0119info:120 title: [Container Name] API121 description: [API description]122 version: 1.0.0123servers:124 - url: https://api.example.com125 description: Production server126paths:127 /api/resource:128 get:129 summary: [Operation summary]130 description: [Operation description]131 parameters:132 - name: param1133 in: query134 schema:135 type: string136 responses:137 '200':138 description: [Response description]139 content:140 application/json:141 schema:142 type: object143````144145## Example Interactions146147- "Synthesize all components into containers based on deployment definitions"148- "Map the API components to containers and document their APIs as OpenAPI specs"149- "Create container-level documentation for the microservices architecture"150- "Document container interfaces as Swagger/OpenAPI specifications"151- "Analyze Kubernetes manifests and create container documentation"152153## Key Distinctions154155- **vs C4-Component agent**: Maps components to deployment units; Component agent focuses on logical grouping156- **vs C4-Context agent**: Provides container-level detail; Context agent creates high-level system diagrams157- **vs C4-Code agent**: Focuses on deployment architecture; Code agent documents individual code elements158159## Output Examples160161When synthesizing containers, provide:162163- Clear container boundaries with deployment rationale164- Descriptive container names and deployment characteristics165- Complete API documentation with OpenAPI/Swagger specifications166- Links to all contained components167- Mermaid container diagrams showing deployment architecture168- Links to deployment configurations (Dockerfiles, K8s manifests, etc.)169- Infrastructure requirements and scaling considerations170- Consistent documentation format across all containers171172<!-- Source: .faos/custom/skills/architecture/c4-container/SKILL.md -->