Documentation

You’re in the simian-agent reference docs. The site root has the marketing pitch; this section is the reference.

Start here

Brand new?Getting started walks from make all through your first directed-chaos fault and your first autonomous-mode plan against an Online Boutique deployment.

Installing in-cluster?Deploying with Helm covers the chart install patterns and the recommended overlay.

Picking which chaos engine to use?Using the chaos engines covers the directed and autonomous patterns for chaos-mesh, network-policy, and envoy-fault — including which one to reach for on which kind of cluster.

Hit something weird?Known limitations collects the GKE Dataplane V2 NetworkChaos bypass, the Envoy injection vs gRPC probe interaction, and other gotchas worth knowing about before you debug.

Reference index

Getting things done

Concepts and design

  • Design — architecture: Fault Executor chokepoint, LLM Provider contract, chaos drivers, MCP surface, deployment topology.
  • Requirements — scope, operating modes, deployment postures, the R-* requirements catalog.
  • Roadmap — phased development plan; what’s shipped, what’s next.
  • DPv2-compatible chaos engines — why we built network-policy and envoy-fault, and what they replace.

Operating

Working on Simian

  • Contributing — how to file issues, structure PRs, and keep the recommended-defaults overlay honest.

Getting started

From clone to your first chaos fault in under 10 minutes.

Design

Architecture: Fault Executor chokepoint, LLM Provider contract, chaos drivers, MCP surface.

Requirements

Scope, operating modes, deployment postures, and the R-* requirements catalog.

Roadmap

Phased development roadmap — what’s shipped, what’s next.

DPv2-compatible chaos engines

Why we ship network-policy + envoy-fault engines for GKE Dataplane V2 clusters.

Deploying with Helm

How to install the controller in-cluster via the Helm chart.

Using the chaos engines

Directed and autonomous patterns for chaos-mesh, network-policy, and envoy-fault.

CLI reference

Every flag on every simian subcommand.

Helm values reference

Every Helm chart value, what it does, and the recommended setting.

Known limitations

Cluster-side gotchas, dataplane caveats, and feature limitations contributors should know about.

Contributing

How to file issues, structure PRs, and keep our chart values overlay honest.