Skip to content

Commit

Permalink
Merge branch 'main' into ldap
Browse files Browse the repository at this point in the history
  • Loading branch information
mikeCRL authored Nov 12, 2024
2 parents 73931fe + b1f3e5c commit 7a50bed
Show file tree
Hide file tree
Showing 120 changed files with 1,555 additions and 317 deletions.
2 changes: 1 addition & 1 deletion src/current/_data/products.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ dedicated: Dedicated

dedicated-advanced: Dedicated advanced

core: Self-Hosted
core: self-hosted

enterprise: Enterprise

Expand Down
14 changes: 11 additions & 3 deletions src/current/_data/redirects.yml
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,14 @@
sources: ['build-a-python-app-with-cockroachdb-pony.md']
versions: ['v20.2', 'v21.1', 'v21.2', 'v22.1', 'v22.2', 'v23.1']

- destination: dev/failover-replication.md
sources: ['cutover-replication.md']
versions: ['24.3']

- destination: failover-replication.md
sources: ['cutover-replication.md']
versions: ['24.3']

- destination: fips.md
sources: ['fips-compliance.md']
versions: ['v23.1']
Expand Down Expand Up @@ -691,9 +699,9 @@
- destination: cockroachcloud/serverless-resource-usage.md
sources: ['cockroachcloud/serverless-benchmarking.md']

- destination: cockroachcloud/upgrade-cockroach-version.md
sources: ['cockroachcloud/upgrade-to-v*.md']
versions: [cockroachcloud]
- destination: upgrade-cockroach-version.md
sources: 'upgrade-to-v*.md'
versions: ['cockroachcloud']

