Repository navigation
Iris docs: GA read-through feedback, Playbooks/Lens/Identity Service self-managed guides, LangCache out - #4435
Conversation
… 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>
🧠 Redis MemoryFound 5 related items from repository history:
Memory updated at 9275627 |
…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>
…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>
…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
left a comment
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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: |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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`. |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
| 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: |
There was a problem hiding this comment.
| 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. |
There was a problem hiding this comment.
| 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. |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
| 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
left a comment
There was a problem hiding this comment.
one more request to revert a change
| "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"} |
There was a problem hiding this comment.
this is incorrect, this page describes a move, please revert this change
mich-elle-luna
left a comment
There was a problem hiding this comment.
another one: https://redis.io/docs/staging/docs/iris-flight-feedback/operate/iris/ this should probably have a tile for the Identity service
…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>
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)
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
service create).@redis-iris/*package, not just Context Gateway.iris --helpand PyPI. The project-setup examples are open TODO comments (see the decisions below). The two Agent Mesh pages lose the same dead links.https://helm.redis.io/aiis now a link.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-irisexample), then the product's own sections. Existing content is moved, not rewritten.IRIS_*variables the CLI writes.Agent Memory
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:/iris/v1/agent-playbooksroutes, with the API reference regenerated from the current contract.http://; only the JWKS URL needs HTTPS. The admin token works on both planes.It covers only the operator pages from #4256; the rest of #4256 is already on
iris-ga-docsvia #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 irismain:AGENTS.mdis updated to match.LangCache leaves the Iris docs. It moves back to its earlier homes:
develop/ai/langcache, the self-managed guide tooperate/rc/langcache/self-managed, and the other operator pages tooperate/rc/langcache./operate/rc/context-engine/langcache/...URLs.rc/context-engine/langcachebridge stub is removed, and its URL redirects to the LangCache page.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 irismain.iris identity keys), operator sign-in with an identity provider (IdP), subject grants, rotation, upgrade, backup, and troubleshooting.Aligned with the latest iris
main(2c9625b):Chart.yaml: Identity Service1.2.0in every guide, and Lens0.2.1, Context Gateway0.2.0, Intent Router0.1.0in place of their<chart-version>placeholders. Agent Memory and Agent Playbooks stay1.0.0. M6 (iris#2368) moves the Identity Service to1.3.0; a TODO tracks it.POST /v1/subject-grants/apply, not the earlierPUT /v1/subject-grants. The Data Plane credential is named (context-gateway-dp, subjectcontext-gateway-dataplane, from the chart README) and needssubject-grant-lookupwhen Data Plane sign-in is on.ids, like every other guide.maxResults/nextToken, or the CLI's--limit/--cursor/--all), per the API contract.Other fixes
redis-iris>=1.0.0andredis-agent-lens>=1.0.0(it was>=0.1.0a4, which uses the old routes), and says what thellm-tracingextra adds.identityService.credentialand the chart doesn't generate it. The merged Iris docs: align Context Gateway and Intent Router self-managed docs with the operator runbooks #4419/Iris docs: align Agent Memory and Identity Service self-managed docs with the operator runbooks #4420 table namedidentityService.runtimeToken, which the chart doesn't have.Needed from others
Decisions needed
Possibly wrong, left as is
limits.mdsays an administrator can change the ingest request size, but the chart has no value for it. Not changed here; Lens owners should confirm.Testing
service create --dry-runwas 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/langcacheagain; Redis Cloud operator docs useoperate/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-irisGitHub 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 Gateway0.2.0).Reviewed by Cursor Bugbot for commit 9275627. Bugbot is set up for automated code reviews on this repo. Configure here.