v25.1.0-alpha.1 Release Notes (#19214)

* Edited release notes * Add v25.1 version paths and files * Workaround for issue using master in cockroachdb/generated-diagrams --------- Co-authored-by: mikeCRL <[email protected]> Co-authored-by: Mike Lewis <[email protected]>
cockroachdb · Dec 19, 2024 · bf70b27 · bf70b27
1 parent 035d5cd
commit bf70b27
Show file tree

Hide file tree

Showing 1,683 changed files with 164,199 additions and 20 deletions.
diff --git a/src/current/_config_cockroachdb.yml b/src/current/_config_cockroachdb.yml
@@ -4,4 +4,4 @@ destination: _site/docs
 homepage_title: CockroachDB Docs
 versions:
   stable: v24.3
-  dev: v24.3
+  dev: v25.1
diff --git a/src/current/_data/releases.yml b/src/current/_data/releases.yml
@@ -7595,4 +7595,30 @@
     docker_arm_experimental: false
     docker_arm_limited_access: false
   source: true
-  previous_release: v24.3.0
+  previous_release: v24.3.0
+
+- release_name: v25.1.0-alpha.1
+  major_version: v25.1
+  release_date: '2024-12-19'
+  release_type: Testing
+  go_version: go1.22.8
+  sha: d18eb683b2759fd8814dacf0baa913f596074a17
+  has_sql_only: true
+  has_sha256sum: true
+  mac:
+    mac_arm: true
+    mac_arm_experimental: true
+    mac_arm_limited_access: false
+  windows: true
+  linux:
+    linux_arm: true
+    linux_arm_experimental: false
+    linux_arm_limited_access: false
+    linux_intel_fips: true
+    linux_arm_fips: false
+  docker:
+    docker_image: cockroachdb/cockroach-unstable
+    docker_arm: true
+    docker_arm_experimental: false
+    docker_arm_limited_access: false
+  source: true
diff --git a/src/current/_data/versions.csv b/src/current/_data/versions.csv
@@ -1,18 +1,19 @@
-major_version,release_date,maint_supp_exp_date,asst_supp_exp_date,last_ga_patch,initial_lts_patch,initial_lts_release_date,lts_maint_supp_exp_date,lts_asst_supp_exp_date,previous_version,crdb_branch_name
-v1.0,2017-05-10,2018-05-10,2018-11-10,N/A,N/A,N/A,N/A,N/A,N/A,release-1.0
-v1.1,2017-10-12,2018-10-12,2019-04-12,N/A,N/A,N/A,N/A,N/A,v1.0,release-1.1
-v2.0,2018-04-04,2019-04-04,2019-10-04,N/A,N/A,N/A,N/A,N/A,v1.1,release-2.0
-v2.1,2018-10-30,2019-10-30,2020-04-30,N/A,N/A,N/A,N/A,N/A,v2.0,release-2.1
-v19.1,2019-04-30,2020-04-30,2020-10-30,N/A,N/A,N/A,N/A,N/A,v2.1,release-19.1
-v19.2,2019-11-12,2020-11-12,2021-05-12,N/A,N/A,N/A,N/A,N/A,v19.1,release-19.2
-v20.1,2020-05-12,2021-05-12,2021-11-12,N/A,N/A,N/A,N/A,N/A,v19.2,release-20.1
-v20.2,2020-11-10,2021-11-10,2022-05-10,N/A,N/A,N/A,N/A,N/A,v20.1,release-20.2
-v21.1,2021-05-18,2022-05-18,2022-11-18,N/A,N/A,N/A,N/A,N/A,v20.2,release-21.1
-v21.2,2021-11-16,2022-11-16,2023-05-16,N/A,N/A,N/A,N/A,N/A,v21.1,release-21.2
-v22.1,2022-05-24,2023-05-24,2023-11-24,N/A,N/A,N/A,N/A,N/A,v21.2,release-22.1
-v22.2,2022-12-05,2023-12-05,2024-06-05,N/A,N/A,N/A,N/A,N/A,v22.1,release-22.2
-v23.1,2023-05-15,2024-05-15,2024-11-15,23.1.11,23.1.12,2023-11-13,2024-11-13,2025-11-13,v22.2,release-23.1
-v23.2,2024-02-05,2025-02-05,2025-08-05,23.2.6,23.2.7,2024-07-08,2025-07-08,2026-07-08,v23.1,release-23.2
-v24.1,2024-05-20,2025-05-20,2025-11-20,24.1.5,24.1.6,2024-10-21,2025-10-21,2026-10-21,v23.2,release-24.1
-v24.2,2024-08-12,2025-02-12,N/A,N/A,N/A,N/A,N/A,N/A,v24.1,release-24.2
-v24.3,2024-11-18,2025-11-18,2026-05-18,N/A,N/A,N/A,N/A,N/A,v24.2,release-24.3
+major_version,release_date,maint_supp_exp_date,asst_supp_exp_date,last_ga_patch,initial_lts_patch,initial_lts_release_date,lts_maint_supp_exp_date,lts_asst_supp_exp_date,previous_version,crdb_branch_name
+v1.0,2017-05-10,2018-05-10,2018-11-10,N/A,N/A,N/A,N/A,N/A,N/A,release-1.0
+v1.1,2017-10-12,2018-10-12,2019-04-12,N/A,N/A,N/A,N/A,N/A,v1.0,release-1.1
+v2.0,2018-04-04,2019-04-04,2019-10-04,N/A,N/A,N/A,N/A,N/A,v1.1,release-2.0
+v2.1,2018-10-30,2019-10-30,2020-04-30,N/A,N/A,N/A,N/A,N/A,v2.0,release-2.1
+v19.1,2019-04-30,2020-04-30,2020-10-30,N/A,N/A,N/A,N/A,N/A,v2.1,release-19.1
+v19.2,2019-11-12,2020-11-12,2021-05-12,N/A,N/A,N/A,N/A,N/A,v19.1,release-19.2
+v20.1,2020-05-12,2021-05-12,2021-11-12,N/A,N/A,N/A,N/A,N/A,v19.2,release-20.1
+v20.2,2020-11-10,2021-11-10,2022-05-10,N/A,N/A,N/A,N/A,N/A,v20.1,release-20.2
+v21.1,2021-05-18,2022-05-18,2022-11-18,N/A,N/A,N/A,N/A,N/A,v20.2,release-21.1
+v21.2,2021-11-16,2022-11-16,2023-05-16,N/A,N/A,N/A,N/A,N/A,v21.1,release-21.2
+v22.1,2022-05-24,2023-05-24,2023-11-24,N/A,N/A,N/A,N/A,N/A,v21.2,release-22.1
+v22.2,2022-12-05,2023-12-05,2024-06-05,N/A,N/A,N/A,N/A,N/A,v22.1,release-22.2
+v23.1,2023-05-15,2024-05-15,2024-11-15,23.1.11,23.1.12,2023-11-13,2024-11-13,2025-11-13,v22.2,release-23.1
+v23.2,2024-02-05,2025-02-05,2025-08-05,23.2.6,23.2.7,2024-07-08,2025-07-08,2026-07-08,v23.1,release-23.2
+v24.1,2024-05-20,2025-05-20,2025-11-20,24.1.5,24.1.6,2024-10-21,2025-10-21,2026-10-21,v23.2,release-24.1
+v24.2,2024-08-12,2025-02-12,N/A,N/A,N/A,N/A,N/A,N/A,v24.1,release-24.2
+v24.3,2024-11-18,2025-11-18,2026-05-18,N/A,N/A,N/A,N/A,N/A,v24.2,release-24.3
+v25.1,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,v24.2,release-24.3
diff --git a/src/current/_includes/releases/v25.1/backward-incompatible.md b/src/current/_includes/releases/v25.1/backward-incompatible.md
@@ -0,0 +1,10 @@
+Before [upgrading to CockroachDB v24.3]({% link v24.3/upgrade-cockroach-version.md %}), be sure to review the following backward-incompatible changes, as well as [key cluster setting changes](#v24-3-0-cluster-settings), and adjust your deployment as necessary.
+
+If you plan to upgrade to v24.3 directly from v24.1 and skip v24.2, be sure to also review the [v24.2 release notes]({% link releases/v24.2.md %}) for backward-incompatible changes from v24.1.
+
+- Upgrading to v24.3 is blocked if no [license]({% link v24.3/licensing-faqs.md %}) is installed, or if a trial/free license is installed with telemetry disabled. [#130576][#130576]
+
+[#130576]: https://github.com/cockroachdb/cockroach/pull/130576
+
+{% comment %}Remove this anchor when it is added to the v24.3.0 GA release notes{% endcomment %}
+<a id="v24-3-0-cluster-settings"></a>
diff --git a/src/current/_includes/releases/v25.1/deprecations.md b/src/current/_includes/releases/v25.1/deprecations.md
@@ -0,0 +1,5 @@
+The following deprecations are announced in v24.3. If you plan to upgrade to v24.3 directly from v24.1 and skip v24.2, be sure to also review the [v24.2 release notes]({% link releases/v24.2.md %}) for deprecations.
+
+- The session variable [`enforce_home_region_follower_reads_enabled`]({% link v24.3/session-variables.md %}#enforce-home-region-follower-reads-enabled) is now deprecated, and will be removed in a future release. The related session variable [`enforce_home_region`]({% link v24.3/session-variables.md %}#enforce-home-region) is **not** deprecated. [#129024][#129024]
+
+[#129024]: https://github.com/cockroachdb/cockroach/pull/129024
diff --git a/src/current/_includes/releases/v25.1/feature-detail-key.html b/src/current/_includes/releases/v25.1/feature-detail-key.html
@@ -0,0 +1,25 @@
+<table>
+ <thead>
+  <tr>
+   <th id="feature-detail-key" colspan="2">Feature detail key</th>
+  </tr>
+ </thead>
+ <tbody>
+  <tr>
+   <td>&starf;</td>
+   <td>Features marked "All&starf;" were recently made available in the CockroachDB Cloud platform. They are available for all supported versions of CockroachDB, under the deployment methods specified in their row under Availability.</td>
+  </tr>
+  <tr>
+   <td>&starf;&starf;</td>
+   <td>Features marked "All&starf;&starf;" were recently made available via tools maintained outside of the CockroachDB binary. They are available to use with all supported versions of CockroachDB, under the deployment methods specified in their row under Availability.</td>
+  </tr>
+  <tr>
+   <td>{% include icon-yes.html %}</td>
+   <td>Feature is available for this deployment method of CockroachDB as specified in the icon’s column: CockroachDB Self-hosted, CockroachDB Advanced, CockroachDB Standard, or CockroachDB Basic.</td>
+  </tr>
+  <tr>
+   <td>{% include icon-no.html %}</td>
+   <td>Feature is not available for this deployment method of CockroachDB as specified in the icon’s column: CockroachDB Self-hosted, CockroachDB Advanced, CockroachDB Standard, or CockroachDB Basic.</td>
+  </tr>
+ </tbody>
+</table>
diff --git a/src/current/_includes/releases/v25.1/feature-highlights-change-data-capture.html b/src/current/_includes/releases/v25.1/feature-highlights-change-data-capture.html
@@ -0,0 +1,30 @@
+<table>
+ <thead>
+  <tr>
+   <th class="center-align" colspan="1" rowspan="2">Feature</th>
+   <th class="center-align" colspan="5" rowspan="1">Availability</th>
+  </tr>
+  <tr>
+    <th colspan="1" rowspan="1">Ver.</th>
+    <th colspan="1" rowspan="1" style="white-space: nowrap;">Self-hosted</th>
+    <th colspan="1" rowspan="1">Advanced</th>
+    <th colspan="1" rowspan="1">Standard</th>
+    <th colspan="1" rowspan="1">Basic</th>
+   </tr>
+ </thead>
+ <tbody>
+  <tr>
+   <td>
+    <p class="feature-summary">IAM authentication support for Amazon MSK Serverless</p>
+    <p class="feature-description">
+     <a href="https://www.cockroachlabs.com/docs/v24.3/change-data-capture-overview.html">Changefeeds</a> support IAM Authentication with Amazon MSK Serverless clusters (Amazon Managed Streaming for Apache Kafka). This feature is generally available.
+    </p>
+   </td>
+   <td>24.3</td>
+   <td class="icon-center">{% include icon-yes.html %}</td>
+   <td class="icon-center">{% include icon-yes.html %}</td>
+   <td class="icon-center">{% include icon-yes.html %}</td>
+   <td class="icon-center">{% include icon-yes.html %}</td>
+  </tr>
+ </tbody>
+</table>
diff --git a/src/current/_includes/releases/v25.1/feature-highlights-cloud.html b/src/current/_includes/releases/v25.1/feature-highlights-cloud.html
@@ -0,0 +1,32 @@
+<table>
+ <thead>
+  <tr>
+   <th class="center-align" colspan="1" rowspan="2">Feature</th>
+   <th class="center-align" colspan="5" rowspan="1">Availability</th>
+  </tr>
+  <tr>
+   <th colspan="1" rowspan="1">Ver.</th>
+   <th colspan="1" rowspan="1" style="white-space: nowrap;">Self-hosted</th>
+   <th colspan="1" rowspan="1">Advanced</th>
+   <th colspan="1" rowspan="1">Standard</th>
+   <th colspan="1" rowspan="1">Basic</th>
+  </tr>
+ </thead>
+ <tbody>
+  <tr>
+   <td>
+    <p class="feature-summary">Free trial on CockroachDB Cloud</p>
+    <p class="feature-description">
+      New CockroachDB Cloud organizations can benefit from a 30-day free trial that enables you to consume up to $400 worth of free credits. Get started by signing up for <a href="https://cockroachlabs.cloud/signup">CockroachDB Cloud</a>
+    </p>
+   </td>
+   <td>All
+    <sup>&starf;</sup>
+   </td>
+   <td class="icon-center">{% include icon-no.html %}</td>
+   <td class="icon-center">{% include icon-no.html %}</td>
+   <td class="icon-center">{% include icon-yes.html %}</td>
+   <td class="icon-center">{% include icon-yes.html %}</td>
+  </tr>
+ </tbody>
+</table>
diff --git a/src/current/_includes/releases/v25.1/feature-highlights-disaster-recovery.html b/src/current/_includes/releases/v25.1/feature-highlights-disaster-recovery.html
@@ -0,0 +1,49 @@
+<table>
+ <thead>
+  <tr>
+   <th class="center-align" colspan="1" rowspan="2">Feature</th>
+   <th class="center-align" colspan="5" rowspan="1">Availability</th>
+  </tr>
+  <tr>
+    <th colspan="1" rowspan="1">Ver.</th>
+    <th colspan="1" rowspan="1" style="white-space: nowrap;">Self-hosted</th>
+    <th colspan="1" rowspan="1">Advanced</th>
+    <th colspan="1" rowspan="1">Standard</th>
+    <th colspan="1" rowspan="1">Basic</th>
+   </tr>
+ </thead>
+ <tbody>
+  <tr>
+   <td>
+    <p class="feature-summary">SELECT now supported on PCR standby clusters</p>
+    <p class="feature-description">
+      <a href="https://cockroachlabs.com/docs/v24.3/physical-cluster-replication-overview.html">Physical cluster replication (PCR)</a> has been enhanced to support <code>SELECT</code> operations on standby clusters. This enables you to scale read performance by running, for example, non-critical workloads on standby clusters.  
+    </p>
+   </td>
+   <td>24.3</td>
+   <td class="icon-center">{% include icon-yes.html %}</td>
+   <td class="icon-center">{% include icon-no.html %}</td>
+   <td class="icon-center">{% include icon-no.html %}</td>
+   <td class="icon-center">{% include icon-no.html %}</td>
+</tr>
+  <tr>
+    <td>
+     <p class="feature-summary">Logical Data Replication in Preview</p>
+     <p class="feature-description">
+      <a href="https://cockroachlabs.com/docs/v24.3/logical-data-replication-overview.html">Logical data replication (LDR)</a> continuously replicates tables between an active source CockroachDB cluster to an active destination CockroachDB cluster. Both source and destination can receive application reads and writes, and participate in bidirectional LDR replication for eventual consistency in the replicating tables.
+      </p>
+      <p class="feature-description">
+      The active-active setup between clusters can provide protection against cluster, datacenter, or region failure while still achieving single-region low latency reads and writes in the individual CockroachDB clusters. Each cluster in an LDR job still benefits individually from multi-active availability with CockroachDB's built-in Raft replication providing data consistency across nodes, zones, and regions. 
+     </p>
+     <p class="feature-description">
+      This feature is in Preview.
+     </p>
+    </td>
+    <td>24.3</td>
+    <td class="icon-center">{% include icon-yes.html %}</td>
+    <td class="icon-center">{% include icon-no.html %}</td>
+    <td class="icon-center">{% include icon-no.html %}</td>
+    <td class="icon-center">{% include icon-no.html %}</td>
+   </tr>
+ </tbody>
+</table>
diff --git a/src/current/_includes/releases/v25.1/feature-highlights-licensing.html b/src/current/_includes/releases/v25.1/feature-highlights-licensing.html
@@ -0,0 +1,55 @@
+<table>
+ <thead>
+  <tr>
+   <th class="center-align" colspan="1" rowspan="2">Feature</th>
+   <th class="center-align" colspan="5" rowspan="1">Availability</th>
+  </tr>
+  <tr>
+    <th colspan="1" rowspan="1">Ver.</th>
+    <th colspan="1" rowspan="1" style="white-space: nowrap;">Self-hosted</th>
+    <th colspan="1" rowspan="1">Advanced</th>
+    <th colspan="1" rowspan="1">Standard</th>
+    <th colspan="1" rowspan="1">Basic</th>
+   </tr>
+ </thead>
+ <tbody>
+  <tr>
+   <td>
+    <p class="feature-summary">Licensing changes</p>
+    <p class="feature-description">
+      All versions of CockroachDB starting from the release date of 24.3.0 onward, including patch fixes for versions 23.1-24.2, are made available under the <a href="https://www.cockroachlabs.com/cockroachdb-software-license">CockroachDB Software License</a>. 
+    </p>
+    <p class="feature-description">
+      See below for a summary of license options for self-hosted deployments. All Cloud deployments automatically have a valid Enterprise license.
+    </p>
+      <ul>
+        <li>
+          <p class="feature-description">
+          <u>Enterprise</u>: This paid license allows usage of all CockroachDB features in accordance with the terms specified in the <a href="https://www.cockroachlabs.com/cockroachdb-software-license">CockroachDB Software License</a>. 
+          </p>
+        </li>
+        <li>
+          <p class="feature-description">
+          <u>Enterprise Free</u>: Same functionality as Enterprise, but free of charge for businesses with less than $10M in annual revenue. Clusters will be throttled after 7 days without sending telemetry. License must be renewed annually. 
+          </p>
+        </li>
+        <li>
+          <p class="feature-description">
+          <u>Enterprise Trial</u>: A 30 day self-service trial license. Telemetry is required during the trial. Clusters will be throttled after 7 days without sending telemetry. Telemetry can be disabled once the cluster is upgraded to a paid Enterprise license.
+          </p>
+        </li>
+      </ul>
+      <p class="feature-description">
+        See the <a href="http://cockroachlabs.com/docs/stable/licensing-faqs">Licensing FAQs page</a> for more details on the CockroachDB Software License and license options.
+
+        You may acquire CockroachDB licenses through the <a href="https://cockroachlabs.cloud/signup?experience=enterprise">CockroachDB Cloud console</a>.
+      </p>
+   </td>
+   <td>24.3</td>
+   <td class="icon-center">{% include icon-yes.html %}</td>
+   <td class="icon-center">{% include icon-yes.html %}</td>
+   <td class="icon-center">{% include icon-yes.html %}</td>
+   <td class="icon-center">{% include icon-yes.html %}</td>
+  </tr>
+ </tbody>
+</table>
diff --git a/src/current/_includes/releases/v25.1/feature-highlights-observability.html b/src/current/_includes/releases/v25.1/feature-highlights-observability.html
@@ -0,0 +1,94 @@
+<table>
+ <thead>
+  <tr>
+   <th class="center-align" colspan="1" rowspan="2">Feature</th>
+   <th class="center-align" colspan="5" rowspan="1">Availability</th>
+  </tr>
+  <tr>
+    <th colspan="1" rowspan="1">Ver.</th>
+    <th colspan="1" rowspan="1" style="white-space: nowrap;">Self-hosted</th>
+    <th colspan="1" rowspan="1">Advanced</th>
+    <th colspan="1" rowspan="1">Standard</th>
+    <th colspan="1" rowspan="1">Basic</th>
+   </tr>
+ </thead>
+ <tbody>
+  <tr>
+   <td>
+    <p class="feature-summary">Improved usability for the DB Console Metrics page</p>
+    <p class="feature-description">
+      Introduced several enhancements to the DB Console Metrics page to support large scale clusters, including the following:
+      <ul>
+        <li>
+          <p class="feature-description">
+          Added on-hover cursor support that will display the closest time-series value and highlight the node in the legend to allow users to quickly pinpoint outliers.
+          </p>
+        </li>
+        <li>
+          <p class="feature-description">
+          Improved legend visibillity and made legends scrollable to improve usability and reduce vertical scrolling.
+          </p>
+        </li>
+      </ul>
+    </p>
+   </td>
+   <td>24.3</td>
+   <td class="icon-center">{% include icon-yes.html %}</td>
+   <td class="icon-center">{% include icon-yes.html %}</td>
+   <td class="icon-center">{% include icon-no.html %}</td>
+   <td class="icon-center">{% include icon-no.html %}</td>
+  </tr>
+  <tr>
+    <td>
+     <p class="feature-summary">Improved peformance and scalability for the DB Console Databases pages</p>
+     <p class="feature-description">
+      CockroachDB now caches the data that is surfaced in the Databases page. This enhances the performance and scalability of the Databases page for large-scale clusters. 
+     </p>
+    </td>
+    <td>24.3</td>
+    <td class="icon-center">{% include icon-yes.html %}</td>
+    <td class="icon-center">{% include icon-yes.html %}</td>
+    <td class="icon-center">{% include icon-no.html %}</td>
+    <td class="icon-center">{% include icon-no.html %}</td>
+   </tr>
+   <tr>
+    <td>
+      <p class="feature-summary">Improved admission control observability</p> 
+    <p class="feature-description">
+      The DB Console Overload page now provides additional metrics to help identify overload in the system. Graphs and metrics on this page provide quick signals on which resource is exhausted and whether it is due to background activity or foreground. 
+      </p>
+      <p class="feature-description">
+      There are now 4 graphs for admission queue delay:
+      </p>
+      <ol>
+        <li>
+          <p class="feature-description">
+            Foreground (regular) CPU work
+          </p>
+        </li>
+        <li>
+          <p class="feature-description">
+            Store (IO) work
+          </p>
+        </li>
+        <li>
+          <p class="feature-description">
+            Background (elastic) CPU work
+          </p>
+        </li>
+        <li>
+          <p class="feature-description">
+            Replication admission control (store overload on replicas)
+          </p>
+        </li>
+      </ol>
+    </p>
+    </td>
+    <td>24.3</td>
+    <td class="icon-center">{% include icon-yes.html %}</td>
+    <td class="icon-center">{% include icon-yes.html %}</td>
+    <td class="icon-center">{% include icon-no.html %}</td>
+    <td class="icon-center">{% include icon-no.html %}</td>
+   </tr>
+ </tbody>
+</table>