Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backport changes from cockroachdb/docs#19001 #19103

Open
wants to merge 1 commit into
base: 20241029-DOC-10624-backports
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/current/_includes/releases/v23.1/v23.1.0-alpha.8.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Release Date: March 27, 2023
- The MuxRangefeed client, which is enabled with the `changefeed.mux_rangefeed.enabled` [cluster setting]({% link v23.1/cluster-settings.md %}), is now more efficient when running against large-scale workloads. [#97957][#97957]
- The `server.oidc_authentication.claim_json_key` [cluster setting]({% link v23.1/cluster-settings.md %}) for DB Console SSO now accepts list-valued token claims. [#98522][#98522]
- Added the `WITH` key_column option to override the message metadata key for [changefeeds]({% link v23.1/changefeed-examples.md %}). This changes the key hashed to determine Kafka partitions. It does not affect the output of `key_in_value` or the domain of the per-key ordering guarantee. [#98806][#98806]
- The [Node Map]({% link v23.1/ui-cluster-overview-page.md %}#node-map-enterprise) now shows normalized CPU usage. [#98225][#98225]
- The [Node Map]({% link v23.1/ui-cluster-overview-page.md %}#node-map) now shows normalized CPU usage. [#98225][#98225]

<h3 id="v23-1-0-alpha-8-sql-language-changes">SQL language changes</h3>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
$ cockroach sql --insecure
~~~

1. Set your organization name and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}) key that you received via email:
1. Set your organization name and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) key:

{% include_cached copy-clipboard.html %}
~~~ sql
Expand All @@ -24,4 +24,4 @@
> SET CLUSTER SETTING kv.rangefeed.enabled = true;
~~~

{% include {{ page.version.version }}/cdc/cdc-cloud-rangefeed.md %}
{% include {{ page.version.version }}/cdc/cdc-cloud-rangefeed.md %}
2 changes: 1 addition & 1 deletion src/current/_includes/v23.1/misc/install-next-steps.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<li><a href="start-a-local-cluster.html">Start a cluster locally</a> and talk to it via the built-in SQL client</li>
<li><a href="learn-cockroachdb-sql.html">Learn more about CockroachDB SQL</a></li>
<li><a href="example-apps.html">Build a simple application</a> with CockroachDB using PostgreSQL-compatible client drivers and ORMs</li>
<li><a href="demo-replication-and-rebalancing.html">Explore core CockroachDB features</a> like automatic replication, rebalancing, and fault tolerance</li>
<li><a href="demo-replication-and-rebalancing.html">Explore CockroachDB features</a> like automatic replication, rebalancing, and fault tolerance</li>
</ul>
</li>
<li>If you&#39;re ready to run CockroachDB in production:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ After completing these steps, nodes will not yet be live. They will complete the
`--cache`<br>`--max-sql-memory` | Increases the node's cache size to 25% of available system memory to improve read performance. The capacity for in-memory SQL processing defaults to 25% of system memory but can be raised, if necessary, to increase the number of simultaneous client connections allowed by the node as well as the node's capacity for in-memory processing of rows when using `ORDER BY`, `GROUP BY`, `DISTINCT`, joins, and window functions. For more details, see [Cache and SQL Memory Size]({% link {{ page.version.version }}/recommended-production-settings.md %}#cache-and-sql-memory-size).
`--background` | Starts the node in the background so you gain control of the terminal to issue more commands.

When deploying across multiple datacenters, or when there is otherwise high latency between nodes, it is recommended to set `--locality` as well. It is also required to use certain [{{ site.data.products.enterprise }} features]({% link {{ page.version.version }}/enterprise-licensing.md %}). For more details, see [Locality]({% link {{ page.version.version }}/cockroach-start.md %}#locality).
When deploying across multiple datacenters, or when there is otherwise high latency between nodes, it is recommended to set `--locality` as well. For more details, see [Locality]({% link {{ page.version.version }}/cockroach-start.md %}#locality).

For other flags not explicitly set, the command uses default values. For example, the node stores data in `--store=cockroach-data` and binds DB Console HTTP requests to `--http-addr=<node1 address>:8080`. To set these options manually, see [Start a Node]({% link {{ page.version.version }}/cockroach-start.md %}).

Expand Down Expand Up @@ -141,7 +141,7 @@ After completing these steps, nodes will not yet be live. They will complete the

{% include {{ page.version.version }}/prod-deployment/advertise-addr-join.md %}

When deploying across multiple datacenters, or when there is otherwise high latency between nodes, it is recommended to set `--locality` as well. It is also required to use certain [{{ site.data.products.enterprise }} features]({% link {{ page.version.version }}/enterprise-licensing.md %}). For more details, see [Locality]({% link {{ page.version.version }}/cockroach-start.md %}#locality).
When deploying across multiple datacenters, or when there is otherwise high latency between nodes, it is recommended to set `--locality` as well. For more details, see [Locality]({% link {{ page.version.version }}/cockroach-start.md %}#locality).

For other flags not explicitly set, the command uses default values. For example, the node stores data in `--store=cockroach-data` and binds DB Console HTTP requests to `--http-addr=localhost:8080`. To set these options manually, see [Start a Node]({% link {{ page.version.version }}/cockroach-start.md %}).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}).
1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#obtain-a-license).

1. Use the [`cockroach start-single-node`]({% link {{ page.version.version }}/cockroach-start-single-node.md %}) command to start a single-node cluster:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
$ cockroach sql --insecure
~~~

1. Set your organization name and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}) key that you received via email:
1. Set your organization name and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) key:

{% include_cached copy-clipboard.html %}
~~~ sql
Expand All @@ -24,4 +24,4 @@
> SET CLUSTER SETTING kv.rangefeed.enabled = true;
~~~

{% include {{ page.version.version }}/cdc/cdc-cloud-rangefeed.md %}
{% include {{ page.version.version }}/cdc/cdc-cloud-rangefeed.md %}
2 changes: 1 addition & 1 deletion src/current/_includes/v23.2/misc/install-next-steps.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<li><a href="start-a-local-cluster.html">Start a cluster locally</a> and talk to it via the built-in SQL client</li>
<li><a href="learn-cockroachdb-sql.html">Learn more about CockroachDB SQL</a></li>
<li><a href="example-apps.html">Build a simple application</a> with CockroachDB using PostgreSQL-compatible client drivers and ORMs</li>
<li><a href="demo-replication-and-rebalancing.html">Explore core CockroachDB features</a> like automatic replication, rebalancing, and fault tolerance</li>
<li><a href="demo-replication-and-rebalancing.html">Explore CockroachDB features</a> like automatic replication, rebalancing, and fault tolerance</li>
</ul>
</li>
<li>If you&#39;re ready to run CockroachDB in production:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ After completing these steps, nodes will not yet be live. They will complete the
`--cache`<br>`--max-sql-memory` | Increases the node's cache size to 25% of available system memory to improve read performance. The capacity for in-memory SQL processing defaults to 25% of system memory but can be raised, if necessary, to increase the number of simultaneous client connections allowed by the node as well as the node's capacity for in-memory processing of rows when using `ORDER BY`, `GROUP BY`, `DISTINCT`, joins, and window functions. For more details, see [Cache and SQL Memory Size]({% link {{ page.version.version }}/recommended-production-settings.md %}#cache-and-sql-memory-size).
`--background` | Starts the node in the background so you gain control of the terminal to issue more commands.

When deploying across multiple datacenters, or when there is otherwise high latency between nodes, it is recommended to set `--locality` as well. It is also required to use certain [{{ site.data.products.enterprise }} features]({% link {{ page.version.version }}/enterprise-licensing.md %}). For more details, see [Locality]({% link {{ page.version.version }}/cockroach-start.md %}#locality).
When deploying across multiple datacenters, or when there is otherwise high latency between nodes, it is recommended to set `--locality` as well. For more details, see [Locality]({% link {{ page.version.version }}/cockroach-start.md %}#locality).

For other flags not explicitly set, the command uses default values. For example, the node stores data in `--store=cockroach-data` and binds DB Console HTTP requests to `--http-addr=<node1 address>:8080`. To set these options manually, see [Start a Node]({% link {{ page.version.version }}/cockroach-start.md %}).

Expand Down Expand Up @@ -141,7 +141,7 @@ After completing these steps, nodes will not yet be live. They will complete the

{% include {{ page.version.version }}/prod-deployment/advertise-addr-join.md %}

When deploying across multiple datacenters, or when there is otherwise high latency between nodes, it is recommended to set `--locality` as well. It is also required to use certain [{{ site.data.products.enterprise }} features]({% link {{ page.version.version }}/enterprise-licensing.md %}). For more details, see [Locality]({% link {{ page.version.version }}/cockroach-start.md %}#locality).
When deploying across multiple datacenters, or when there is otherwise high latency between nodes, it is recommended to set `--locality` as well. For more details, see [Locality]({% link {{ page.version.version }}/cockroach-start.md %}#locality).

For other flags not explicitly set, the command uses default values. For example, the node stores data in `--store=cockroach-data` and binds DB Console HTTP requests to `--http-addr=localhost:8080`. To set these options manually, see [Start a Node]({% link {{ page.version.version }}/cockroach-start.md %}).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}).
1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#obtain-a-license).

1. Use the [`cockroach start-single-node`]({% link {{ page.version.version }}/cockroach-start-single-node.md %}) command to start a single-node cluster:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
$ cockroach sql --insecure
~~~

1. Set your organization name and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}) key that you received via email:
1. Set your organization name and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) key:

{% include_cached copy-clipboard.html %}
~~~ sql
Expand All @@ -24,4 +24,4 @@
> SET CLUSTER SETTING kv.rangefeed.enabled = true;
~~~

{% include {{ page.version.version }}/cdc/cdc-cloud-rangefeed.md %}
{% include {{ page.version.version }}/cdc/cdc-cloud-rangefeed.md %}
2 changes: 1 addition & 1 deletion src/current/_includes/v24.1/essential-alerts.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ CockroachDB uses the [Pebble]({% link {{ page.version.version }}/architecture/st

### Enterprise license expiration

Avoid [enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}) expiration to avoid any disruption to feature access.
Avoid [license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) expiration to avoid any disruption to feature access.

**Metric**
<br>[`seconds.until.enterprise.license.expiry`]({% link {{ page.version.version }}/essential-metrics-{{ include.deployment }}.md %}#seconds-until-enterprise-license-expiry)
Expand Down
2 changes: 1 addition & 1 deletion src/current/_includes/v24.1/misc/install-next-steps.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<li><a href="start-a-local-cluster.html">Start a cluster locally</a> and talk to it via the built-in SQL client</li>
<li><a href="learn-cockroachdb-sql.html">Learn more about CockroachDB SQL</a></li>
<li><a href="example-apps.html">Build a simple application</a> with CockroachDB using PostgreSQL-compatible client drivers and ORMs</li>
<li><a href="demo-replication-and-rebalancing.html">Explore core CockroachDB features</a> like automatic replication, rebalancing, and fault tolerance</li>
<li><a href="demo-replication-and-rebalancing.html">Explore CockroachDB features</a> like automatic replication, rebalancing, and fault tolerance</li>
</ul>
</li>
<li>If you&#39;re ready to run CockroachDB in production:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ After completing these steps, nodes will not yet be live. They will complete the
`--cache`<br>`--max-sql-memory` | Increases the node's cache size to 25% of available system memory to improve read performance. The capacity for in-memory SQL processing defaults to 25% of system memory but can be raised, if necessary, to increase the number of simultaneous client connections allowed by the node as well as the node's capacity for in-memory processing of rows when using `ORDER BY`, `GROUP BY`, `DISTINCT`, joins, and window functions. For more details, see [Cache and SQL Memory Size]({% link {{ page.version.version }}/recommended-production-settings.md %}#cache-and-sql-memory-size).
`--background` | Starts the node in the background so you gain control of the terminal to issue more commands.

When deploying across multiple datacenters, or when there is otherwise high latency between nodes, it is recommended to set `--locality` as well. It is also required to use certain [{{ site.data.products.enterprise }} features]({% link {{ page.version.version }}/enterprise-licensing.md %}). For more details, see [Locality]({% link {{ page.version.version }}/cockroach-start.md %}#locality).
When deploying across multiple datacenters, or when there is otherwise high latency between nodes, it is recommended to set `--locality` as well. For more details, see [Locality]({% link {{ page.version.version }}/cockroach-start.md %}#locality).

For other flags not explicitly set, the command uses default values. For example, the node stores data in `--store=cockroach-data` and binds DB Console HTTP requests to `--http-addr=<node1 address>:8080`. To set these options manually, see [Start a Node]({% link {{ page.version.version }}/cockroach-start.md %}).

Expand Down Expand Up @@ -141,7 +141,7 @@ After completing these steps, nodes will not yet be live. They will complete the

{% include {{ page.version.version }}/prod-deployment/advertise-addr-join.md %}

When deploying across multiple datacenters, or when there is otherwise high latency between nodes, it is recommended to set `--locality` as well. It is also required to use certain [{{ site.data.products.enterprise }} features]({% link {{ page.version.version }}/enterprise-licensing.md %}). For more details, see [Locality]({% link {{ page.version.version }}/cockroach-start.md %}#locality).
When deploying across multiple datacenters, or when there is otherwise high latency between nodes, it is recommended to set `--locality` as well. For more details, see [Locality]({% link {{ page.version.version }}/cockroach-start.md %}#locality).

For other flags not explicitly set, the command uses default values. For example, the node stores data in `--store=cockroach-data` and binds DB Console HTTP requests to `--http-addr=localhost:8080`. To set these options manually, see [Start a Node]({% link {{ page.version.version }}/cockroach-start.md %}).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}).
1. If you do not already have one, [request a trial {{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#obtain-a-license).

1. Use the [`cockroach start-single-node`]({% link {{ page.version.version }}/cockroach-start-single-node.md %}) command to start a single-node cluster:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
$ cockroach sql --insecure
~~~

1. Set your organization name and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/enterprise-licensing.md %}) key that you received via email:
1. Set your organization name and [{{ site.data.products.enterprise }} license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) key:

{% include_cached copy-clipboard.html %}
~~~ sql
Expand All @@ -24,4 +24,4 @@
> SET CLUSTER SETTING kv.rangefeed.enabled = true;
~~~

{% include {{ page.version.version }}/cdc/cdc-cloud-rangefeed.md %}
{% include {{ page.version.version }}/cdc/cdc-cloud-rangefeed.md %}
2 changes: 1 addition & 1 deletion src/current/_includes/v24.2/essential-alerts.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ CockroachDB uses the [Pebble]({% link {{ page.version.version }}/architecture/st

### Enterprise license expiration

Avoid [enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}) expiration to avoid any disruption to feature access.
Avoid [license]({% link {{ page.version.version }}/licensing-faqs.md %}#types-of-licenses) expiration to avoid any disruption to feature access.

**Metric**
<br>[`seconds.until.enterprise.license.expiry`]({% link {{ page.version.version }}/essential-metrics-{{ include.deployment }}.md %}#seconds-until-enterprise-license-expiry)
Expand Down
2 changes: 1 addition & 1 deletion src/current/_includes/v24.2/misc/install-next-steps.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<li><a href="start-a-local-cluster.html">Start a cluster locally</a> and talk to it via the built-in SQL client</li>
<li><a href="learn-cockroachdb-sql.html">Learn more about CockroachDB SQL</a></li>
<li><a href="example-apps.html">Build a simple application</a> with CockroachDB using PostgreSQL-compatible client drivers and ORMs</li>
<li><a href="demo-replication-and-rebalancing.html">Explore core CockroachDB features</a> like automatic replication, rebalancing, and fault tolerance</li>
<li><a href="demo-replication-and-rebalancing.html">Explore CockroachDB features</a> like automatic replication, rebalancing, and fault tolerance</li>
</ul>
</li>
<li>If you&#39;re ready to run CockroachDB in production:
Expand Down
Loading
Loading