{
  "schema_version": 2,
  "id": "operate/kubernetes/re-databases/modules",
  "title": "Configure modules",
  "url": "https://redis.io/docs/latest/operate/kubernetes/7.22/re-databases/modules/",
  "summary": "Deploy Redis Enterprise databases with modules using the Redis Enterprise operator for Kubernetes.",
  "content": "\nRedis Enterprise modules extend Redis functionality with additional data types, commands, and capabilities. The Redis Enterprise operator supports deploying databases with modules through the `RedisEnterpriseDatabase` (REDB) and `RedisEnterpriseActiveActiveDatabase` (REAADB) custom resources.\n\n## Prerequisites\n\nBefore you begin, verify that you have:\n\n- [Redis Enterprise operator deployed](https://redis.io/docs/latest/operate/kubernetes/deployment/quick-start) in your Kubernetes cluster\n- [Redis Enterprise Cluster (REC)](https://redis.io/docs/latest/operate/kubernetes/re-clusters) running and in a healthy state\n- Modules uploaded to the Redis Enterprise cluster (see [Check available modules](#check-available-modules))\n\n## Available modules\n\nRedis Enterprise includes several built-in modules:\n\n| Module | Name | Description |\n|--------|------|-------------|\n| **[RediSearch](https://redis.io/docs/latest/develop/ai/search-and-query)** | `search` | Full-text search and secondary indexing |\n| **[RedisJSON](https://redis.io/docs/latest/develop/data-types/json)** | `ReJSON` | JSON data type support |\n| **[RedisTimeSeries](https://redis.io/docs/latest/develop/data-types/timeseries)** | `timeseries` | Time series data structures |\n| **[RedisBloom](https://redis.io/docs/latest/develop/data-types/probabilistic)** | `bf` | Probabilistic data structures (Bloom filters, etc.) |\n\n### Check available modules\n\nBefore configuring databases with modules, check which modules are available in your cluster:\n\n```bash\nkubectl get rec \u003ccluster-name\u003e -o jsonpath='{.status.modules}' | jq\n```\n\nThis command shows the modules installed in the cluster along with their available versions.\n\n\u003e [!NOTE]\n\u003e Use the `NAME` field instead of the `DISPLAY_NAME` field when configuring databases with modules.\n\n## Install additional modules\n\nIf you need to install additional modules or specific versions, upload them using the Redis Enterprise API. See [Upload module v2](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/modules#post-module-v2) for more information.\n\n## Module configuration\n\nEach module in the [`modulesList`](https://redis.io/docs/latest/operate/kubernetes/reference/api/redis_enterprise_database_api#specmoduleslist) supports the following fields:\n\n- **name** (required): The module name (for example, \"search\", \"ReJSON\")\n- **version** (optional): Specific module version. For Active-Active databases, if specified for one participating cluster, it must be specified for all participating clusters. If omitted, modules will auto-update.\n- **config** (optional): Module-specific configuration parameters\n\nFor detailed module configuration options and parameters, see [Redis modules](https://redis.io/docs/latest/develop/reference/modules).\n\n## Upgrade considerations\n\nWhen upgrading Redis Enterprise clusters or the operator with modules, follow these guidelines:\n\n#### Pre-upgrade planning\n\n- **Check module compatibility**: Verify that your current module versions are compatible with the target Redis Enterprise version. Check each module's [`min_redis_version`](https://redis.io/docs/latest/operate/rs/references/rest-api/objects/module/) requirement.\n- **Review module dependencies**: Some modules may have specific version requirements or dependencies\n- **Document current configurations**: Record all module versions and configurations before upgrading\n- **Test in non-production**: Always test module upgrades in a development or staging environment first\n\n#### Module version management during upgrades\n\n- **Upload required modules**: Ensure all necessary module versions are uploaded to the cluster before upgrading\n- **Version consistency**: For Active-Active databases, ensure module versions are consistent across all participating clusters. If you specify a version for one cluster, specify the same version for all clusters. Omit versions to allow auto-updates.\n- **Compatibility requirements**: Consult the Redis Enterprise documentation for module compatibility matrices and verify each module's [`min_redis_version`](https://redis.io/docs/latest/operate/rs/references/rest-api/objects/module/) requirement\n\n#### Upgrade sequence\n\n1. **Upload new module versions** (if required) to the cluster before upgrading Redis Enterprise\n2. **Upgrade the Redis Enterprise cluster** following standard upgrade procedures\n3. **Verify module functionality** after the cluster upgrade completes\n4. **Update database configurations** if new module versions require configuration changes\n\n#### Post-upgrade verification\n\n- **Check module status**: Verify all modules are loaded correctly: `kubectl get rec \u003ccluster-name\u003e -o jsonpath='{.status.modules}'`\n- **Test module functionality**: Validate that module-specific commands and features work as expected\n- **Monitor performance**: Watch for any performance changes after the upgrade\n- **Update documentation**: Record the new module versions and any configuration changes\n\nFor detailed upgrade procedures, see [Upgrade Redis Enterprise clusters](https://redis.io/docs/latest/operate/kubernetes/upgrade/upgrade-redis-cluster).\n\n## Related information\n\n- [Database controller](https://redis.io/docs/latest/operate/kubernetes/re-databases/db-controller) - Learn how to create and manage Redis Enterprise databases\n- [Active-Active databases](https://redis.io/docs/latest/operate/kubernetes/active-active) - Set up globally distributed Active-Active databases\n- [Database connectivity](https://redis.io/docs/latest/operate/kubernetes/networking/database-connectivity) - Connect applications to your Redis Enterprise databases\n- [REDB API reference](https://redis.io/docs/latest/operate/kubernetes/reference/api/redis_enterprise_database_api) - Complete API specification for REDB resources\n- [REAADB API reference](https://redis.io/docs/latest/operate/kubernetes/reference/api/redis_enterprise_active_active_database_api) - API reference for Active-Active databases\n- [Redis modules documentation](https://redis.io/docs/latest/develop/reference/modules/) - Official Redis modules documentation\n",
  "tags": ["docs","operate","kubernetes"],
  "last_updated": "2026-10-21T09:46:20-07:00"
}