docs: added cloud redis documentation (#12760)

* docs: added cloud redis documentation

* small fix

* add diagram

* small fixes
This commit is contained in:
Shahed Nasser
2025-06-18 10:42:09 +03:00
committed by GitHub
parent 5856963e0b
commit 97d5f52ffa
4 changed files with 61 additions and 1 deletions

View File

@@ -0,0 +1,46 @@
export const metadata = {
title: `Redis`,
}
# {metadata.title}
In this guide, you'll learn about the managed Redis service that Cloud provides as part of your project environments.
## Managed Redis Service
Cloud offers a managed Redis service for your project environments. Each environment has its own dedicated Redis instance that is automatically provisioned when the environment is created.
So, when you create a new project, Cloud creates a production Redis instance for the production environment. If you create a staging environment, Cloud creates a separate Redis instance for that environment as well.
![Diagram showcasing Redis isolation between environments](https://res.cloudinary.com/dza7lstvk/image/upload/v1750230910/Cloud/redis-cloud_llg83c.jpg)
---
## Configured Redis Infrastructure Modules
Cloud automatically configures your Medusa application to use Redis-based Infrastructure Modules, including:
- [Redis Event Module](!resources!/infrastructure-modules/event/redis)
- [Redis Cache Module](!resources!/infrastructure-modules/cache/redis)
- [Redis Locking Module Provider](!resources!/infrastructure-modules/locking/redis)
- [Redis Workflow Engine Module](!resources!/infrastructure-modules/workflow-engine/redis)
So, you don't need to configure any of these modules and providers or set up Redis manually. Also, if you have them configured in `medusa-config.ts`, remove them to avoid conflicts.
<Note>
If you're using a Medusa version before v2.7.0, [contact support](#) for assistance in configuring the Redis modules.
</Note>
### Override Redis Configurations
If you need to customize the Redis configurations for any of the Redis modules and providers, you must host and manage your own Redis instance externally.
Then, configure the modules and providers you're overriding in your `medusa-config.ts` file to connect to your external Redis instance. Refer to the documentation for each module for more details on how to configure it.
<Note title="Tip">
To set the connection URL of your external Redis instance, refer to the [Environments](../environments/page.mdx#add-environment-variables) guide to learn how to add environment variables. You can then use these variables in your `medusa-config.ts` file to connect to your Redis instance.
</Note>

View File

@@ -6,5 +6,6 @@ export const generatedEditDates = {
"app/deployments/page.mdx": "2025-06-17T11:17:03.236Z",
"app/organizations/page.mdx": "2025-06-17T10:48:50.969Z",
"app/notifications/page.mdx": "2025-06-17T12:29:18.819Z",
"app/database/page.mdx": "2025-06-17T14:34:57.104Z"
"app/database/page.mdx": "2025-06-17T14:34:57.104Z",
"app/redis/page.mdx": "2025-06-18T06:50:30.705Z"
}

View File

@@ -69,6 +69,14 @@ export const generatedSidebars = [
"title": "Database",
"path": "/database",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"title": "Redis",
"path": "/redis",
"children": []
}
]
},

View File

@@ -49,6 +49,11 @@ export const sidebar = [
title: "Database",
path: "/database",
},
{
type: "link",
title: "Redis",
path: "/redis",
},
],
},
{