Self-managed Redis Intent Router

Deploy, configure, and operate Redis Intent Router on a self-managed Kubernetes cluster.

Note:

Install Intent Router with the redis-iris suite chart, the supported self-managed install. Installing the redis-intent-router chart on its own isn't a supported install path. These guides document its values, which you set under the suite chart's intent: key.

Intent Router classifies each incoming user message by intent, so your application can send it to the right agent, workflow, or handler. Developers define intents with example phrases, and their applications send messages to a Router to find the closest match. Before developers can do that, a platform administrator deploys Intent Router and creates Routers and agent keys for them.

This guide is for that administrator. It covers deploying Intent Router on your own Kubernetes cluster with a Helm chart, then configuring, securing, and operating it. To install, start with the prerequisites.

The redis-intent-router Helm chart deploys one tenant's Intent Router control plane and data plane. It deploys no Identity Service: it connects to an Identity Service release that you install separately, which issues and checks agent keys. You provide the Identity Service release, the Redis databases, the embedding provider credentials, and the license.

Applications call the data plane to author intents and match queries, as described in the data-plane API reference. The control-plane API reference documents the administration endpoints for Routers.

These guides use redis-intent-router chart 1.0.0. Its images are tagged with the chart version, 1.0.0.

What you deploy

Component Purpose Service port
Control plane Create and manage Routers, and validate agent-key grants. 9400
Data plane Store intents and examples, build each Router's vector index, and serve matching. 9401
Identity Service Issue agent keys and check them for the data plane. Installed as its own release. 9200
Metadata Redis Store Router records and the mailbox the planes coordinate through. Customer-provided
Data-plane Redis Store intents, examples, and a vector index for each Router. Needs Redis Search. Customer-provided
Embedding provider Embed examples and queries. Customer-provided

Use a separate Redis for the control plane's metadata and for the data plane. The data-plane Redis needs the Search and Query engine: use a Redis 8 build that includes it, such as the official redis:8 image, or load the module.

How the components work together

Flow Caller Service Backing store
Router administration Platform admin Control plane Metadata Redis
Agent-key administration Platform admin Identity Service Identity Service metadata Redis
Grant validation Identity Service Control plane Metadata Redis
Authoring and matching Application Data plane Data-plane Redis and the embedding provider
  1. Platform admins create Routers through the control plane, then mint agent keys through the Identity Service.
  2. The Identity Service asks the control plane to confirm that a Router exists before it mints a key for it.
  3. The control plane writes each Router's desired configuration to a mailbox in the metadata Redis. The data plane applies it, builds the Router's vector index, and publishes the result back. The two planes never call each other.
  4. Applications call the data plane with an agent key. The data plane checks the key with the Identity Service and reads or writes the Router's data.

A Router serves requests only after the data plane has applied its current configuration. Until then, data requests return 409.

API surfaces

API surface Endpoint Purpose
Data plane /iris/data/v1/intent/routers/{routerId} Authoring and matching for one Router.
Control plane /iris/v1/intent/routers, /iris/v1/intent/models Administration of Routers and the model they use.
Health /health/liveness, /health/readiness Liveness and readiness on both planes.
Identity Service /v1/api-keys Administration of agent keys.

Get started

  1. Review the prerequisites.
  2. Prepare the configuration.
  3. Deploy the chart.
  4. Load administrative credentials.
  5. Create a Router and an agent key.

Manage the deployment

RATE THIS PAGE
Back to top ↑