WIP: Redis Agent Playbooks self-managed operator docs by tylerhutcherson · Pull Request #4256 · redis/docs

tylerhutcherson · 2026-10-13T16:24:11Z

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

Adds setup and administration guidance under /operate/iris/agent-playbook/. Operators can prepare dependencies, deploy the chart, provision playbooks and scoped 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.
Private embedding configuration through embedders_connection_details, a public model catalog, bootstrap credentials, scoped application keys, shared control-plane/data-plane OpenID Connect configuration, and optional Identity Service Control authentication.
Model discovery before provisioning, Secret/checksum rollouts, health/metrics, administrative clearing, suspension/deletion, backup responsibilities, and upgrades.
Opt-in Redis Agent Memory FAQ extraction with workload trust, persistent queueing, generation credentials, staged worker/binding activation, cleanup, and monitoring.
Developer handoffs for setup, authentication, retrieval configuration, clearing, and extraction. The shortened developer page is titled Proposals and still links directly to extraction setup.

Release boundary

The matching Helm chart remains unpublished. Guides intentionally use <chart-version> and individual control-plane, data-plane, and Identity Service image-tag placeholders.

The control-plane reference is locked to Iris revision 304467e3e3acf5ff9e6800e03055f0a7806bc14d, with a checked source hash and 13-operation inventory covering model listing, playbook administration, extraction store listing, and extraction binding administration.

Validation

Direct CLI examples: 17 CLI/reference checks passed on the combined stack, plus 5 developer-only reference checks. All 10 CLI programs pass Bash syntax checks; all five rendered guides show literal iris commands with the standard product environment variables. --json is used only where a response is saved or parsed.
Latest Proposals prose edit: 6 reference checks passed, with the title, 44 code panels, and 14 source links/anchors verified in the local Hugo preview. Existing examples and anchors are unchanged; earlier executable checks remain applicable.
Full combined Playbooks docs suite: 138 passed with redis-iris==0.1.0a4, its redis-agent-playbook==0.1.0a3 dependency, and @redis-iris/agent-playbook@0.1.0-alpha.3.
12 live Python/CLI smoke tests passed against freshly built local Iris control/data planes, isolated Redis/Identity Service dependencies, and scoped author/reader keys. Temporary playbooks and keys were removed after each case.
Full Hugo 0.143 build passes: 19,928 pages, 665 non-page files, 2,116 static files, and 1,245 aliases. All 47 CLI panels and new source links/anchors were checked in rendered output.
Strict TypeScript compilation, Python/shell parsing, OpenAPI checks, source hashes, links, and git diff --check pass.
Earlier operator validation still applies to unchanged deployment content: Helm smoke/safety tests, lint, standard and extraction rendering, and all 41 Bash and 13 YAML fences passed.
This docs repository has no Taskfile; validation uses the dedicated Playbooks suite and supported Hugo version.

Remaining release work

Fill approved chart/image versions, platform support, and release-specific upgrade notes once the matching chart is published.
Qualify production sizing, high availability, minimum Redis access-control permissions, and backup/restore guarantees.
Correct stale upstream generated extraction descriptions before regenerating the reference; this PR preserves the locked generated contract.
CLI parity follow-up: redis/redis-iris#39.

Stack and publication

Parent: #4249 — WIP: Redis Agent Playbooks developer docs, targeting main, including unified Python examples and 47 CLI tabs, with direct executable invocations in c45109ecc.
This rebased PR: MOD-19679-playbook-operator-docs → MOD-19391-playbook-developer-docs, head 430c680a5. Review relative to the parent to see operator scope and handoffs.
Merge the developer PR first, then retarget/rebase this PR onto main and verify its remaining diff.

Both PRs remain draft/WIP and unmerged pending launch publication approval. Merging into main publishes the documentation.

github-actions · 2026-10-13T16:24:29Z

🧠 Redis Memory

Found 8 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.
PR — docs(iris): MOD-19272 Agent Memory self-managed docs for the iris-identity-service subchart (chart 1.0.0)

Do not merge yet
Commit — docs: align Playbooks operator guides with Iris main

docs: align Playbooks operator guides with Iris main
Commit — docs: align Playbooks operator guides with Iris main

docs: align Playbooks operator guides with Iris main

Memory updated at 430c680

github-actions · 2026-10-13T16:24:30Z

CLAassistant · 2026-10-13T16:27:28Z

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 · 2026-10-13T18:15:32Z

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!

…amples Adds three TCE pseudo-client keys, "Python (Iris)", "TypeScript (Iris)", and "cURL (Iris)", so Iris examples can use the standard clients-example system instead of multitabs. Each key is the visible tab title and is shared across all Iris products, so names avoid any one SDK package. - config.toml: keys in clientsExamples and clientsConfig, modeled on RedisVL. Own clientId (iris-python/-typescript/-curl), empty quickstartSlug and mappingClientId, so tabs don't carry redis-py or node-redis identity in the code-examples JSON metadata. - build/local_examples.py: .ts/.mts -> typescript, .sh -> bash; a path containing 'iris' selects the Iris client (put sources under local_examples/iris/). .mts keeps top-level await working under tsx. Non-Iris .ts/.sh files resolve to no configured client. - build/components/example.py: comment prefixes for typescript (//) and bash (#); without them Example() rejects the language. Verified with a throwaway three-language set: the build tagged each file with the right client and Hugo rendered the tabs with correct step slices, lexers, full-file templates, and clientId/clientName. The test set was removed; no pages are converted in this commit. Gotcha: get_example_id_from_file reads only line 1, so .sh sources must start with "# EXAMPLE:" and cannot carry a shebang. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Discover turn context through the SDK before running OpenAI Agents SDK or LangGraph. Keep standard MCP clients and tool guidance on the existing MCP page, and suppress drafts while tool failures remain unresolved.

