{
  "schema_version": 2,
  "id": "operate/iris/agent-playbook/self-managed",
  "title": "Self-managed Redis Agent Playbooks",
  "url": "https://redis.io/docs/latest/operate/iris/agent-playbook/self-managed/",
  "summary": "Deploy, configure, and operate Redis Agent Playbooks on a self-managed Kubernetes cluster.",
  "tags": [
    "docs",
    "operate",
    "iris"
  ],
  "last_updated": "2026-11-03T16:45:14-08:00",
  "children": [
    {
      "id": "operate/iris/agent-playbook/self-managed/prerequisites",
      "summary": "Review software, Identity Service, Redis, embedding, network, Secret, and image prerequisites for self-managed Agent Playbooks.",
      "title": "Self-managed Agent Playbooks prerequisites",
      "url": "https://redis.io/docs/latest/operate/iris/agent-playbook/self-managed/prerequisites/"
    },
    {
      "id": "operate/iris/agent-playbook/self-managed/configuration",
      "summary": "Prepare Helm values, the storage and embedding Secrets, Identity Service connection settings, private CA trust, security, and tracing for Agent Playbooks.",
      "title": "Configure self-managed Agent Playbooks",
      "url": "https://redis.io/docs/latest/operate/iris/agent-playbook/self-managed/configuration/"
    },
    {
      "id": "operate/iris/agent-playbook/self-managed/deploy",
      "summary": "Install the Identity Service and Redis Agent Playbooks, then create a playbook, mint an agent key, and make one authenticated call.",
      "title": "Deploy Redis Agent Playbooks",
      "url": "https://redis.io/docs/latest/operate/iris/agent-playbook/self-managed/deploy/"
    },
    {
      "id": "operate/iris/agent-playbook/self-managed/authentication",
      "summary": "Understand the Agent Playbooks credentials, load the administration tokens, scope agent-key grants, and configure operator sign-in with OpenID Connect.",
      "title": "Authentication and authorization",
      "url": "https://redis.io/docs/latest/operate/iris/agent-playbook/self-managed/authentication/"
    },
    {
      "id": "operate/iris/agent-playbook/self-managed/api-examples",
      "summary": "Create a playbook, mint publisher and reader agent keys, verify agent access, and hand connection details to a developer.",
      "title": "Self-managed Agent Playbooks API examples",
      "url": "https://redis.io/docs/latest/operate/iris/agent-playbook/self-managed/api-examples/"
    },
    {
      "id": "operate/iris/agent-playbook/self-managed/control-plane-api-reference",
      "summary": "",
      "title": "Agent Playbooks control-plane API reference",
      "url": "https://redis.io/docs/latest/operate/iris/agent-playbook/self-managed/control-plane-api-reference/"
    },
    {
      "id": "operate/iris/agent-playbook/self-managed/extraction",
      "summary": "Connect Redis Agent Memory, run the Agent Playbooks extraction worker, and create, enable, pause, and remove extraction bindings.",
      "title": "Configure background FAQ extraction",
      "url": "https://redis.io/docs/latest/operate/iris/agent-playbook/self-managed/extraction/"
    },
    {
      "id": "operate/iris/agent-playbook/self-managed/operations",
      "summary": "Check health, rotate keys and Secrets, clear, suspend, or delete playbooks, back up storage, and upgrade Agent Playbooks.",
      "title": "Operate self-managed Agent Playbooks",
      "url": "https://redis.io/docs/latest/operate/iris/agent-playbook/self-managed/operations/"
    },
    {
      "id": "operate/iris/agent-playbook/self-managed/reference",
      "summary": "Look up Helm values and resolve common Agent Playbooks deployment problems.",
      "title": "Configuration and troubleshooting",
      "url": "https://redis.io/docs/latest/operate/iris/agent-playbook/self-managed/reference/"
    }
  ],
  "page_type": "content",
  "content_hash": "d8d76214eb3aeea80ba128b6fad3b30ee0f1fc0869a2874988f0e382ef0b1c4f",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "> [!NOTE]\n> Install Agent Playbooks with the [`redis-iris` suite chart](https://redis.io/docs/latest/operate/iris/self-managed), the supported self-managed install. Installing the `redis-agent-playbook` chart on its own isn't a supported install path. These guides document its values, which you set under the suite chart's `playbook:` key.\n\nRedis Agent Playbooks store the answers and procedures your business approves as versioned FAQs and skills, and serve the published versions to your agents. Developers author entries and review proposals in a playbook; agents retrieve published entries over REST or the Model Context Protocol (MCP). Before developers can do that, a platform administrator deploys Agent Playbooks and creates playbooks and agent keys for them.\n\nThis guide is for that administrator. It covers deploying Agent Playbooks on your own Kubernetes cluster with a Helm chart, then configuring, securing, and operating it. To install, start with the [prerequisites](https://redis.io/docs/latest/operate/iris/agent-playbook/self-managed/prerequisites).\n\nThe `redis-agent-playbook` Helm chart deploys the Agent Playbooks control plane and data plane, and optionally a background extraction worker. It connects to a separately installed Identity Service release, which issues and checks agent keys. You provide the Identity Service release, the Redis databases, the embedding provider, and the license. The chart does not install Redis or configure ingress and certificates.\n\nThese guides use `redis-agent-playbook` chart `1.0.0`.\n\nApplications call the data plane to author, review, and retrieve entries, as described in the [data-plane API reference](https://redis.io/docs/latest/develop/ai/context-engine/agent-playbooks/api-reference). The [control-plane API reference](https://redis.io/docs/latest/operate/iris/agent-playbook/self-managed/control-plane-api-reference) documents the administration endpoints for playbooks."
    },
    {
      "id": "what-you-deploy",
      "title": "What you deploy",
      "role": "content",
      "text": "| Component | Purpose | Service port |\n| --- | --- | --- |\n| Control plane | Create playbooks, manage their settings and lifecycle, and validate agent-key grants. | `9200` |\n| Data plane | Author and retrieve FAQs and skills, review proposals, and serve MCP requests. | `9201` |\n| Extraction worker | Optionally propose FAQs from connected Redis Agent Memory sessions. | `9203` |\n| Identity Service | Issue agent keys and check them for the data plane. Installed as its own release. | `9200` |\n| Metadata Redis | Store playbook configuration. | Customer-provided |\n| Content Redis | Store entries, proposals, and search indexes. Needs JSON and Search. | Customer-provided |\n\nMetadata and content need physically separate Redis deployments."
    },
    {
      "id": "how-the-components-work-together",
      "title": "How the components work together",
      "role": "content",
      "text": "| Flow | Caller | Service | Backing store |\n| --- | --- | --- | --- |\n| Playbook administration | Platform admin | Control plane | Metadata Redis |\n| Agent-key administration | Platform admin | Identity Service | Identity Service metadata Redis |\n| Grant validation | Identity Service | Control plane | Metadata Redis |\n| Authoring, review, and retrieval | Application or agent | Data plane | Content Redis and the embedding provider |\n\n1. Platform admins create playbooks through the control plane, then mint agent keys through the Identity Service.\n1. The Identity Service asks the control plane to confirm each playbook grant before it stores a key.\n1. Applications call the data plane with an agent key. The data plane checks the key with the Identity Service and reads or writes the playbook's content."
    },
    {
      "id": "api-surfaces",
      "title": "API surfaces",
      "role": "content",
      "text": "| API surface | Endpoint | Purpose |\n| --- | --- | --- |\n| Data plane | `/iris/data/v1/agent-playbooks/playbooks/{playbookId}` | Authoring, review, and retrieval for one playbook. |\n| MCP | `/iris/data/v1/agent-playbooks/playbooks/{playbookId}/mcp` | Read-only MCP tools for agents, on the data-plane port. |\n| Control plane | `/iris/v1/agent-playbooks/playbooks`, `/iris/v1/agent-playbooks/models` | Administration of playbooks, their settings, and extraction bindings. |\n| Health | `/health/liveness`, `/health/readiness` | Liveness and readiness on both planes. |\n| Identity Service | `/v1/api-keys` | Administration of agent keys. |"
    },
    {
      "id": "get-started",
      "title": "Get started",
      "role": "content",
      "text": "1. Review the [prerequisites](https://redis.io/docs/latest/operate/iris/agent-playbook/self-managed/prerequisites).\n1. Prepare the [configuration](https://redis.io/docs/latest/operate/iris/agent-playbook/self-managed/configuration).\n1. [Deploy the chart](https://redis.io/docs/latest/operate/iris/agent-playbook/self-managed/deploy).\n1. [Load administrative credentials](https://redis.io/docs/latest/operate/iris/agent-playbook/self-managed/authentication#load-the-administrative-credentials).\n1. [Create a playbook and agent keys](https://redis.io/docs/latest/operate/iris/agent-playbook/self-managed/api-examples).\n1. Optional: [configure background FAQ extraction](https://redis.io/docs/latest/operate/iris/agent-playbook/self-managed/extraction)."
    },
    {
      "id": "manage-the-deployment",
      "title": "Manage the deployment",
      "role": "content",
      "text": "- [Rotate or revoke agent keys](https://redis.io/docs/latest/operate/iris/agent-playbook/self-managed/operations#rotate-or-revoke-agent-keys).\n- [Check health, clear content, rotate Secrets, back up, and upgrade](https://redis.io/docs/latest/operate/iris/agent-playbook/self-managed/operations).\n- [Configure operator sign-in with OpenID Connect (OIDC)](https://redis.io/docs/latest/operate/iris/agent-playbook/self-managed/authentication#configure-operator-oidc-access).\n- [Troubleshoot the deployment](https://redis.io/docs/latest/operate/iris/agent-playbook/self-managed/reference#troubleshooting)."
    }
  ],
  "examples": []
}