diff --git a/src/current/_config_cockroachdb.yml b/src/current/_config_cockroachdb.yml index 06587c7afed..c2533e5a626 100644 --- 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 index 97d5a535500..98da58b1198 100644 --- 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 \ No newline at end of file + 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 new file mode 100644 index 00000000000..de9ffe81ab7 --- /dev/null +++ b/src/current/_includes/releases/v24.2/feature-highlights-change-data-capture.html @@ -0,0 +1,67 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FeatureAvailability
Ver.Self-HostedDedicatedServerless
+

Improved performance for changefeeds at scale

+

+ Mux rangefeed is a subsystem that improves the performance of rangefeeds with scale. In v24.2, Mux rangefeeds are enabled by default.

+ 		24.1{% include icon-yes.html %}{% include icon-yes.html %}{% include icon-yes.html %}
+

Emit changefeed messages to an Azure Event Hub

+

Changefeeds can emit messages to an Azure Event Hub, which is compatible with Apache Kafka. You can use the Kafka changefeed and sink configuration options.

+ 		24.1{% include icon-yes.html %}{% include icon-yes.html %}{% include icon-yes.html %}
+

Google Cloud Pub/Sub sink for changefeeds is now generally available

+

The changefeed sink for Google Cloud Pub/Sub is GA.

+ 		24.1{% include icon-yes.html %}{% include icon-yes.html %}{% include icon-yes.html %}
+

Filter changefeed messages based on cluster, SQL session, or row-level TTL jobs

+

Use the disable_changefeed_replication session variable to prevent changefeeds from emitting messages for any changes during that session. Also in v24.2, you can enable the ignore_disable_changefeed_replication option to ignore the storage parameter or cluster setting that disables changefeed replication. These settings can be useful to manage multiple changefeed use cases on the same table.

+ 		24.1{% include icon-yes.html %}{% include icon-yes.html %}{% include icon-yes.html %}
+

Set Kafka quotas per changefeed

+

For Kafka sinks, implement a resource usage limit per changefeed by setting a client ID and quota in your Kafka server's configuration.

+ 		24.1{% include icon-yes.html %}{% include icon-yes.html %}{% include icon-yes.html %}
diff --git a/src/current/_includes/releases/v24.2/feature-highlights-migrations.html b/src/current/_includes/releases/v24.2/feature-highlights-migrations.html new file mode 100644 index 00000000000..e905956a2f6 --- /dev/null +++ b/src/current/_includes/releases/v24.2/feature-highlights-migrations.html @@ -0,0 +1,28 @@ + + + + + + + + + + + + + + + + + + + + + + +
FeatureAvailability
Ver.Self-HostedDedicatedServerless
+

+

+ MOLT Fetch 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.

+ 		All* + {% include icon-yes.html %}{% include icon-yes.html %}{% include icon-yes.html %}
diff --git a/src/current/_includes/releases/v24.2/feature-highlights-observability.html b/src/current/_includes/releases/v24.2/feature-highlights-observability.html new file mode 100644 index 00000000000..ea20de28183 --- /dev/null +++ b/src/current/_includes/releases/v24.2/feature-highlights-observability.html @@ -0,0 +1,74 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FeatureAvailability
Ver.Self-HostedDedicatedServerless
+

CockroachDB Dedicated supports a Prometheus-compatibile metric scrape endpoint.

+

The Prometheus-compatibile metric scrape endpoint for CockroachDB Dedicated is generally available.

+ 		All* + {% include icon-no.html %}{% include icon-yes.html %}{% include icon-no.html %}
+

Export CockroachDB Dedicated metrics to Azure Monitor

+

CockroachDB Dedicated supports exporting metrics to Azure Monitor in limited access. Contact your Cockroach Labs account team for access.

+ 		All* + {% include icon-no.html %}{% include icon-yes.html %}{% include icon-no.html %}
+

Export CockroachDB Dedicated logs to Azure Monitor