- destination: community-tooling.md
sources:
Expand Down
8 changes: 8 additions & 0 deletions src/current/_includes/common/numa_and_go.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
In a [NUMA (non-uniform memory access) architecture](https://en.wikipedia.org/wiki/Non-uniform_memory_access), the system’s memory is physically distributed across multiple memory banks or "nodes", and each node is assigned to a processor. A processor can access its local memory much faster than non-local memory. This non-uniform memory access can lead to performance differences depending on data location.

CockroachDB is written in Go, which has no process-level support for NUMA scheduling or pinning. Instead, you must manage NUMA at the operating system level. To run multiple CockroachDB clusters on a NUMA architecture:

- Assign no more than 32 cores to the node for each instance. Refer to the documentation for [`numactl --membind`](https://man7.org/linux/man-pages/man8/numactl.8.html).
- Ensure that your orchestration framework, process manager, or startup scripts start each CockroachDB in a separate NUMA node.
- If multiple CockroachDB nodes for the same CockroachDB cluster run on the same physical host, ensure that they are in the same [`--locality`]({% link {{ page.version.version }}/architecture/replication-layer.md %}#intra-locality) to ensure that data is distributed across different physical hosts.
- Ensure that each CockroachDB node writes to a unique set of storage volumes (block devices).
2 changes: 1 addition & 1 deletion src/current/_includes/releases/v24.3/v24.3.0-beta.2.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Release Date: October 28, 2024

<h3 id="v24-3-0-beta-2-db-console-changes">DB Console changes</h3>

- The [**SQL Statements**]({% link v24.3/ui-overview-dashboard.md %}#sql-statements) graph on the [**Overview**]({% link v24.3/ui-overview-dashboard.md %}) and [**SQL**]({% link v24.3/ui-sql-dashboard.md %}) dashboard pages in DB Console now show **Total Queries** as a general Queries Per Second (QPS) metric. [#133198][#133198]
- The **SQL Statements** graph on the [**Overview**]({% link v24.3/ui-overview-dashboard.md %}) and [**SQL**]({% link v24.3/ui-sql-dashboard.md %}) dashboard pages in DB Console has been renamed [**SQL Queries Per Second**]({% link v24.3/ui-overview-dashboard.md %}#sql-queries-per-second) and now shows **Total Queries** as a general Queries Per Second (QPS) metric. [#133198][#133198]
- Due to the inaccuracy of the **Range Count** column on the [**Databases** page]({% link v24.3/ui-databases-page.md %}) and the cost incurred to fetch the correct range count for every database in a cluster, this data will no longer be visible. This data is still available via a [`SHOW RANGES`]({% link v24.3/show-ranges.md %}) query. [#133267][#133267]

<h3 id="v24-3-0-beta-2-bug-fixes">Bug fixes</h3>
Expand Down
6 changes: 4 additions & 2 deletions src/current/_includes/v23.2/ui/ui-metrics-navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ Use the **Graph** menu to display metrics for your entire cluster or for a speci

To the right of the Graph and Dashboard menus, a time interval selector allows you to filter the view for a predefined or custom time interval. Use the navigation buttons to move to the previous, next, or current time interval. When you select a time interval, the same interval is selected in the [SQL Activity]({% link {{ page.version.version }}/ui-overview.md %}#sql-activity) pages. However, if you select 10 or 30 minutes, the interval defaults to 1 hour in SQL Activity pages.

When viewing graphs, two perpendicular lines will appear at your mouse cursor providing further insight into the data. The metric values are displayed in the legend under the graph. Click anywhere within the graph to pin the values in place, decoupling the values from your mouse movements. Click anywhere within the graph to cause the values to change with your mouse movements once more.
Hovering your mouse pointer over the graph title will display a tooltip with a description and the [metrics]({% link {{ page.version.version }}/essential-metrics-self-hosted.md %} ) used to create the graph.

Hovering your mouse cursor over the graph title will display a tooltip with a description and the [metrics]({% link {{ page.version.version }}/essential-metrics-self-hosted.md %} ) used to create the graph.
When hovering on graphs, crosshair lines will appear at your mouse pointer. The series' values corresponding to the given time in the cross hairs are displayed in the legend under the graph. Hovering the mouse pointer on a given series displays the corresponding value near the mouse pointer and highlights the series line (graying out other series lines). Click anywhere within the graph to freeze the values in place. Click anywhere within the graph again to cause the values to change with your mouse movements once more.

In the legend, click on an individual series to isolate it on the graph. The other series will be hidden, while the hover will still work. Click the individual series again to make the other series visible. If there are many series, a scrollbar may appear on the right of the legend. This is to limit the size of the legend so that it does not get endlessly large, particularly on clusters with many nodes.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
The CockroachDB {{ site.data.products.core }} integration with Datadog only supports displaying cluster-wide averages of reported metrics. Filtering by a specific node is unsupported.
The integration of your CockroachDB {{ site.data.products.core }} cluster with Datadog only supports displaying cluster-wide averages of reported metrics. Filtering by a specific node is unsupported.
6 changes: 4 additions & 2 deletions src/current/_includes/v24.1/ui/ui-metrics-navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ Use the **Graph** menu to display metrics for your entire cluster or for a speci

To the right of the Graph and Dashboard menus, a time interval selector allows you to filter the view for a predefined or custom time interval. Use the navigation buttons to move to the previous, next, or current time interval. When you select a time interval, the same interval is selected in the [SQL Activity]({% link {{ page.version.version }}/ui-overview.md %}#sql-activity) pages. However, if you select 10 or 30 minutes, the interval defaults to 1 hour in SQL Activity pages.

When viewing graphs, two perpendicular lines will appear at your mouse cursor providing further insight into the data. The metric values are displayed in the legend under the graph. Click anywhere within the graph to pin the values in place, decoupling the values from your mouse movements. Click anywhere within the graph to cause the values to change with your mouse movements once more.
Hovering your mouse pointer over the graph title will display a tooltip with a description and the [metrics]({% link {{ page.version.version }}/essential-metrics-self-hosted.md %} ) used to create the graph.

Hovering your mouse cursor over the graph title will display a tooltip with a description and the [metrics]({% link {{ page.version.version }}/essential-metrics-self-hosted.md %} ) used to create the graph.
When hovering on graphs, crosshair lines will appear at your mouse pointer. The series' values corresponding to the given time in the cross hairs are displayed in the legend under the graph. Hovering the mouse pointer on a given series displays the corresponding value near the mouse pointer and highlights the series line (graying out other series lines). Click anywhere within the graph to freeze the values in place. Click anywhere within the graph again to cause the values to change with your mouse movements once more.

In the legend, click on an individual series to isolate it on the graph. The other series will be hidden, while the hover will still work. Click the individual series again to make the other series visible. If there are many series, a scrollbar may appear on the right of the legend. This is to limit the size of the legend so that it does not get endlessly large, particularly on clusters with many nodes.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
The CockroachDB {{ site.data.products.core }} integration with Datadog only supports displaying cluster-wide averages of reported metrics. Filtering by a specific node is unsupported.
The integration of your CockroachDB {{ site.data.products.core }} cluster with Datadog only supports displaying cluster-wide averages of reported metrics. Filtering by a specific node is unsupported.
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,12 @@
"urls": [
"/${VERSION}/apply-statement-performance-rules.html"
]
},
{
"title": "Troubleshoot Lock Contention",
"urls": [
"/${VERSION}/troubleshoot-lock-contention.html"
]
}
]
}
Expand Down
6 changes: 4 additions & 2 deletions src/current/_includes/v24.2/ui/ui-metrics-navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ Use the **Graph** menu to display metrics for your entire cluster or for a speci

To the right of the Graph and Dashboard menus, a time interval selector allows you to filter the view for a predefined or custom time interval. Use the navigation buttons to move to the previous, next, or current time interval. When you select a time interval, the same interval is selected in the [SQL Activity]({% link {{ page.version.version }}/ui-overview.md %}#sql-activity) pages. However, if you select 10 or 30 minutes, the interval defaults to 1 hour in SQL Activity pages.

When viewing graphs, two perpendicular lines will appear at your mouse cursor providing further insight into the data. The metric values are displayed in the legend under the graph. Click anywhere within the graph to pin the values in place, decoupling the values from your mouse movements. Click anywhere within the graph to cause the values to change with your mouse movements once more.
Hovering your mouse pointer over the graph title will display a tooltip with a description and the [metrics]({% link {{ page.version.version }}/essential-metrics-self-hosted.md %} ) used to create the graph.

Hovering your mouse cursor over the graph title will display a tooltip with a description and the [metrics]({% link {{ page.version.version }}/essential-metrics-self-hosted.md %} ) used to create the graph.
When hovering on graphs, crosshair lines will appear at your mouse pointer. The series' values corresponding to the given time in the cross hairs are displayed in the legend under the graph. Hovering the mouse pointer on a given series displays the corresponding value near the mouse pointer and highlights the series line (graying out other series lines). Click anywhere within the graph to freeze the values in place. Click anywhere within the graph again to cause the values to change with your mouse movements once more.

In the legend, click on an individual series to isolate it on the graph. The other series will be hidden, while the hover will still work. Click the individual series again to make the other series visible. If there are many series, a scrollbar may appear on the right of the legend. This is to limit the size of the legend so that it does not get endlessly large, particularly on clusters with many nodes.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1 +1 @@
The CockroachDB {{ site.data.products.core }} integration with Datadog only supports displaying cluster-wide averages of reported metrics. Filtering by a specific node is unsupported.
The integration of your CockroachDB {{ site.data.products.core }} cluster with Datadog only supports displaying cluster-wide averages of reported metrics. Filtering by a specific node is unsupported.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
After a failover, there is no mechanism to stop applications from connecting to the original primary cluster. It is necessary to redirect application traffic manually, such as by using a network load balancer or adjusting DNS records.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
After the [cutover process]({% link {{ page.version.version }}/cutover-replication.md %}) for [physical cluster replication]({% link {{ page.version.version }}/physical-cluster-replication-overview.md %}), [scheduled changefeeds]({% link {{ page.version.version }}/create-schedule-for-changefeed.md %}) will continue on the promoted cluster. You will need to manage [pausing]({% link {{ page.version.version }}/pause-schedules.md %}) or [canceling]({% link {{ page.version.version }}/drop-schedules.md %}) the schedule on the promoted standby cluster to avoid two clusters running the same changefeed to one sink. [#123776](https://github.com/cockroachdb/cockroach/issues/123776)
After the [failover process]({% link {{ page.version.version }}/failover-replication.md %}) for [physical cluster replication]({% link {{ page.version.version }}/physical-cluster-replication-overview.md %}), [scheduled changefeeds]({% link {{ page.version.version }}/create-schedule-for-changefeed.md %}) will continue on the promoted cluster. You will need to manage [pausing]({% link {{ page.version.version }}/pause-schedules.md %}) or [canceling]({% link {{ page.version.version }}/drop-schedules.md %}) the schedule on the promoted standby cluster to avoid two clusters running the same changefeed to one sink. [#123776](https://github.com/cockroachdb/cockroach/issues/123776)
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
- Physical cluster replication is supported only on CockroachDB {{ site.data.products.core }} in new clusters on v23.2 or above. Physical Cluster Replication cannot be enabled on clusters that have been upgraded from a previous version of CockroachDB.
- Read queries are not supported on the standby cluster before [cutover]({% link {{ page.version.version }}/cutover-replication.md %}).
- Read queries are not supported on the standby cluster before [failover]({% link {{ page.version.version }}/failover-replication.md %}).
- The primary and standby cluster **cannot have different [region topology]({% link {{ page.version.version }}/topology-patterns.md %})**. For example, replicating a multi-region primary cluster to a single-region standby cluster is not supported. Mismatching regions between a multi-region primary and standby cluster is also not supported.
- Cutting back to the primary cluster after a cutover is a manual process. Refer to [Cut back to the primary cluster]({% link {{ page.version.version }}/cutover-replication.md %}#cut-back-to-the-primary-cluster). In addition, after cutover, to continue using physical cluster replication, you must configure it again.
- Before cutover to the standby, the standby cluster does not support running [backups]({% link {{ page.version.version }}/backup-and-restore-overview.md %}) or [changefeeds]({% link {{ page.version.version }}/change-data-capture-overview.md %}).
- Large data imports, such as those produced by [`RESTORE`]({% link {{ page.version.version }}/restore.md %}) or [`IMPORT INTO`]({% link {{ page.version.version }}/import-into.md %}), may dramatically increase [replication lag]({% link {{ page.version.version }}/physical-cluster-replication-technical-overview.md %}#cutover-and-promotion-process).
- Failing back to the primary cluster after a failover is a manual process. Refer to [Fail back to the primary cluster]({% link {{ page.version.version }}/failover-replication.md %}#fail-back-to-the-primary-cluster). In addition, after failover, to continue using physical cluster replication, you must configure it again.
- Before failover to the standby, the standby cluster does not support running [backups]({% link {{ page.version.version }}/backup-and-restore-overview.md %}) or [changefeeds]({% link {{ page.version.version }}/change-data-capture-overview.md %}).
- Large data imports, such as those produced by [`RESTORE`]({% link {{ page.version.version }}/restore.md %}) or [`IMPORT INTO`]({% link {{ page.version.version }}/import-into.md %}), may dramatically increase [replication lag]({% link {{ page.version.version }}/physical-cluster-replication-technical-overview.md %}#failover-and-promotion-process).

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
When you [fail back]({% link {{ page.version.version }}/failover-replication.md %}#fail-back-to-the-primary-cluster) to a cluster that was previously the primary cluster, you should fail over to the `LATEST` timestamp. Using a [historical timestamp]({% link {{ page.version.version }}/as-of-system-time.md %}) may lead to the failback failing. {% if page.name == "failover-replication.md" %} Refer to the [PCR known limitations]({% link {{ page.version.version }}/physical-cluster-replication-overview.md %}#known-limitations).{% endif %}
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
To cut back to a cluster that was previously the primary cluster, use the [`ALTER VIRTUAL CLUSTER`]({% link {{ page.version.version }}/alter-virtual-cluster.md %}) syntax:
To fail back to a cluster that was previously the primary cluster, use the [`ALTER VIRTUAL CLUSTER`]({% link {{ page.version.version }}/alter-virtual-cluster.md %}) syntax:

{% include_cached copy-clipboard.html %}
~~~ sql
ALTER VIRTUAL CLUSTER {original_primary_vc} START REPLICATION OF {promoted_standby_vc} ON {connection_string_standby};
~~~

The original primary virtual cluster may be almost up to date with the promoted standby's virtual cluster. The difference in data between the two virtual clusters will include only the writes that have been applied to the promoted standby after cutover from the primary cluster.
The original primary virtual cluster may be almost up to date with the promoted standby's virtual cluster. The difference in data between the two virtual clusters will include only the writes that have been applied to the promoted standby after failover from the primary cluster.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
We do not recommend setting `RETENTION` much higher than the 24-hour default on the standby cluster. Accumulated data from an excessive [retention (cutover) window]({% link {{ page.version.version }}/physical-cluster-replication-technical-overview.md %}#cutover-and-promotion-process) could affect queries running on the standby cluster that is active following a [cutover]({% link {{ page.version.version }}/cutover-replication.md %}).
We do not recommend setting `RETENTION` much higher than the 24-hour default on the standby cluster. Accumulated data from an excessive [retention (failover) window]({% link {{ page.version.version }}/physical-cluster-replication-technical-overview.md %}#failover-and-promotion-process) could affect queries running on the standby cluster that is active following a [failover]({% link {{ page.version.version }}/failover-replication.md %}).
Loading

0 comments on commit 7a50bed

Please sign in to comment.