From e033f8ba4e00c5c0e7ee34eecf9613607db234f1 Mon Sep 17 00:00:00 2001 From: Rafi Shamim Date: Fri, 25 Apr 2025 12:03:19 -0400 Subject: [PATCH 1/2] Fix outdated information in node shutdown docs In 2024, we made the decision to go back to setting the server.shutdown.connections.timeout value back to 0 (default) for Advanced clusters. This docs page was never updated to reflect that. See here for the record of this meeting: https://cockroachlabs.atlassian.net/wiki/spaces/MC/pages/3674636289/Re-Decision+connection+timeout+setting+rollout+for+CockroachDB+Cloud+clusters --- src/current/v23.2/node-shutdown.md | 4 ++-- src/current/v24.1/node-shutdown.md | 4 ++-- src/current/v24.2/node-shutdown.md | 4 ++-- src/current/v24.3/node-shutdown.md | 4 ++-- src/current/v25.1/node-shutdown.md | 4 ++-- src/current/v25.2/node-shutdown.md | 4 ++-- 6 files changed, 12 insertions(+), 12 deletions(-) diff --git a/src/current/v23.2/node-shutdown.md b/src/current/v23.2/node-shutdown.md index 59556b95075..4acf2f48b19 100644 --- a/src/current/v23.2/node-shutdown.md +++ b/src/current/v23.2/node-shutdown.md @@ -876,9 +876,9 @@ Cockroach Labs recommends that you: ## Decommissioning and draining on CockroachDB {{ site.data.products.advanced }} -Most of the guidance in this page is most relevant to manual deployments, although decommissioning and draining work the same way behind the scenes in a CockroachDB {{ site.data.products.advanced }} cluster. CockroachDB {{ site.data.products.advanced }} clusters have a `server.shutdown.connections.timeout` of 1800 seconds (30 minutes) and a termination grace period that is slightly longer. The termination grace period is not configurable, and adjusting `server.shutdown.connections.timeout` is generally not recommended. +Most of the guidance in this page is most relevant to manual deployments, although decommissioning and draining work the same way behind the scenes in a CockroachDB {{ site.data.products.advanced }} cluster. CockroachDB {{ site.data.products.advanced }} clusters have a termination grace period that is slightly longer than 30 minutes, and this grace period is not configurable. -Client applications or application servers that connect to CockroachDB {{ site.data.products.advanced }} clusters should use connection pools that have a maximum lifetime that is shorter than the [`server.shutdown.connections.timeout`](#server-shutdown-connections-timeout) setting. +Client applications or application servers that connect to CockroachDB {{ site.data.products.advanced }} clusters may adjust the the [`server.shutdown.connections.timeout`](#server-shutdown-connections-timeout) setting and should make sure the connection pool maximum lifetime is shorter than that value, as per the guidance in the rest of this page. ## See also diff --git a/src/current/v24.1/node-shutdown.md b/src/current/v24.1/node-shutdown.md index 59556b95075..4acf2f48b19 100644 --- a/src/current/v24.1/node-shutdown.md +++ b/src/current/v24.1/node-shutdown.md @@ -876,9 +876,9 @@ Cockroach Labs recommends that you: ## Decommissioning and draining on CockroachDB {{ site.data.products.advanced }} -Most of the guidance in this page is most relevant to manual deployments, although decommissioning and draining work the same way behind the scenes in a CockroachDB {{ site.data.products.advanced }} cluster. CockroachDB {{ site.data.products.advanced }} clusters have a `server.shutdown.connections.timeout` of 1800 seconds (30 minutes) and a termination grace period that is slightly longer. The termination grace period is not configurable, and adjusting `server.shutdown.connections.timeout` is generally not recommended. +Most of the guidance in this page is most relevant to manual deployments, although decommissioning and draining work the same way behind the scenes in a CockroachDB {{ site.data.products.advanced }} cluster. CockroachDB {{ site.data.products.advanced }} clusters have a termination grace period that is slightly longer than 30 minutes, and this grace period is not configurable. -Client applications or application servers that connect to CockroachDB {{ site.data.products.advanced }} clusters should use connection pools that have a maximum lifetime that is shorter than the [`server.shutdown.connections.timeout`](#server-shutdown-connections-timeout) setting. +Client applications or application servers that connect to CockroachDB {{ site.data.products.advanced }} clusters may adjust the the [`server.shutdown.connections.timeout`](#server-shutdown-connections-timeout) setting and should make sure the connection pool maximum lifetime is shorter than that value, as per the guidance in the rest of this page. ## See also diff --git a/src/current/v24.2/node-shutdown.md b/src/current/v24.2/node-shutdown.md index 59556b95075..4acf2f48b19 100644 --- a/src/current/v24.2/node-shutdown.md +++ b/src/current/v24.2/node-shutdown.md @@ -876,9 +876,9 @@ Cockroach Labs recommends that you: ## Decommissioning and draining on CockroachDB {{ site.data.products.advanced }} -Most of the guidance in this page is most relevant to manual deployments, although decommissioning and draining work the same way behind the scenes in a CockroachDB {{ site.data.products.advanced }} cluster. CockroachDB {{ site.data.products.advanced }} clusters have a `server.shutdown.connections.timeout` of 1800 seconds (30 minutes) and a termination grace period that is slightly longer. The termination grace period is not configurable, and adjusting `server.shutdown.connections.timeout` is generally not recommended. +Most of the guidance in this page is most relevant to manual deployments, although decommissioning and draining work the same way behind the scenes in a CockroachDB {{ site.data.products.advanced }} cluster. CockroachDB {{ site.data.products.advanced }} clusters have a termination grace period that is slightly longer than 30 minutes, and this grace period is not configurable. -Client applications or application servers that connect to CockroachDB {{ site.data.products.advanced }} clusters should use connection pools that have a maximum lifetime that is shorter than the [`server.shutdown.connections.timeout`](#server-shutdown-connections-timeout) setting. +Client applications or application servers that connect to CockroachDB {{ site.data.products.advanced }} clusters may adjust the the [`server.shutdown.connections.timeout`](#server-shutdown-connections-timeout) setting and should make sure the connection pool maximum lifetime is shorter than that value, as per the guidance in the rest of this page. ## See also diff --git a/src/current/v24.3/node-shutdown.md b/src/current/v24.3/node-shutdown.md index 59556b95075..4acf2f48b19 100644 --- a/src/current/v24.3/node-shutdown.md +++ b/src/current/v24.3/node-shutdown.md @@ -876,9 +876,9 @@ Cockroach Labs recommends that you: ## Decommissioning and draining on CockroachDB {{ site.data.products.advanced }} -Most of the guidance in this page is most relevant to manual deployments, although decommissioning and draining work the same way behind the scenes in a CockroachDB {{ site.data.products.advanced }} cluster. CockroachDB {{ site.data.products.advanced }} clusters have a `server.shutdown.connections.timeout` of 1800 seconds (30 minutes) and a termination grace period that is slightly longer. The termination grace period is not configurable, and adjusting `server.shutdown.connections.timeout` is generally not recommended. +Most of the guidance in this page is most relevant to manual deployments, although decommissioning and draining work the same way behind the scenes in a CockroachDB {{ site.data.products.advanced }} cluster. CockroachDB {{ site.data.products.advanced }} clusters have a termination grace period that is slightly longer than 30 minutes, and this grace period is not configurable. -Client applications or application servers that connect to CockroachDB {{ site.data.products.advanced }} clusters should use connection pools that have a maximum lifetime that is shorter than the [`server.shutdown.connections.timeout`](#server-shutdown-connections-timeout) setting. +Client applications or application servers that connect to CockroachDB {{ site.data.products.advanced }} clusters may adjust the the [`server.shutdown.connections.timeout`](#server-shutdown-connections-timeout) setting and should make sure the connection pool maximum lifetime is shorter than that value, as per the guidance in the rest of this page. ## See also diff --git a/src/current/v25.1/node-shutdown.md b/src/current/v25.1/node-shutdown.md index db8e156f1e2..a6711f0f214 100644 --- a/src/current/v25.1/node-shutdown.md +++ b/src/current/v25.1/node-shutdown.md @@ -876,9 +876,9 @@ Cockroach Labs recommends that you: ## Decommissioning and draining on CockroachDB {{ site.data.products.advanced }} -Most of the guidance in this page is most relevant to manual deployments, although decommissioning and draining work the same way behind the scenes in a CockroachDB {{ site.data.products.advanced }} cluster. CockroachDB {{ site.data.products.advanced }} clusters have a `server.shutdown.connections.timeout` of 1800 seconds (30 minutes) and a termination grace period that is slightly longer. The termination grace period is not configurable, and adjusting `server.shutdown.connections.timeout` is generally not recommended. +Most of the guidance in this page is most relevant to manual deployments, although decommissioning and draining work the same way behind the scenes in a CockroachDB {{ site.data.products.advanced }} cluster. CockroachDB {{ site.data.products.advanced }} clusters have a termination grace period that is slightly longer than 30 minutes, and this grace period is not configurable. -Client applications or application servers that connect to CockroachDB {{ site.data.products.advanced }} clusters should use connection pools that have a maximum lifetime that is shorter than the [`server.shutdown.connections.timeout`](#server-shutdown-connections-timeout) setting. +Client applications or application servers that connect to CockroachDB {{ site.data.products.advanced }} clusters may adjust the the [`server.shutdown.connections.timeout`](#server-shutdown-connections-timeout) setting and should make sure the connection pool maximum lifetime is shorter than that value, as per the guidance in the rest of this page. ## See also diff --git a/src/current/v25.2/node-shutdown.md b/src/current/v25.2/node-shutdown.md index db8e156f1e2..a6711f0f214 100644 --- a/src/current/v25.2/node-shutdown.md +++ b/src/current/v25.2/node-shutdown.md @@ -876,9 +876,9 @@ Cockroach Labs recommends that you: ## Decommissioning and draining on CockroachDB {{ site.data.products.advanced }} -Most of the guidance in this page is most relevant to manual deployments, although decommissioning and draining work the same way behind the scenes in a CockroachDB {{ site.data.products.advanced }} cluster. CockroachDB {{ site.data.products.advanced }} clusters have a `server.shutdown.connections.timeout` of 1800 seconds (30 minutes) and a termination grace period that is slightly longer. The termination grace period is not configurable, and adjusting `server.shutdown.connections.timeout` is generally not recommended. +Most of the guidance in this page is most relevant to manual deployments, although decommissioning and draining work the same way behind the scenes in a CockroachDB {{ site.data.products.advanced }} cluster. CockroachDB {{ site.data.products.advanced }} clusters have a termination grace period that is slightly longer than 30 minutes, and this grace period is not configurable. -Client applications or application servers that connect to CockroachDB {{ site.data.products.advanced }} clusters should use connection pools that have a maximum lifetime that is shorter than the [`server.shutdown.connections.timeout`](#server-shutdown-connections-timeout) setting. +Client applications or application servers that connect to CockroachDB {{ site.data.products.advanced }} clusters may adjust the the [`server.shutdown.connections.timeout`](#server-shutdown-connections-timeout) setting and should make sure the connection pool maximum lifetime is shorter than that value, as per the guidance in the rest of this page. ## See also From a8a7d7b0b91b45e40706c73db40cdc8ab62b8172 Mon Sep 17 00:00:00 2001 From: Ryan Kuo <8740013+taroface@users.noreply.github.com> Date: Tue, 6 May 2025 16:40:34 -0400 Subject: [PATCH 2/2] Apply suggestions from code review --- src/current/v23.2/node-shutdown.md | 4 ++-- src/current/v24.1/node-shutdown.md | 4 ++-- src/current/v24.2/node-shutdown.md | 4 ++-- src/current/v24.3/node-shutdown.md | 4 ++-- src/current/v25.1/node-shutdown.md | 4 ++-- src/current/v25.2/node-shutdown.md | 4 ++-- 6 files changed, 12 insertions(+), 12 deletions(-) diff --git a/src/current/v23.2/node-shutdown.md b/src/current/v23.2/node-shutdown.md index 4acf2f48b19..9d5b830c27f 100644 --- a/src/current/v23.2/node-shutdown.md +++ b/src/current/v23.2/node-shutdown.md @@ -876,9 +876,9 @@ Cockroach Labs recommends that you: ## Decommissioning and draining on CockroachDB {{ site.data.products.advanced }} -Most of the guidance in this page is most relevant to manual deployments, although decommissioning and draining work the same way behind the scenes in a CockroachDB {{ site.data.products.advanced }} cluster. CockroachDB {{ site.data.products.advanced }} clusters have a termination grace period that is slightly longer than 30 minutes, and this grace period is not configurable. +Most of the guidance in this page is most relevant to manual deployments, although decommissioning and draining work the same way behind the scenes in a CockroachDB {{ site.data.products.advanced }} cluster. CockroachDB {{ site.data.products.advanced }} clusters are deployed with the [server.shutdown.connections.timeout](#server-shutdown-connections-timeout) setting at its default value of `0s`, and have a termination grace period that is slightly longer than 30 minutes. This grace period is not configurable. -Client applications or application servers that connect to CockroachDB {{ site.data.products.advanced }} clusters may adjust the the [`server.shutdown.connections.timeout`](#server-shutdown-connections-timeout) setting and should make sure the connection pool maximum lifetime is shorter than that value, as per the guidance in the rest of this page. +You can adjust the [`server.shutdown.connections.timeout`](#server-shutdown-connections-timeout) setting for client applications or application servers that connect to CockroachDB {{ site.data.products.advanced }} clusters. Ensure that the connection pool maximum lifetime is shorter than that value, as per the [Cluster settings](#server-shutdown-connections-timeout) guidance. ## See also diff --git a/src/current/v24.1/node-shutdown.md b/src/current/v24.1/node-shutdown.md index 4acf2f48b19..9d5b830c27f 100644 --- a/src/current/v24.1/node-shutdown.md +++ b/src/current/v24.1/node-shutdown.md @@ -876,9 +876,9 @@ Cockroach Labs recommends that you: ## Decommissioning and draining on CockroachDB {{ site.data.products.advanced }} -Most of the guidance in this page is most relevant to manual deployments, although decommissioning and draining work the same way behind the scenes in a CockroachDB {{ site.data.products.advanced }} cluster. CockroachDB {{ site.data.products.advanced }} clusters have a termination grace period that is slightly longer than 30 minutes, and this grace period is not configurable. +Most of the guidance in this page is most relevant to manual deployments, although decommissioning and draining work the same way behind the scenes in a CockroachDB {{ site.data.products.advanced }} cluster. CockroachDB {{ site.data.products.advanced }} clusters are deployed with the [server.shutdown.connections.timeout](#server-shutdown-connections-timeout) setting at its default value of `0s`, and have a termination grace period that is slightly longer than 30 minutes. This grace period is not configurable. -Client applications or application servers that connect to CockroachDB {{ site.data.products.advanced }} clusters may adjust the the [`server.shutdown.connections.timeout`](#server-shutdown-connections-timeout) setting and should make sure the connection pool maximum lifetime is shorter than that value, as per the guidance in the rest of this page. +You can adjust the [`server.shutdown.connections.timeout`](#server-shutdown-connections-timeout) setting for client applications or application servers that connect to CockroachDB {{ site.data.products.advanced }} clusters. Ensure that the connection pool maximum lifetime is shorter than that value, as per the [Cluster settings](#server-shutdown-connections-timeout) guidance. ## See also diff --git a/src/current/v24.2/node-shutdown.md b/src/current/v24.2/node-shutdown.md index 4acf2f48b19..9d5b830c27f 100644 --- a/src/current/v24.2/node-shutdown.md +++ b/src/current/v24.2/node-shutdown.md @@ -876,9 +876,9 @@ Cockroach Labs recommends that you: ## Decommissioning and draining on CockroachDB {{ site.data.products.advanced }} -Most of the guidance in this page is most relevant to manual deployments, although decommissioning and draining work the same way behind the scenes in a CockroachDB {{ site.data.products.advanced }} cluster. CockroachDB {{ site.data.products.advanced }} clusters have a termination grace period that is slightly longer than 30 minutes, and this grace period is not configurable. +Most of the guidance in this page is most relevant to manual deployments, although decommissioning and draining work the same way behind the scenes in a CockroachDB {{ site.data.products.advanced }} cluster. CockroachDB {{ site.data.products.advanced }} clusters are deployed with the [server.shutdown.connections.timeout](#server-shutdown-connections-timeout) setting at its default value of `0s`, and have a termination grace period that is slightly longer than 30 minutes. This grace period is not configurable. -Client applications or application servers that connect to CockroachDB {{ site.data.products.advanced }} clusters may adjust the the [`server.shutdown.connections.timeout`](#server-shutdown-connections-timeout) setting and should make sure the connection pool maximum lifetime is shorter than that value, as per the guidance in the rest of this page. +You can adjust the [`server.shutdown.connections.timeout`](#server-shutdown-connections-timeout) setting for client applications or application servers that connect to CockroachDB {{ site.data.products.advanced }} clusters. Ensure that the connection pool maximum lifetime is shorter than that value, as per the [Cluster settings](#server-shutdown-connections-timeout) guidance. ## See also diff --git a/src/current/v24.3/node-shutdown.md b/src/current/v24.3/node-shutdown.md index 4acf2f48b19..9d5b830c27f 100644 --- a/src/current/v24.3/node-shutdown.md +++ b/src/current/v24.3/node-shutdown.md @@ -876,9 +876,9 @@ Cockroach Labs recommends that you: ## Decommissioning and draining on CockroachDB {{ site.data.products.advanced }} -Most of the guidance in this page is most relevant to manual deployments, although decommissioning and draining work the same way behind the scenes in a CockroachDB {{ site.data.products.advanced }} cluster. CockroachDB {{ site.data.products.advanced }} clusters have a termination grace period that is slightly longer than 30 minutes, and this grace period is not configurable. +Most of the guidance in this page is most relevant to manual deployments, although decommissioning and draining work the same way behind the scenes in a CockroachDB {{ site.data.products.advanced }} cluster. CockroachDB {{ site.data.products.advanced }} clusters are deployed with the [server.shutdown.connections.timeout](#server-shutdown-connections-timeout) setting at its default value of `0s`, and have a termination grace period that is slightly longer than 30 minutes. This grace period is not configurable. -Client applications or application servers that connect to CockroachDB {{ site.data.products.advanced }} clusters may adjust the the [`server.shutdown.connections.timeout`](#server-shutdown-connections-timeout) setting and should make sure the connection pool maximum lifetime is shorter than that value, as per the guidance in the rest of this page. +You can adjust the [`server.shutdown.connections.timeout`](#server-shutdown-connections-timeout) setting for client applications or application servers that connect to CockroachDB {{ site.data.products.advanced }} clusters. Ensure that the connection pool maximum lifetime is shorter than that value, as per the [Cluster settings](#server-shutdown-connections-timeout) guidance. ## See also diff --git a/src/current/v25.1/node-shutdown.md b/src/current/v25.1/node-shutdown.md index a6711f0f214..e95ca33f513 100644 --- a/src/current/v25.1/node-shutdown.md +++ b/src/current/v25.1/node-shutdown.md @@ -876,9 +876,9 @@ Cockroach Labs recommends that you: ## Decommissioning and draining on CockroachDB {{ site.data.products.advanced }} -Most of the guidance in this page is most relevant to manual deployments, although decommissioning and draining work the same way behind the scenes in a CockroachDB {{ site.data.products.advanced }} cluster. CockroachDB {{ site.data.products.advanced }} clusters have a termination grace period that is slightly longer than 30 minutes, and this grace period is not configurable. +Most of the guidance in this page is most relevant to manual deployments, although decommissioning and draining work the same way behind the scenes in a CockroachDB {{ site.data.products.advanced }} cluster. CockroachDB {{ site.data.products.advanced }} clusters are deployed with the [server.shutdown.connections.timeout](#server-shutdown-connections-timeout) setting at its default value of `0s`, and have a termination grace period that is slightly longer than 30 minutes. This grace period is not configurable. -Client applications or application servers that connect to CockroachDB {{ site.data.products.advanced }} clusters may adjust the the [`server.shutdown.connections.timeout`](#server-shutdown-connections-timeout) setting and should make sure the connection pool maximum lifetime is shorter than that value, as per the guidance in the rest of this page. +You can adjust the [`server.shutdown.connections.timeout`](#server-shutdown-connections-timeout) setting for client applications or application servers that connect to CockroachDB {{ site.data.products.advanced }} clusters. Ensure that the connection pool maximum lifetime is shorter than that value, as per the [Cluster settings](#server-shutdown-connections-timeout) guidance. ## See also diff --git a/src/current/v25.2/node-shutdown.md b/src/current/v25.2/node-shutdown.md index a6711f0f214..e95ca33f513 100644 --- a/src/current/v25.2/node-shutdown.md +++ b/src/current/v25.2/node-shutdown.md @@ -876,9 +876,9 @@ Cockroach Labs recommends that you: ## Decommissioning and draining on CockroachDB {{ site.data.products.advanced }} -Most of the guidance in this page is most relevant to manual deployments, although decommissioning and draining work the same way behind the scenes in a CockroachDB {{ site.data.products.advanced }} cluster. CockroachDB {{ site.data.products.advanced }} clusters have a termination grace period that is slightly longer than 30 minutes, and this grace period is not configurable. +Most of the guidance in this page is most relevant to manual deployments, although decommissioning and draining work the same way behind the scenes in a CockroachDB {{ site.data.products.advanced }} cluster. CockroachDB {{ site.data.products.advanced }} clusters are deployed with the [server.shutdown.connections.timeout](#server-shutdown-connections-timeout) setting at its default value of `0s`, and have a termination grace period that is slightly longer than 30 minutes. This grace period is not configurable. -Client applications or application servers that connect to CockroachDB {{ site.data.products.advanced }} clusters may adjust the the [`server.shutdown.connections.timeout`](#server-shutdown-connections-timeout) setting and should make sure the connection pool maximum lifetime is shorter than that value, as per the guidance in the rest of this page. +You can adjust the [`server.shutdown.connections.timeout`](#server-shutdown-connections-timeout) setting for client applications or application servers that connect to CockroachDB {{ site.data.products.advanced }} clusters. Ensure that the connection pool maximum lifetime is shorter than that value, as per the [Cluster settings](#server-shutdown-connections-timeout) guidance. ## See also