+

CockroachDB Dedicated supports exporting logs to Azure Monitor in limited access. Contact your Cockroach Labs account team for access.

+ 		All* + {% include icon-no.html %}{% include icon-yes.html %}{% include icon-no.html %}
+ + + + + + + + + + + + + + + + + + + + + + + + +
Feature detail key
*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.
**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.
{% include icon-yes.html %}Feature is available for this deployment method of CockroachDB as specified in the icon’s column: CockroachDB Self-Hosted, CockroachDB Dedicated, or CockroachDB Serverless.
{% include icon-no.html %}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.
diff --git a/src/current/_includes/releases/v24.2/feature-highlights-operations.html b/src/current/_includes/releases/v24.2/feature-highlights-operations.html new file mode 100644 index 00000000000..cc386a58a6f --- /dev/null +++ b/src/current/_includes/releases/v24.2/feature-highlights-operations.html @@ -0,0 +1,52 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FeatureAvailability
Ver.Self-HostedDedicatedServerless
+

New Regions for CockroachDB Dedicated

+

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.

+

With these new regions, 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.

+ 		All* + {% include icon-no.html %}{% include icon-yes.html %}{% include icon-no.html %}
+

Organize Cloud clusters using Folders

+

+ Folders 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 release note. +

+ 		All* + {% include icon-no.html %}{% include icon-yes.html %}{% include icon-yes.html %}
+

CockroachDB Cloud Terraform provider IAM enhancements

+

The CockroachDB Cloud Terraform provider 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.

+ 		All* + {% include icon-no.html %}{% include icon-yes.html %}{% include icon-yes.html %}
diff --git a/src/current/_includes/releases/v24.2/feature-highlights-performance.html b/src/current/_includes/releases/v24.2/feature-highlights-performance.html new file mode 100644 index 00000000000..f07e5a7495c --- /dev/null +++ b/src/current/_includes/releases/v24.2/feature-highlights-performance.html @@ -0,0 +1,78 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FeatureAvailability
Ver.Self-HostedDedicatedServerless
+

WAL (Write-ahead Logging) Failover

+

When a CockroachDB node is configured to run with multiple stores, you can mitigate some effects of disk stalls by configuring the node to failover the store's write-ahead log (WAL) to another store's data directory.

+

This feature is in preview.

+ 		24.1{% include icon-yes.html %}{% include icon-no.html %}{% include icon-no.html %}
+

Autocommit DDL

+

In 24.1 we have added the autocommit_before_ddl + session +variable. 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 READ +COMMITTED more easily, without needing to teach the schema changer about +READ COMMITTED.

+ 		24.1{% include icon-yes.html %}{% include icon-yes.html %}{% include icon-yes.html %}
+

Statistics for virtual computed columns

+

CockroachDB now collects statistics for virtual computed columns, 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.

+

For more information, you can also view a video demo.

+ 		24.1{% include icon-yes.html %}{% include icon-yes.html %}{% include icon-yes.html %}
+

Write Amplification Improvements

+

A number of Pebble improvements are now on by default, leading to a reduction in write amplification. Of particular note, a vast majority of range snapshots previously ingested into L0 are now ingested directly into L6 in the LSM, reducing write and read amplification with positive effects to node stability and SQL performance.

+ 		24.1{% include icon-yes.html %}{% include icon-yes.html %}{% include icon-yes.html %}
+

Increased SLA for multi-region Dedicated clusters

+

CockroachDB Dedicated multi-region clusters now offer a five-nines (99.999%) availability target.

+ 		All* + {% include icon-no.html %}{% include icon-yes.html %}{% include icon-no.html %}
diff --git a/src/current/_includes/releases/v24.2/feature-highlights-recovery.html b/src/current/_includes/releases/v24.2/feature-highlights-recovery.html new file mode 100644 index 00000000000..ed3e5facebf --- /dev/null +++ b/src/current/_includes/releases/v24.2/feature-highlights-recovery.html @@ -0,0 +1,27 @@ + + + + + + + + + + + + + + + + + + + + + + +
FeatureAvailability
Ver.Self-HostedDedicatedServerless
+

