Add cloud-first release notes for v24.2.0

Fixes DOC-10587, REL-1220
cockroachdb · Aug 7, 2024 · 89e3fd8 · 89e3fd8
1 parent c74a328
commit 89e3fd8
Show file tree

Hide file tree

Showing 11 changed files with 589 additions and 2 deletions.
diff --git a/src/current/_config_cockroachdb.yml b/src/current/_config_cockroachdb.yml
@@ -3,5 +3,5 @@ current_cloud_version: v24.1
 destination: _site/docs
 homepage_title: CockroachDB Docs
 versions:
-  stable: v24.1
+  stable: v24.2
   dev: v24.2
diff --git a/src/current/_data/releases.yml b/src/current/_data/releases.yml
@@ -6509,4 +6509,38 @@
     docker_arm_experimental: false
     docker_arm_limited_access: false
   source: true
-  previous_release: v24.2.0-beta.3
+  previous_release: v24.2.0-beta.3
+
+- release_name: v24.2.0
+  major_version: v24.2
+  release_date: '2024-08-13'
+  release_type: Production
+  go_version: go1.22.5
+  sha: XXX
+  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
+    docker_arm: true
+    docker_arm_experimental: false
+    docker_arm_limited_access: false
+  source: true
+  previous_release: v24.2.0-rc.1
+  cloud_only: true
+  cloud_only_message_short: 'Available only for select CockroachDB Cloud clusters'
+  cloud_only_message: >
+      This version is currently available only for select
+      CockroachDB Cloud clusters. To request to upgrade
+      a CockroachDB self-hosted cluster to this version,
+      [contact support](https://support.cockroachlabs.com/hc/requests/new).
diff --git a/src/current/_includes/releases/v24.2/feature-highlights-change-data-capture.html b/src/current/_includes/releases/v24.2/feature-highlights-change-data-capture.html
@@ -0,0 +1,67 @@
+<table>
+ <thead>
+  <tr>
+   <th class="center-align" colspan="1" rowspan="2">Feature</th>
+   <th class="center-align" colspan="4" 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">Dedicated</th>
+   <th colspan="1" rowspan="1">Serverless</th>
+  </tr>
+ </thead>
+ <tbody>
+  <tr>
+   <td>
+    <p class="feature-summary">Improved performance for changefeeds at scale</p>
+    <p class="feature-description">
+     <a href="https://www.cockroachlabs.com/docs/v24.2/advanced-changefeed-configuration#mux-rangefeeds">Mux rangefeed</a> is a subsystem that improves the performance of <a href="https://www.cockroachlabs.com/docs/v24.2/create-and-configure-changefeeds#enable-rangefeeds">rangefeeds</a> with scale. In v24.2, Mux rangefeeds are enabled by default.</p>
+   </td>
+   <td>24.1</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>
+  <tr>
+   <td>
+    <p class="feature-summary">Emit changefeed messages to an Azure Event Hub</p>
+    <p class="feature-description">Changefeeds can emit messages to an <a href="https://www.cockroachlabs.com/docs/v24.2/changefeed-examples#create-a-changefeed-connected-to-an-azure-event-hubs-sink">Azure Event Hub</a>, which is compatible with Apache Kafka. You can use the Kafka changefeed and sink configuration options.</p>
+   </td>
+   <td>24.1</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>
+  <tr>
+   <td>
+    <p class="feature-summary">Google Cloud Pub/Sub sink for changefeeds is now generally available</p>
+    <p class="feature-description">The changefeed <a href="https://www.cockroachlabs.com/docs/v24.2/changefeed-sinks#google-cloud-pub-sub">sink for Google Cloud Pub/Sub</a> is GA.</p>
+   </td>
+   <td>24.1</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>
+  <tr>
+   <td>
+    <p class="feature-summary">Filter changefeed messages based on cluster, SQL session, or row-level TTL jobs</p>
+    <p class="feature-description">Use the <code>disable_changefeed_replication</code> session variable to prevent changefeeds from emitting messages for any changes during that session. Also in v24.2, you can enable the <code>ignore_disable_changefeed_replication</code> option to ignore the storage parameter or cluster setting that disables changefeed replication. These <a href="https://www.cockroachlabs.com/docs/v24.2/changefeed-messages#filtering-changefeed-messages">settings</a> can be useful to manage multiple changefeed use cases on the same table.</p>
+   </td>
+   <td>24.1</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>
+  <tr>
+   <td>
+    <p class="feature-summary">Set Kafka quotas per changefeed</p>
+    <p class="feature-description">For <a href="https://www.cockroachlabs.com/docs/v24.2/changefeed-sinks#kafka-sink-configuration">Kafka sinks</a>, implement a resource usage limit per changefeed by setting a client ID and quota in your Kafka server's configuration.</p>
+   </td>
+   <td>24.1</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/v24.2/feature-highlights-migrations.html b/src/current/_includes/releases/v24.2/feature-highlights-migrations.html
@@ -0,0 +1,28 @@
+<table>
+ <thead>
+  <tr>
+   <th class="center-align" colspan="1" rowspan="2">Feature</th>
+   <th class="center-align" colspan="4" 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">Dedicated</th>
+   <th colspan="1" rowspan="1">Serverless</th>
+  </tr>
+ </thead>
+ <tbody>
+  <tr>
+   <td>
+    <p class="feature-summary"></p>
+    <p class="feature-description">
+     <a href="https://www.cockroachlabs.com/docs/v24.2/molt-fetch.html">MOLT Fetch</a> is GA. MOLT Fetch automatically imports data from a PostgreSQL, MySQL, or CockroachDB source to a target CockroachDB database. If the fetch process encounters an error, data import can be continued from the point where it was interrupted. MOLT Fetch can be configured to replicate ongoing changes on the source database to CockroachDB following the initial data load.</p>
+   </td>
+   <td>All<sup>*</sup>
+   </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/v24.2/feature-highlights-observability.html b/src/current/_includes/releases/v24.2/feature-highlights-observability.html
@@ -0,0 +1,74 @@
+<table>
+ <thead>
+  <tr>
+   <th class="center-align" colspan="1" rowspan="2">Feature</th>
+   <th class="center-align" colspan="4" 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">Dedicated</th>
+   <th colspan="1" rowspan="1">Serverless</th>
+  </tr>
+ </thead>
+ <tbody>
+  <tr>
+   <td>
+    <p class="feature-summary">CockroachDB Dedicated supports a Prometheus-compatibile metric scrape endpoint.</p>
+    <p class="feature-description">The <a href="https://www.cockroachlabs.com/docs/cockroachcloud/export-metrics.html?filters=prometheus-metrics-export">Prometheus-compatibile metric scrape endpoint</a> for CockroachDB Dedicated is generally available.</p>
+   </td>
+   <td>All<sup>*</sup>
+   </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-no.html %}</td>
+  </tr>
+  <tr>
+   <td>
+    <p class="feature-summary">Export CockroachDB Dedicated metrics to Azure Monitor</p>
+    <p class="feature-description">CockroachDB Dedicated supports <a href="https://www.cockroachlabs.com/docs/cockroachcloud/export-metrics?filters=azure-monitor-metrics-export">exporting metrics to Azure Monitor</a> in limited access. Contact your Cockroach Labs account team for access.</p>
+   </td>
+   <td>All<sup>*</sup>
+   </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-no.html %}</td>
+  </tr>
+  <tr>
+   <td>
+    <p class="feature-summary">Export CockroachDB Dedicated logs to Azure Monitor</p>
+    <p class="feature-description">CockroachDB Dedicated supports <a href="https://www.cockroachlabs.com/docs/cockroachcloud/export-logs?filters=azure-monitor-log-export">exporting logs to Azure Monitor</a> in limited access. Contact your Cockroach Labs account team for access.</p>
+   </td>
+   <td>All<sup>*</sup>
+   </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-no.html %}</td>
+  </tr>
+ </tbody>
+</table>
+<table>
+ <thead>
+  <tr>
+   <th id="feature-detail-key" colspan="2">Feature detail key</th>
+  </tr>
+ </thead>
+ <tbody>
+  <tr>
+   <td>*</td>
+   <td>Features marked “All*” 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>**</td>
+   <td>Features marked “All**” were recently made available via migration 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 Dedicated, or CockroachDB Serverless.</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 Dedicated, or CockroachDB Serverless.</td>
+  </tr>
+ </tbody>
+</table>
diff --git a/src/current/_includes/releases/v24.2/feature-highlights-operations.html b/src/current/_includes/releases/v24.2/feature-highlights-operations.html
@@ -0,0 +1,52 @@
+<table>
+ <thead>
+  <tr>
+   <th class="center-align" colspan="1" rowspan="2">Feature</th>
+   <th class="center-align" colspan="4" 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">Dedicated</th>
+   <th colspan="1" rowspan="1">Serverless</th>
+  </tr>
+ </thead>
+ <tbody>
+  <tr>
+   <td>
+    <p class="feature-summary">New Regions for CockroachDB Dedicated</p>
+    <p class="feature-description">Cockroach Cloud is now available in additional Azure regions. This expansion enhances our global reach and offers more options for deploying resilient, distributed databases with low latency and high availability.</p>
+    <p class="feature-description">With these <a href="https://www.cockroachlabs.com/docs/releases/cloud#2024-04-18-general-updates">new regions</a>, you can now select a geographical location that best fits your needs, reducing data latency and ensuring compliance with regional data residency regulations. Deploying in a region close to your service or customers means improved performance and a better user experience.</p>
+   </td>
+   <td>All<sup>*</sup>
+   </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-no.html %}</td>
+  </tr>
+  <tr>
+   <td>
+    <p class="feature-summary">Organize Cloud clusters using Folders</p>
+    <p class="feature-description">
+     <a href="https://www.cockroachlabs.com/docs/cockroachcloud/folders">Folders</a> help users organize and manage access for Clusters by projects, teams or business units. This feature is now in public preview and available to all Cloud organizations. For additional details, refer to the <a href="https://www.cockroachlabs.com/docs/releases/cloud#may-12-2024">release note.</a>
+    </p>
+   </td>
+   <td>All<sup>*</sup>
+   </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>
+  <tr>
+   <td>
+    <p class="feature-summary">CockroachDB Cloud Terraform provider IAM enhancements</p>
+    <p class="feature-description">The <a href="https://registry.terraform.io/providers/cockroachdb/cockroach/latest">CockroachDB Cloud Terraform provider</a> has new resources for User Role Grant and Service Accounts, and a new data source for Folders. These new features improve customers’ ability to manage secure access to data, API, and infrastructure on CockroachDB Cloud.</p>
+   </td>
+   <td>All<sup>*</sup>
+   </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/v24.2/feature-highlights-performance.html b/src/current/_includes/releases/v24.2/feature-highlights-performance.html
@@ -0,0 +1,78 @@
+<table>
+ <thead>
+  <tr>
+   <th class="center-align" colspan="1" rowspan="2">Feature</th>
+   <th class="center-align" colspan="4" 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">Dedicated</th>
+   <th colspan="1" rowspan="1">Serverless</th>
+  </tr>
+ </thead>
+ <tbody>
+  <tr>
+   <td>
+    <p class="feature-summary">WAL (Write-ahead Logging) Failover</p>
+    <p class="feature-description">When a CockroachDB node is configured to run with multiple stores, you can mitigate some effects of disk stalls by configuring the node to <a href="https://www.cockroachlabs.com/docs/v24.2/cockroach-start#write-ahead-log-wal-failover">failover the store's write-ahead log (WAL)</a> to another store's data directory.</p>
+    <p class="feature-description">This feature is in preview.</p>
+   </td>
+   <td>24.1</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">Autocommit DDL</p>
+    <p class="feature-description">In 24.1 we have added the <code>autocommit_before_ddl</code>
+     <a href="https://www.cockroachlabs.com/docs/v24.2/session-variables#supported-variables">session
+variable</a>. When set to true, any schema change statement that is sent
+during an explicit transaction will cause the transaction to commit
+before executing the schema change.
+This setting can be used to improve compatibility with some tools that
+do not work well due to our limitations with schema changes in explicit
+transactions. It also can be used to use schema changes under <code>READ
+COMMITTED</code> more easily, without needing to teach the schema changer about
+<code>READ COMMITTED</code>.</p>
+   </td>
+   <td>24.1</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>
+  <tr>
+   <td>
+    <p class="feature-summary">Statistics for virtual computed columns</p>
+    <p class="feature-description">CockroachDB now collects statistics for <a href="https://www.cockroachlabs.com/docs/v24.2/computed-columns.html#virtual-computed-columns">virtual computed columns</a>, making it possible to optimize query plans for tables that have these columns. Customers will see better query performance for queries that involve virtual computed columns.</p>
+    <p class="feature-description">For more information, you can also view a <a href="https://youtu.be/5D9jUV8Vs_U">video demo</a>.</p>
+   </td>
+   <td>24.1</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>
+  <tr>
+   <td>
+    <p class="feature-summary">Write Amplification Improvements</p>
+    <p class="feature-description">A number of <a href="https://www.cockroachlabs.com/docs/v24.2/architecture/storage-layer">Pebble</a> improvements are now on by default, leading to a reduction in <a href="https://www.cockroachlabs.com/docs/v24.2/architecture/storage-layer#inverted-lsms">write amplification</a>. Of particular note, a vast majority of range snapshots previously ingested into L0 are now ingested directly into L6 in the <a href="https://www.cockroachlabs.com/docs/v24.2/architecture/storage-layer#log-structured-merge-trees">LSM</a>, reducing write and read amplification with positive effects to node stability and SQL performance.</p>
+   </td>
+   <td>24.1</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>
+  <tr>
+   <td>
+    <p class="feature-summary">Increased SLA for multi-region Dedicated clusters</p>
+    <p class="feature-description">CockroachDB Dedicated multi-region clusters now offer a <a href="https://www.cockroachlabs.com/cloud-terms-and-conditions/cockroachcloud-technical-service-level-agreement/">five-nines (99.999%) availability target</a>.</p>
+   </td>
+   <td>All<sup>*</sup>
+   </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-no.html %}</td>
+  </tr>
+ </tbody>
+</table>
diff --git a/src/current/_includes/releases/v24.2/feature-highlights-recovery.html b/src/current/_includes/releases/v24.2/feature-highlights-recovery.html
@@ -0,0 +1,27 @@
+<table>
+ <thead>
+  <tr>
+   <th class="center-align" colspan="1" rowspan="2">Feature</th>
+   <th class="center-align" colspan="4" 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">Dedicated</th>
+   <th colspan="1" rowspan="1">Serverless</th>
+  </tr>
+ </thead>
+ <tbody>
+  <tr>
+   <td>
+    <p class="feature-summary">Physical Cluster Replication is now generally available</p>
+    <p class="feature-description">
+     <a href="https://www.cockroachlabs.com/docs/v24.2/physical-cluster-replication-overview">Physical Cluster Replication</a> is an asynchonous replication feature that allows your cluster to recover from full-cluster failure with a low RPO and RTO. In 24.1, it is a GA feature, requiring an Enterprise license, and only available for self-hosted CockroachDB deployments. For more information, refer to the <a href="https://www.cockroachlabs.com/docs/v24.2/physical-cluster-replication-overview">Physical Cluster Replication overview</a> and a <a href="https://www.cockroachlabs.com/blog/232-physical-cluster-replication/">blog post about Physical Cluster Replication</a>.</p>
+   </td>
+   <td>24.1</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>