RS 8.0.20 release docs

assets/css/index.css

@@ -84,6 +84,23 @@ section.prose {
   @apply text-base;
 }
 
+/* Nested ordered list styling for alphabetic numbering on sublists */
+.prose ol {
+  list-style-type: decimal;
+}
+
+.prose ol ol {
+  list-style-type: lower-alpha;
+}
+
+.prose ol ol ol {
+  list-style-type: lower-roman;
+}
+
+.prose ol ol ol ol {
+  list-style-type: decimal;
+}
+
 .prose pre {
   @apply bg-slate-900 rounded-lg;
 }

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

@@ -199,6 +199,7 @@
 | redis_server_search_global_total | The total number of user and internal cursors in the shard, either holding pending results or actively executing `FT.CURSOR READ`. Deprecated in 8.0 (split into <span class="break-all">redis_server_search_cursors_internal_active</span> and <span class="break-all">redis_server_search_cursors_user_active</span>), but still available in older versions. <sup>[1](#tnote-1)</sup> |
 | <span class="break-all">redis_server_search_number_of_indexes</span> | Total number of indexes in the shard <sup>[1](#tnote-1)</sup> |
 | <span class="break-all">redis_server_search_number_of_active_indexes</span> | The total number of indexes running a background indexing and/or background query processing operation. Background indexing refers to vector ingestion process, or in-progress background indexer. <sup>[1](#tnote-1)</sup> |
+| <span class="break-all">redis_server_search_total_num_docs_in_indexes</span> | The total number of documents currently indexed across all indexes in the shard. <sup>[2](#tnote-2)</sup> |
 | <span class="break-all">redis_server_search_number_of_active_indexes_running_queries</span> | Total count of indexes currently running a background query process. <sup>[1](#tnote-1)</sup> |
 | <span class="break-all">redis_server_search_number_of_active_indexes_indexing</span> | Total count of indexes currently undergoing a background indexing process. Background indexing refers to vector ingestion process, or in-progress background indexer. This metric is limited by the number of WORKER threads allocated for writing operations + the number of indexes. <sup>[1](#tnote-1)</sup> |
 | <span class="break-all">redis_server_search_total_active_write_threads</span> | Total count of background write (indexing) processes currently running in the shard. Background indexing refers to vector ingestion process, or in-progress background indexer. This metric is limited by the number of threads allocated for writing operations. <sup>[1](#tnote-1)</sup> |
@@ -229,6 +230,12 @@
 | <span class="break-all">redis_server_search_fields_geoshape_Sortable</span> | The total number of `SORTABLE GEOSHAPE` fields across all indexes in the shard. This field appears only if its value is larger than 0. <sup>[2](#tnote-2)</sup> |
 | <span class="break-all">redis_server_search_fields_geoshape_NoIndex</span> | The total number of `NOINDEX GEOSHAPE` fields across all indexes in the shard; i.e., used for sorting only but not indexed. This field appears only if its value is larger than 0. <sup>[2](#tnote-2)</sup> |
 | <span class="break-all">redis_server_search_fields_geoshape_IndexErrors</span> | The total number of indexing failures caused by attempts to index a document containing a `GEOSHAPE` field. This field appears only if `GEOSHAPE` fields exist. <sup>[2](#tnote-2)</sup> |
+| <span class="break-all">redis_server_search_total_indexing_ops_text_fields</span> | The total number of indexing operations performed on `TEXT` fields across all indexes in the shard. <sup>[2](#tnote-2)</sup> |
+| <span class="break-all">redis_server_search_total_indexing_ops_tag_fields</span> | The total number of indexing operations performed on `TAG` fields across all indexes in the shard. <sup>[2](#tnote-2)</sup> |
+| <span class="break-all">redis_server_search_total_indexing_ops_numeric_fields</span> | The total number of indexing operations performed on `NUMERIC` fields across all indexes in the shard. <sup>[2](#tnote-2)</sup> |
+| <span class="break-all">redis_server_search_total_indexing_ops_geo_fields</span> | The total number of indexing operations performed on `GEO` fields across all indexes in the shard. <sup>[2](#tnote-2)</sup> |
+| <span class="break-all">redis_server_search_total_indexing_ops_geoshape_fields</span> | The total number of indexing operations performed on `GEOSHAPE` fields across all indexes in the shard. <sup>[2](#tnote-2)</sup> |
+| <span class="break-all">redis_server_search_total_indexing_ops_vector_fields</span> | The total number of indexing operations performed on `VECTOR` fields across all indexes in the shard. <sup>[2](#tnote-2)</sup> |
 | <span class="break-all">redis_server_search_used_memory_indexes</span> | The total memory allocated by all indexes in the shard in bytes. <sup>[1](#tnote-1)</sup> |
 | <span class="break-all">redis_server_search_smallest_memory_index</span> | The memory usage of the index with the smallest memory usage in the shard in bytes. <sup>[1](#tnote-1)</sup> |
 | <span class="break-all">redis_server_search_largest_memory_index</span> | The memory usage of the index with the largest memory usage in the shard in bytes. <sup>[1](#tnote-1)</sup> |
@@ -247,6 +254,29 @@
 | <span class="break-all">redis_server_search_total_active_queries</span> | The total number of background queries currently being executed in the shard, excluding `FT.CURSOR READ`. <sup>[1](#tnote-1)</sup> |
 | <span class="break-all">redis_server_search_errors_indexing_failures</span> | The total number of indexing failures recorded across all indexes in the shard. <sup>[1](#tnote-1)</sup> |
 | <span class="break-all">redis_server_search_errors_for_index_with_max_failures</span> | The number of indexing failures in the index with the highest count of failures. <sup>[1](#tnote-1)</sup> |
+| <span class="break-all">redis_server_search_OOM_indexing_failures_indexes_count</span> | The count of indexes that experienced out-of-memory (OOM) failures during background indexing. <sup>[2](#tnote-2)</sup> |
+| <span class="break-all">redis_server_search_shard_total_query_errors_syntax</span> | The total number of query syntax errors occurred in the shard. <sup>[2](#tnote-2)</sup> |
+| <span class="break-all">redis_server_search_shard_total_query_errors_arguments</span> | The total number of queries in the shard that failed due to missing or invalid arguments. <sup>[2](#tnote-2)</sup> |
+| <span class="break-all">redis_server_search_shard_total_query_errors_timeout</span> | The total number of query timeout errors occurred in the shard (when timeout policy is 'fail'). <sup>[2](#tnote-2)</sup> |
+| <span class="break-all">redis_server_search_shard_total_query_warnings_timeout</span> | The total number of query timeout warnings occurred in the shard (when timeout policy is 'return partial results'). <sup>[2](#tnote-2)</sup> |
+| <span class="break-all">redis_server_search_shard_total_query_errors_oom</span> | The total number of query out-of-memory errors occurred in the shard. <sup>[4](#tnote-4)</sup> |
+| <span class="break-all">redis_server_search_shard_total_query_warnings_oom</span> | The total number of query out-of-memory warnings occurred in the shard. <sup>[4](#tnote-4)</sup> |
+| <span class="break-all">redis_server_search_shard_total_query_warnings_max_prefix_expansions</span> | The total number of max prefix expansion warnings occurred in the shard. <sup>[2](#tnote-2)</sup> |
+| <span class="break-all">redis_server_search_coord_total_query_errors_syntax</span> | The total number of query syntax errors occurred at the coordinator. <sup>[2](#tnote-2)</sup> |
+| <span class="break-all">redis_server_search_coord_total_query_errors_arguments</span> | The total number of query argument errors encountered by the shard's coordinator. <sup>[2](#tnote-2)</sup> |
+| <span class="break-all">redis_server_search_coord_total_query_errors_timeout</span> | The total number of query timeout errors encountered by the shard's coordinator (when timeout policy is 'fail'). <sup>[2](#tnote-2)</sup> |
+| <span class="break-all">redis_server_search_coord_total_query_warnings_timeout</span> | The total number of query timeout warnings encountered by the shard's coordinator (when timeout policy is 'return partial results'). <sup>[2](#tnote-2)</sup> |
+| <span class="break-all">redis_server_search_coord_total_query_errors_oom</span> | The total number of query out-of-memory errors encountered by the shard's coordinator. <sup>[4](#tnote-4)</sup> |
+| <span class="break-all">redis_server_search_coord_total_query_warnings_oom</span> | The total number of query out-of-memory warnings encountered by the shard's coordinator. <sup>[4](#tnote-4)</sup> |
+| <span class="break-all">redis_server_search_coord_total_query_warnings_max_prefix_expansions</span> | The total number of max prefix expansion warnings encountered by the shard's coordinator. <sup>[2](#tnote-2)</sup> |
+| <span class="break-all">redis_server_search_uv_threads_running_queries</span> | The number of I/O threads currently handling query distribution to shards in cluster environments. <sup>[2](#tnote-2)</sup> |
+| <span class="break-all">redis_server_search_uv_threads_running_topology_update</span> | The number of UV threads currently running topology updates. <sup>[3](#tnote-3)</sup> |
+| <span class="break-all">redis_server_search_active_worker_threads</span> | The number of active worker threads. <sup>[2](#tnote-2)</sup> |
+| <span class="break-all">redis_server_search_active_coord_threads</span> | The number of active coordinator threads. <sup>[2](#tnote-2)</sup> |
+| <span class="break-all">redis_server_search_workers_low_priority_pending_jobs</span> | The number of pending low-priority jobs in worker threads, such as vector background indexing, graph updates, and vector garbage collection in graph-based indexes. <sup>[2](#tnote-2)</sup> |
+| <span class="break-all">redis_server_search_workers_high_priority_pending_jobs</span> | The number of pending high-priority jobs in worker threads, such as query execution. <sup>[2](#tnote-2)</sup> |
+| <span class="break-all">redis_server_search_workers_admin_priority_pending_jobs</span> | The number of pending admin-priority jobs in worker threads, such as threadpool configuration changes. <sup>[3](#tnote-3)</sup> |
+| <span class="break-all">redis_server_search_coord_high_priority_pending_jobs</span> | The number of pending jobs in the coordinator thread queue. Coordinator threads only have a high-priority queue and are primarily used for query distribution. <sup>[2](#tnote-2)</sup> |
 | <span class="break-all">shard_ping_failures</span> | gauge | Number of consecutive ping failures for a shard. Labels: shard_uid, role |
 | <span class="break-all">shard_ping_failure_duration_seconds</span> | gauge | Duration of ongoing failures (0 when healthy). Labels: shard_uid, role |
 

content/embeds/supported-platforms-embed.md

@@ -20,6 +20,7 @@ Redis Software is supported on several operating systems, cloud environments, a
 | Ubuntu 20.04<sup>[2](#table-note-2)</sup> | <span title="Supported">&#x2705;</span> | <span title="Supported">&#x2705;</span> | <span title="Supported">&#x2705;</span> | <span title="Supported">&#x2705;</span> | <span title="Supported">&#x2705;</span> | <span title="Supported">&#x2705;</span> | – |
 | Ubuntu 18.04<sup>[2](#table-note-2)</sup> | – | – | – | <span title="Deprecated" class="font-serif">:warning:</span> | <span title="Deprecated" class="font-serif">:warning:</span> | <span title="Deprecated" class="font-serif">:warning:</span> | <span title="Deprecated" class="font-serif">:warning:</span> |
 | Ubuntu 16.04<sup>[2](#table-note-2)</sup> | – | – | – | – | <span title="Deprecated" class="font-serif">:warning:</span> | <span title="Deprecated" class="font-serif">:warning:</span> | <span title="Deprecated" class="font-serif">:warning:</span> |
+| Amazon Linux 2023<sup>[6](#table-note-6)</sup> | <span title="Supported">&#x2705;</span> | – | – | – | – | – | – |
 | Amazon Linux 2 | <span title="Supported">&#x2705;</span> | <span title="Supported">&#x2705;</span> | <span title="Supported">&#x2705;</span> | <span title="Supported">&#x2705;</span> | <span title="Supported">&#x2705;</span> | <span title="Supported">&#x2705;</span> | – |
 | Amazon Linux 1 | – | – | – | – | <span title="Deprecated" class="font-serif">:warning:</span> | <span title="Deprecated" class="font-serif">:warning:</span> | <span title="Deprecated" class="font-serif">:warning:</span> |
 | Kubernetes<sup>[3](#table-note-3)</sup> | <span title="Supported">&#x2705;</span> | <span title="Supported">&#x2705;</span> | <span title="Supported">&#x2705;</span> | <span title="Supported">&#x2705;</span> | <span title="Supported">&#x2705;</span> | <span title="Supported">&#x2705;</span> | <span title="Supported">&#x2705;</span> |
@@ -35,6 +36,8 @@ Redis Software is supported on several operating systems, cloud environments, a
 
 5. <a name="table-note-5"></a>Supported only if [FIPS was enabled during RHEL installation](https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/security_hardening/switching-rhel-to-fips-mode_security-hardening#proc_installing-the-system-with-fips-mode-enabled_switching-rhel-to-fips-mode) to ensure FIPS compliance.
 
+6. <a name="table-note-6"></a>Amazon Linux 2023 support was added in Redis Software version 8.0.20.
+
 The following table shows which Redis Software version first tested and added support for each RHEL version:
 
 | RHEL version | Redis Software version |

content/operate/rs/references/cli-utilities/rladmin/status.md

@@ -40,6 +40,7 @@ rladmin status
 | extra rack_id | Shows `rack_id` and `second_rack_id` even if the cluster is not `rack_aware` |
 | extra redis_version | Shows Redis version of all databases in the cluster |
 | extra state_machine | Shows execution of state machine information  |
+| extra traffic_manually_disabled | Conditionally shows if any database's traffic was manually stopped with the `stop_traffic` API |
 | extra watchdog | Shows watchdog status  |
 
 ### Returns
@@ -112,6 +113,7 @@ rladmin status databases
 | extra rack_id | Shows `rack_id` and `second_rack_id` even if the cluster is not `rack_aware` |
 | extra redis_version | Shows Redis version of all databases in the cluster |
 | extra state_machine | Shows execution of state machine information  |
+| extra traffic_manually_disabled | Conditionally shows if any database's traffic was manually stopped with the `stop_traffic` API |
 | extra watchdog | Shows watchdog status  |
 
 ### Returns {#returns-dbs}

content/operate/rs/references/rest-api/objects/bdb/_index.md

@@ -175,6 +175,7 @@ An API object that represents a managed database in the cluster.
 | timeseries | [complex object]({{< relref "/operate/rs/references/rest-api/objects/bdb/timeseries" >}}); Configuration fields for timeseries. |
 | tls_mode | Require TLS-authenticated and encrypted connections to the database<br />Values:<br />'enabled'<br /> **'disabled'** <br />'replica_ssl' |
 | tracking_table_max_keys | integer; The client-side caching invalidation table size. 0 makes the cache unlimited. |
+| traffic_manually_disabled | boolean; Whether traffic was manually turned off using the stop_traffic API (read-only) |
 | type | Type of database<br />Values:<br />**'redis'** <br />'memcached' |
 | use_nodes | array of strings; Cluster node UIDs to use for database shards and bound endpoints |
 | use_selective_flush | boolean (default: true); If true, enable selective flush of destination shards |

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

@@ -31,13 +31,22 @@ An API object that represents the cluster.
 | crdb_coordinator_port | integer, (range: 1024-65535) (default: 9081) | CRDB coordinator port |
 | <span class="break-all">crdt_rest_client_retries</span> | integer | Maximum number of retries for the REST client used by the Active-Active management API |
 | <span class="break-all">crdt_rest_client_timeout</span> | integer | Timeout for REST client used by the Active-Active management API |
+| <span class="break-all">crdt_supported_featureset_version</span> | integer | CRDB supported featureset version (read-only) |
+| <span class="break-all">crdt_supported_featureset_version_map</span> | object | CRDB supported featureset version mapping by Redis version (read-only) |
+| <span class="break-all">crdt_supported_module_featureset_version_map</span> | object | Mapping of module names to per-module-semantic-version supported CRDB featureset versions (read-only) |
+| <span class="break-all">crdt_supported_protocol_versions</span> | array of strings | CRDB supported protocol versions (read-only) |
+| <span class="break-all">crdt_supported_protocol_versions_map</span> | object | CRDB supported protocol versions mapping by Redis version (read-only) |
 | created_time | string | Cluster creation date (read-only) |
 | data_cipher_list | string | Specifies the enabled ciphers for the data plane. The ciphers are specified in the format understood by the OpenSSL library. |
 | <span class="break-all">data_cipher_suites_tls_1_3</span> | string | Specifies the enabled TLS 1.3 ciphers for the data plane. |
 | debuginfo_path | string | Path to a local directory used when generating support packages |
 | <span class="break-all">default_non_sharded_proxy_policy</span> | string (default: single) | Default proxy_policy for newly created non-sharded databases' endpoints (read-only) |
 | <span class="break-all">default_sharded_proxy_policy</span> | string (default: all-master-shards) | Default proxy_policy for newly created sharded databases' endpoints (read-only) |
 | <span class="break-all">disconnect_clients_on_password_removal</span> | "enabled"<br />"disabled"<br />**"auto"** | This flag controls whether client connections using removed, revoked, or rotated passwords are actively disconnected |
+| <span class="break-all">dmc_external_authentication</span> | boolean (default: false) | Enable DMC to call the authentication_service for basic authentication |
+| <span class="break-all">dmc_external_cba_authentication</span> | boolean (default: false) | Enable DMC to call the authentication_service for certificate-based authentication |
+| <span class="break-all">dmc_external_entraid_authentication</span> | boolean (default: false) | Enable DMC to call the authentication_service for entraid authentication |
+| <span class="break-all">dmc_external_ldap_authentication</span> | boolean (default: false) | Enable DMC to call the authentication_service for LDAP-based authentication |
 | email_alerts | boolean (default: false) | Send node/cluster email alerts (requires valid SMTP and email_from settings) |
 | email_from | string | Sender email for automated emails |
 | encrypt_pkeys | boolean (default: false) | Enable or turn off encryption of private keys |
@@ -48,6 +57,7 @@ An API object that represents the cluster.
 | handle_redirects | boolean (default: false) | Handle API HTTPS requests and redirect to the master node internally |
 | http_support | boolean (default: false) | Enable or turn off HTTP support |
 | logrotate_settings | [logrotate_settings]({{<relref "/operate/rs/references/rest-api/objects/cluster/logrotate_settings">}}) object | Settings for logrotate configuration |
+| mask_bdb_credentials | boolean (default: false) | If set to true, the BDB credentials will be masked in the BDB API responses |
 | metrics_auth | boolean (default: false) | If true, requires authentication for requests to the metrics exporter |
 | <span class="break-all">min_control_TLS_version</span> | "1.2"<br />"1.3" | The minimum version of TLS protocol which is supported at the control path |
 | min_data_TLS_version | "1.2"<br />"1.3" | The minimum version of TLS protocol which is supported at the data path |