Add > Guide > Valkey Migration #359
Conversation
Preview Available 🚀Commit Author: Karan Popat Preview Link: turbot-com-git-docs-guardrailsadd-valkey-guide-turbot.vercel.app |
Preview Available 🚀Commit Author: Karan Popat Preview Link: turbot-com-git-docs-guardrailsadd-valkey-guide-turbot.vercel.app |
Preview Available 🚀Commit Author: Karan Popat Preview Link: turbot-com-git-docs-guardrailsadd-valkey-guide-turbot.vercel.app |
|
|
||
| In this guide, you will: | ||
|
|
||
| * Use AWS Service Catalog to migrate from Redis to Valkey cache. |
There was a problem hiding this comment.
Use the Turbot Enterprise Database provisioned product in service catalog to migrate from Redis to Valkey.
|
|
||
| [Turbot Guardrails Enterprise Database (TED)](/guardrails/docs/reference/glossary#turbot-guardrails-enterprise-database-ted) is an AWS Service Catalog product that automates the provisioning and management of the underlying database and caching infrastructure required for enterprise deployments of Turbot Guardrails. | ||
|
|
||
| As part of its infrastructure, TED currently uses Redis as the caching engine. This guide introduces Valkey as the new, community-driven alternative to Redis — offering improved governance, long-term sustainability, and compatibility with existing Redis features. |
There was a problem hiding this comment.
As part of its infrastructure, TED versions prior to 1.50 use Redis as the caching engine. This guide shows how to update a TED deployment using Redis to one using Valkey.
| @@ -123,6 +123,18 @@ Choose to **Use Elasticache** and select the desired values for **ElastiCache Ve | |||
|
|
|||
|  | |||
|
|
|||
| If you would prefer to use **Valkey** — an open-source, Redis-compatible cache engine that provides enhanced governance and long-term sustainability: | |||
| If you would prefer to use **Valkey** — an open-source, Redis-compatible cache engine that provides enhanced governance and long-term sustainability: | ||
|
|
||
| >[!CAUTION] | ||
| > Once the ElastiCache has been moved to Valkey it cannot be reverted. |
| >[!CAUTION] | ||
| > Once the ElastiCache has been moved to Valkey it cannot be reverted. | ||
|
|
||
| Set `ElastiCache Engine` to **Valkey**. Choose the appropriate `Valkey Cache Version` from the dropdown list. |
There was a problem hiding this comment.
ElastiCache Engine is deprecated and can be ignored.
| @@ -88,6 +88,27 @@ The values of the parameters will initially be set to match previous run of the | |||
| > Upgrading to a major version can introduce significant changes and potential risks. You should not upgrade to a new major version without first consulting with Turbot Support. | |||
| > To ensure cost-efficiency, review and update instance types and ElastiCache Versions at least annually to align with the latest supported options. | |||
|
|
|||
| ### Migrate to Valkey Cache | |||
|
|
|||
| As part of the TED infrastructure, Redis has been the default caching engine. This update introduces [Valkey](https://valkey.io/), a community-driven alternative to Redis, offering long-term sustainability, enhanced governance, and full compatibility with existing Redis APIs. | |||
There was a problem hiding this comment.
As part of the TED infrastructure, Redis has previously been the default caching engine. We now reccommend moving to Valkey](https://valkey.io/), a community-driven alternative to Redis.
Preview Available 🚀Commit Author: Karan Popat Preview Link: turbot-com-git-docs-guardrailsadd-valkey-guide-turbot.vercel.app |
Preview Available 🚀Commit Author: Karan Popat Preview Link: turbot-com-git-docs-guardrailsadd-valkey-guide-turbot.vercel.app |
|
|
||
| * [ ] The newly created Valkey caches can be found under `Valkey caches` in the AWS ElastiCache dashboard. | ||
|
|
||
|  |
There was a problem hiding this comment.
use /.aws-valkey-cache-complete.png
Preview Available 🚀Commit Author: Karan Popat Preview Link: turbot-com-git-docs-guardrailsadd-valkey-guide-turbot.vercel.app |
Preview Available 🚀Commit Author: Karan Popat Preview Link: turbot-com-git-docs-guardrailsadd-valkey-guide-turbot.vercel.app |
Preview Available 🚀Commit Author: Karan Popat Preview Link: turbot-com-git-docs-guardrailsadd-valkey-guide-turbot.vercel.app |
Preview Available 🚀Commit Author: Karan Popat Preview Link: turbot-com-git-docs-guardrailsadd-valkey-guide-turbot.vercel.app |
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for migrating from Redis to Valkey Cache, including new guides and references in existing documents.
- Introduces a new Valkey migration guide in docs/guides/hosting-guardrails/updating-stacks/migrate-to-valkey-cache
- Adds Valkey migration references to TED update and installation guides
- Introduces a second guide ("Upgrade to Valkey Cache") with similar content
Reviewed Changes
Copilot reviewed 6 out of 17 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/sidebar.json | Updated sidebar to include a new guide for Valkey migration |
| docs/guides/hosting-guardrails/updating-stacks/update-ted/index.md | Added a section explaining the switch to Valkey cache with a link to the migration guide |
| docs/guides/hosting-guardrails/updating-stacks/migrate-to-valkey-cache/index.md | New guide detailing the migration process from Redis to Valkey Cache |
| docs/guides/hosting-guardrails/updating-stacks/index.md | Updated guide index to list the new Valkey migration guide |
| docs/guides/hosting-guardrails/updating-stacks/Upgrade-to-valkey/index.md | New guide titled “Upgrade to Valkey Cache” with steps for updating TED for Valkey |
| docs/guides/hosting-guardrails/installation/install-ted/index.md | Updated installation guide to include instructions for upgrading to Valkey |
Created a draft for Valkey Cache migration from redis with the required information.
3 samples: