Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/operate/iris/agent-memory/self-managed/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ documents the self-managed admin endpoints for stores.

## What you are deploying

The `redis-iris` chart `1.0.0` deploys the Agent Memory Data Plane, workers, and Control Plane,
The `redis-iris` chart `1.0` deploys the Agent Memory Data Plane, workers, and Control Plane,
with the Identity Service and the Iris console, under fixed names. Agent Memory's values go under
the `memory:` key, and the chart's `examples/memory-only.yaml` is a working values file to start
from. You provide the Redis databases.
Expand Down
2 changes: 1 addition & 1 deletion content/operate/iris/agent-memory/self-managed/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ For a new release, follow [Run the preflight](/content/operate/iris/self-managed

```bash
helm upgrade iris redis-ai/redis-iris \
--version 1.0.0 \
--version '~1.0.1' \
--namespace <namespace-name> \
-f iris-values.yaml
```
Expand Down
7 changes: 3 additions & 4 deletions content/operate/iris/agent-memory/self-managed/operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ and then removes what it created. See [Verify the deployment](/content/operate/i

## FIPS

The suite chart `1.0.0` doesn't support the Federal Information Processing Standards (FIPS)
The suite chart `1.0` doesn't support the Federal Information Processing Standards (FIPS)
profile. `global.security.profile: fips` fails the install. See
[Not supported in this release](/content/operate/iris/self-managed/_index.md#not-supported-in-this-release).

Expand All @@ -125,11 +125,10 @@ the direct caller also has a valid Redis Agent Memory credential.

The Agent Memory chart inside the suite package includes `networkpolicy.reference.yaml` as a
reference manifest. It is not templated, because allowed callers are environment-specific. Get it
from the suite package:
from the suite package, at `redis-iris/charts/redis-agent-memory/networkpolicy.reference.yaml`:

```bash
helm pull redis-ai/redis-iris --version 1.0.0 --untar
tar -xzf redis-iris/charts/redis-agent-memory-1.0.0.tgz redis-agent-memory/networkpolicy.reference.yaml
helm pull redis-ai/redis-iris --version '~1.0.1' --untar
```

Customize the placeholders before applying it:
Expand Down
24 changes: 11 additions & 13 deletions content/operate/iris/agent-memory/self-managed/prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ aliases:
- /operate/iris/agent-memory/self-managed/plan-deployment/
---

Agent Memory installs as the `memory` service of the `redis-iris` Helm chart `1.0.0`, from the
Agent Memory installs as the `memory` service of the `redis-iris` Helm chart `1.0`, from the
Redis AI Helm repository `https://helm.redis.io/ai`. The suite deploys the Agent Memory Data Plane,
workers, and Control Plane, with the Identity Service and the Iris console. Start with the
[suite prerequisites](/content/operate/iris/self-managed/_index.md#prerequisites). This page adds
Expand All @@ -25,8 +25,8 @@ what Agent Memory needs.

| Item | Where it comes from |
| ---- | ------------------- |
| Helm chart | `redis-ai/redis-iris` `1.0.0` |
| Container images | Docker Hub: `redislabs/agent-memory:1.0.0` and `redislabs/agent-memory-control-plane:1.0.0`, plus the Identity Service and console images the suite installs |
| Helm chart | `redis-ai/redis-iris` `1.0` |
| Container images | Docker Hub: `redislabs/agent-memory` and `redislabs/agent-memory-control-plane`, tagged with the chart version, plus the Identity Service and console images the suite installs |
| Redis databases | You provide Store Redis, Job Redis, and Metadata Redis |
| License key | One suite license. Contact your Redis representative or [contact sales](https://redis.io/contact/). |
| Provider credentials | You provide embedding provider credentials and, when worker features are enabled, promotion or summarization LLM credentials |
Expand Down Expand Up @@ -105,25 +105,23 @@ The suite generates Memory's runtime credential, Control Plane internal token, a
## Air-gapped and private registry installs

Mirror these Agent Memory images into your internal registry, along with the images of the
other components the suite installs:
other components the suite installs. Each Redis image tag is the chart version:

| Image | Needed |
| --- | --- |
| `redislabs/agent-memory:1.0.0` | Always (Data Plane and workers) |
| `redislabs/agent-memory-control-plane:1.0.0` | Always |
| `redislabs/iris-identity-service:1.0.0` | Always |
| `redislabs/agent-memory` | Always (Data Plane and workers) |
| `redislabs/agent-memory-control-plane` | Always |
| `redislabs/iris-identity-service` | Always |
| `curlimages/curl:8.17.0` | The suite preflight (`preflight.image`) |
| `python:3.13-alpine` | `helm test iris` (`tests.suiteVerify.image`) |
| `hibiken/asynqmon:0.7.2` | Optional, with `memory.controlplane.queueMonitor` |
| `ghcr.io/jpedrosouza/asynqdash:1.2.0` | Optional, with `memory.controlplane.queueMonitor` |

```bash
docker pull redislabs/agent-memory:1.0.0
docker tag redislabs/agent-memory:1.0.0 \
registry.example.com/redislabs/agent-memory:1.0.0
docker push registry.example.com/redislabs/agent-memory:1.0.0
skopeo copy --all docker://redislabs/agent-memory:<chart-version> \
docker://registry.example.com/redislabs/agent-memory:<chart-version>
```

Repeat for each image. If the registry requires authentication, create an image pull Secret:
Repeat for each image. `--all` copies every platform. `docker pull` and `docker push` copy only your workstation's, so nodes of the other platform can't pull the image. If the registry requires authentication, create an image pull Secret:

```bash
kubectl -n <namespace-name> create secret docker-registry iris-registry \
Expand Down
4 changes: 2 additions & 2 deletions content/operate/iris/agent-memory/self-managed/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,8 @@ CSI-synced Secrets, make sure a Control Plane pod also mounts the corresponding

| Need | Reference |
| --- | --- |
| Suite chart values | `helm show values redis-ai/redis-iris --version 1.0.0` |
| Agent Memory chart values and README | `charts/redis-agent-memory-1.0.0.tgz` in the suite package (`helm pull redis-ai/redis-iris --version 1.0.0 --untar`) |
| Suite chart values | `helm show values redis-ai/redis-iris --version '~1.0.1'` |
| Agent Memory chart values and README | `redis-iris/charts/redis-agent-memory/` in the suite package (`helm pull redis-ai/redis-iris --version '~1.0.1' --untar`) |
| NetworkPolicy reference | [Network policy](/content/operate/iris/agent-memory/self-managed/operations.md#network-policy) |
| Redis Agent Memory API reference | [Redis Agent Memory API]({{< relref "/develop/ai/context-engine/agent-memory/api-reference" >}}) |
| Control Plane API reference | [Control Plane API reference]({{< relref "/operate/iris/agent-memory/self-managed/control-plane-api-reference" >}}) |
Expand Down
2 changes: 1 addition & 1 deletion content/operate/iris/agent-playbook/self-managed/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Redis Agent Playbooks store the answers and procedures your business approves as

This guide is for that administrator. It covers deploying Agent Playbooks on your own Kubernetes cluster, then configuring, securing, and operating it. To install, follow [Install the Redis Iris suite](/content/operate/iris/self-managed/_index.md), then [Deploy](/content/operate/iris/agent-playbook/self-managed/deploy.md).

The `redis-iris` chart `1.0.0` deploys the Agent Playbooks control plane and data plane, and optionally a background extraction worker, with the Identity Service that issues and checks agent keys. Agent Playbooks values go under the `playbook:` key, and the chart's `examples/playbook.yaml` is a working values file to start from. You provide the Redis databases, the embedding provider, and the suite license. The chart doesn't install Redis.
The `redis-iris` chart `1.0` deploys the Agent Playbooks control plane and data plane, and optionally a background extraction worker, with the Identity Service that issues and checks agent keys. Agent Playbooks values go under the `playbook:` key, and the chart's `examples/playbook.yaml` is a working values file to start from. You provide the Redis databases, the embedding provider, and the suite license. The chart doesn't install Redis.

Applications call the data plane to author, review, and retrieve entries, as described in the [data-plane API reference](/content/develop/ai/context-engine/agent-playbooks/api-reference.md). The [control-plane API reference](/content/operate/iris/agent-playbook/self-managed/control-plane-api-reference.md) documents the administration endpoints for playbooks.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ weight: 30
hideListLinks: true
---

The `redis-iris` chart `1.0.0` renders the Agent Playbooks control-plane and data-plane configuration from the `playbook:` values in `iris-values.yaml`. Storage URLs and provider credentials stay in Secrets you create. The suite supplies the tenant, the license, and the Identity Service connection and credentials, as [Add the Agent Playbooks values](/content/operate/iris/agent-playbook/self-managed/deploy.md#2-add-the-agent-playbooks-values) lists.
The `redis-iris` chart `1.0` renders the Agent Playbooks control-plane and data-plane configuration from the `playbook:` values in `iris-values.yaml`. Storage URLs and provider credentials stay in Secrets you create. The suite supplies the tenant, the license, and the Identity Service connection and credentials, as [Add the Agent Playbooks values](/content/operate/iris/agent-playbook/self-managed/deploy.md#2-add-the-agent-playbooks-values) lists.

## Storage configuration

Expand Down Expand Up @@ -86,7 +86,7 @@ The install fails with a named message when a required value is missing: `playbo
For every value and its default, see the [configuration reference](/content/operate/iris/agent-playbook/self-managed/reference.md#configuration-reference), or run:

```bash
helm show values redis-ai/redis-iris --version 1.0.0
helm show values redis-ai/redis-iris --version '~1.0.1'
```

## Trust a private CA
Expand All @@ -102,7 +102,7 @@ Set `global.tls.caCertSecret: playbook-ca` for every service, or `playbook.tls.c

## Configure tracing

The Federal Information Processing Standards (FIPS) profile isn't supported in `redis-iris` `1.0.0`. See [Not supported in this release](/content/operate/iris/self-managed/_index.md#not-supported-in-this-release).
The Federal Information Processing Standards (FIPS) profile isn't supported in `redis-iris` `1.0`. See [Not supported in this release](/content/operate/iris/self-managed/_index.md#not-supported-in-this-release).

To export traces from the control plane, data plane, and extraction worker, configure a trusted OpenTelemetry Protocol (OTLP) collector:

Expand Down
2 changes: 1 addition & 1 deletion content/operate/iris/agent-playbook/self-managed/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ For a new release, follow [Run the preflight](/content/operate/iris/self-managed

```bash
helm upgrade iris redis-ai/redis-iris \
--version 1.0.0 \
--version '~1.0.1' \
--namespace <namespace-name> \
-f iris-values.yaml
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ Upgrade the release:

```bash
helm upgrade iris redis-ai/redis-iris \
--version 1.0.0 \
--version '~1.0.1' \
--namespace <namespace-name> \
-f iris-values.yaml
kubectl -n <namespace-name> rollout status deployment/redis-agent-playbook-worker
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ weight: 20
hideListLinks: true
---

The `redis-iris` chart `1.0.0` deploys the Agent Playbooks control plane, data plane, and optional extraction worker, with the Identity Service. Start with the suite's [prerequisites](/content/operate/iris/self-managed/_index.md#prerequisites). This page lists what Agent Playbooks adds: the Redis databases, the embedding provider, and Kubernetes exposure.
The `redis-iris` chart `1.0` deploys the Agent Playbooks control plane, data plane, and optional extraction worker, with the Identity Service. Start with the suite's [prerequisites](/content/operate/iris/self-managed/_index.md#prerequisites). This page lists what Agent Playbooks adds: the Redis databases, the embedding provider, and Kubernetes exposure.

## What you need

Expand Down Expand Up @@ -75,12 +75,12 @@ The Identity Service's metadata Redis is a suite prerequisite. It can use the Ag

## Images and network access

The suite chart pins these images:
The suite chart pins these images, tagged with the chart version:

| Component | Image |
| --- | --- |
| Control plane | `redislabs/iris-agent-playbook-control:1.0.0` |
| Data plane and extraction worker | `redislabs/iris-agent-playbook-data:1.0.0` |
| Control plane | `redislabs/iris-agent-playbook-control` |
| Data plane and extraction worker | `redislabs/iris-agent-playbook-data` |

Allow chart downloads, image pulls, Redis connections, and data-plane access to the embedding provider. The data plane and control plane must reach the Identity Service, and the Identity Service must reach the control plane on port `9200`. For a disconnected installation, mirror the images, use a downloaded chart package, and set the image repositories and `imagePullSecrets` under `playbook:` in `iris-values.yaml`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ aliases:
- /operate/iris/context-retriever/self-managed/
---

The `redis-iris` chart `1.0.0` deploys the Context Gateway Control Plane and Data Plane, with the Identity Service that issues and checks agent keys. Context Gateway values go under the `contextGateway:` key, and the chart's `examples/context-gateway.yaml` is a working values file to start from. You provide the Redis databases, the `https://` origin MCP clients reach the Data Plane at, and the suite license. The chart doesn't install Redis, Vault, or Secrets Store CSI (Container Storage Interface) Driver resources. To install, follow [Install the Redis Iris suite](/content/operate/iris/self-managed/_index.md), then [Deploy](/content/operate/iris/context-gateway/self-managed/deploy.md).
The `redis-iris` chart `1.0` deploys the Context Gateway Control Plane and Data Plane, with the Identity Service that issues and checks agent keys. Context Gateway values go under the `contextGateway:` key, and the chart's `examples/context-gateway.yaml` is a working values file to start from. You provide the Redis databases, the `https://` origin MCP clients reach the Data Plane at, and the suite license. The chart doesn't install Redis, Vault, or Secrets Store CSI (Container Storage Interface) Driver resources. To install, follow [Install the Redis Iris suite](/content/operate/iris/self-managed/_index.md), then [Deploy](/content/operate/iris/context-gateway/self-managed/deploy.md).

Agents call the Data Plane's Model Context Protocol (MCP) endpoint, described in the [MCP API Reference](/content/develop/ai/context-engine/context-gateway/api-reference.md). The [Control Plane API Reference](/content/operate/iris/context-gateway/self-managed/control-plane-api-reference.md) documents the self-managed administration endpoints for Gateways and Upstreams.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ For a new release, follow [Run the preflight](/content/operate/iris/self-managed

```bash
helm upgrade iris redis-ai/redis-iris \
--version 1.0.0 \
--version '~1.0.1' \
--namespace <namespace-name> \
-f iris-values.yaml
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Redis URLs, tokens, keyrings, and the license belong in Kubernetes Secrets or Se

The chart defaults to these repositories and pins the image tags that match its chart version. Leave `image.repository` and `image.tag` unset for a public install, and override them only to pull from a mirror.

Chart `1.0.0` pins both images to tag `1.0.0`.
The chart pins both images to its own version.

## Air-gapped and private registry installs

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,6 @@ Each file reference accepts a Kubernetes Secret or a Secrets Store Container Sto

| Need | Reference |
| --- | --- |
| Helm chart values | `helm show values redis-ai/redis-iris --version 1.0.0`, with Context Gateway under `contextGateway:` |
| Helm chart values | `helm show values redis-ai/redis-iris --version '~1.0.1'`, with Context Gateway under `contextGateway:` |
| Chart examples | `examples/context-gateway.yaml` in the `redis-iris` chart package |
| Chart README | `helm show readme redis-ai/redis-iris --version 1.0.0` |
| Chart README | `helm show readme redis-ai/redis-iris --version '~1.0.1'` |
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The Identity Service is the one place where a self-managed Redis Iris installati
1. It keeps the grants of each key. A grant says which resource the caller can use, and how.
1. It answers the data planes when they ask whether a key is valid, and what it can do.

This guide is for the platform administrator who installs the Identity Service, manages agent keys, and manages operator access. The `redis-iris` chart `1.0.0` always installs the Identity Service, as `iris-identity-service`. Its values go under the `identityService:` key, with the shared values under `global.iris`. It needs no license of its own, because the suite license covers it. To install, follow [Install the Redis Iris suite](/content/operate/iris/self-managed/_index.md), then [Deploy](/content/operate/iris/identity-service/self-managed/deploy.md).
This guide is for the platform administrator who installs the Identity Service, manages agent keys, and manages operator access. The `redis-iris` chart `1.0` always installs the Identity Service, as `iris-identity-service`. Its values go under the `identityService:` key, with the shared values under `global.iris`. It needs no license of its own, because the suite license covers it. To install, follow [Install the Redis Iris suite](/content/operate/iris/self-managed/_index.md), then [Deploy](/content/operate/iris/identity-service/self-managed/deploy.md).

## What you deploy

Expand Down
4 changes: 2 additions & 2 deletions content/operate/iris/identity-service/self-managed/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,9 @@ Run the [suite preflight](/content/operate/iris/self-managed/_index.md#4-run-the
```bash
helm repo add redis-ai https://helm.redis.io/ai
helm repo update redis-ai
helm pull redis-ai/redis-iris --version 1.0.0 --untar
helm pull redis-ai/redis-iris --version '~1.0.1' --untar
helm install iris redis-ai/redis-iris \
--version 1.0.0 \
--version '~1.0.1' \
--namespace <namespace-name> \
-f redis-iris/examples/memory-only.yaml \
-f iris-values.yaml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The Identity Service depends on a metadata Redis and Secrets that you set up fir

| Requirement | Detail |
| --- | --- |
| Suite chart | `redis-iris` chart `1.0.0` in the Redis AI Helm repository, `https://helm.redis.io/ai`. The suite prerequisites list the Kubernetes, Helm, and Metrics API versions. |
| Suite chart | `redis-iris` chart `1.0` in the Redis AI Helm repository, `https://helm.redis.io/ai`. The suite prerequisites list the Kubernetes, Helm, and Metrics API versions. |
| Namespace | A namespace that holds only this release. The examples use `<namespace-name>`. |
| Metadata Redis | A Redis database for the Identity Service, as described in [Metadata Redis](#metadata-redis). |
| `kubectl`, `curl` | For the install and administration examples. |
Expand Down
2 changes: 1 addition & 1 deletion content/operate/iris/intent-router/self-managed/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Intent Router classifies each incoming user message by intent, so your applicati

This guide is for that administrator. It covers deploying Intent Router on your own Kubernetes cluster, then configuring, securing, and operating it. To install, follow [Install the Redis Iris suite](/content/operate/iris/self-managed/_index.md), then [Deploy](/content/operate/iris/intent-router/self-managed/deploy.md).

The `redis-iris` chart `1.0.0` deploys the Intent Router control plane and data plane, with the Identity Service that issues and checks agent keys. Intent Router values go under the `intent:` key, and the chart's `examples/intent.yaml` is a working values file to start from. You provide the Redis databases, the embedding provider credentials, and the suite license.
The `redis-iris` chart `1.0` deploys the Intent Router control plane and data plane, with the Identity Service that issues and checks agent keys. Intent Router values go under the `intent:` key, and the chart's `examples/intent.yaml` is a working values file to start from. You provide the Redis databases, the embedding provider credentials, and the suite license.

Applications call the data plane to author intents and match queries, as described in the [data-plane API reference](/content/develop/ai/context-engine/intent-router/api-reference.md). The [control-plane API reference](/content/operate/iris/intent-router/self-managed/control-plane-api-reference.md) documents the administration endpoints for Routers.

Expand Down
2 changes: 1 addition & 1 deletion content/operate/iris/intent-router/self-managed/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ For a new release, follow [Run the preflight](/content/operate/iris/self-managed

```bash
helm upgrade iris redis-ai/redis-iris \
--version 1.0.0 \
--version '~1.0.1' \
--namespace <namespace-name> \
-f iris-values.yaml
```
Expand Down
Loading
Loading