WIP: Redis Agent Playbooks self-managed operator docs

[tylerhutcherson]

MOD-19679 — Self-managed Redis Agent Playbooks operator documentation.

Adds setup and administration docs under /operate/iris/agent-playbook/. Operators can prepare dependencies, deploy the Helm chart, provision playbooks and application keys, configure identity-provider access, and optionally extract FAQ proposals from Redis Agent Memory.

Scope

• Eleven pages: operator landing, self-managed overview, planning, prerequisites, configuration, deployment, authentication/access, API examples, background extraction, operations, and the generated control-plane reference.
• Current private embedding configuration using embedders_connection_details, while the public model catalog remains in Helm values.
• Bootstrap credentials, scoped application keys, shared control-plane/data-plane OIDC, role boundaries, and optional Identity Service Control OIDC.
• Model discovery before playbook creation, Secret/checksum rollouts, health and metrics, administrative clearing, suspension/deletion, backup responsibilities, and upgrades.
• Optional Redis Agent Memory FAQ extraction with workload trust, a persistent queue, generation-model credentials, staged worker and binding activation, pause/cleanup, and monitoring.
• Developer handoffs for setup, clearing, proposal extraction, content authoring, retrieval, and agent integration.

Release boundary

The chart matching current Iris main has not been published. These guides intentionally use <chart-version> plus control-plane, data-plane, and Identity Service image-tag placeholders. They do not mix the previous alpha.3 chart with current configuration.

The control-plane reference is byte-identical to Iris main at 304467e3e3acf5ff9e6800e03055f0a7806bc14d. It now covers 13 operations: model listing; playbook create/list/get/update/delete/clear; extraction store listing; and extraction binding create/list/get/update/delete. Its hash and operation inventory are locked in tests.

Validation

• Complete Playbooks docs suite: 127 passed against redis-agent-playbook==0.1.0a3 and @redis-iris/agent-playbook@0.1.0-alpha.3.
• Current Iris Helm Go smoke/safety tests pass.
• Helm lint and template rendering pass for the standard source fixture and a docs-shaped extraction deployment with all four workloads.
• All 41 Bash and 13 YAML operator fences parse.
• Full Hugo 0.143 build passes: 19,928 pages, 665 non-page files, 2,116 static files, and 1,245 aliases. Existing warnings are outside Playbooks.
• OpenAPI validation, source hash, cross-links, and git diff --check pass.

The generic task lint and task test commands are unavailable because this repository has no Taskfile; validation uses the dedicated Playbooks suite and supported Hugo version.

Remaining release work

• Add the approved chart version, image tags, platform matrix, and release-specific upgrade notes when the matching chart is published.
• Qualify production sizing, high availability, minimum Redis ACL permissions, and supported backup/restore guarantees.
• Iris main still contains stale generated extraction descriptions that say no worker exists or that workers arrive later. This PR preserves the generated contract; the Smithy source should be corrected and the reference regenerated.

Stack and publication

• Parent: #4249 — WIP: Redis Agent Playbooks developer docs, targeting main.
• This PR: MOD-19679-playbook-operator-docs → MOD-19391-playbook-developer-docs.
• Merge the developer PR first, then retarget or rebase this PR onto main and verify the remaining diff.

Both PRs stay draft/WIP. No publication gate is added. Merging into main publishes the docs; draft state does not hide merged pages. Keep both unmerged until launch publication is approved.

[github-actions]

🧠 Redis Memory

Found 5 related items from repository history:

• PR — WIP: Playbook developer docs

  MOD-19391 — Publish Redis Agent Playbook documentation on redis.io.

• PR — WIP: Playbook developer docs

  Adds the Agent Playbooks developer docs under /develop/ai/context-engine/agent-playbook/ for docs-team and product review. The guides cove

• PR — MOD-18528: Document Playbook bindings and RAM service-subject authentication

  Summary

• PR — MOD-17747: Add self-managed LangCache documentation

  Summary