Physical Cluster Replication is now generally available

+

+ Physical Cluster Replication 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 Physical Cluster Replication overview and a blog post about Physical Cluster Replication.

+ 		24.1{% include icon-yes.html %}{% include icon-no.html %}{% include icon-no.html %}
diff --git a/src/current/_includes/releases/v24.2/feature-highlights-security.html b/src/current/_includes/releases/v24.2/feature-highlights-security.html new file mode 100644 index 00000000000..50220dc8d49 --- /dev/null +++ b/src/current/_includes/releases/v24.2/feature-highlights-security.html @@ -0,0 +1,45 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FeatureAvailability
Ver.Self-HostedDedicatedServerless
+

Private connectivity in CockroachDB Dedicated with Google Cloud Private Service Connect

+

+ Private connectivity using Private Service Connect is now available in preview for CockroachDB Dedicated clusters on GCP. For more information, refer to Establish Private Connectivity and a video about how to set it up.

+ 		All* + {% include icon-no.html %}{% include icon-yes.html %}{% include icon-no.html %}
+

Support for matching against SUBJECT

+

When using certificate based authentication, CockroachDB now supports mapping of SQL user roles to values in the Subject field of the X.509 certificate used for TLS authentication.

+

Subject mapping is useful if: +

    +
  • You run your own Certificate Authority (CA) infrastructure.
    • +
  • You need to use your existing CA infrastructure to manage SQL user authentication.
    • +
  • You need to use the same CA for multiple CockroachDB clusters.
    • +
+

+ 		24.1{% include icon-yes.html %}{% include icon-yes.html %}{% include icon-no.html %}
diff --git a/src/current/_includes/releases/v24.2/feature-highlights-sql.html b/src/current/_includes/releases/v24.2/feature-highlights-sql.html new file mode 100644 index 00000000000..02a91393e51 --- /dev/null +++ b/src/current/_includes/releases/v24.2/feature-highlights-sql.html @@ -0,0 +1,74 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FeatureAvailability
Ver.Self-HostedDedicatedServerless
+

Stored Procedures and UDF Improvements

+

Support for PL/pgSQL, user-defined functions, and stored procedures is now expanded: +

+

+

For more information, you can also view a video demo.

+ 		24.1{% include icon-yes.html %}{% include icon-yes.html %}{% include icon-yes.html %}
+

Read Committed Isolation in GA

+

Read Committed isolation is now GA. Under + READ COMMITTED + isolation, DDL operations can be auto-committed, and RETRY_SERIALIZABLE errors are absent. This offers a simpler migration path for applications and removes the need for client-side retry handling, which is necessary under SERIALIZABLE isolation.

+

For more information, you can also view a video about using Read Committed isolation and the blog post Isolation levels without the anomaly table.

+ 		24.1{% include icon-yes.html %}{% include icon-yes.html %}{% include icon-yes.html %}
+

SELECT FOR SHARE updates

+

A shared lock that is acquired explicitly using + SELECT FOR SHARE + or implicitly by a read-committed transaction, can now be re-acquired with higher strength by either using a SELECT FOR UPDATE statement or by writing to the key.

+ 		24.1{% include icon-yes.html %}{% include icon-yes.html %}{% include icon-yes.html %}
+

SHOW DEFAULT SESSION VARIABLES FOR ROLE

+

Previously, a database administrator could discover which session variables were set for a role only by switching into to that user or querying a system table. The new command + SHOW DEFAULT SESSION VARIABLES FOR ROLE + shows the database administrator the default values for session variables applied to a given user.

