You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
If you need to install additional modules or specific versions, upload them using the Redis Enterprise API. See [Upload module v2]({{< relref "/operate/rs/references/rest-api/requests/modules/#post-module-v2" >}}) for more information.
68
51
69
52
## Module configuration
70
53
71
-
#### Module parameters
72
-
73
54
Each module in the [`modulesList`]({{< relref "/operate/kubernetes/reference/api/redis_enterprise_database_api#specmoduleslist" >}}) supports the following fields:
74
55
75
56
-**name** (required): The module name (for example, "search", "ReJSON")
76
-
-**version** (optionalfor REDB, required for REAADB): Specific module version
57
+
-**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.
For detailed module configuration options and parameters, see [Redis modules]({{< relref "/develop/reference/modules" >}}).
104
61
105
62
## Upgrade considerations
106
63
107
64
When upgrading Redis Enterprise clusters or the operator with modules, follow these guidelines:
108
65
109
66
#### Pre-upgrade planning
110
67
111
-
- **Check module compatibility**: Verify that your current module versions are compatible with the target Redis Enterprise version
68
+
-**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.
112
69
-**Review module dependencies**: Some modules may have specific version requirements or dependencies
113
70
-**Document current configurations**: Record all module versions and configurations before upgrading
114
71
-**Test in non-production**: Always test module upgrades in a development or staging environment first
115
72
116
73
#### Module version management during upgrades
117
74
118
75
-**Upload required modules**: Ensure all necessary module versions are uploaded to the cluster before upgrading
119
-
- **Version pinning**: For Active-Active databases, explicitly specify module versions to prevent automatic updates
120
-
- **Compatibility matrices**: Consult the Redis Enterprise documentation for module compatibility matrices
76
+
-**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.
77
+
-**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
121
78
122
79
#### Upgrade sequence
123
80
@@ -135,58 +92,6 @@ When upgrading Redis Enterprise clusters or the operator with modules, follow th
135
92
136
93
For detailed upgrade procedures, see [Upgrade Redis Enterprise clusters]({{< relref "/operate/kubernetes/upgrade/upgrade-redis-cluster" >}}).
137
94
138
-
## Best practices
139
-
140
-
#### Module version management
141
-
142
-
- For production environments, specify explicit module versions in Active-Active databases
143
-
- Use the cluster's available modules list to ensure compatibility
144
-
- Test module upgrades in non-production environments first
145
-
146
-
#### Resource planning
147
-
148
-
- Modules consume additional memory and CPU resources
149
-
- Plan cluster resources accordingly when using multiple modules
150
-
- Monitor module-specific metrics and performance
151
-
152
-
#### Configuration management
153
-
154
-
- Use module configuration parameters to optimize performance
155
-
- Document module configurations for consistency across environments
156
-
- Consider module-specific backup and recovery requirements
157
-
158
-
## Troubleshooting
159
-
160
-
#### Common issues
161
-
162
-
1. **Module not available error:**
163
-
- Check if the module is installed: `kubectl get rec <cluster-name> -o jsonpath='{.status.modules}'`
164
-
- Upload the module if missing using the API endpoint
165
-
166
-
2. **Version compatibility issues:**
167
-
- Verify module version compatibility with your Redis Enterprise version
168
-
- Check the Redis Enterprise documentation for supported module versions
169
-
170
-
3. **Configuration errors:**
171
-
- Validate module configuration parameters
172
-
- Check Redis Enterprise logs for specific error messages
173
-
174
-
#### Debugging commands
175
-
176
-
```bash
177
-
# Check cluster status and available modules
178
-
kubectl get rec <cluster-name> -o yaml
179
-
180
-
# Check database status
181
-
kubectl get redb <database-name> -o yaml
182
-
183
-
# View operator logs
184
-
kubectl logs -l name=redis-enterprise-operator
185
-
186
-
# Check cluster logs
187
-
kubectl logs <cluster-pod-name>
188
-
```
189
-
190
95
## Related information
191
96
192
97
-[Database controller]({{< relref "/operate/kubernetes/re-databases/db-controller" >}}) - Learn how to create and manage Redis Enterprise databases
0 commit comments