Skip to content

Commit 6ffe636

Browse files
redisdocsapp[bot]github-actions[bot]kaitlynmichael
authored
k8s api docs 7.22.0-15 (#1860)
* k8s api docs 7.22.0-15 * remove alertsettings from redb --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Kaitlyn Michael <[email protected]>
1 parent 11bd778 commit 6ffe636

File tree

4 files changed

+44
-23
lines changed

4 files changed

+44
-23
lines changed

content/embeds/k8s/openshift_rec.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ spec:
2626
memory: 4Gi
2727
redisEnterpriseImageSpec:
2828
repository: registry.connect.redhat.com/redislabs/redis-enterprise
29-
versionTag: 7.22.0-28
29+
versionTag: 7.22.0-216
3030
redisEnterpriseServicesRiggerImageSpec:
3131
repository: registry.connect.redhat.com/redislabs/services-manager
3232
bootstrapperImageSpec:

content/operate/kubernetes/reference/redis_enterprise_active_active_database_api.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,13 @@ The Active-Active database global configurations, contains the global properties
202202
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/>
203203
</td>
204204
<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>
205212
</tr><tr>
206213
<td>defaultUser</td>
207214
<td>boolean</td>
@@ -404,6 +411,8 @@ Connection/ association to the Active-Active database.
404411
</tr></tbody>
405412
</table>
406413

414+
415+
407416
### spec.globalConfigurations.backup
408417
<sup><sup>[↩ Parent](#specglobalconfigurations)</sup></sup>
409418

content/operate/kubernetes/reference/redis_enterprise_cluster_api.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ categories:
77
- kubernetes
88
linkTitle: REC API
99
weight: 30
10-
aliases: [ /operate/kubernetes/reference/cluster-options, ]
1110
---
1211

1312
apiVersion:
@@ -12195,7 +12194,7 @@ Specification for service rigger
1219512194
<td>databaseServicePortPolicy</td>
1219612195
<td>enum</td>
1219712196
<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/>
1219912198
<br/>
1220012199
<i>Enum</i>: DatabasePortForward, RedisDefaultPort<br/>
1220112200
</td>
@@ -24166,6 +24165,13 @@ The configuration of the usage meter.
2416624165
Image specification<br/>
2416724166
</td>
2416824167
<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/>
24173+
</td>
24174+
<td>false</td>
2416924175
</tr><tr>
2417024176
<td><a href="#specusagemetercallhomeclientresources">resources</a></td>
2417124177
<td>object</td>

content/operate/kubernetes/reference/redis_enterprise_database_api.md

Lines changed: 26 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ categories:
77
- kubernetes
88
linkTitle: REDB API
99
weight: 30
10-
aliases: [ /operate/kubernetes/reference/db-options, ]
1110
---
1211

1312
apiVersion:
@@ -122,49 +121,56 @@ RedisEnterpriseDatabaseSpec defines the desired state of RedisEnterpriseDatabase
122121
<td>databasePort</td>
123122
<td>integer</td>
124123
<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/>
126125
</td>
127126
<td>false</td>
128127
</tr><tr>
129128
<td>databaseSecretName</td>
130129
<td>string</td>
131130
<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/>
133139
</td>
134140
<td>false</td>
135141
</tr><tr>
136142
<td>defaultUser</td>
137143
<td>boolean</td>
138144
<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/>
140146
</td>
141147
<td>false</td>
142148
</tr><tr>
143149
<td>evictionPolicy</td>
144150
<td>string</td>
145151
<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/>
147153
</td>
148154
<td>false</td>
149155
</tr><tr>
150156
<td>isRof</td>
151157
<td>boolean</td>
152158
<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/>
154160
</td>
155161
<td>false</td>
156162
</tr><tr>
157163
<td>memcachedSaslSecretName</td>
158164
<td>string</td>
159165
<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/>
161167
</td>
162168
<td>false</td>
163169
</tr><tr>
164170
<td>memorySize</td>
165171
<td>string</td>
166172
<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/>
168174
</td>
169175
<td>false</td>
170176
</tr><tr>
@@ -178,14 +184,14 @@ RedisEnterpriseDatabaseSpec defines the desired state of RedisEnterpriseDatabase
178184
<td>ossCluster</td>
179185
<td>boolean</td>
180186
<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/>
182188
</td>
183189
<td>false</td>
184190
</tr><tr>
185191
<td>persistence</td>
186192
<td>enum</td>
187193
<td>
188-
Database on-disk persistence policy<br/>
194+
Database persistence policy for on-disk storage.<br/>
189195
<br/>
190196
<i>Enum</i>: disabled, aofEverySecond, aofAlways, snapshotEvery1Hour, snapshotEvery6Hour, snapshotEvery12Hour<br/>
191197
</td>
@@ -194,21 +200,21 @@ RedisEnterpriseDatabaseSpec defines the desired state of RedisEnterpriseDatabase
194200
<td>proxyPolicy</td>
195201
<td>string</td>
196202
<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/>
198204
</td>
199205
<td>false</td>
200206
</tr><tr>
201207
<td>rackAware</td>
202208
<td>boolean</td>
203209
<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/>
205211
</td>
206212
<td>false</td>
207213
</tr><tr>
208214
<td><a href="#specredisenterprisecluster">redisEnterpriseCluster</a></td>
209215
<td>object</td>
210216
<td>
211-
Connection to Redis Enterprise Cluster<br/>
217+
Connection to the Redis Enterprise Cluster.<br/>
212218
</td>
213219
<td>false</td>
214220
</tr><tr>
@@ -229,7 +235,7 @@ RedisEnterpriseDatabaseSpec defines the desired state of RedisEnterpriseDatabase
229235
<td>replication</td>
230236
<td>boolean</td>
231237
<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/>
233239
</td>
234240
<td>false</td>
235241
</tr><tr>
@@ -243,7 +249,7 @@ RedisEnterpriseDatabaseSpec defines the desired state of RedisEnterpriseDatabase
243249
<td>rofRamSize</td>
244250
<td>string</td>
245251
<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/>
247253
</td>
248254
<td>false</td>
249255
</tr><tr>
@@ -257,7 +263,7 @@ RedisEnterpriseDatabaseSpec defines the desired state of RedisEnterpriseDatabase
257263
<td>shardCount</td>
258264
<td>integer</td>
259265
<td>
260-
Number of database server-side shards<br/>
266+
Number of database server-side shards.<br/>
261267
</td>
262268
<td>false</td>
263269
</tr><tr>
@@ -271,7 +277,7 @@ RedisEnterpriseDatabaseSpec defines the desired state of RedisEnterpriseDatabase
271277
<td>shardsPlacement</td>
272278
<td>enum</td>
273279
<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/>
275281
<br/>
276282
<i>Enum</i>: dense, sparse<br/>
277283
</td>
@@ -280,7 +286,7 @@ RedisEnterpriseDatabaseSpec defines the desired state of RedisEnterpriseDatabase
280286
<td>tlsMode</td>
281287
<td>enum</td>
282288
<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/>
284290
<br/>
285291
<i>Enum</i>: disabled, enabled, replica_ssl<br/>
286292
</td>
@@ -289,7 +295,7 @@ RedisEnterpriseDatabaseSpec defines the desired state of RedisEnterpriseDatabase
289295
<td>type</td>
290296
<td>enum</td>
291297
<td>
292-
The type of the database (redis or memcached). Defaults to "redis".<br/>
298+
Database type: redis or memcached.<br/>
293299
<br/>
294300
<i>Enum</i>: redis, memcached<br/>
295301
</td>
@@ -1164,7 +1170,7 @@ Redis Enterprise module (see https://redis.io/docs/latest/develop/reference/modu
11641170
### spec.redisEnterpriseCluster
11651171
<sup><sup>[↩ Parent](#spec)</sup></sup>
11661172

1167-
Connection to Redis Enterprise Cluster
1173+
Connection to the Redis Enterprise Cluster.
11681174

11691175
<table>
11701176
<thead>

0 commit comments

Comments
 (0)