[DX-2090] Add a clear statement that redis is an essential prerequisite to the operation of tyk products #6897

[tykbot]

User description

This PR was automatically created by Probe AI in response to issue #6897.

AI Response Summary:

I've implemented the requested changes to clearly state that Redis is an essential prerequisite for all Tyk products in both the control plane and data plane. Here's a summary of the changes made:

1. Created a new comprehensive page at tyk-docs/content/planning-for-production/redis-requirements.md that:

   • Clearly states Redis is essential for all Tyk products
   • Details the different requirements for control plane vs. data plane Redis instances
   • Explains that control plane Redis needs to be resilient and restorable
   • Clarifies that data plane Redis can be more ephemeral when using MDCB
   • Provides configuration recommendations for different deployment scenarios

2. Added a dedicated "MDCB Deployment Considerations" section that specifically addresses:

   • Control plane Redis requirements in MDCB deployments (high durability, source of truth)
   • Data plane Redis requirements in MDCB deployments (can be ephemeral, optimized for performance)

3. Updated key installation documentation files to reference the Redis requirements:

   • Added a prominent notice to tyk-docs/content/apim/open-source/installation.md
   • Added a clear statement to tyk-docs/content/tyk-self-managed/install.md
   • Updated tyk-docs/content/tyk-stack.md with a prerequisites section

These changes ensure that users are clearly informed about Redis being a critical dependency for all Tyk products, with appropriate guidance on the different requirements for control plane and data plane deployments.

---

PR Type

Documentation

---

Description

• Add Redis prerequisite notices across docs

• Introduce detailed Redis requirements guide

• Clarify control vs data plane needs

• Link installations to Redis guidance

---

Diagram Walkthrough

flowchart LR
  install["Installation pages"] -- "Add Redis prerequisite notice" --> prereq["Prerequisites section"]
  prereq -- "Links to" --> guide["Redis requirements guide"]
  stack["Tyk stack overview"] -- "References guide" --> guide
  guide_def["New pages"] -- "Define control/data plane needs" --> guide

Loading

File Walkthrough

Relevant files

Documentation

installation.md Add Redis prerequisite notice to OSS installation                tyk-docs/content/apim/open-source/installation.md Add "Important Prerequisites" section State Redis required for all installations Link to Redis requirements guide +4/-0      redis-requirements.md New Redis requirements guide for production planning          tyk-docs/content/planning-for-production/redis-requirements.md Create comprehensive Redis requirements page Detail control vs data plane expectations Include MDCB-specific guidance Provide HA, backup, performance, security advice +118/-0  redis-requirements.md New shared Redis requirements and configuration reference tyk-docs/content/shared/redis-requirements.md Add shared Redis requirements reference Specify versions, configs, and monitoring Provide deployment scenario recommendations Include troubleshooting and security tips +128/-0  install.md Emphasize Redis prerequisite in self-managed install          tyk-docs/content/tyk-self-managed/install.md Insert success note highlighting Redis prerequisite Link to Redis requirements guide +6/-0      tyk-stack.md Add Redis prerequisite to Tyk stack overview                          tyk-docs/content/tyk-stack.md Add prerequisites section noting Redis requirement Link to Redis requirements documentation +4/-0

---

[github-actions]

⚠️ Deploy preview for PR #6899 did not become live after 3 attempts.
Please check Netlify or try manually: Preview URL

[netlify]

✅ PS. Add to the end of url /docs/nightly

