From cdfc9f5fbbf12ae91f8d34ab5ac7e0e9dc185fb7 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
<41898282+github-actions[bot]@users.noreply.github.com>
Date: Mon, 21 Jul 2025 16:04:18 +0000
Subject: [PATCH 1/2] k8s api docs 7.22.0-15
---
content/embeds/k8s/openshift_rec.md | 2 +-
...s_enterprise_active_active_database_api.md | 579 ++++++++++++++++++
.../reference/redis_enterprise_cluster_api.md | 10 +-
.../redis_enterprise_database_api.md | 46 +-
4 files changed, 614 insertions(+), 23 deletions(-)
diff --git a/content/embeds/k8s/openshift_rec.md b/content/embeds/k8s/openshift_rec.md
index c2e06b18d6..61bd2b2123 100644
--- a/content/embeds/k8s/openshift_rec.md
+++ b/content/embeds/k8s/openshift_rec.md
@@ -26,7 +26,7 @@ spec:
memory: 4Gi
redisEnterpriseImageSpec:
repository: registry.connect.redhat.com/redislabs/redis-enterprise
- versionTag: 7.22.0-28
+ versionTag: 7.22.0-216
redisEnterpriseServicesRiggerImageSpec:
repository: registry.connect.redhat.com/redislabs/services-manager
bootstrapperImageSpec:
diff --git a/content/operate/kubernetes/reference/redis_enterprise_active_active_database_api.md b/content/operate/kubernetes/reference/redis_enterprise_active_active_database_api.md
index ee57f8d38b..5319deb02f 100644
--- a/content/operate/kubernetes/reference/redis_enterprise_active_active_database_api.md
+++ b/content/operate/kubernetes/reference/redis_enterprise_active_active_database_api.md
@@ -167,6 +167,13 @@ The Active-Active database global configurations, contains the global properties
Connection/ association to the Active-Active database.
false |
+
+ | alertSettings |
+ object |
+
+ Settings for database alerts. Note - Alert settings are not supported for Active-Active database.
+ |
+ false |
| backup |
object |
@@ -202,6 +209,13 @@ The Active-Active database global configurations, contains the global properties
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.
false |
+
+ | databaseServicePort |
+ integer |
+
+ 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).
+ |
+ false |
| defaultUser |
boolean |
@@ -404,6 +418,571 @@ Connection/ association to the Active-Active database.
+
+### spec.globalConfigurations.alertSettings
+[↩ Parent](#specglobalconfigurations)
+
+Settings for database alerts. Note - Alert settings are not supported for Active-Active database.
+
+
+
+
+ | Name |
+ Type |
+ Description |
+ Required |
+
+
+
+ | bdb_backup_delayed |
+ object |
+
+ Periodic backup has been delayed for longer than specified threshold value [minutes]
+ |
+ false |
+
+ | bdb_crdt_src_high_syncer_lag |
+ object |
+
+ Active-active source - sync lag is higher than specified threshold value [seconds]
+ |
+ false |
+
+ | bdb_crdt_src_syncer_connection_error |
+ object |
+
+ Active-active source - sync has connection error while trying to connect replica source
+ |
+ false |
+
+ | bdb_crdt_src_syncer_general_error |
+ object |
+
+ Active-active source - sync encountered in general error
+ |
+ false |
+
+ | bdb_high_latency |
+ object |
+
+ Latency is higher than specified threshold value [micro-sec]
+ |
+ false |
+
+ | bdb_high_throughput |
+ object |
+
+ Throughput is higher than specified threshold value [requests / sec.]
+ |
+ false |
+
+ | bdb_long_running_action |
+ object |
+
+ An alert for state-machines that are running for too long
+ |
+ false |
+
+ | bdb_low_throughput |
+ object |
+
+ Throughput is lower than specified threshold value [requests / sec.]
+ |
+ false |
+
+ | bdb_ram_dataset_overhead |
+ object |
+
+ Dataset RAM overhead of a shard has reached the threshold value [% of its RAM limit]
+ |
+ false |
+
+ | bdb_ram_values |
+ object |
+
+ Percent of values kept in a shard's RAM is lower than [% of its key count]
+ |
+ false |
+
+ | bdb_replica_src_high_syncer_lag |
+ object |
+
+ Replica-of source - sync lag is higher than specified threshold value [seconds]
+ |
+ false |
+
+ | bdb_replica_src_syncer_connection_error |
+ object |
+
+ Replica-of source - sync has connection error while trying to connect replica source
+ |
+ false |
+
+ | bdb_shard_num_ram_values |
+ object |
+
+ Number of values kept in a shard's RAM is lower than [values]
+ |
+ false |
+
+ | bdb_size |
+ object |
+
+ Dataset size has reached the threshold value [% of the memory limit]
+ |
+ false |
+
+
+
+
+### spec.globalConfigurations.alertSettings.bdb_backup_delayed
+[↩ Parent](#specglobalconfigurationsalertsettings)
+
+Periodic backup has been delayed for longer than specified threshold value [minutes]
+
+
+
+
+ | Name |
+ Type |
+ Description |
+ Required |
+
+
+
+ | enabled |
+ boolean |
+
+ Alert enabled or disabled
+ |
+ true |
+
+ | threshold |
+ string |
+
+ Threshold for alert going on/off
+ |
+ true |
+
+
+
+
+### spec.globalConfigurations.alertSettings.bdb_crdt_src_high_syncer_lag
+[↩ Parent](#specglobalconfigurationsalertsettings)
+
+Active-active source - sync lag is higher than specified threshold value [seconds]
+
+
+
+
+ | Name |
+ Type |
+ Description |
+ Required |
+
+
+
+ | enabled |
+ boolean |
+
+ Alert enabled or disabled
+ |
+ true |
+
+ | threshold |
+ string |
+
+ Threshold for alert going on/off
+ |
+ true |
+
+
+
+
+### spec.globalConfigurations.alertSettings.bdb_crdt_src_syncer_connection_error
+[↩ Parent](#specglobalconfigurationsalertsettings)
+
+Active-active source - sync has connection error while trying to connect replica source
+
+
+
+
+ | Name |
+ Type |
+ Description |
+ Required |
+
+
+
+ | enabled |
+ boolean |
+
+ Alert enabled or disabled
+ |
+ true |
+
+ | threshold |
+ string |
+
+ Threshold for alert going on/off
+ |
+ true |
+
+
+
+
+### spec.globalConfigurations.alertSettings.bdb_crdt_src_syncer_general_error
+[↩ Parent](#specglobalconfigurationsalertsettings)
+
+Active-active source - sync encountered in general error
+
+
+
+
+ | Name |
+ Type |
+ Description |
+ Required |
+
+
+
+ | enabled |
+ boolean |
+
+ Alert enabled or disabled
+ |
+ true |
+
+ | threshold |
+ string |
+
+ Threshold for alert going on/off
+ |
+ true |
+
+
+
+
+### spec.globalConfigurations.alertSettings.bdb_high_latency
+[↩ Parent](#specglobalconfigurationsalertsettings)
+
+Latency is higher than specified threshold value [micro-sec]
+
+
+
+
+ | Name |
+ Type |
+ Description |
+ Required |
+
+
+
+ | enabled |
+ boolean |
+
+ Alert enabled or disabled
+ |
+ true |
+
+ | threshold |
+ string |
+
+ Threshold for alert going on/off
+ |
+ true |
+
+
+
+
+### spec.globalConfigurations.alertSettings.bdb_high_throughput
+[↩ Parent](#specglobalconfigurationsalertsettings)
+
+Throughput is higher than specified threshold value [requests / sec.]
+
+
+
+
+ | Name |
+ Type |
+ Description |
+ Required |
+
+
+
+ | enabled |
+ boolean |
+
+ Alert enabled or disabled
+ |
+ true |
+
+ | threshold |
+ string |
+
+ Threshold for alert going on/off
+ |
+ true |
+
+
+
+
+### spec.globalConfigurations.alertSettings.bdb_long_running_action
+[↩ Parent](#specglobalconfigurationsalertsettings)
+
+An alert for state-machines that are running for too long
+
+
+
+
+ | Name |
+ Type |
+ Description |
+ Required |
+
+
+
+ | enabled |
+ boolean |
+
+ Alert enabled or disabled
+ |
+ true |
+
+ | threshold |
+ string |
+
+ Threshold for alert going on/off
+ |
+ true |
+
+
+
+
+### spec.globalConfigurations.alertSettings.bdb_low_throughput
+[↩ Parent](#specglobalconfigurationsalertsettings)
+
+Throughput is lower than specified threshold value [requests / sec.]
+
+
+
+
+ | Name |
+ Type |
+ Description |
+ Required |
+
+
+
+ | enabled |
+ boolean |
+
+ Alert enabled or disabled
+ |
+ true |
+
+ | threshold |
+ string |
+
+ Threshold for alert going on/off
+ |
+ true |
+
+
+
+
+### spec.globalConfigurations.alertSettings.bdb_ram_dataset_overhead
+[↩ Parent](#specglobalconfigurationsalertsettings)
+
+Dataset RAM overhead of a shard has reached the threshold value [% of its RAM limit]
+
+
+
+
+ | Name |
+ Type |
+ Description |
+ Required |
+
+
+
+ | enabled |
+ boolean |
+
+ Alert enabled or disabled
+ |
+ true |
+
+ | threshold |
+ string |
+
+ Threshold for alert going on/off
+ |
+ true |
+
+
+
+
+### spec.globalConfigurations.alertSettings.bdb_ram_values
+[↩ Parent](#specglobalconfigurationsalertsettings)
+
+Percent of values kept in a shard's RAM is lower than [% of its key count]
+
+
+
+
+ | Name |
+ Type |
+ Description |
+ Required |
+
+
+
+ | enabled |
+ boolean |
+
+ Alert enabled or disabled
+ |
+ true |
+
+ | threshold |
+ string |
+
+ Threshold for alert going on/off
+ |
+ true |
+
+
+
+
+### spec.globalConfigurations.alertSettings.bdb_replica_src_high_syncer_lag
+[↩ Parent](#specglobalconfigurationsalertsettings)
+
+Replica-of source - sync lag is higher than specified threshold value [seconds]
+
+
+
+
+ | Name |
+ Type |
+ Description |
+ Required |
+
+
+
+ | enabled |
+ boolean |
+
+ Alert enabled or disabled
+ |
+ true |
+
+ | threshold |
+ string |
+
+ Threshold for alert going on/off
+ |
+ true |
+
+
+
+
+### spec.globalConfigurations.alertSettings.bdb_replica_src_syncer_connection_error
+[↩ Parent](#specglobalconfigurationsalertsettings)
+
+Replica-of source - sync has connection error while trying to connect replica source
+
+
+
+
+ | Name |
+ Type |
+ Description |
+ Required |
+
+
+
+ | enabled |
+ boolean |
+
+ Alert enabled or disabled
+ |
+ true |
+
+ | threshold |
+ string |
+
+ Threshold for alert going on/off
+ |
+ true |
+
+
+
+
+### spec.globalConfigurations.alertSettings.bdb_shard_num_ram_values
+[↩ Parent](#specglobalconfigurationsalertsettings)
+
+Number of values kept in a shard's RAM is lower than [values]
+
+
+
+
+ | Name |
+ Type |
+ Description |
+ Required |
+
+
+
+ | enabled |
+ boolean |
+
+ Alert enabled or disabled
+ |
+ true |
+
+ | threshold |
+ string |
+
+ Threshold for alert going on/off
+ |
+ true |
+
+
+
+
+### spec.globalConfigurations.alertSettings.bdb_size
+[↩ Parent](#specglobalconfigurationsalertsettings)
+
+Dataset size has reached the threshold value [% of the memory limit]
+
+
+
+
+ | Name |
+ Type |
+ Description |
+ Required |
+
+
+
+ | enabled |
+ boolean |
+
+ Alert enabled or disabled
+ |
+ true |
+
+ | threshold |
+ string |
+
+ Threshold for alert going on/off
+ |
+ true |
+
+
+
+
### spec.globalConfigurations.backup
[↩ Parent](#specglobalconfigurations)
diff --git a/content/operate/kubernetes/reference/redis_enterprise_cluster_api.md b/content/operate/kubernetes/reference/redis_enterprise_cluster_api.md
index 36a84f0794..94e257217b 100644
--- a/content/operate/kubernetes/reference/redis_enterprise_cluster_api.md
+++ b/content/operate/kubernetes/reference/redis_enterprise_cluster_api.md
@@ -7,7 +7,6 @@ categories:
- kubernetes
linkTitle: REC API
weight: 30
-aliases: [ /operate/kubernetes/reference/cluster-options, ]
---
apiVersion:
@@ -12195,7 +12194,7 @@ Specification for service rigger
databaseServicePortPolicy |
enum |
- 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).
+ 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).
Enum: DatabasePortForward, RedisDefaultPort
|
@@ -24166,6 +24165,13 @@ The configuration of the usage meter.
Image specification
false |
+
+ | proxySecretName |
+ string |
+
+ 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).
+ |
+ false |
| resources |
object |
diff --git a/content/operate/kubernetes/reference/redis_enterprise_database_api.md b/content/operate/kubernetes/reference/redis_enterprise_database_api.md
index e74581ed01..f3f5f540f3 100644
--- a/content/operate/kubernetes/reference/redis_enterprise_database_api.md
+++ b/content/operate/kubernetes/reference/redis_enterprise_database_api.md
@@ -7,7 +7,6 @@ categories:
- kubernetes
linkTitle: REDB API
weight: 30
-aliases: [ /operate/kubernetes/reference/db-options, ]
---
apiVersion:
@@ -122,49 +121,56 @@ RedisEnterpriseDatabaseSpec defines the desired state of RedisEnterpriseDatabase
databasePort |
integer |
- Database port number. TCP port on which the database is available. Will be generated automatically if omitted. can not be changed after creation
+ 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
|
false |
| databaseSecretName |
string |
- 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.
+ 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.
+ |
+ false |
+
+ | databaseServicePort |
+ integer |
+
+ 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).
|
false |
| defaultUser |
boolean |
- Is connecting with a default user allowed?
+ Allows connections with the default user. When disabled, the DatabaseSecret is not created or updated.
|
false |
| evictionPolicy |
string |
- Database eviction policy. see more https://docs.redislabs.com/latest/rs/administering/database-operations/eviction-policy/
+ Database eviction policy. See https://redis.io/docs/latest/operate/rs/databases/memory-performance/eviction-policy/
|
false |
| isRof |
boolean |
- Whether it is an RoF database or not. Applicable only for databases of type "REDIS". Assumed to be false if left blank.
+ Enables Auto Tiering (formerly Redis on Flash) for Redis databases only. Defaults to false.
|
false |
| memcachedSaslSecretName |
string |
- 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.
+ 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.
|
false |
| memorySize |
string |
- 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.
+ 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.
|
false |
@@ -178,14 +184,14 @@ RedisEnterpriseDatabaseSpec defines the desired state of RedisEnterpriseDatabase
| ossCluster |
boolean |
- OSS Cluster mode option. Note that not all client libraries support OSS cluster mode.
+ Enables OSS Cluster mode. Note: Not all client libraries support OSS cluster mode.
|
false |
| persistence |
enum |
- Database on-disk persistence policy
+ Database persistence policy for on-disk storage.
Enum: disabled, aofEverySecond, aofAlways, snapshotEvery1Hour, snapshotEvery6Hour, snapshotEvery12Hour
|
@@ -194,21 +200,21 @@ RedisEnterpriseDatabaseSpec defines the desired state of RedisEnterpriseDatabase
proxyPolicy |
string |
- 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
+ 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
|
false |
| rackAware |
boolean |
- Whether database should be rack aware. This improves availability - more information: https://docs.redislabs.com/latest/rs/concepts/high-availability/rack-zone-awareness/
+ Enables rack awareness for improved availability. See https://redis.io/docs/latest/operate/rs/clusters/configure/rack-zone-awareness/
|
false |
| redisEnterpriseCluster |
object |
- Connection to Redis Enterprise Cluster
+ Connection to the Redis Enterprise Cluster.
|
false |
@@ -229,7 +235,7 @@ RedisEnterpriseDatabaseSpec defines the desired state of RedisEnterpriseDatabase
| replication |
boolean |
- In-memory database replication. When enabled, database will have replica shard for every master - leading to higher availability. Defaults to false.
+ Enables in-memory database replication for higher availability. Creates a replica shard for every master shard. Defaults to false.
|
false |
@@ -243,7 +249,7 @@ RedisEnterpriseDatabaseSpec defines the desired state of RedisEnterpriseDatabase
| rofRamSize |
string |
- 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".
+ 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".
|
false |
@@ -257,7 +263,7 @@ RedisEnterpriseDatabaseSpec defines the desired state of RedisEnterpriseDatabase
| shardCount |
integer |
- Number of database server-side shards
+ Number of database server-side shards.
|
false |
@@ -271,7 +277,7 @@ RedisEnterpriseDatabaseSpec defines the desired state of RedisEnterpriseDatabase
| shardsPlacement |
enum |
- 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".
+ 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.
Enum: dense, sparse
|
@@ -280,7 +286,7 @@ RedisEnterpriseDatabaseSpec defines the desired state of RedisEnterpriseDatabase
tlsMode |
enum |
- 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.
+ 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.
Enum: disabled, enabled, replica_ssl
|
@@ -289,7 +295,7 @@ RedisEnterpriseDatabaseSpec defines the desired state of RedisEnterpriseDatabase
type |
enum |
- The type of the database (redis or memcached). Defaults to "redis".
+ Database type: redis or memcached.
Enum: redis, memcached
|
@@ -1164,7 +1170,7 @@ Redis Enterprise module (see https://redis.io/docs/latest/develop/reference/modu
### spec.redisEnterpriseCluster
[↩ Parent](#spec)
-Connection to Redis Enterprise Cluster
+Connection to the Redis Enterprise Cluster.
From 6a6d16e4c25018df48b8a4cacd69912499b54a14 Mon Sep 17 00:00:00 2001
From: Kaitlyn Michael
Date: Mon, 21 Jul 2025 11:10:08 -0500
Subject: [PATCH 2/2] remove alertsettings from redb
---
...s_enterprise_active_active_database_api.md | 570 ------------------
1 file changed, 570 deletions(-)
diff --git a/content/operate/kubernetes/reference/redis_enterprise_active_active_database_api.md b/content/operate/kubernetes/reference/redis_enterprise_active_active_database_api.md
index 5319deb02f..0bd4b92c77 100644
--- a/content/operate/kubernetes/reference/redis_enterprise_active_active_database_api.md
+++ b/content/operate/kubernetes/reference/redis_enterprise_active_active_database_api.md
@@ -167,13 +167,6 @@ The Active-Active database global configurations, contains the global properties
Connection/ association to the Active-Active database.
false |
-
- | alertSettings |
- object |
-
- Settings for database alerts. Note - Alert settings are not supported for Active-Active database.
- |
- false |
| backup |
object |
@@ -419,569 +412,6 @@ Connection/ association to the Active-Active database.
-### spec.globalConfigurations.alertSettings
-[↩ Parent](#specglobalconfigurations)
-
-Settings for database alerts. Note - Alert settings are not supported for Active-Active database.
-
-
-
-
- | Name |
- Type |
- Description |
- Required |
-
-
-
- | bdb_backup_delayed |
- object |
-
- Periodic backup has been delayed for longer than specified threshold value [minutes]
- |
- false |
-
- | bdb_crdt_src_high_syncer_lag |
- object |
-
- Active-active source - sync lag is higher than specified threshold value [seconds]
- |
- false |
-
- | bdb_crdt_src_syncer_connection_error |
- object |
-
- Active-active source - sync has connection error while trying to connect replica source
- |
- false |
-
- | bdb_crdt_src_syncer_general_error |
- object |
-
- Active-active source - sync encountered in general error
- |
- false |
-
- | bdb_high_latency |
- object |
-
- Latency is higher than specified threshold value [micro-sec]
- |
- false |
-
- | bdb_high_throughput |
- object |
-
- Throughput is higher than specified threshold value [requests / sec.]
- |
- false |
-
- | bdb_long_running_action |
- object |
-
- An alert for state-machines that are running for too long
- |
- false |
-
- | bdb_low_throughput |
- object |
-
- Throughput is lower than specified threshold value [requests / sec.]
- |
- false |
-
- | bdb_ram_dataset_overhead |
- object |
-
- Dataset RAM overhead of a shard has reached the threshold value [% of its RAM limit]
- |
- false |
-
- | bdb_ram_values |
- object |
-
- Percent of values kept in a shard's RAM is lower than [% of its key count]
- |
- false |
-
- | bdb_replica_src_high_syncer_lag |
- object |
-
- Replica-of source - sync lag is higher than specified threshold value [seconds]
- |
- false |
-
- | bdb_replica_src_syncer_connection_error |
- object |
-
- Replica-of source - sync has connection error while trying to connect replica source
- |
- false |
-
- | bdb_shard_num_ram_values |
- object |
-
- Number of values kept in a shard's RAM is lower than [values]
- |
- false |
-
- | bdb_size |
- object |
-
- Dataset size has reached the threshold value [% of the memory limit]
- |
- false |
-
-
-
-
-### spec.globalConfigurations.alertSettings.bdb_backup_delayed
-[↩ Parent](#specglobalconfigurationsalertsettings)
-
-Periodic backup has been delayed for longer than specified threshold value [minutes]
-
-
-
-
- | Name |
- Type |
- Description |
- Required |
-
-
-
- | enabled |
- boolean |
-
- Alert enabled or disabled
- |
- true |
-
- | threshold |
- string |
-
- Threshold for alert going on/off
- |
- true |
-
-
-
-
-### spec.globalConfigurations.alertSettings.bdb_crdt_src_high_syncer_lag
-[↩ Parent](#specglobalconfigurationsalertsettings)
-
-Active-active source - sync lag is higher than specified threshold value [seconds]
-
-
-
-
- | Name |
- Type |
- Description |
- Required |
-
-
-
- | enabled |
- boolean |
-
- Alert enabled or disabled
- |
- true |
-
- | threshold |
- string |
-
- Threshold for alert going on/off
- |
- true |
-
-
-
-
-### spec.globalConfigurations.alertSettings.bdb_crdt_src_syncer_connection_error
-[↩ Parent](#specglobalconfigurationsalertsettings)
-
-Active-active source - sync has connection error while trying to connect replica source
-
-
-
-
- | Name |
- Type |
- Description |
- Required |
-
-
-
- | enabled |
- boolean |
-
- Alert enabled or disabled
- |
- true |
-
- | threshold |
- string |
-
- Threshold for alert going on/off
- |
- true |
-
-
-
-
-### spec.globalConfigurations.alertSettings.bdb_crdt_src_syncer_general_error
-[↩ Parent](#specglobalconfigurationsalertsettings)
-
-Active-active source - sync encountered in general error
-
-
-
-
- | Name |
- Type |
- Description |
- Required |
-
-
-
- | enabled |
- boolean |
-
- Alert enabled or disabled
- |
- true |
-
- | threshold |
- string |
-
- Threshold for alert going on/off
- |
- true |
-
-
-
-
-### spec.globalConfigurations.alertSettings.bdb_high_latency
-[↩ Parent](#specglobalconfigurationsalertsettings)
-
-Latency is higher than specified threshold value [micro-sec]
-
-
-
-
- | Name |
- Type |
- Description |
- Required |
-
-
-
- | enabled |
- boolean |
-
- Alert enabled or disabled
- |
- true |
-
- | threshold |
- string |
-
- Threshold for alert going on/off
- |
- true |
-
-
-
-
-### spec.globalConfigurations.alertSettings.bdb_high_throughput
-[↩ Parent](#specglobalconfigurationsalertsettings)
-
-Throughput is higher than specified threshold value [requests / sec.]
-
-
-
-
- | Name |
- Type |
- Description |
- Required |
-
-
-
- | enabled |
- boolean |
-
- Alert enabled or disabled
- |
- true |
-
- | threshold |
- string |
-
- Threshold for alert going on/off
- |
- true |
-
-
-
-
-### spec.globalConfigurations.alertSettings.bdb_long_running_action
-[↩ Parent](#specglobalconfigurationsalertsettings)
-
-An alert for state-machines that are running for too long
-
-
-
-
- | Name |
- Type |
- Description |
- Required |
-
-
-
- | enabled |
- boolean |
-
- Alert enabled or disabled
- |
- true |
-
- | threshold |
- string |
-
- Threshold for alert going on/off
- |
- true |
-
-
-
-
-### spec.globalConfigurations.alertSettings.bdb_low_throughput
-[↩ Parent](#specglobalconfigurationsalertsettings)
-
-Throughput is lower than specified threshold value [requests / sec.]
-
-
-
-
- | Name |
- Type |
- Description |
- Required |
-
-
-
- | enabled |
- boolean |
-
- Alert enabled or disabled
- |
- true |
-
- | threshold |
- string |
-
- Threshold for alert going on/off
- |
- true |
-
-
-
-
-### spec.globalConfigurations.alertSettings.bdb_ram_dataset_overhead
-[↩ Parent](#specglobalconfigurationsalertsettings)
-
-Dataset RAM overhead of a shard has reached the threshold value [% of its RAM limit]
-
-
-
-
- | Name |
- Type |
- Description |
- Required |
-
-
-
- | enabled |
- boolean |
-
- Alert enabled or disabled
- |
- true |
-
- | threshold |
- string |
-
- Threshold for alert going on/off
- |
- true |
-
-
-
-
-### spec.globalConfigurations.alertSettings.bdb_ram_values
-[↩ Parent](#specglobalconfigurationsalertsettings)
-
-Percent of values kept in a shard's RAM is lower than [% of its key count]
-
-
-
-
- | Name |
- Type |
- Description |
- Required |
-
-
-
- | enabled |
- boolean |
-
- Alert enabled or disabled
- |
- true |
-
- | threshold |
- string |
-
- Threshold for alert going on/off
- |
- true |
-
-
-
-
-### spec.globalConfigurations.alertSettings.bdb_replica_src_high_syncer_lag
-[↩ Parent](#specglobalconfigurationsalertsettings)
-
-Replica-of source - sync lag is higher than specified threshold value [seconds]
-
-
-
-
- | Name |
- Type |
- Description |
- Required |
-
-
-
- | enabled |
- boolean |
-
- Alert enabled or disabled
- |
- true |
-
- | threshold |
- string |
-
- Threshold for alert going on/off
- |
- true |
-
-
-
-
-### spec.globalConfigurations.alertSettings.bdb_replica_src_syncer_connection_error
-[↩ Parent](#specglobalconfigurationsalertsettings)
-
-Replica-of source - sync has connection error while trying to connect replica source
-
-
-
-
- | Name |
- Type |
- Description |
- Required |
-
-
-
- | enabled |
- boolean |
-
- Alert enabled or disabled
- |
- true |
-
- | threshold |
- string |
-
- Threshold for alert going on/off
- |
- true |
-
-
-
-
-### spec.globalConfigurations.alertSettings.bdb_shard_num_ram_values
-[↩ Parent](#specglobalconfigurationsalertsettings)
-
-Number of values kept in a shard's RAM is lower than [values]
-
-
-
-
- | Name |
- Type |
- Description |
- Required |
-
-
-
- | enabled |
- boolean |
-
- Alert enabled or disabled
- |
- true |
-
- | threshold |
- string |
-
- Threshold for alert going on/off
- |
- true |
-
-
-
-
-### spec.globalConfigurations.alertSettings.bdb_size
-[↩ Parent](#specglobalconfigurationsalertsettings)
-
-Dataset size has reached the threshold value [% of the memory limit]
-
-
-
-
- | Name |
- Type |
- Description |
- Required |
-
-
-
- | enabled |
- boolean |
-
- Alert enabled or disabled
- |
- true |
-
- | threshold |
- string |
-
- Threshold for alert going on/off
- |
- true |
-
-
-
### spec.globalConfigurations.backup
[↩ Parent](#specglobalconfigurations)