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
Copy file name to clipboardExpand all lines: content/operate/kubernetes/reference/redis_enterprise_active_active_database_api.md
+9Lines changed: 9 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -202,6 +202,13 @@ The Active-Active database global configurations, contains the global properties
202
202
The name of the secret that holds the password to the database (redis databases only). If secret does not exist, it will be created. To define the password, create an opaque secret and set the name in the spec. The password will be taken from the value of the 'password' key. Use an empty string as value within the secret to disable authentication for the database. Notes - For Active-Active databases this secret will not be automatically created, and also, memcached databases must not be set with a value, and a secret/password will not be automatically created for them. Use the memcachedSaslSecretName field to set authentication parameters for memcached databases.<br/>
203
203
</td>
204
204
<td>false</td>
205
+
</tr><tr>
206
+
<td>databaseServicePort</td>
207
+
<td>integer</td>
208
+
<td>
209
+
A custom port to be exposed by the database services. Can be be modified/added/removed after REDB creation. If set, it'll replace the default service port (namely, databasePort or defaultRedisPort).<br/>
210
+
</td>
211
+
<td>false</td>
205
212
</tr><tr>
206
213
<td>defaultUser</td>
207
214
<td>boolean</td>
@@ -404,6 +411,8 @@ Connection/ association to the Active-Active database.
@@ -12195,7 +12194,7 @@ Specification for service rigger
12195
12194
<td>databaseServicePortPolicy</td>
12196
12195
<td>enum</td>
12197
12196
<td>
12198
-
databaseServicePortPolicy instructs how to determine the service ports for REDB services. Defaults to DatabasePortForward, if not specified otherwise. DatabasePortForward - The service port will be the same as the database port. RedisDefaultPort - The service port will be the default Redis port (6379).<br/>
12197
+
databaseServicePortPolicy instructs how to determine the service ports for REDB services. Defaults to DatabasePortForward, if not specified otherwise. Note - Regardless whether this flag is set or not, if an REDB/REAADB configured with databaseServicePort that would be the port exposed by the Service. DatabasePortForward - The service port will be the same as the database port. RedisDefaultPort - The service port will be the default Redis port (6379).<br/>
@@ -24166,6 +24165,13 @@ The configuration of the usage meter.
24166
24165
Image specification<br/>
24167
24166
</td>
24168
24167
<td>false</td>
24168
+
</tr><tr>
24169
+
<td>proxySecretName</td>
24170
+
<td>string</td>
24171
+
<td>
24172
+
if needed, add proxy details in secret. the name of the proxy secret in the secret, can send the following keys: proxy-url, proxy-username, proxy-password (the url includes the proxy port).<br/>
@@ -122,49 +121,56 @@ RedisEnterpriseDatabaseSpec defines the desired state of RedisEnterpriseDatabase
122
121
<td>databasePort</td>
123
122
<td>integer</td>
124
123
<td>
125
-
Database port number. TCP port on which the database is available. Will be generated automatically if omitted. can not be changed after creation<br/>
124
+
TCP port assigned to the database within the Redis Enterprise cluster. Must be unique across all databases in the Redis Enterprise cluster. Will be generated automatically if omitted. can not be changed after creation<br/>
126
125
</td>
127
126
<td>false</td>
128
127
</tr><tr>
129
128
<td>databaseSecretName</td>
130
129
<td>string</td>
131
130
<td>
132
-
The name of the secret that holds the password to the database (redis databases only). If secret does not exist, it will be created. To define the password, create an opaque secret and set the name in the spec. The password will be taken from the value of the 'password' key. Use an empty string as value within the secret to disable authentication for the database. Notes - For Active-Active databases this secret will not be automatically created, and also, memcached databases must not be set with a value, and a secret/password will not be automatically created for them. Use the memcachedSaslSecretName field to set authentication parameters for memcached databases.<br/>
131
+
Name of the secret containing the database password (Redis databases only). The secret is created automatically if it does not exist. The password is stored under the "password" key in the secret. If creating the secret manually, create an opaque secret with the password under the "password" key. To disable authentication, set the value of the "password" key in the secret to an empty string. Note: For Active-Active databases, this secret is not created automatically. For memcached databases, use memcachedSaslSecretName instead.<br/>
132
+
</td>
133
+
<td>false</td>
134
+
</tr><tr>
135
+
<td>databaseServicePort</td>
136
+
<td>integer</td>
137
+
<td>
138
+
A custom port to be exposed by the database Services. Can be modified/added/removed after REDB creation. If set, it'll replace the default service port (namely, databasePort or defaultRedisPort).<br/>
133
139
</td>
134
140
<td>false</td>
135
141
</tr><tr>
136
142
<td>defaultUser</td>
137
143
<td>boolean</td>
138
144
<td>
139
-
Is connecting with a default user allowed?<br/>
145
+
Allows connections with the default user. When disabled, the DatabaseSecret is not created or updated.<br/>
140
146
</td>
141
147
<td>false</td>
142
148
</tr><tr>
143
149
<td>evictionPolicy</td>
144
150
<td>string</td>
145
151
<td>
146
-
Database eviction policy. see more https://docs.redislabs.com/latest/rs/administering/database-operations/eviction-policy/<br/>
152
+
Database eviction policy. See https://redis.io/docs/latest/operate/rs/databases/memory-performance/eviction-policy/<br/>
147
153
</td>
148
154
<td>false</td>
149
155
</tr><tr>
150
156
<td>isRof</td>
151
157
<td>boolean</td>
152
158
<td>
153
-
Whether it is an RoF database or not. Applicable only for databases of type "REDIS". Assumed to be false if left blank.<br/>
159
+
Enables Auto Tiering (formerly Redis on Flash) for Redis databases only. Defaults to false.<br/>
154
160
</td>
155
161
<td>false</td>
156
162
</tr><tr>
157
163
<td>memcachedSaslSecretName</td>
158
164
<td>string</td>
159
165
<td>
160
-
Credentials used for binary authentication in memcached databases. The credentials should be saved as an opaque secret and the name of that secret should be configured using this field. For username, use 'username' as the key and the actual username as the value. For password, use 'password' as the key and the actual password as the value. Note that connections are not encrypted.<br/>
166
+
Name of the secret containing credentials for memcached database authentication. Store credentials in an opaque secret with "username" and "password" keys. Note: Connections are not encrypted.<br/>
161
167
</td>
162
168
<td>false</td>
163
169
</tr><tr>
164
170
<td>memorySize</td>
165
171
<td>string</td>
166
172
<td>
167
-
memory size of database. use formats like 100MB, 0.1GB. minimum value in 100MB. When redis on flash (RoF) is enabled, this value refers to RAM+Flash memory, and it must not be below 1GB.<br/>
173
+
Memory size for the database using formats like 100MB or 0.1GB. Minimum value is 100MB. For Auto Tiering (formerly Redis on Flash), this value represents RAM+Flash memory and must be at least 1GB.<br/>
168
174
</td>
169
175
<td>false</td>
170
176
</tr><tr>
@@ -178,14 +184,14 @@ RedisEnterpriseDatabaseSpec defines the desired state of RedisEnterpriseDatabase
178
184
<td>ossCluster</td>
179
185
<td>boolean</td>
180
186
<td>
181
-
OSS Cluster mode option. Note that not all client libraries support OSS cluster mode.<br/>
187
+
Enables OSS Cluster mode. Note: Not all client libraries support OSS cluster mode.<br/>
182
188
</td>
183
189
<td>false</td>
184
190
</tr><tr>
185
191
<td>persistence</td>
186
192
<td>enum</td>
187
193
<td>
188
-
Database on-disk persistence policy<br/>
194
+
Database persistence policy for on-disk storage.<br/>
@@ -194,21 +200,21 @@ RedisEnterpriseDatabaseSpec defines the desired state of RedisEnterpriseDatabase
194
200
<td>proxyPolicy</td>
195
201
<td>string</td>
196
202
<td>
197
-
The policy used for proxy binding to the endpoint. Supported proxy policies are: single/all-master-shards/all-nodes When left blank, the default value will be chosen according to the value of ossCluster - single if disabled, all-master-shards when enabled<br/>
203
+
Proxy policy for the database. Supported proxy policies are: single/all-master-shards/all-nodes When left blank, the default value will be chosen according to the value of ossCluster - single if disabled, all-master-shards when enabled<br/>
198
204
</td>
199
205
<td>false</td>
200
206
</tr><tr>
201
207
<td>rackAware</td>
202
208
<td>boolean</td>
203
209
<td>
204
-
Whether database should be rack aware. This improves availability - more information: https://docs.redislabs.com/latest/rs/concepts/high-availability/rack-zone-awareness/<br/>
210
+
Enables rack awareness for improved availability. See https://redis.io/docs/latest/operate/rs/clusters/configure/rack-zone-awareness/<br/>
@@ -229,7 +235,7 @@ RedisEnterpriseDatabaseSpec defines the desired state of RedisEnterpriseDatabase
229
235
<td>replication</td>
230
236
<td>boolean</td>
231
237
<td>
232
-
In-memory database replication. When enabled, database will have replica shard for every master - leading to higher availability. Defaults to false.<br/>
238
+
Enables in-memory database replication for higher availability. Creates a replica shard for every master shard. Defaults to false.<br/>
233
239
</td>
234
240
<td>false</td>
235
241
</tr><tr>
@@ -243,7 +249,7 @@ RedisEnterpriseDatabaseSpec defines the desired state of RedisEnterpriseDatabase
243
249
<td>rofRamSize</td>
244
250
<td>string</td>
245
251
<td>
246
-
The size of the RAM portion of an RoF database. Similarly to "memorySize" use formats like 100MB, 0.1GB. It must be at least 10% of combined memory size (RAM and Flash), as specified by "memorySize".<br/>
252
+
The size of the RAM portion of an Auto Tiering (formerly Redis on Flash) database. Similarly to "memorySize" use formats like 100MB, 0.1GB. It must be at least 10% of combined memory size (RAM and Flash), as specified by "memorySize".<br/>
247
253
</td>
248
254
<td>false</td>
249
255
</tr><tr>
@@ -257,7 +263,7 @@ RedisEnterpriseDatabaseSpec defines the desired state of RedisEnterpriseDatabase
257
263
<td>shardCount</td>
258
264
<td>integer</td>
259
265
<td>
260
-
Number of database server-side shards<br/>
266
+
Number of database server-side shards.<br/>
261
267
</td>
262
268
<td>false</td>
263
269
</tr><tr>
@@ -271,7 +277,7 @@ RedisEnterpriseDatabaseSpec defines the desired state of RedisEnterpriseDatabase
271
277
<td>shardsPlacement</td>
272
278
<td>enum</td>
273
279
<td>
274
-
Control the density of shards - should they reside on as few or as many nodes as possible. Available options are "dense" or "sparse". If left unset, defaults to "dense".<br/>
280
+
Shard placement strategy: "dense" or "sparse". dense: Shards reside on as few nodes as possible. sparse: Shards are distributed across as many nodes as possible.<br/>
275
281
<br/>
276
282
<i>Enum</i>: dense, sparse<br/>
277
283
</td>
@@ -280,7 +286,7 @@ RedisEnterpriseDatabaseSpec defines the desired state of RedisEnterpriseDatabase
280
286
<td>tlsMode</td>
281
287
<td>enum</td>
282
288
<td>
283
-
Require SSL authenticated and encrypted connections to the database. enabled - all incoming connections to the Database must use SSL. disabled - no incoming connection to the Database should use SSL. replica_ssl - databases that replicate from this one need to use SSL.<br/>
289
+
Require TLS authenticated and encrypted connections to the database. enabled - all client and replication connections to the Database must use TLS. disabled - no incoming connection to the Database should use TLS. replica_ssl - databases that replicate from this one need to use TLS.<br/>
284
290
<br/>
285
291
<i>Enum</i>: disabled, enabled, replica_ssl<br/>
286
292
</td>
@@ -289,7 +295,7 @@ RedisEnterpriseDatabaseSpec defines the desired state of RedisEnterpriseDatabase
289
295
<td>type</td>
290
296
<td>enum</td>
291
297
<td>
292
-
The type of the database (redis or memcached). Defaults to "redis".<br/>
298
+
Database type: redis or memcached.<br/>
293
299
<br/>
294
300
<i>Enum</i>: redis, memcached<br/>
295
301
</td>
@@ -1164,7 +1170,7 @@ Redis Enterprise module (see https://redis.io/docs/latest/develop/reference/modu
0 commit comments