Skip to content

Iris docs: GA read-through feedback, Playbooks/Lens/Identity Service self-managed guides, LangCache out - #4435

Merged
rbs333 merged 17 commits into
iris-ga-docsfrom
docs/iris-flight-feedback
Nov 3, 2026
Merged

rbs333 merged 17 commits into
iris-ga-docsfrom
docs/iris-flight-feedback

Conversation

@rbs333

@rbs333 rbs333 commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

Applies the GA read-through feedback to the Iris docs on iris-ga-docs: the landing page, SDK and CLI setup, the five product landing pages, and the operate section. Adds self-managed guides for Agent Playbooks and Lens, and an operator guide for the Identity Service they all share.

Changes

Landing page (Redis Iris context engine)

  • Description no longer says "approved answers".
  • The tiles get a heading, Explore Redis Iris. Lens is marked (beta), like Agent Mesh.
  • "What is Redis Iris?" is rewritten as one line per capability, in the same order as the tiles.

One product order everywhere. Agent Memory, Agent Playbooks, Context Gateway, Intent Router, Lens, then Agent Mesh and Data Integration: both sidebars (develop weights changed), the landing tiles, and the operate landing page.

SDK and CLI setup

  • Drops "one object per Redis Iris service". The Iris pieces are called "capabilities", and "service" is kept for instances (service create).
  • Corrects the JavaScript/TypeScript note: every capability has its own @redis-iris/* package, not just Context Gateway.
  • Removes every link to the redis-iris GitHub repo. It's internal, so they'd break for public readers. The CLI reference now points to iris --help and PyPI. The project-setup examples are open TODO comments (see the decisions below). The two Agent Mesh pages lose the same dead links.
  • The Redis Cloud steps link to the concepts page. The wrong "Playbooks Cloud setup guide" sentence is removed. https://helm.redis.io/ai is now a link.
  • The self-managed section links each capability's self-managed guide, including the new Agent Playbooks and Lens guides.

Product landing pages (Agent Memory, Agent Playbooks, Context Gateway, Intent Router, Lens) now share one structure: What is, Why use, Concepts, Quick example (Redis Cloud setup link, self-managed setup link, a unified redis-iris example), then the product's own sections. Existing content is moved, not rewritten.

  • The Agent Playbooks, Intent Router and Lens examples use the quickstarts' existing example sets.
  • The Agent Memory and Context Gateway examples are new inline Python, checked against redis-iris 1.0. They use the same IRIS_* variables the CLI writes.
  • Agent Memory: the Cloud card no longer calls the self-managed path "Redis Software", which wasn't accurate.

Agent Memory

  • The Cloud page is retitled Create an Agent Memory service on Redis Cloud (sidebar: Create Cloud service).
  • The self-managed landing page gets a Create a store with the CLI and SDK section: iris.toml, service create --dry-run, --write-env, service check, and an SDK snippet. The dry run was tested against the 1.0 CLI.

Agent Playbooks self-managed guide (new): 10 pages under operate/iris/agent-playbook/self-managed/, ported from @tylerhutcherson's draft #4256 and updated:

  • Chart 1.0.0, with the Identity Service as a separate release (chart 1.0.0, matching Agent Memory after Iris docs: align Agent Memory and Identity Service self-managed docs with the operator runbooks #4420).
  • The unified /iris/v1/agent-playbooks routes, with the API reference regenerated from the current contract.
  • Static JWT trust for extraction from Agent Memory.
  • The OpenID Connect (OIDC) issuer may be http://; only the JWKS URL needs HTTPS. The admin token works on both planes.
  • Linked from the operate Playbooks landing page.

It covers only the operator pages from #4256; the rest of #4256 is already on iris-ga-docs via #4249 and #4429. Open questions are left as TODO comments: GA image tags, supported Kubernetes versions and sizing, backup and restore, and the 0.10.2 → 1.0.0 upgrade path.

Lens self-managed guide (new): 6 pages under operate/iris/lens/self-managed/, written from the Lens Helm chart README and values on iris main:

  • Prerequisites, configuration, deploy (ending with a developer hand-off), authentication, and operations.
  • Identity Service chart 1.0.0, like the other guides.
  • Linked from the operate Lens page.
  • The Lens developer pages (quickstart, configure, concepts, limits, inspect sessions) now link it, replacing their "when the operator pages exist" TODOs. The Lens AGENTS.md is updated to match.

LangCache leaves the Iris docs. It moves back to its earlier homes:

  • Developer pages go to develop/ai/langcache, the self-managed guide to operate/rc/langcache/self-managed, and the other operator pages to operate/rc/langcache.
  • Every Iris-era URL stays as an alias. I checked that each one redirects in the build, including the older /operate/rc/context-engine/langcache/... URLs.
  • Links across the site, the home page, the Redis Cloud bridge page and two comments point at the new paths.
  • The rc/context-engine/langcache bridge stub is removed, and its URL redirects to the LangCache page.
  • Its self-managed guide now sits under the Redis Cloud section, because it has no earlier home. A better place for it is a follow-up.

Identity Service operator guide (new): 5 pages under operate/iris/identity-service/: overview, deploy (with prerequisites), configuration, authentication, operations. Drafted from the Identity Service operator guide and chart on iris main.

  • It covers product registration for all five capabilities, the control and runtime credentials, agent-key lifecycle (curl and iris identity keys), operator sign-in with an identity provider (IdP), subject grants, rotation, upgrade, backup, and troubleshooting.
  • Every product's self-managed deploy page now links it from its Identity Service step, and the operate landing page and SDK and CLI setup list it. The Agent Playbooks TODO for an operator sign-in link is resolved.
  • Changes that land with the M6 PR (a PodDisruptionBudget value and upgrade-path rules) are TODO comments only, not documented behavior.

Aligned with the latest iris main (2c9625b):

  • Chart versions now come from each chart's Chart.yaml: Identity Service 1.2.0 in every guide, and Lens 0.2.1, Context Gateway 0.2.0, Intent Router 0.1.0 in place of their <chart-version> placeholders. Agent Memory and Agent Playbooks stay 1.0.0. M6 (iris#2368) moves the Identity Service to 1.3.0; a TODO tracks it.
  • Context Gateway: subject grants use POST /v1/subject-grants/apply, not the earlier PUT /v1/subject-grants. The Data Plane credential is named (context-gateway-dp, subject context-gateway-dataplane, from the chart README) and needs subject-grant-lookup when Data Plane sign-in is on.
  • Intent Router examples use Identity Service release ids, like every other guide.
  • Identity Service key listing is documented as paginated (maxResults/nextToken, or the CLI's --limit/--cursor/--all), per the API contract.

Other fixes

Needed from others

  • Intent Router on Redis Cloud (@mich-elle-luna): the console has Intent Router screens, but the docs have no Cloud pages for it. The Intent Router quick example has a TODO where the Redis Cloud link goes.

Decisions needed

  • Identity Service placement: a standalone section, because all five capabilities share it. It could instead be folded into each product guide.
  • Project setup examples: the Redis Cloud and self-managed examples live in the internal redis-iris repo. Restore the links once it's public, or drop them for good.

Possibly wrong, left as is

  • Lens limits.md says an administrator can change the ingest request size, but the chart has no value for it. Not changed here; Lens owners should confirm.

Testing

  • Hugo build: no errors, and no warnings on Iris or Context Engine pages (examples index regenerated first).
  • Every tile link on the Iris pages resolves to a page.
  • CLI lines checked against the redis-iris 1.0 command tree. The Agent Memory service create --dry-run was run against a test profile.

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only changes (paths, aliases, new markdown); no application code or auth logic is modified.

Overview
This PR reshapes Redis Iris (Context Engine) documentation for GA: landing pages, shared onboarding patterns, new operator guides, and LangCache moved out of the Iris tree.

LangCache developer docs live under develop/ai/langcache again; Redis Cloud operator docs use operate/rc/langcache (including self-managed). Old Iris URLs are aliases so existing links redirect. Cross-site links, embeds, and whats-new entries follow the new paths.

Iris develop/operate UX is aligned: a consistent product order (Agent Memory → Playbooks → Context Gateway → Intent Router → Lens), retitled Explore Redis Iris tiles (Lens beta), and a rewritten capability list on the context-engine index. SDK and CLI setup drops internal redis-iris GitHub links, documents @redis-iris/* npm packages per product, and lists self-managed guides plus the new Identity Service operator section.

Product landing pages (Agent Memory, Playbooks, Context Gateway, Intent Router, Lens) share Concepts + Quick example (Cloud/self-managed setup, pip install 'redis-iris>=1.0.0', embedded examples). Agent Memory Cloud page is retitled; self-managed Agent Memory adds CLI/SDK store creation (iris.toml, service create, service check).

New operator content: full Agent Playbooks self-managed guide (chart 1.0.0, Identity Service 1.2.0), Lens self-managed guide (with developer pages linking operator handoffs), and Identity Service guide (deploy, keys, OIDC, product registration). Operate Iris index expands tiles and self-managed links. Identity Service chart references bump to 1.2.0 across Agent Memory, Playbooks deploy/ops, etc.

Smaller fixes: Intent Router quickstart step order, Context Gateway subject-grants API path, Agent Mesh doc link removal, Lens quickstart package versions (>=1.0.0), LangCache OpenAPI description URL, and chart version placeholders (e.g. Context Gateway 0.2.0).

Reviewed by Cursor Bugbot for commit 9275627. Bugbot is set up for automated code reviews on this repo. Configure here.

rbs333 and others added 6 commits November 3, 2026 09:50
… product pages

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ing extra adds

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Ported from Tyler Hutcherson's draft #4256 and updated to chart 1.0.0 (Identity
Service as a separate release), the unified /iris/v1/agent-playbooks routes, static
JWT trust for extraction, and the current control-plane contract.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ent Memory does

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ce.credential, not generated

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

Staging links:
https://redis.io/docs/staging/docs/iris-flight-feedback/develop/ai/
https://redis.io/docs/staging/docs/iris-flight-feedback/develop/ai/agent-builder/agent-concepts/
https://redis.io/docs/staging/docs/iris-flight-feedback/develop/ai/context-engine/
https://redis.io/docs/staging/docs/iris-flight-feedback/develop/ai/context-engine/agent-memory/
https://redis.io/docs/staging/docs/iris-flight-feedback/develop/ai/context-engine/agent-mesh/
https://redis.io/docs/staging/docs/iris-flight-feedback/develop/ai/context-engine/agent-mesh/a2a-sdk/
https://redis.io/docs/staging/docs/iris-flight-feedback/develop/ai/context-engine/agent-mesh/fastapi-sse-sdk/
https://redis.io/docs/staging/docs/iris-flight-feedback/develop/ai/context-engine/agent-playbooks/
https://redis.io/docs/staging/docs/iris-flight-feedback/develop/ai/context-engine/context-gateway/
https://redis.io/docs/staging/docs/iris-flight-feedback/develop/ai/context-engine/intent-router/
https://redis.io/docs/staging/docs/iris-flight-feedback/develop/ai/context-engine/lens/
https://redis.io/docs/staging/docs/iris-flight-feedback/develop/ai/context-engine/lens/AGENTS/
https://redis.io/docs/staging/docs/iris-flight-feedback/develop/ai/context-engine/lens/concepts/
https://redis.io/docs/staging/docs/iris-flight-feedback/develop/ai/context-engine/lens/configure/
https://redis.io/docs/staging/docs/iris-flight-feedback/develop/ai/context-engine/lens/inspect-sessions/
https://redis.io/docs/staging/docs/iris-flight-feedback/develop/ai/context-engine/lens/limits/
https://redis.io/docs/staging/docs/iris-flight-feedback/develop/ai/context-engine/lens/quickstart/
https://redis.io/docs/staging/docs/iris-flight-feedback/develop/ai/context-engine/sdk-and-cli/
https://redis.io/docs/staging/docs/iris-flight-feedback/develop/ai/langcache/
https://redis.io/docs/staging/docs/iris-flight-feedback/develop/ai/langcache/api-examples/
https://redis.io/docs/staging/docs/iris-flight-feedback/develop/ai/langcache/api-reference/
https://redis.io/docs/staging/docs/iris-flight-feedback/develop/ai/langcache/concepts/
https://redis.io/docs/staging/docs/iris-flight-feedback/develop/ai/langcache/interactive-demo/
https://redis.io/docs/staging/docs/iris-flight-feedback/develop/use-cases/semantic-cache/
https://redis.io/docs/staging/docs/iris-flight-feedback/develop/whats-new/
https://redis.io/docs/staging/docs/iris-flight-feedback/operate/
https://redis.io/docs/staging/docs/iris-flight-feedback/operate/iris/
https://redis.io/docs/staging/docs/iris-flight-feedback/operate/iris/agent-memory/

@github-actions

github-actions Bot commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

🧠 Redis Memory

Found 5 related items from repository history:

Memory updated at 9275627

rbs333 and others added 2 commits November 3, 2026 10:10
…per pages

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
… operate/rc/langcache

Every Iris-era URL stays as an alias, and links across the site point at the new paths.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@rbs333 rbs333 changed the title Iris docs: apply the GA read-through feedback, add the Agent Playbooks self-managed guide Iris docs: apply the GA read-through feedback, add Playbooks and Lens self-managed guides, move LangCache out Nov 3, 2026
@rbs333
rbs333 marked this pull request as ready for review November 3, 2026 15:21
…m every product guide

Drafted from the Identity Service operator guide and chart on iris main. Changes that
land with M6 are TODO comments, not documented behavior.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@rbs333 rbs333 changed the title Iris docs: apply the GA read-through feedback, add Playbooks and Lens self-managed guides, move LangCache out Iris docs: GA read-through feedback, Playbooks/Lens/Identity Service self-managed guides, LangCache out Nov 3, 2026
@mich-elle-luna mich-elle-luna added the iris Iris context engine docs label Nov 3, 2026
…ext Gateway subject grants, use release ids for Intent Router

- Identity Service chart 1.2.0 in every guide; Lens 0.2.1, Context Gateway 0.2.0 and Intent Router 0.1.0 replace their install placeholders.
- Context Gateway: POST /v1/subject-grants/apply, and subject-grant-lookup for Data Plane sign-in.
- The Identity Service guide uses the Context Gateway chart's subject, context-gateway-dataplane.
- Intent Router examples use Identity Service release ids, like the other guides.
- Identity Service key listing is paginated.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

@mich-elle-luna mich-elle-luna left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just a few questions/comments thank you!

- develop
- ai
description: Redis Iris is a suite of managed and self-managed services that give your customers accurate, consistent experiences with your AI agents by providing memories, approved answers, governed access to business data, and turn-by-turn tracing.
description: Redis Iris is a suite of managed and self-managed services that give your customers accurate, consistent experiences with your AI agents with memory, published answers and procedures, intent routing, governed access to tools and business data, and turn-by-turn tracing.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is more confusing

## What is Redis Iris?

Redis Iris is a production-ready context engine for AI agents that:
Redis Iris is a context engine for AI agents. Each capability solves one problem, and you can use one or all of them:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should lead with what the user needs, not with the list of service names, this is more confusing

The [`redis-iris`](https://pypi.org/project/redis-iris/) package is the Python software development kit (SDK) for every Redis Iris capability, plus the `iris` command-line interface (CLI), which creates services, mints keys, and checks connections. Your agent reads only `IRIS_*` environment variables, so the same code runs on Redis Cloud and on a self-managed deployment.

Start with a service's quickstart: [Agent Memory](/content/develop/ai/context-engine/agent-memory/quickstart.md), [Agent Playbooks](/content/develop/ai/context-engine/agent-playbooks/quickstart.md), [Context Gateway](/content/develop/ai/context-engine/context-gateway/quickstart.md), or [Lens](/content/develop/ai/context-engine/lens/quickstart.md). This page covers the setup they share.
Start with a capability's quickstart: [Agent Memory](/content/develop/ai/context-engine/agent-memory/quickstart.md), [Agent Playbooks](/content/develop/ai/context-engine/agent-playbooks/quickstart.md), [Context Gateway](/content/develop/ai/context-engine/context-gateway/quickstart.md), [Intent Router](/content/develop/ai/context-engine/intent-router/quickstart.md), or [Lens](/content/develop/ai/context-engine/lens/quickstart.md). This page covers the setup they share.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is not how we are describing them, we are using services


### Upgrade with OIDC enabled

The data plane used to accept only the audience `api://playbook-dp`. If your IdP still issues that audience, set `auth.oidc.audience: api://playbook-dp` before you upgrade, or every token is rejected. `controlplane.oidc.audience` no longer exists, and the render fails if it's still set. A `controlplane.delegatedAuth` block also fails the render: move its `enabled` setting to `controlplane.oidc.enabled`.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need to document this?

showPageContent: true
---

Use the self-managed control-plane API to list configured models, manage playbooks, clear content, and configure extraction bindings. Authenticate with the admin token or an operator's OpenID Connect (OIDC) access token.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this page shouldn't have any content on it (it loads at the top of the api docs and looks broken


The data-plane Service on port `9201` serves both REST and MCP. To expose MCP, route `/iris/data/v1/agent-playbooks/playbooks/{playbookId}/mcp` to the data-plane Service and keep the complete path, the `Authorization` header, the request body, and the MCP and `Accept` headers. MCP messages use `POST`. The transport is stateless, so an authenticated `GET` or `DELETE` returns `405`.

Exposing a whole Identity Service Service also exposes its administration routes. Expose only the routes your applications need.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Exposing a whole Identity Service Service also exposes its administration routes. Expose only the routes your applications need.
Exposing a whole Identity Service also exposes its administration routes. Expose only the routes your applications need.

- A runtime credential in `runtime.serviceCredentials`, so the product's data plane can check agent keys.
- A grant validator in `productValidation.products.<product>`, so the Identity Service can check the product's resources before it stores a grant.

This table lists the entries for each product, with the release names and Secret names that the products' deploy guides use:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This table lists the entries for each product, with the release names and Secret names that the products' deploy guides use:
This table lists the entries for each service, with the release names and Secret names used in the associated deployment guide:


### Serve several products from one release

One release serves every product. Write all entries in one values file. Helm replaces lists instead of merging them, so each `helm upgrade` must restate every `serviceCredentials` entry, not only the new one.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
One release serves every product. Write all entries in one values file. Helm replaces lists instead of merging them, so each `helm upgrade` must restate every `serviceCredentials` entry, not only the new one.
One release serves every service. Write all entries in one values file. Helm replaces lists instead of merging them, so each `helm upgrade` must restate every `serviceCredentials` entry, not only the new one.

hideListLinks: true
---

Follow these steps to install the Identity Service with the `iris-identity-service` Helm chart, register your first Iris product with it, and check that its control API accepts your control token.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this will be confusing to use the term products in the id service docs

hideListLinks: true
---

Lens traces your AI agents' turns, so developers can see what each source returned, what entered the prompt, and how each step went. Before developers can send turns, a platform administrator deploys Lens, connects it to an Identity Service, and gives each application an endpoint and API keys.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Lens traces your AI agents' turns, so developers can see what each source returned, what entered the prompt, and how each step went. Before developers can send turns, a platform administrator deploys Lens, connects it to an Identity Service, and gives each application an endpoint and API keys.
Lens traces your AI agent turns, so developers can see what each source returned, what entered the prompt, and how each step went. Before developers can send turns, a platform administrator deploys Lens, connects it to an Identity Service, and gives each application an endpoint and API keys.

@mich-elle-luna mich-elle-luna left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one more request to revert a change

Comment thread content/ai-agent-resources.md Outdated
"shadowed_count": 10,
"redirects": [
{"from": "/develop/ai/langcache", "to": "https://redis.io/docs/latest/develop/ai/context-engine/langcache/", "moved_on": "2026-05-11"}
{"from": "/develop/ai/langcache", "to": "https://redis.io/docs/latest/develop/ai/langcache/", "moved_on": "2026-05-11"}

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is incorrect, this page describes a move, please revert this change

@mich-elle-luna mich-elle-luna left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

another one: https://redis.io/docs/staging/docs/iris-flight-feedback/operate/iris/ this should probably have a tile for the Identity service

rbs333 and others added 7 commits November 3, 2026 12:49
…ght-feedback

# Conflicts:
#	content/develop/ai/context-engine/agent-memory/_index.md
…the diagram restyle

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- Landing page: restore the description and the need-first What is list, in product order, with Lens and Agent Mesh marked beta.
- SDK and CLI setup and the operate landing page say service, not capability.
- Identity Service pages say service instead of product in prose; field names are unchanged.
- Agent Playbooks: drop the pre-1.0 OIDC upgrade note; the control-plane API reference page carries no body.
- Suggested wording on the Playbooks prerequisites, Identity Service configuration and Lens overview.
- Revert the ai-agent-resources redirect record, which documents a past move.
- Add an Identity Service tile to the operate landing page.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ght-feedback

# Conflicts:
#	build/agent_playbook_docs/test_reference.py
Every section under Deploy and operate now has Deployment options with Redis Cloud and
Self-managed subsections, in the Agent Playbooks shape. Intent Router's Redis Cloud
subsection waits on its Cloud pages.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…t call

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@rbs333
rbs333 merged commit cbab608 into iris-ga-docs Nov 3, 2026
104 checks passed
@rbs333
rbs333 deleted the docs/iris-flight-feedback branch November 3, 2026 22:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

iris Iris context engine docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants