DevOps & Tooling · Any coding agent
Kubernetes & Helm Charts ARCHITECTURE.md
An ARCHITECTURE.md for Kubernetes & Helm Charts: module responsibilities, data flow and the boundaries code changes must keep.
- Path
- ARCHITECTURE.md
- Loads
- Read when referenced
- Format
- Markdown (.md)
- Used by
- Any coding agent
What this file tells the agent
ARCHITECTURE.md describes module responsibilities, state boundaries and data flow, so a coding agent knows where code belongs before it changes anything. Point to it from CLAUDE.md or AGENTS.md so agents read it.
- Always specify explicit resources.requests and resources.limits (both CPU and memory) on every container.
- Enforce strict security contexts: readOnlyRootFilesystem: true, runAsNonRoot: true, and allowPrivilegeEscalation: false.
- Mandate both livenessProbe and readinessProbe with appropriate initialDelaySeconds on deployment workloads.
- Validate Helm template indentation using nindent filters (e.g. toYaml . | nindent 8) to eliminate YAML formatting corruption.
- Configure PodDisruptionBudgets (PDB) and topology spread constraints for multi-node high availability.
Code to avoid, and what to write instead
The rule steers the agent away from the left and toward the right.
# Dangerous: No resource constraints, root container, missing probes
apiVersion: apps/v1
kind: Deployment
metadata:
name: bad-service
spec:
template:
spec:
containers:
- name: app
image: myapp:latest # Mutable tag and unconstrained limits!apiVersion: apps/v1
kind: Deployment
metadata:
name: api-service
labels:
app.kubernetes.io/name: api-service
spec:
replicas: 3
template:
spec:
securityContext:
runAsNonRoot: true
runAsUser: 10001
containers:
- name: api
image: registry.example.com/api:v1.4.0
securityContext:
allowPrivilegeEscalation: false
readOnlyRootFilesystem: true
resources:
requests:
cpu: 100m
memory: 128Mi
limits:
cpu: 500m
memory: 512Mi
readinessProbe:
httpGet:
path: /healthz
port: 8080
initialDelaySeconds: 5Install it in one command
- 01
Go to your project root
The file goes at ARCHITECTURE.md, relative to the root.
- 02
Download the file
Run the command on the right. It downloads this preset and writes the file.
- 03
Make sure it gets used
Agents read it when your CLAUDE.md or AGENTS.md points to it. Add a line such as "Read ARCHITECTURE.md before structural changes".
$ curl -fsSL "https://www.devscratchpad.tech/api/raw/architecture-md/kubernetes-helm" -o "ARCHITECTURE.md"
writes ARCHITECTURE.md
ARCHITECTURE.md
To write the file from your own code instead, use Read your code or Convert Legacy Rules in the editor above.
More for Kubernetes & Helm Charts
Questions
- What belongs in ARCHITECTURE.md?
- How the main modules relate, how state and data flow, and the boundaries every change must keep.
- How does ARCHITECTURE.md help AI agents?
- It tells them where code belongs and which boundaries to keep, so they are less likely to add circular dependencies or skip layers. Point to it from CLAUDE.md or AGENTS.md so they read it.