diff --git a/src/current/_data/releases.yml b/src/current/_data/releases.yml index 79fee4eb1f2..980b1c265eb 100644 --- a/src/current/_data/releases.yml +++ b/src/current/_data/releases.yml @@ -7787,13 +7787,6 @@ docker_arm_limited_access: false source: true previous_release: v24.1.9 - 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). - release_name: v24.2.8 major_version: v24.2 @@ -7821,13 +7814,6 @@ docker_arm_limited_access: false source: true previous_release: v24.2.7 - 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). - release_name: v24.3.3 major_version: v24.3 @@ -7855,13 +7841,6 @@ docker_arm_limited_access: false source: true previous_release: v24.3.2 - 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). - release_name: v23.2.19 major_version: v23.2 @@ -7889,10 +7868,3 @@ docker_arm_limited_access: false source: true previous_release: v23.2.18 - 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/cockroachcloud/cloud-api.md b/src/current/cockroachcloud/cloud-api.md index 2d443fd1a96..aa3490acb53 100644 --- a/src/current/cockroachcloud/cloud-api.md +++ b/src/current/cockroachcloud/cloud-api.md @@ -8,7 +8,7 @@ cloud: true The Cloud API is a [REST interface](https://wikipedia.org/wiki/Representational_state_transfer) that allows you programmatic access to manage the lifecycle of clusters within your organization. -This document pertains to the `latest` version of the API's `v1` endpoints, `2024-09-16`. For more detailed coverage of API endpoints for this version and prior verisons, refer to the [API reference documentation](https://www.cockroachlabs.com/docs/api/cloud/v1). +This document pertains to the `latest` version of the API's `v1` endpoints, `2024-09-16`. For more detailed coverage of API endpoints for this version and prior versions, refer to the [API reference documentation](https://www.cockroachlabs.com/docs/api/cloud/v1). To manage clusters and other resources in CockroachDB Cloud, you can also use the [CockroachDB Cloud Terraform provider]({% link cockroachcloud/provision-a-cluster-with-terraform.md %}), which implements the API. @@ -799,6 +799,7 @@ If the request was successful, the client will receive a list of SQL users. ~~~ Where: + - `` is the SQL username of the user. - `` is the token to use for retrieving the next page of results, if any. @@ -863,6 +864,7 @@ curl --request DELETE \ ~~~ Where: + - `{cluster_id}` is the unique ID of this cluster. {{site.data.alerts.callout_info}} The cluster ID used in the Cloud API is different from the routing ID used when [connecting to clusters]({% link cockroachcloud/connect-to-your-cluster.md %}). @@ -899,6 +901,7 @@ curl --request PUT \ ~~~ Where: + - `{cluster_id}` is the unique ID of this cluster. {{site.data.alerts.callout_info}} The cluster ID used in the Cloud API is different from the routing ID used when [connecting to clusters]({% link cockroachcloud/connect-to-your-cluster.md %}). diff --git a/src/current/images/v24.3/wal-failover-behavior.png b/src/current/images/v24.3/wal-failover-behavior.png new file mode 100644 index 00000000000..d6eb3b295f0 Binary files /dev/null and b/src/current/images/v24.3/wal-failover-behavior.png differ diff --git a/src/current/images/v24.3/wal-failover-overview.png b/src/current/images/v24.3/wal-failover-overview.png new file mode 100644 index 00000000000..b737986463a Binary files /dev/null and b/src/current/images/v24.3/wal-failover-overview.png differ diff --git a/src/current/images/v25.1/wal-failover-behavior.png b/src/current/images/v25.1/wal-failover-behavior.png new file mode 100644 index 00000000000..d6eb3b295f0 Binary files /dev/null and b/src/current/images/v25.1/wal-failover-behavior.png differ diff --git a/src/current/images/v25.1/wal-failover-overview.png b/src/current/images/v25.1/wal-failover-overview.png new file mode 100644 index 00000000000..b737986463a Binary files /dev/null and b/src/current/images/v25.1/wal-failover-overview.png differ diff --git a/src/current/jekyll-algolia-dev/lib/jekyll/algolia/indexer.rb b/src/current/jekyll-algolia-dev/lib/jekyll/algolia/indexer.rb index a09ba7741f0..fc6ddf547c7 100644 --- a/src/current/jekyll-algolia-dev/lib/jekyll/algolia/indexer.rb +++ b/src/current/jekyll-algolia-dev/lib/jekyll/algolia/indexer.rb @@ -357,6 +357,24 @@ def self.update_synonyms synonyms: ['materialized view', 'material view'] }, false) + index.save_synonym('session setting', { + objectID: 'session setting', + type: 'synonym', + synonyms: ['session setting', 'session variable', 'session settings', 'session variables', 'session var', 'session vars'] + }, false) + + index.save_synonym('cluster setting', { + objectID: 'cluster setting', + type: 'synonym', + synonyms: ['cluster setting', 'cluster variable', 'cluster settings', 'cluster variables', 'cluster var', 'cluster vars'] + }, false) + + index.save_synonym('molt', { + objectID: 'molt', + type: 'synonym', + synonyms: ['molt', 'migrate off legacy technology'] + }, false) + return end diff --git a/src/current/v24.3/wal-failover.md b/src/current/v24.3/wal-failover.md index 1966284e31a..ee3925c2c89 100644 --- a/src/current/v24.3/wal-failover.md +++ b/src/current/v24.3/wal-failover.md @@ -27,6 +27,10 @@ When a disk stalls on a node, it could be due to complete hardware failure or it WAL failover uses a secondary disk to fail over WAL writes to when transient disk stalls occur. This limits the write impact to a few hundreds of milliseconds (the [failover threshold, which is configurable](#unhealthy-op-threshold)). Note that WAL failover **only preserves availability of writes**. If reads to the underlying storage are also stalled, operations that read and do not find data in the block cache or page cache will stall. +The following diagram shows how WAL failover works at a high level. For more information about the WAL, memtables, and SSTables, refer to the [Architecture » Storage Layer documentation]({% link {{ page.version.version }}/architecture/storage-layer.md %}). + +WAL failover overview diagram + ## Create and configure a cluster to be ready for WAL failover The steps to provision a cluster that has a single data store versus a multi-store cluster are slightly different. In this section, we will provide high-level instructions for setting up each of these configurations. We will use [GCE](https://cloud.google.com/compute/docs) as the environment. You will need to translate these instructions into the steps used by the deployment tools in your environment. @@ -371,6 +375,10 @@ If a disk stalls for longer than the duration of [`COCKROACH_ENGINE_MAX_SYNC_DUR In a [multi-store](#multi-store-config) cluster, if a disk for a store has a transient stall, WAL will failover to the second store's disk. When the stall on the first disk clears, the WAL will failback to the first disk. WAL failover will daisy-chain from store _A_ to store _B_ to store _C_. +The following diagram shows the behavior of WAL writes during a disk stall with and without WAL failover enabled. + +how long WAL writes take during a disk stall with and without WAL failover enabled + ## FAQs ### 1. What are the benefits of WAL failover? diff --git a/src/current/v25.1/wal-failover.md b/src/current/v25.1/wal-failover.md index eac722c8024..bcac4d00518 100644 --- a/src/current/v25.1/wal-failover.md +++ b/src/current/v25.1/wal-failover.md @@ -27,6 +27,10 @@ When a disk stalls on a node, it could be due to complete hardware failure or it WAL failover uses a secondary disk to fail over WAL writes to when transient disk stalls occur. This limits the write impact to a few hundreds of milliseconds (the [failover threshold, which is configurable](#unhealthy-op-threshold)). Note that WAL failover **only preserves availability of writes**. If reads to the underlying storage are also stalled, operations that read and do not find data in the block cache or page cache will stall. +The following diagram shows how WAL failover works at a high level. For more information about the WAL, memtables, and SSTables, refer to the [Architecture » Storage Layer documentation]({% link {{ page.version.version }}/architecture/storage-layer.md %}). + +WAL failover overview diagram + ## Create and configure a cluster to be ready for WAL failover The steps to provision a cluster that has a single data store versus a multi-store cluster are slightly different. In this section, we will provide high-level instructions for setting up each of these configurations. We will use [GCE](https://cloud.google.com/compute/docs) as the environment. You will need to translate these instructions into the steps used by the deployment tools in your environment. @@ -371,6 +375,10 @@ If a disk stalls for longer than the duration of [`COCKROACH_ENGINE_MAX_SYNC_DUR In a [multi-store](#multi-store-config) cluster, if a disk for a store has a transient stall, WAL will failover to the second store's disk. When the stall on the first disk clears, the WAL will failback to the first disk. WAL failover will daisy-chain from store _A_ to store _B_ to store _C_. +The following diagram shows the behavior of WAL writes during a disk stall with and without WAL failover enabled. + +how long WAL writes take during a disk stall with and without WAL failover enabled + ## FAQs ### 1. What are the benefits of WAL failover?