Skip to content

Commit 55f2584

Browse files
committed
docs: replace ASCII architecture diagram with Mermaid flowchart
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> require DCO sign-off for all commits in AGENTS.md Signed-off-by: Carlos Sanchez <carlos@apache.org>
1 parent cc82d2c commit 55f2584

2 files changed

Lines changed: 33 additions & 38 deletions

File tree

AGENTS.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,16 @@ Common targets:
2929
- `make vet` - Run Go vet
3030
- `make lint` - Run linter
3131

32+
## Git Workflow
33+
34+
All commits must be signed off to certify the [Developer Certificate of Origin (DCO)](https://developercertificate.org/). Use the `-s` flag when committing:
35+
36+
```bash
37+
git commit -s -m "feat: my change"
38+
```
39+
40+
This adds a `Signed-off-by: Name <email>` trailer to the commit message. PRs with unsigned commits will fail the DCO check.
41+
3242
## 1. Build the Plugin Image
3343

3444
Build the Docker image for the plugin using Make:

README.md

Lines changed: 23 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -85,44 +85,29 @@ No LLM configuration needed in the plugin. The agent handles its own model confi
8585

8686
### Architecture
8787

88-
```
89-
┌─────────────────┐
90-
│ Argo Rollouts │
91-
│ Controller │
92-
└────────┬────────┘
93-
94-
│ 1. AnalysisRun
95-
96-
┌─────────────────┐
97-
│ Plugin (Go) │
98-
│ - Collect ctx │
99-
│ - Send A2A req │
100-
└────────┬────────┘
101-
102-
│ 2. HTTP POST /a2a/analyze
103-
104-
┌─────────────────────────────────────┐
105-
│ Kubernetes Agent (example) │
106-
│ ┌─────────────────────────────────┐ │
107-
│ │ 3. Diagnostic Agents │ │
108-
│ │ - Fetch logs, events, metrics│ │
109-
│ └─────────────────────────────────┘ │
110-
│ ┌─────────────────────────────────┐ │
111-
│ │ 4. Analysis Agent (AI) │ │
112-
│ │ - Log & Metrics analysis │ │
113-
│ │ - Root cause identification │ │
114-
│ └─────────────────────────────────┘ │
115-
└────────┬────────────────────────┬───┘
116-
│ │
117-
│ 5. Return decision │ 7. Async remediation
118-
│ (promote/rollback) │
119-
▼ ▼
120-
┌─────────────────┐ ┌─────────────────┐
121-
│ Plugin │ │ Remediation │
122-
│ 6. Promote or │ │ Agent │
123-
│ abort canary │ │ - Create GitHub │
124-
└─────────────────┘ │ PRs/Issues. │
125-
└─────────────────┘
88+
```mermaid
89+
flowchart TD
90+
ArgoRollouts["Argo Rollouts<br/>Controller"]
91+
92+
subgraph Plugin["Plugin (Go)"]
93+
CollectCtx["Collect context"]
94+
SendA2A["Send A2A request"]
95+
CollectCtx --> SendA2A
96+
end
97+
98+
subgraph KubeAgent["Kubernetes Agent"]
99+
DiagAgents["3. Diagnostic Agents<br/>Fetch logs, events, metrics"]
100+
AnalysisAgent["4. Analysis Agent (AI)<br/>Log & Metrics analysis<br/>Root cause identification"]
101+
DiagAgents --> AnalysisAgent
102+
end
103+
104+
Decision["Plugin<br/>Promote or abort canary"]
105+
RemediationAgent["Remediation Agent<br/>Create GitHub PRs / Issues"]
106+
107+
ArgoRollouts -->|"1. AnalysisRun"| Plugin
108+
Plugin -->|"2. HTTP POST /a2a/analyze"| KubeAgent
109+
KubeAgent -->|"5. Return decision (promote/rollback)"| Decision
110+
KubeAgent -.->|"7. Async remediation"| RemediationAgent
126111
```
127112

128113
## Prerequisites

0 commit comments

Comments
 (0)