mich-elle-luna

thank you!

tylerhutcherson added documentation Improvements or additions to documentation op Operate docs iris Iris context engine docs labels Oct 13, 2026

tylerhutcherson mentioned this pull request Oct 13, 2026

MOD-19391: Redis Agent Playbooks developer docs #4249

Merged

mich-elle-luna self-assigned this Oct 13, 2026

mich-elle-luna self-requested a review October 13, 2026 17:09

tylerhutcherson and others added 9 commits October 14, 2026 14:38

docs: scaffold Agent Playbooks guides and review handoff

79b0b08

docs(iris): refine Playbooks developer guides and examples

6cfd434

docs: align Playbooks navigation with the Iris docs space

e9a9733

docs: give the FAQ authoring guide a task-specific URL

678179f

docs: simplify cross-language naming explanations

cb7cfed

docs: use standard TCE sources for Playbooks examples

364beb2

docs: separate Playbooks MCP and agent integration guides

7c162e8

Discover turn context through the SDK before running OpenAI Agents SDK or LangGraph. Keep standard MCP clients and tool guidance on the existing MCP page, and suppress drafts while tool failures remain unresolved.

docs: simplify Playbooks MCP examples and guide navigation

d7293c3

tylerhutcherson force-pushed the MOD-19679-playbook-operator-docs branch from 0829b25 to efdbd73 Compare October 14, 2026 18:45

tylerhutcherson force-pushed the MOD-19391-playbook-developer-docs branch from c0ef4a2 to d7293c3 Compare October 14, 2026 18:45

tylerhutcherson added 2 commits October 14, 2026 21:20

docs: improve Playbooks navigation and Python examples

252d8df

docs: add Playbooks workflow diagrams

a73af6b

github-actions Bot mentioned this pull request Oct 15, 2026

MOD-19813: Document Memory 0.8.0 with a standalone Identity Service #4272

Merged

tylerhutcherson added 2 commits October 15, 2026 08:45

docs: clarify Redis Agent Playbooks terminology

76f9293

docs: align Playbooks guides with alpha.3 SDKs

1009f90

tylerhutcherson force-pushed the MOD-19679-playbook-operator-docs branch from 14dcc3e to 85afad0 Compare October 18, 2026 00:59

tylerhutcherson changed the title ~~WIP: Playbook self-managed operator docs~~ WIP: Redis Agent Playbooks self-managed operator docs Oct 18, 2026

docs: add unified Python and CLI Playbooks examples

8a4411c

tylerhutcherson force-pushed the MOD-19679-playbook-operator-docs branch from 85afad0 to eb6d8a6 Compare October 21, 2026 02:44

docs: focus Proposals guide on reusable agent knowledge

9a3a264

tylerhutcherson force-pushed the MOD-19679-playbook-operator-docs branch from eb6d8a6 to 2c70e92 Compare October 21, 2026 11:25

tylerhutcherson added 4 commits October 21, 2026 07:37

docs: show Iris CLI commands directly

c45109e

docs: add self-managed Agent Playbooks operator guides

7c9291f

docs: tighten Playbooks operator onboarding and handoffs

53e3a78

docs: align Playbooks operator guides with Iris main

430c680

tylerhutcherson force-pushed the MOD-19679-playbook-operator-docs branch from 2c70e92 to 430c680 Compare October 21, 2026 11:38

nkanu17 mentioned this pull request Oct 22, 2026

RED-220418: Add Context Gateway developer docs #4323

Merged

tylerhutcherson force-pushed the MOD-19391-playbook-developer-docs branch from fafb18d to 7520513 Compare October 22, 2026 20:39

Base automatically changed from MOD-19391-playbook-developer-docs to iris-ga-docs October 22, 2026 22:33

mich-elle-luna approved these changes Oct 22, 2026

View reviewed changes

atlassian Bot mentioned this pull request Oct 23, 2026

Consolidate Agent Memory documentation for GA #4001

Open

github-actions Bot mentioned this pull request Oct 23, 2026

MOD-20121: Align Playbook extraction authentication setup #4330

Draft

tylerhutcherson mentioned this pull request Oct 23, 2026

MOD-20121: Update Playbook operator extraction setup #4331

Draft

Navigation Menu

Repository navigation

WIP: Redis Agent Playbooks self-managed operator docs - #4256

WIP: Redis Agent Playbooks self-managed operator docs#4256
tylerhutcherson wants to merge 19 commits into
iris-ga-docsfrom
MOD-19679-playbook-operator-docs

tylerhutcherson commented Oct 13, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Oct 13, 2026 •

edited by atlassian Bot

Loading

Summary

Summary

Do not merge yet

Uh oh!

github-actions Bot commented Oct 13, 2026 •

edited

Loading

Uh oh!

CLAassistant commented Oct 13, 2026

Uh oh!

mich-elle-luna commented Oct 13, 2026

Uh oh!

mich-elle-luna left a comment

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

tylerhutcherson commented Oct 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Scope

Release boundary

Validation

Remaining release work

Stack and publication

Uh oh!

github-actions Bot commented Oct 13, 2026 • edited by atlassian Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🧠 Redis Memory

Summary

Summary

Do not merge yet

Uh oh!

github-actions Bot commented Oct 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

CLAassistant commented Oct 13, 2026

Uh oh!

mich-elle-luna commented Oct 13, 2026

Uh oh!

mich-elle-luna left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

tylerhutcherson commented Oct 13, 2026 •

edited

Loading

github-actions Bot commented Oct 13, 2026 •

edited by atlassian Bot

Loading

github-actions Bot commented Oct 13, 2026 •

edited

Loading