+ 		24.1{% include icon-yes.html %}{% include icon-yes.html %}{% include icon-yes.html %}
diff --git a/src/current/_includes/releases/v24.2/v24.2.0.md b/src/current/_includes/releases/v24.2/v24.2.0.md new file mode 100644 index 00000000000..e7ab7568138 --- /dev/null +++ b/src/current/_includes/releases/v24.2/v24.2.0.md @@ -0,0 +1,108 @@ +## v24.2.0 + +Release Date: August 13, 2024 + +With the release of CockroachDB v24.2, we've added new capabilities to help you migrate, build, and operate more efficiently. Refer to our summary of the most significant user-facing changes under [Feature Highlights](#v24-2-0-feature-highlights). + +{% include releases/new-release-downloads-docker-image.md release=include.release advisory_key="a103220"%} + +

Feature highlights

+ +This section summarizes the most significant user-facing changes in v24.2.0 and other features recently made available to CockroachDB users across versions. For a complete list of features and changes in v24.2, including bug fixes and performance improvements, refer to the [release notes]({% link releases/index.md %}#testing-releases) for previous v24.2 testing releases. You can also search the docs for sections labeled [New in v24.2](https://www.cockroachlabs.com/docs/search?query=new+in+v24.2). + +- **Feature categories** + - [Performance](#v24-2-0-performance) + - [Change data capture](#v24-2-0-change-data-capture) + - [Recovery](#v24-2-0-recovery) + - [Security](#v24-2-0-security) + - [Migrations](#v24-2-0-migrations) + - [SQL](#v24-2-0-sql) + - [Operations](#v24-2-0-operations) + - [Observability](#v24-2-0-observability) +- **Additional information** + - [Backward-incompatible changes](#v24-2-0-backward-incompatible-changes) + - [Deprecations](#v24-2-0-deprecations) + - [Known limitations](#v24-2-0-known-limitations) + - [Additional resources](#v24-2-0-additional-resources) + +{{ site.data.alerts.callout_info }} +In CockroachDB Self-Hosted, all available features are free to use unless their description specifies that an Enterprise license is required. For more information, refer to the [Licensing FAQ](https://www.cockroachlabs.com/docs/stable/licensing-faqs). +{{ site.data.alerts.end }} + +
+ +

Performance

+ +{% include releases/v24.2/feature-highlights-performance.html %} + +

Change Data Capture

+ +{% include releases/v24.2/feature-highlights-change-data-capture.html %} + +

Recovery

+ +{% include releases/v24.2/feature-highlights-recovery.html %} + +

Security

+ +{% include releases/v24.2/feature-highlights-security.html %} + +

Migrations

+ +{% include releases/v24.2/feature-highlights-migrations.html %} + +

SQL

+ +{% include releases/v24.2/feature-highlights-sql.html %} + +

Operations

+ +{% include releases/v24.2/feature-highlights-operations.html %} + +

Observability

+ +{% include releases/v24.2/feature-highlights-observability.html %} + +

Backward-incompatible changes

+ +Before [upgrading to CockroachDB v24.2]({% link v24.2/upgrade-cockroach-version.md %}), be sure to review the following backward-incompatible changes, as well as [key cluster setting changes](#v24-2-0-cluster-settings), and adjust your deployment as necessary. + +- [XXX](): ADD STUFF HERE + +

Key Cluster Setting Changes

+ +The following changes should be reviewed prior to upgrading. Default cluster settings will be used unless you have manually set a value for a setting. This can be confirmed by checking the `system.settings` table (`select * from system.settings`) to view the non-default settings. + +- [XXX](): ADD CLUSTER SETTINGS HERE + +

Deprecations

+ +- [XXX](): ADD DEPRECATIONS HERE + +

Known limitations

+ +For information about new and unresolved limitations in CockroachDB v24.2, with suggested workarounds where applicable, refer to [Known Limitations](https://www.cockroachlabs.com/docs/v24.2/known-limitations). + +

Additional resources

+ +Resource | Topic | Description +---------------------+--------------------------------------------+------------- +Cockroach University | [Introduction to Distributed SQL and CockroachDB](https://university.cockroachlabs.com/courses/course-v1:crl+intro-to-distributed-sql-and-cockroachdb+self-paced/about) | This course introduces the core concepts behind distributed SQL databases and describes how CockroachDB fits into this landscape. You will learn what differentiates CockroachDB from both legacy SQL and NoSQL databases and how CockroachDB ensures consistent transactions without sacrificing scale and resiliency. You'll learn about CockroachDB's seamless horizontal scalability, distributed transactions with strict ACID guarantees, and high availability and resilience. +Cockroach University | [Practical First Steps with CockroachDB](https://university.cockroachlabs.com/courses/course-v1:crl+practical-first-steps-with-crdb+self-paced/about) | This course will give you the tools you need to get started with CockroachDB. During the course, you will learn how to spin up a cluster, use the Admin UI to monitor cluster activity, and use SQL shell to solve a set of hands-on exercises. +Cockroach University | [Enterprise Application Development with CockroachDB](https://university.cockroachlabs.com/courses/course-v1:crl+client-side-txn-handling+self-paced/about) | This course is the first in a series designed to equip you with best practices for mastering application-level (client-side) transaction management in CockroachDB. We'll dive deep on common differences between CockroachDB and legacy SQL databases and help you sidestep challenges you might encounter when migrating to CockroachDB from Oracle, PostgreSQL, and MySQL. +Cockroach University | [Building a Highly Resilient Multi-region Database using CockroachDB](https://university.cockroachlabs.com/courses/course-v1:crl+intro-to-resilience-in-multi-region+self-paced/about) | This course is part of a series introducing solutions to running low-latency, highly resilient applications for data-intensive workloads on CockroachDB. In this course we focus on surviving large-scale infrastructure failures like losing an entire cloud region without losing data during recovery. We’ll show you how to use CockroachDB survival goals in a multi-region cluster to implement a highly resilient database that survives node or network failures across multiple regions with zero data loss. +Docs | [Migration Overview](https://www.cockroachlabs.com/docs/v24.2/migration-overview) | This page summarizes the steps of migrating a database to CockroachDB, which include testing and updating your schema to work with CockroachDB, moving your data into CockroachDB, and testing and updating your application. +Docs | [Architecture Overview](https://www.cockroachlabs.com/docs/v24.2/architecture/overview) | This page provides a starting point for understanding the architecture and design choices that enable CockroachDB's scalability and consistency capabilities. +Docs | [SQL Feature Support](https://www.cockroachlabs.com/docs/v24.2/sql-feature-support) | The page summarizes the standard SQL features CockroachDB supports as well as common extensions to the standard. +Docs | [Change Data Capture Overview](https://www.cockroachlabs.com/docs/v24.2/change-data-capture-overview) | This page summarizes CockroachDB's data streaming capabilities. Change data capture (CDC) provides efficient, distributed, row-level changefeeds into a configurable sink for downstream processing such as reporting, caching, or full-text indexing. +Docs | [Backup Architecture](https://www.cockroachlabs.com/docs/v24.2/backup-architecture) | This page describes the backup job workflow with a high-level overview, diagrams, and more details on each phase of the job. + +[#115166]: https://github.com/cockroachdb/cockroach/pull/115166 +[#113893]: https://github.com/cockroachdb/cockroach/pull/113893 +[#115166]: https://github.com/cockroachdb/cockroach/pull/115166 +[#122368]: https://github.com/cockroachdb/cockroach/pull/122368 +[#116664]: https://github.com/cockroachdb/cockroach/pull/116664 +[#120509]: https://github.com/cockroachdb/cockroach/pull/120509 +[#118781]: https://github.com/cockroachdb/cockroach/pull/118781 +[#117729]: https://github.com/cockroachdb/cockroach/pull/117729 +[#120255]: https://github.com/cockroachdb/cockroach/pull/120255