Commit 89ecf99
committed
docs: document operator UI, PAT auth, and AI rule suggester
Bring the doc set up-to-date with what this PR ships so new devs and
operators aren't figuring out a live feature set from source.
- README.md: new "Operator UI" section under Monitoring covering enable
flags, role mapping (admin/maintain → operator, write/triage/read →
writer), per-repo replay authorization, and AI-suggester providers.
Enhanced Features list gains an "Operator UI" group. Tools list gains
test-llm and test-pem entries.
- docs/CONFIG-REFERENCE.md: new "Operator UI" and "AI Rule Suggester
(LLM)" env-var tables covering OPERATOR_UI_ENABLED, OPERATOR_AUTH_REPO,
OPERATOR_REPO_SLUG, OPERATOR_RELEASE_*, LLM_PROVIDER, LLM_BASE_URL,
LLM_MODEL, ANTHROPIC_API_KEY, ANTHROPIC_API_KEY_SECRET_NAME. Calls out
the 30/hour/PAT rate limit on /suggest-rule.
- docs/DEPLOYMENT.md: Secret Manager step #4 for anthropic-api-key plus
the IAM binding; pre-deploy checklist gains the operator-UI auth repo
bullet; post-deploy smoke test for the operator UI + AI settings.
- docs/LOCAL-TESTING.md: "Optional (for Operator UI + AI rule suggester)"
env-var block and a step-by-step "Testing the Operator UI Locally"
section that points at cmd/test-llm for provider verification.
- docs/FAQ.md: new "Operator UI" section (what it is, who can access,
how the AI suggester works, how to debug "not connected").
- AGENT.md: full rewrite. Expanded file map covers all operator_*.go,
llm_*.go, web/operator/index.html embed, webhook_trace_buffer, and
log_buffer. New sections on authorization model, security posture
(auth fail-closed, PAT hashing, SSRF defense-in-depth, LLM cost cap),
and edit patterns for operator UI / LLM provider work. Key doc table
rebuilt with clickable links.1 parent 14c9d29 commit 89ecf99
6 files changed
Lines changed: 337 additions & 92 deletions
Large diffs are not rendered by default.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
32 | 39 | | |
33 | 40 | | |
34 | 41 | | |
| |||
385 | 392 | | |
386 | 393 | | |
387 | 394 | | |
| 395 | + | |
| 396 | + | |
| 397 | + | |
| 398 | + | |
| 399 | + | |
| 400 | + | |
| 401 | + | |
| 402 | + | |
| 403 | + | |
| 404 | + | |
| 405 | + | |
| 406 | + | |
| 407 | + | |
| 408 | + | |
| 409 | + | |
| 410 | + | |
| 411 | + | |
| 412 | + | |
| 413 | + | |
| 414 | + | |
| 415 | + | |
| 416 | + | |
| 417 | + | |
| 418 | + | |
| 419 | + | |
| 420 | + | |
| 421 | + | |
| 422 | + | |
| 423 | + | |
| 424 | + | |
| 425 | + | |
| 426 | + | |
| 427 | + | |
| 428 | + | |
| 429 | + | |
| 430 | + | |
| 431 | + | |
| 432 | + | |
| 433 | + | |
| 434 | + | |
| 435 | + | |
388 | 436 | | |
389 | 437 | | |
390 | 438 | | |
| |||
598 | 646 | | |
599 | 647 | | |
600 | 648 | | |
| 649 | + | |
| 650 | + | |
601 | 651 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
| 18 | + | |
| 19 | + | |
18 | 20 | | |
19 | 21 | | |
20 | 22 | | |
| |||
127 | 129 | | |
128 | 130 | | |
129 | 131 | | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
130 | 158 | | |
131 | 159 | | |
132 | 160 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
164 | 164 | | |
165 | 165 | | |
166 | 166 | | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
167 | 183 | | |
168 | 184 | | |
169 | 185 | | |
| |||
185 | 201 | | |
186 | 202 | | |
187 | 203 | | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
188 | 209 | | |
189 | 210 | | |
190 | 211 | | |
| |||
322 | 343 | | |
323 | 344 | | |
324 | 345 | | |
325 | | - | |
326 | | - | |
| 346 | + | |
| 347 | + | |
327 | 348 | | |
328 | 349 | | |
329 | 350 | | |
| 351 | + | |
330 | 352 | | |
331 | 353 | | |
332 | 354 | | |
| |||
480 | 502 | | |
481 | 503 | | |
482 | 504 | | |
| 505 | + | |
| 506 | + | |
| 507 | + | |
| 508 | + | |
| 509 | + | |
| 510 | + | |
| 511 | + | |
| 512 | + | |
| 513 | + | |
| 514 | + | |
483 | 515 | | |
484 | 516 | | |
485 | 517 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
30 | 30 | | |
31 | 31 | | |
32 | 32 | | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
33 | 75 | | |
34 | 76 | | |
35 | 77 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
343 | 343 | | |
344 | 344 | | |
345 | 345 | | |
| 346 | + | |
| 347 | + | |
| 348 | + | |
| 349 | + | |
| 350 | + | |
| 351 | + | |
| 352 | + | |
| 353 | + | |
| 354 | + | |
| 355 | + | |
| 356 | + | |
| 357 | + | |
| 358 | + | |
| 359 | + | |
| 360 | + | |
| 361 | + | |
| 362 | + | |
| 363 | + | |
| 364 | + | |
| 365 | + | |
| 366 | + | |
| 367 | + | |
| 368 | + | |
| 369 | + | |
| 370 | + | |
| 371 | + | |
| 372 | + | |
| 373 | + | |
| 374 | + | |
| 375 | + | |
| 376 | + | |
| 377 | + | |
| 378 | + | |
| 379 | + | |
| 380 | + | |
| 381 | + | |
| 382 | + | |
346 | 383 | | |
347 | 384 | | |
348 | 385 | | |
| |||
0 commit comments