• PR — MOD-18825: Correct Iris self-managed docs for RAM 0.7.0 and LangCache 0.0.1

  Ticket: MOD-18825 · Control Plane OpenAPI text: [redislabsdev/iris#1648](https://github.

Memory updated at 85afad0

[github-actions]

Staging links:
https://redis.io/docs/staging/MOD-19679-playbook-operator-docs/develop/ai/context-engine/agent-playbook/
https://redis.io/docs/staging/MOD-19679-playbook-operator-docs/develop/ai/context-engine/agent-playbook/concepts/
https://redis.io/docs/staging/MOD-19679-playbook-operator-docs/develop/ai/context-engine/agent-playbook/limits/
https://redis.io/docs/staging/MOD-19679-playbook-operator-docs/develop/ai/context-engine/agent-playbook/proposals/
https://redis.io/docs/staging/MOD-19679-playbook-operator-docs/develop/ai/context-engine/agent-playbook/quickstart/
https://redis.io/docs/staging/MOD-19679-playbook-operator-docs/develop/ai/context-engine/agent-playbook/retrieval/
https://redis.io/docs/staging/MOD-19679-playbook-operator-docs/operate/iris/
https://redis.io/docs/staging/MOD-19679-playbook-operator-docs/operate/iris/agent-playbook/
https://redis.io/docs/staging/MOD-19679-playbook-operator-docs/operate/iris/agent-playbook/self-managed/
https://redis.io/docs/staging/MOD-19679-playbook-operator-docs/operate/iris/agent-playbook/self-managed/api-examples/
https://redis.io/docs/staging/MOD-19679-playbook-operator-docs/operate/iris/agent-playbook/self-managed/authentication/
https://redis.io/docs/staging/MOD-19679-playbook-operator-docs/operate/iris/agent-playbook/self-managed/configuration/
https://redis.io/docs/staging/MOD-19679-playbook-operator-docs/operate/iris/agent-playbook/self-managed/control-plane-api-reference/
https://redis.io/docs/staging/MOD-19679-playbook-operator-docs/operate/iris/agent-playbook/self-managed/deploy/
https://redis.io/docs/staging/MOD-19679-playbook-operator-docs/operate/iris/agent-playbook/self-managed/extraction/
https://redis.io/docs/staging/MOD-19679-playbook-operator-docs/operate/iris/agent-playbook/self-managed/operations/
https://redis.io/docs/staging/MOD-19679-playbook-operator-docs/operate/iris/agent-playbook/self-managed/plan-deployment/
https://redis.io/docs/staging/MOD-19679-playbook-operator-docs/operate/iris/agent-playbook/self-managed/prerequisites/

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[mich-elle-luna]

Hi Tyler, this is looking good so far. But, I've merged in lots of changes since you branched, so here is the info to get this branch to appear with the new look/feel and nav menu from claude:

"Nothing in their pages needs to change. Their branches were cut on Sept 30, before the Iris work merged, and staging builds each branch as-is. Both branches are 133 commits behind main, so they don't have the new nav or dark theme.

What they need to do: Merge main into both branches (or rebase onto it) and push. Their new pages are under develop/ai/context-engine/agent-playbook/ and operate/iris/agent-playbook/. Everything under those two folders gets the Iris sidebar and dark theme automatically, with no frontmatter or extra setup.

What they'll run into:

Developer branch (MOD-19391-playbook-developer-docs): A dry-run merge with main is clean.
Operator branch (MOD-19679-playbook-operator-docs): One conflict, in content/operate/iris/_index.md. They added an Agent Playbooks tile and reworded the intro. Meanwhile main added a console screenshot, switched the tiles from color swatches to icons, and added lists of links. Resolving it means keeping main's version and re-adding their tile and wording.
Their new tile uses a color swatch (color="bg-blue-300"), while the other tiles now use icons. No playbook icon exists yet. They could use icon-redis-iris-64-duotone.png for now, or ask for a new icon."

thank you!