MicrosoftKnown publishermicrosoft/chaos-studio/samples/aks-zone-down-demo/AGENTS.md

chaos-studio / aks-zone-down-demo

AGENTS.md3 starsChanged 5 months agoMITView on GitHub

Context and ground rules for AI agents (GitHub Copilot, Claude, or similar) running this demo on a user's behalf. A break-fix-prove resilience demo for Azure Chaos Studio Workspaces (public preview). The arc matters: 1. Deploy the AKS store demo app with its default single-replica deployments to a zone-redundant AKS cluster. 2. Run the Compute Zone Down scenario against the zone the store-front pod runs in. The storefront going down is the expected, desired outcome of run 1 — it demonstrates…

Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 31,439 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository11 other files it gives its agents.
- chaos-impactSkill
- chaos-study-designSkill
- chaos-study-historySkill
- chaos-study-reportSkill
- chaos-study-runSkill
- chaos-study-scopeSkill
- chaos-studySkill
- create-workspaceSkill
- run-scenarioSkill
- setup-scenarioSkill
- start-chaosSkill

The file

We split this AGENTS.md into the rules it gives an agent

3 rules. About 0 are common, 1 is distinctive, and 2 are very specific to this project.

≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.

Common
Distinctive
Very specific

Very specific:
Run the Compute Zone Down scenario against the zone the store-front pod runs in.
line 13
Distinctive:
Run only in a subscription and resource group set aside for demos.
line 23
Very specific:
Create the workspace and run the scenario per README.md ("Run the demo").
line 41

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.

Files

AGENTS.md

Agent guide: AKS zone-down demo

Context and ground rules for AI agents (GitHub Copilot, Claude, or similar) running this demo on a user's behalf.

What this demo is

A break-fix-prove resilience demo for Azure Chaos Studio Workspaces (public preview). The arc matters:

Deploy the AKS store demo app with its default single-replica deployments to a zone-redundant AKS cluster.
Run the Compute Zone Down scenario against the zone the store-front pod runs in. The storefront going down is the expected, desired outcome of run 1 — it demonstrates the resilience gap. Do not treat the outage as an error to fix mid-run, and do not scale the deployment before run 1; that destroys the lesson.
Apply the fix (replicas + zone topology spread constraint, in README.md step 5), rerun the same scenario, and show the storefront surviving.

Ground rules

Run only in a subscription and resource group set aside for demos. Never target production resources.
deploy.sh tags its resource group chaos-demo=aks-zone-down-demo, and cleanup.sh refuses to delete a group without that tag. Don't bypass the guard.
Confirm with the user before starting a scenario run and before any deletion.
Chaos Studio Workspaces are in public preview; regions and behavior can change. If something doesn't match these instructions, prefer the live docs (links at the end) over improvising.

Steps

./deploy.sh — env overrides: RESOURCE_GROUP, LOCATION, CLUSTER_NAME, MANIFEST_URL. It prints the storefront URL, the cluster's infrastructure resource group (MC_*), and the zone the store-front pod landed in. Verify the storefront loads before proceeding.
Create the workspace and run the scenario per README.md ("Run the demo"). You can do this in the Azure portal with the user, or with the az chaos CLI extension and this repo's Copilot CLI plugin. Permissions: the Reader banner on the workspace, and the Fix Permissions action on the scenario configuration page when validation reports missing RBAC.
Between runs, apply the fix exactly as written in README.md step 5, and confirm the replicas spread across nodes before rerunning.
./cleanup.sh when finished (FORCE=1 skips the confirmation prompt).

References

Full walkthrough: https://learn.microsoft.com/azure/chaos-studio/chaos-studio-tutorial-sample-app
Manage workspaces and scenarios with the CLI: https://learn.microsoft.com/azure/chaos-studio/chaos-studio-manage-cli
Least-privilege roles: https://learn.microsoft.com/azure/chaos-studio/chaos-studio-workspaces-least-privilege-roles
Copilot CLI plugin: ../../copilot-cli-plugin/

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

It worked
Partly
It didn't

What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free