From 2c6fdbd83900765e38412ad7b8180b8c93a3ab4c Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 18 Feb 2025 13:34:55 +0000 Subject: [PATCH] k8s api docs 7.8.4-8 --- content/embeds/k8s/openshift_rec.md | 2 +- ...s_enterprise_active_active_database_api.md | 580 +++++++++++++++++- .../reference/redis_enterprise_cluster_api.md | 57 ++ 3 files changed, 637 insertions(+), 2 deletions(-) diff --git a/content/embeds/k8s/openshift_rec.md b/content/embeds/k8s/openshift_rec.md index 25b32e22b6..7f4978586d 100644 --- a/content/embeds/k8s/openshift_rec.md +++ b/content/embeds/k8s/openshift_rec.md @@ -10,7 +10,7 @@ spec: nodes: 3 redisEnterpriseImageSpec: repository: registry.connect.redhat.com/redislabs/redis-enterprise - versionTag: 7.8.2-34.rhel8-openshift + versionTag: 7.8.4-66.rhel8-openshift 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 3ad2ed833c..abb0266879 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 @@ -153,6 +153,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 @@ -267,6 +274,13 @@ The Active-Active database global configurations, contains the global properties Connection to Redis Enterprise Cluster
false + + redisVersion + string + + Redis OSS version. Version can be specified via prefix, or via channels - for existing databases - Upgrade Redis OSS version. For new databases - the version which the database will be created with. If set to 'major' - will always upgrade to the most recent major Redis version. If set to 'latest' - will always upgrade to the most recent Redis version. Depends on 'redisUpgradePolicy' - if you want to set the value to 'latest' for some databases, you must set redisUpgradePolicy on the cluster before. Possible values are 'major' or 'latest' When using upgrade - make sure to backup the database before. This value is used only for database type 'redis'. Note - Specifying Redis version is currently not supported for Active-Active database.
+ + false replicaSources []object @@ -384,6 +398,570 @@ 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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
bdb_backup_delayedobject + Periodic backup has been delayed for longer than specified threshold value [minutes]
+ 		false
bdb_crdt_src_high_syncer_lagobject + Active-active source - sync lag is higher than specified threshold value [seconds]
+ 		false
bdb_crdt_src_syncer_connection_errorobject + Active-active source - sync has connection error while trying to connect replica source
+ 		false
bdb_crdt_src_syncer_general_errorobject + Active-active source - sync encountered in general error
+ 		false
bdb_high_latencyobject + Latency is higher than specified threshold value [micro-sec]
+ 		false
bdb_high_throughputobject + Throughput is higher than specified threshold value [requests / sec.]
+ 		false
bdb_long_running_actionobject + An alert for state-machines that are running for too long
+ 		false
bdb_low_throughputobject + Throughput is lower than specified threshold value [requests / sec.]
+ 		false
bdb_ram_dataset_overheadobject + Dataset RAM overhead of a shard has reached the threshold value [% of its RAM limit]
+ 		false
bdb_ram_valuesobject + Percent of values kept in a shard's RAM is lower than [% of its key count]
+ 		false
bdb_replica_src_high_syncer_lagobject + Replica-of source - sync lag is higher than specified threshold value [seconds]
+ 		false
bdb_replica_src_syncer_connection_errorobject + Replica-of source - sync has connection error while trying to connect replica source
+ 		false
bdb_shard_num_ram_valuesobject + Number of values kept in a shard's RAM is lower than [values]
+ 		false
bdb_sizeobject + 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] + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
enabledboolean + Alert enabled or disabled
+ 		true
thresholdstring + 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] + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
enabledboolean + Alert enabled or disabled
+ 		true
thresholdstring + 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 + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
enabledboolean + Alert enabled or disabled
+ 		true
thresholdstring + 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 + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
enabledboolean + Alert enabled or disabled
+ 		true
thresholdstring + Threshold for alert going on/off
+ 		true
+ + +### spec.globalConfigurations.alertSettings.bdb_high_latency +[↩ Parent](#specglobalconfigurationsalertsettings) + +Latency is higher than specified threshold value [micro-sec] + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
enabledboolean + Alert enabled or disabled
+ 		true
thresholdstring + Threshold for alert going on/off
+ 		true
+ + +### spec.globalConfigurations.alertSettings.bdb_high_throughput +[↩ Parent](#specglobalconfigurationsalertsettings) + +Throughput is higher than specified threshold value [requests / sec.] + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
enabledboolean + Alert enabled or disabled
+ 		true
thresholdstring + 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 + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
enabledboolean + Alert enabled or disabled
+ 		true
thresholdstring + Threshold for alert going on/off
+ 		true
+ + +### spec.globalConfigurations.alertSettings.bdb_low_throughput +[↩ Parent](#specglobalconfigurationsalertsettings) + +Throughput is lower than specified threshold value [requests / sec.] + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
enabledboolean + Alert enabled or disabled
+ 		true
thresholdstring + 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] + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
enabledboolean + Alert enabled or disabled
+ 		true
thresholdstring + 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] + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
enabledboolean + Alert enabled or disabled
+ 		true
thresholdstring + 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] + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
enabledboolean + Alert enabled or disabled
+ 		true
thresholdstring + 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 + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
enabledboolean + Alert enabled or disabled
+ 		true
thresholdstring + 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] + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
enabledboolean + Alert enabled or disabled
+ 		true
thresholdstring + 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] + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
enabledboolean + Alert enabled or disabled
+ 		true
thresholdstring + Threshold for alert going on/off
+ 		true
+ + ### spec.globalConfigurations.backup [↩ Parent](#specglobalconfigurations) @@ -891,7 +1469,7 @@ Specifications for DB upgrade. upgradeModulesToLatest boolean - Upgrades the modules to the latest version that supports the DB version during a DB upgrade action, to upgrade the DB version view the 'redisVersion' field. Note - This field is currently not supported for Active-Active databases.
+ Upgrades the modules to the latest version that supportes the DB version during a DB upgrade action, to upgrade the DB version view the 'redisVersion' field. Note - This field is currently not supported for Active-Active databases.
true diff --git a/content/operate/kubernetes/reference/redis_enterprise_cluster_api.md b/content/operate/kubernetes/reference/redis_enterprise_cluster_api.md index 5f5ced4efe..5b9bd89676 100644 --- a/content/operate/kubernetes/reference/redis_enterprise_cluster_api.md +++ b/content/operate/kubernetes/reference/redis_enterprise_cluster_api.md @@ -423,6 +423,13 @@ RedisEnterpriseClusterSpec defines the desired state of RedisEnterpriseCluster Whether databases will turn on RESP3 compatibility upon database upgrade. Note - Deleting this property after explicitly setting its value shall have no effect. Please view the corresponding field in RS doc for more info.
false + + securityContext + object + + the security configuration that will be applied to RS pods.
+ + false serviceAccountName string @@ -12030,6 +12037,56 @@ Stores configurations specific to redis on flash. If provided, the cluster will +### spec.securityContext +[↩ Parent](#spec) + +the security configuration that will be applied to RS pods. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
readOnlyRootFilesystemPolicyobject + Whether RS containers has a read-only root filesystem and what is the policy. some mandatory paths are still writable so RS can work properly.
+ 		false
+ + +### spec.securityContext.readOnlyRootFilesystemPolicy +[↩ Parent](#specsecuritycontext) + +Whether RS containers has a read-only root filesystem and what is the policy. some mandatory paths are still writable so RS can work properly. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
enabledboolean + Whether RS containers has a read-only root filesystem. Default is false.
+ 		true
+ + ### spec.services [↩ Parent](#spec)