Skip to content

Commit 2eb2d4b

Browse files
rrelledgerrelledge
authored
RS: Configure license expiration alert (#563)
* DOC-4038 RS: Configure license expiration alert * DOC-4038 Add RS CMUI instructions and screenshot for license expiration alert config * DOC-4038 Add RS CMUI screenshot that shows cluster license expiration alert
1 parent b0ebe37 commit 2eb2d4b

File tree

4 files changed

+68
-28
lines changed

4 files changed

+68
-28
lines changed

‎content/operate/rs/clusters/configure/license-keys.md‎

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,46 @@ When the license is expired:
8888
- Fail over when a node fails and explicitly migrate shards between nodes.
8989

9090
- Upgrade a node to a new version of Redis Enterprise Software.
91-
91+
92+
## Configure license expiration alert
93+
94+
By default, a cluster license alert is scheduled to occur 7 days before the cluster license expiration date.
95+
96+
{{<image filename="images/rs/screenshots/cluster/cluster-license-expiration-alert.png" alt="An alert appears in the Cluster Manager UI that says 'Your license will expire on day-month-year time. Contact support to renew your license.'" >}}
97+
98+
You can adjust the threshold value of the cluster license expiration alert based on how far in advance you want to be notified of the license expiration. The value should be within a reasonable range that allows your organization enough time to take action, such as renewing the license, before it expires.
99+
100+
To change the cluster license alert settings, use one of the following methods:
101+
102+
- Cluster Manager UI:
103+
104+
1. On the **Cluster > Configuration** screen, select the **Alerts Settings** tab.
105+
106+
1. Click **Edit**.
107+
108+
1. In the **Cluster utilization** section, enable the alert setting "License expiry notifications will be sent \<value\> days before the license expires" and enter a new value in the box.
109+
110+
{{<image filename="images/rs/screenshots/cluster/cluster-config-alert-settings-utilization.png" alt="Cluster utilization alert settings." >}}
111+
112+
1. Click **Save**.
113+
114+
115+
- [Update cluster]({{<relref "/operate/rs/references/rest-api/requests/cluster#put-cluster">}}) REST API request:
116+
117+
The following example changes the cluster license alert to occur 30 days before the cluster license expiration date:
118+
119+
```sh
120+
PUT /v1/cluster
121+
{
122+
"alert_settings": {
123+
"cluster_license_about_to_expire": {
124+
"enabled": true,
125+
"threshold": "30"
126+
}
127+
}
128+
}
129+
```
130+
92131
## Monitor cluster license
93132

94133
As of version 7.2, Redis Enterprise exposes the license quotas and the shards consumption metrics in the Cluster Manager UI or via the [Prometheus integration]({{< relref "/integrate/prometheus-with-redis-enterprise/" >}}).

‎content/operate/rs/references/rest-api/objects/cluster/alert_settings.md‎

Lines changed: 28 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -13,30 +13,31 @@ weight: $weight
1313

1414
| Name | Type/Value | Description |
1515
|------|------------|-------------|
16-
| cluster_certs_about_to_expire | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object | Cluster certificate will expire in x days |
17-
| cluster_even_node_count | boolean (default:&nbsp;false) | True high availability requires an odd number of nodes in the cluster |
18-
| cluster_flash_overcommit | boolean (default:&nbsp;false) | Flash memory committed to databases is larger than cluster total flash memory |
19-
| cluster_inconsistent_redis_sw | boolean (default:&nbsp;false) | Some shards in the cluster are running different versions of Redis software |
20-
| cluster_inconsistent_rl_sw | boolean (default:&nbsp;false) | Some nodes in the cluster are running different versions of Redis Enterprise software |
21-
| cluster_internal_bdb | boolean (default:&nbsp;false) | Issues with internal cluster databases |
22-
| cluster_multiple_nodes_down | boolean (default:&nbsp;false) | Multiple cluster nodes are down (this might cause data loss) |
23-
| cluster_node_joined | boolean (default:&nbsp;false) | New node joined the cluster |
24-
| cluster_node_remove_abort_completed | boolean (default:&nbsp;false) | Cancel node remove operation completed |
25-
| cluster_node_remove_abort_failed | boolean (default:&nbsp;false) | Cancel node remove operation failed |
26-
| cluster_node_remove_completed | boolean (default:&nbsp;false) | Node removed from the cluster |
27-
| cluster_node_remove_failed | boolean (default:&nbsp;false) | Failed to remove a node from the cluster |
28-
| cluster_ocsp_query_failed | boolean (default:&nbsp;false) | Failed to query the OCSP server |
29-
| cluster_ocsp_status_revoked | boolean (default:&nbsp;false) | OCSP certificate status is REVOKED |
30-
| cluster_ram_overcommit | boolean (default:&nbsp;false) | RAM committed to databases is larger than cluster total RAM |
31-
| cluster_too_few_nodes_for_replication | boolean (default:&nbsp;false) | Replication requires at least 2 nodes in the cluster |
32-
| node_aof_slow_disk_io | boolean (default:&nbsp;false) | AOF reaching disk I/O limits
33-
| node_checks_error | boolean (default:&nbsp;false) | Some node checks have failed |
34-
| node_cpu_utilization | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object | Node CPU utilization has reached the threshold value (% of the utilization limit) |
35-
| node_ephemeral_storage | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object | Node ephemeral storage has reached the threshold value (% of the storage limit) |
36-
| node_failed | boolean (default:&nbsp;false) | Node failed |
37-
| node_free_flash | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object | Node flash storage has reached the threshold value (% of the storage limit) |
38-
| node_insufficient_disk_aofrw | boolean (default:&nbsp;false) | Insufficient AOF disk space |
39-
| node_internal_certs_about_to_expire | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object| Internal certificate on node will expire in x days |
40-
| node_memory | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object | Node memory has reached the threshold value (% of the memory limit) |
41-
| node_net_throughput | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object | Node network throughput has reached the threshold value (bytes/s) |
42-
| node_persistent_storage | [cluster_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}}) object | Node persistent storage has reached the threshold value (% of the storage limit) |
16+
| cluster_certs_about_to_expire | <span class="break-all">[cluster_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}})</span> object | Cluster certificate will expire in x days |
17+
| cluster_even_node_count | boolean (default: false) | True high availability requires an odd number of nodes in the cluster |
18+
| cluster_flash_overcommit | boolean (default: false) | Flash memory committed to databases is larger than cluster total flash memory |
19+
| cluster_inconsistent_redis_sw | boolean (default: false) | Some shards in the cluster are running different versions of Redis software |
20+
| cluster_inconsistent_rl_sw | boolean (default: false) | Some nodes in the cluster are running different versions of Redis Enterprise software |
21+
| cluster_internal_bdb | boolean (default: false) | Issues with internal cluster databases |
22+
| cluster_license_about_to_expire | <span class="break-all">[cluster_alert_settings_with_threshold]({{<relref "/operate/rs/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold">}})</span> object | Cluster license will expire in x days. This alert is enabled by default. Its default threshold is 7 days before license expiration. |
23+
| cluster_multiple_nodes_down | boolean (default: false) | Multiple cluster nodes are down (this might cause data loss) |
24+
| cluster_node_joined | boolean (default: false) | New node joined the cluster |
25+
| cluster_node_remove_abort_completed | boolean (default: false) | Cancel node remove operation completed |
26+
| cluster_node_remove_abort_failed | boolean (default: false) | Cancel node remove operation failed |
27+
| cluster_node_remove_completed | boolean (default: false) | Node removed from the cluster |
28+
| cluster_node_remove_failed | boolean (default: false) | Failed to remove a node from the cluster |
29+
| cluster_ocsp_query_failed | boolean (default: false) | Failed to query the OCSP server |
30+
| cluster_ocsp_status_revoked | boolean (default: false) | OCSP certificate status is REVOKED |
31+
| cluster_ram_overcommit | boolean (default: false) | RAM committed to databases is larger than cluster total RAM |
32+
| cluster_too_few_nodes_for_replication | boolean (default: false) | Replication requires at least 2 nodes in the cluster |
33+
| node_aof_slow_disk_io | boolean (default: false) | AOF reaching disk I/O limits
34+
| node_checks_error | boolean (default: false) | Some node checks have failed |
35+
| node_cpu_utilization | <span class="break-all">[cluster_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}})</span> object | Node CPU utilization has reached the threshold value (% of the utilization limit) |
36+
| node_ephemeral_storage | <span class="break-all">[cluster_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}})</span> object | Node ephemeral storage has reached the threshold value (% of the storage limit) |
37+
| node_failed | boolean (default: false) | Node failed |
38+
| node_free_flash | <span class="break-all">[cluster_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}})</span> object | Node flash storage has reached the threshold value (% of the storage limit) |
39+
| node_insufficient_disk_aofrw | boolean (default: false) | Insufficient AOF disk space |
40+
| node_internal_certs_about_to_expire | <span class="break-all">[cluster_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}})</span> object| Internal certificate on node will expire in x days |
41+
| node_memory | <span class="break-all">[cluster_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}})</span> object | Node memory has reached the threshold value (% of the memory limit) |
42+
| node_net_throughput | <span class="break-all">[cluster_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}})</span> object | Node network throughput has reached the threshold value (bytes/s) |
43+
| node_persistent_storage | <span class="break-all">[cluster_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}})</span> object | Node persistent storage has reached the threshold value (% of the storage limit) |

‎static/images/rs/screenshots/cluster/cluster-config-alert-settings-utilization.png‎

121 KB
Loading

‎static/images/rs/screenshots/cluster/cluster-license-expiration-alert.png‎

84 KB
Loading

0 commit comments

Comments
 (0)