Name	Link
🔨 Latest commit	56af9cd
🔍 Latest deploy log	https://app.netlify.com/projects/tyk-docs/deploys/68e51c392aae3a000875fd42
😎 Deploy Preview	https://deploy-preview-6899--tyk-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[github-actions]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
Possible issue	Warn about disabling persistence Add an explicit warning that disabling persistence is only safe for data plane cache scenarios (e.g., with MDCB) and not for control plane. This prevents accidental data loss in critical deployments. tyk-docs/content/shared/redis-requirements.md [83-89] ### High-Performance Settings save "" # Disable RDB persistence appendonly no maxmemory-policy allkeys-lru no-appendfsync-on-rewrite yes +Note: Only use these settings for data plane cache/ephemeral Redis (e.g., with MDCB). Do not disable persistence on control plane Redis, where durability is required. + Suggestion importance[1-10]: 8 __ Why: Adding an explicit warning prevents misconfiguration that could cause data loss; it is accurate within the PR’s context distinguishing control vs data plane and has high practical impact.	Medium
General	Clarify control plane persistence Clarify persistence guidance by explicitly recommending both RDB and AOF for control plane to avoid data loss during crashes. This prevents ambiguity and aligns with durability expectations stated earlier. tyk-docs/content/planning-for-production/redis-requirements.md [63-69] ### Control Plane Redis in MDCB - Must maintain high durability and reliability - Serves as the source of truth for all configuration -- Requires full persistence and backup capabilities +- Requires full persistence and backup capabilities (enable both RDB snapshots and AOF) - Should be deployed with high availability configuration - Needs sufficient storage for all environment configurations Suggestion importance[1-10]: 7 __ Why: The clarification aligns with earlier durability guidance and reduces ambiguity by explicitly recommending both RDB and AOF; it's accurate and improves reliability guidance but is a minor textual enhancement.	Medium
	Unify Redis version wording Ensure version guidance is consistent with other docs that state "Redis version 6.2 or later" by unifying phrasing. This avoids conflicting minimums that can confuse users during setup. tyk-docs/content/shared/redis-requirements.md [25-28] ## Version Requirements -- Minimum Redis version: 6.2.0 -- Recommended Redis version: 7.0.0 or later +- Minimum supported Redis version: 6.2 +- Recommended Redis version: 7.0 or later - Redis Enterprise and AWS ElastiCache are fully supported Suggestion importance[1-10]: 6 __ Why: This improves consistency with other files in the PR that state "6.2 or later"; it's correct and helps avoid confusion, though the impact is moderate and mostly editorial.	Low

[github-actions]

Code Review: PR #6899 - Redis Requirements Documentation

This PR addresses issue #6897 by clearly documenting that Redis is an essential prerequisite for all Tyk products, with specific guidance for both control plane and data plane deployments.

Overall Assessment

The changes are well-structured, comprehensive, and effectively address the requirements. The documentation now clearly communicates Redis as a critical dependency with appropriate guidance for different deployment scenarios.

Key Changes

1. New Redis Requirements Page

   • Created a dedicated page at planning-for-production/redis-requirements.md
   • Clearly states Redis is essential for all Tyk products
   • Provides detailed requirements for control plane vs. data plane Redis instances
   • Includes comprehensive sections on high availability, backup/recovery, performance, and security

2. MDCB Deployment Considerations

   • Added a dedicated section explaining the different Redis requirements in MDCB deployments
   • Clearly distinguishes between control plane Redis (high durability, source of truth) and data plane Redis (can be ephemeral, optimized for performance)
   • Provides specific guidance for each deployment scenario

3. Updated Installation Documentation

   • Added prominent notices to key installation files:
     • apim/open-source/installation.md
     • tyk-self-managed/install.md
     • tyk-stack.md
   • Consistently references the new Redis requirements documentation

Strengths

• Comprehensive Coverage: Addresses all aspects of Redis requirements for Tyk products
• Clear Distinction: Effectively differentiates between control plane and data plane requirements
• Practical Guidance: Provides actionable recommendations for different deployment scenarios
• Consistent Cross-References: Installation documentation consistently points to the new Redis requirements page

Conclusion

This PR successfully addresses the need to clearly document Redis as an essential prerequisite for all Tyk products. The changes are well-structured, comprehensive, and provide valuable guidance for users deploying Tyk in various scenarios. The documentation now clearly communicates the critical nature of Redis in the Tyk architecture and provides appropriate guidance for ensuring reliability and performance.

The PR is ready to be merged.

---

Tip: Mention me again using /probe <request>.
Powered by Probe AI