Skip to content

Commit f6bc0af

Browse files
committed
DOC-5748 DOC-5779 Added last_login to user REST API reference and changes related to blocking new user creation after the maximum limit is reached
1 parent a82b3b2 commit f6bc0af

File tree

4 files changed

+17
-6
lines changed

4 files changed

+17
-6
lines changed

content/embeds/rs-prometheus-metrics-v2.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@
7878
| <span class="break-all">total_node_count{cluster_wd=<node_uid>}</span> | gauge| Number of nodes |
7979
| <span class="break-all">total_primary_selection_ended{cluster_wd=<node_uid>}</span> | counter | Monotonic counter for each selection process that ended |
8080
| <span class="break-all">total_primary_selections{cluster_wd=<node_uid>}</span> | counter | Monotonic counter for each selection process that started|
81+
| users_count | gauge | Current number of users on the cluster |
8182

8283
## Replication metrics
8384

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ weight: $weight
2929
| cluster_ocsp_status_revoked | boolean (default: false) | OCSP certificate status is REVOKED |
3030
| cluster_ram_overcommit | boolean (default: false) | RAM committed to databases is larger than cluster total RAM |
3131
| cluster_too_few_nodes_for_replication | boolean (default: false) | Replication requires at least 2 nodes in the cluster |
32+
| cluster_users_count_approaches_limit | <span class="break-all">[cluster_alert_settings_with_threshold]({{< relref "/operate/rs/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold" >}})</span> object | Number of users approaches the maximum limit of 32,000 users. This alert is enabled with a 90% threshold by default on new clusters. |
3233
| node_aof_slow_disk_io | boolean (default: false) | AOF reaching disk I/O limits
3334
| node_checks_error | boolean (default: false) | Some node checks have failed |
3435
| 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) |

content/operate/rs/references/rest-api/objects/user.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,18 @@ weight: $weight
1414
|------|------------|-------------|
1515
| uid | integer | User's unique ID |
1616
| account_id | integer | SM account ID |
17-
| action_uid | string | Action UID. If it exists, progress can be tracked by the `GET`&nbsp;`/actions/{uid}` API request (read-only) |
17+
| action_uid | string | Action UID. If it exists, progress can be tracked by the <span class="break-all">`GET /actions/{uid}`</span> API request (read-only) |
1818
| auth_method | **'regular'**<br />'certificate'<br />'entraid' | User's authentication method |
1919
| bdbs_email_alerts | complex object | UIDs of databases that user will receive alerts for |
20-
| certificate_subject_line | string | The certificate’s subject line as defined by RFC2253. Used for certificate-based authentication users only. |
20+
| <span class="break-all">certificate_subject_line</span> | string | The certificate’s subject line as defined by RFC2253. Used for certificate-based authentication users only. |
2121
| cluster_email_alerts | boolean | Activate cluster email alerts for a user |
2222
| email | string | User's email (pattern matching only ASCII characters) |
23-
| email_alerts | boolean (default:&nbsp;true) | Activate email alerts for a user |
23+
| email_alerts | boolean (default: true) | Activate email alerts for a user |
24+
| last_login | integer | UNIX timestamp of the user's last login time. This denotes the last time an authentication with the user's credentials was successful. (read-only) |
2425
| name | string | User's name (pattern does not allow non-ASCII and special characters &,\<,>,") |
25-
| password | string | User's password. If `password_hash_method` is set to `1`, the password should be hashed using SHA-256. The format before hashing is `username:clustername:password`. |
26-
| password_hash_method | '1' | Used when password is passed pre-hashed to specify the hashing method |
27-
| password_issue_date | string | The date in which the password was set (read-only) |
26+
| password | string | User's password. If `password_hash_method` is set to `1`, the password should be hashed using SHA-256. The format before hashing is <span class="break-all">`username:clustername:password`</span>. |
27+
| <span class="break-all">password_hash_method</span> | '1' | Used when password is passed pre-hashed to specify the hashing method |
28+
| <span class="break-all">password_issue_date</span> | string | The date in which the password was set (read-only) |
2829
| role | 'admin'<br />'cluster_member'<br />'cluster_viewer'<br />'db_member'<br /> **'db_viewer'** <br />'user_manager'<br />'none' | User's [role]({{< relref "/operate/rs/references/rest-api/permissions#roles" >}}) |
2930
| role_uids | array of integers | UIDs of user's roles for role-based access control |
3031
| status | 'active'<br />'locked'<br />'password_expired' | User sign-in status (read-only)<br />**active**: able to sign in<br />**locked**: unable to sign in<br />**password_expired**: unable to sign in because the password expired |

content/operate/rs/release-notes/rs-8-0-releases/rs-8-0-tba.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,12 @@ The [metrics stream engine]({{<relref "/operate/rs/monitoring/metrics_stream_eng
133133
crdb-cli crdb update --crdb-guid <guid> --update-db-config-modules true
134134
```
135135
136+
- Added a check to block new user creation after the maximum limit of 32,000 users has been reached:
137+
138+
- Added a [cluster alert]({{<relref "operate/rs/references/rest-api/objects/cluster/alert_settings">}}) `cluster_users_count_approaches_limit`, which triggers when the number of users surpasses a threshold percentage of the maximum user limit. This alert is enabled with a 90% threshold by default on new clusters.
139+
140+
- Added a `users_count` cluster metric to [Prometheus metrics v2]({{<relref "/operate/rs/references/metrics/prometheus-metrics-v2">}}) that shows the current number of users on the cluster.
141+
136142
- New [database configuration]({{<relref "/operate/rs/references/rest-api/requests/bdbs">}}) fields in the REST API for automatic shard balancing:
137143
138144
- `auto_shards_balancing`: Automatically balances database shards.
@@ -145,6 +151,8 @@ The [metrics stream engine]({{<relref "/operate/rs/monitoring/metrics_stream_eng
145151
146152
- Additional REST API enhancements:
147153
154+
- New `last_login` field for [users]({{<relref "/operate/rs/references/rest-api/requests/users">}}), which stores the UNIX timestamp of the user's last successful login to the Cluster Manager UI or REST API.
155+
148156
- Added [cluster configuration]({{<relref "/operate/rs/references/rest-api/requests/cluster">}}) fields:
149157

150158
- `disconnect_clients_on_password_removal`: Controls whether client connections using removed, revoked, or rotated passwords are actively disconnected.

0 commit comments

Comments
 (0)