Skip to content

Commit

Permalink
WIP PR for Rich's licensing backports (#19143)
Browse files Browse the repository at this point in the history
* Backport changes from #19008 (#19106)

Addresses DOC-11674

Summary of changes:

- Backport changes from #19008 to v23.1, v23.2, v24.1,
  and v24.2

* Backport changes from #19072 (#19109)

* Backport changes from #19072

Addresses DOC-11674

Summary of changes:

- Backport #19072 to v23.1, v23.2, v24.1, v24.2

* Backport changes from #19031 (#19108)

Addresses DOC-11674

Summary of changes:

- Backport #19031 to v23.1, v23.2, v24.1, v24.2

* Backport changes from #19001 (#19103)

Addresses DOC-10665, DOC-11674

Summary of changes:

- Backport changes from #19001; a few manual edits were
  required due to a few patches that didn't merge automagically

* Backport changes from #19126 (#19133)

Addresses DOC-11674, DOC-11692

* Merge origin/main into 20241029-DOC-10624-backports (#19140)

* Merge origin/main back into core relicensing backport branch (#19142)

* Backport changes from #19002 (#19138)

* Backport changes from #19002

Addresses DOC-11674

* Backport telemetry docs from #19131 (#19145)

Addresses DOC-11051

* Backport upgrade license info from #19125 (#19146)

Addresses DOC-11693

* Fix broken link on upgrade page include

---------

Co-authored-by: Rich Loveland <[email protected]>
  • Loading branch information
mdlinville and rmloveland authored Nov 18, 2024
1 parent 0f15840 commit 0dbe86c
Show file tree
Hide file tree
Showing 397 changed files with 810 additions and 2,377 deletions.
2 changes: 1 addition & 1 deletion src/current/_data/redirects.yml
Original file line number Diff line number Diff line change
Expand Up @@ -519,7 +519,7 @@

- destination: licensing-faqs.md
sources: ['enterprise-licensing.md']
versions: ['v24.3']
versions: ['v23.1', 'v23.2', 'v24.1', 'v24.2', 'v24.3']

- destination: :version/licensing-faqs.md
sources: [':version/get-started-with-enterprise-trial.md']
Expand Down
3 changes: 0 additions & 3 deletions src/current/_data/releases.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7491,6 +7491,3 @@
CockroachDB Cloud clusters. To request to upgrade
a CockroachDB self-hosted cluster to this version,
[contact support](https://support.cockroachlabs.com/hc/requests/new).
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ If a cluster with an **Enterprise Free** or **Enterprise Trial** license is upgr

For more information, refer to the [Licensing FAQs]({% link {{ page.version.version }}/licensing-faqs.md %}).

If you want to stay on the previous version, you can [roll back the upgrade before finalization]({% link {{ page.version.version }}/upgrade-cockroach-version.md%}#roll-back-a-major-version-upgrade).
If you want to stay on the previous version, you can roll back the upgrade before finalization.
2 changes: 1 addition & 1 deletion src/current/_includes/releases/v23.1/v23.1.0-alpha.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Release Date: March 20, 2023

<h3 id="v23-1-0-alpha-7-{{-site.data.products.enterprise-}}-edition-changes">{{ site.data.products.enterprise }} edition changes</h3>

- Sinkless [changefeeds]({% link v23.1/create-changefeed.md %}) that use the [`AS SELECT`]({% link v23.1/selection-queries.md %}) syntax now require an [enterprise license]({% link v23.1/enterprise-licensing.md %}). [#98241][#98241]
- Sinkless [changefeeds]({% link v23.1/create-changefeed.md %}) that use the [`AS SELECT`]({% link v23.1/selection-queries.md %}) syntax now require an enterprise license. [#98241][#98241]
- [External connections]({% link v23.1/create-external-connection.md %}) can now be used as the URI value for a Confluent schema registry. For example, `CREATE EXTERNAL CONNECTION reg AS "https://example.cloud?opt=val"; CREATE CHANGEFEED FOR foo WITH format='avro',confluent_schema_registry='external://reg'` [#97140][#97140]
- [Backup schedules]({% link v23.1/create-schedule-for-backup.md %}) created or altered to have the option `on_previous_running` will have the full backup schedule created with the user specified option, but will override the incremental backup schedule to always default to `on_previous_running = wait`. This ensures correctness of the backup chains created by the incremental schedule by preventing duplicate incremental jobs from racing against each other. [#98249][#98249]
- [Changefeeds]({% link v23.1/changefeed-sinks.md %}#kafka) to a Kafka sink now support the `OAUTHBEARER` `sasl_mechanism`. [#98053][#98053]
Expand Down
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
4 changes: 0 additions & 4 deletions src/current/_includes/releases/v23.1/v23.1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -228,10 +228,6 @@ Asyncpg is commonly used with ORM libraries such as SQLAlchemy to provide a simp

<h5>Change data capture (Changefeeds)</h5>

{{site.data.alerts.callout_info}}
The following are [enterprise-only]({% link v23.1/enterprise-licensing.md %}) features. [Request a 30-day trial license](https://www.cockroachlabs.com/get-cockroachdb/enterprise/) to try them out.
{{site.data.alerts.end}}

<table>
<thead>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion src/current/_includes/releases/v23.2/v23.2.12.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Release Date: September 25, 2024
- The [DB Console]({% link v23.2/ui-overview-dashboard.md %}) time-series graphs now have hover behavior that focuses on individual lines and shows values under the mouse pointer. [cockroachdb/cockroach#128864][#128864]
- Users with the [`VIEWACTIVITY` privilege]({% link v23.2/security-reference/authorization.md %}#viewactivity) can download [statement bundles]({% link v23.2/explain-analyze.md %}) from [DB Console]({% link v23.2/ui-overview.md %}). [#129502][#129502]
- The [DB Console]({% link v23.2/ui-overview.md %}) now displays an alert message when the [license is expired]({% link v23.2/licensing-faqs.md %}#monitor-for-license-expiry) or if there are fewer than 15 days left before the license expires. [#130509][#130509]
- The [DB Console]({% link v23.2/ui-overview.md %}) will now show a notification alerting customers without an [Enterprise license]({% link v23.2/enterprise-licensing.md %}) to [upcoming license changes](https://www.cockroachlabs.com/enterprise-license-update/) with a link to more information. [#130509][#130509]
- The [DB Console]({% link v23.2/ui-overview.md %}) will now show a notification alerting customers without an Enterprise license to [upcoming license changes](https://www.cockroachlabs.com/enterprise-license-update/) with a link to more information. [#130509][#130509]

<h3 id="v23-2-12-bug-fixes">Bug fixes</h3>

Expand Down
2 changes: 1 addition & 1 deletion src/current/_includes/releases/v23.2/v23.2.13.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Release Date: October 17, 2024

<h3 id="v23-2-13-db-console-changes">DB Console changes</h3>

- The [DB Console]({% link v24.2/ui-overview.md %}) now shows a notification if the cluster has no [Enterprise license]({% link v24.2/enterprise-licensing.md %}) set. Refer to [upcoming license changes](https://www.cockroachlabs.com/enterprise-license-update/) for more information. [#130425][#130425]
- The [DB Console]({% link v24.2/ui-overview.md %}) now shows a notification if the cluster has no Enterprise license set. Refer to [upcoming license changes](https://www.cockroachlabs.com/enterprise-license-update/) for more information. [#130425][#130425]

<h3 id="v23-2-13-bug-fixes">Bug fixes</h3>

Expand Down
2 changes: 1 addition & 1 deletion src/current/_includes/releases/v24.1/v24.1.6.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Release Date: October 17, 2024

<h3 id="v24-1-6-db-console-changes">DB Console changes</h3>

- The [DB Console]({% link v24.1/ui-overview.md %}) will now show a notification alerting customers without an [Enterprise license]({% link v24.1/enterprise-licensing.md %}) to [upcoming license changes](https://www.cockroachlabs.com/enterprise-license-update/) with a link to more information. [#130426][#130426]
- The [DB Console]({% link v24.1/ui-overview.md %}) will now show a notification alerting customers without an Enterprise license to [upcoming license changes](https://www.cockroachlabs.com/enterprise-license-update/) with a link to more information. [#130426][#130426]

<h3 id="v24-1-6-bug-fixes">Bug fixes</h3>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<p class="feature-description">
Users can now store <a href="https://www.cockroachlabs.com/docs/v24.2/vector.html">
<code>VECTOR</code>
</a> embeddings within CockroachDB with <code>pgvector</code>-compatible semantics to build AI-driven applications. Numerous <a href="https://www.cockroachlabs.com/docs/v24.2/functions-and-operators.html#pgvector-functions">built-in functions</a> have been added for running similarity search across vectors. Note that vector indexing is not supported in this release. This feature is in <a href="https://cockroachlabs.com/docs/stable/feature-availability.html">Preview</a> and requires an <a href="https://www.cockroachlabs.com/docs/stable/enterprise-licensing">Enterprise license</a>.
</a> embeddings within CockroachDB with <code>pgvector</code>-compatible semantics to build AI-driven applications. Numerous <a href="https://www.cockroachlabs.com/docs/v24.2/functions-and-operators.html#pgvector-functions">built-in functions</a> have been added for running similarity search across vectors. Note that vector indexing is not supported in this release. This feature is in <a href="https://cockroachlabs.com/docs/stable/feature-availability.html">Preview</a>.
</p>
</td>
<td>24.2</td>
Expand All @@ -30,7 +30,7 @@
<td>
<p class="feature-summary">Generic query plans</p>
<p class="feature-description">
Users can now enable <a href="https://www.cockroachlabs.com/docs/v24.2/cost-based-optimizer.html#query-plan-type">generic query plans</a>. Generic query plans optimize query execution for prepared statements by reusing precompiled query plans, and significantly reduce the CPU overhead associated with parsing and planning repeated queries, at the expense of plan quality. This feature is in <a href="https://cockroachlabs.com/docs/stable/feature-availability.html">Preview</a> and requires an <a href="https://www.cockroachlabs.com/docs/stable/enterprise-licensing">Enterprise license</a>.
Users can now enable <a href="https://www.cockroachlabs.com/docs/v24.2/cost-based-optimizer.html#query-plan-type">generic query plans</a>. Generic query plans optimize query execution for prepared statements by reusing precompiled query plans, and significantly reduce the CPU overhead associated with parsing and planning repeated queries, at the expense of plan quality. This feature is in <a href="https://cockroachlabs.com/docs/stable/feature-availability.html">Preview</a>.
</p>
</td>
<td>24.2</td>
Expand Down
2 changes: 1 addition & 1 deletion src/current/_includes/releases/v24.2/v24.2.3.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Release Date: September 25, 2024

- Users with the `VIEWACTIVITY` [system privilege]({% link v24.2/security-reference/authorization.md %}#supported-privileges) can now download [statement bundles]({% link v24.2/ui-statements-page.md %}#diagnostics) from the DB Console. [#129504][#129504]
- Users with the `VIEWACTIVITY` [system privilege]({% link v24.2/security-reference/authorization.md %}#supported-privileges) can now request, view, and cancel [statement bundles]({% link v24.2/ui-statements-page.md %}#diagnostics) from the DB Console. [#129809][#129809]
- The DB Console now displays a notification to alert customers without an [Enterprise license]({% link v24.2/enterprise-licensing.md %}) to upcoming license changes. [#130511][#130511]
- The DB Console now displays a notification to alert customers without an Enterprise license to upcoming license changes. [#130511][#130511]

<h3 id="v24-2-3-bug-fixes">Bug fixes</h3>

Expand Down
2 changes: 1 addition & 1 deletion src/current/_includes/releases/v24.2/v24.2.4.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Release Date: October 17, 2024
<h3 id="v24-2-4-db-console-changes">DB Console changes</h3>

- Streamlined [metric chart]({% link v24.2/ui-overview.md %}#metrics) legends by removing the name of the chart from labels, where it was an identical prefix for all labels on the chart. [#129359][#129359]
- The [DB Console]({% link v24.2/ui-overview.md %}) now shows a notification if the cluster has no [Enterprise license]({% link v24.2/enterprise-licensing.md %}) set. Refer to [upcoming license changes](https://www.cockroachlabs.com/enterprise-license-update/) for more information. [#130417][#130417]
- The [DB Console]({% link v24.2/ui-overview.md %}) now shows a notification if the cluster has no Enterprise license set. Refer to [upcoming license changes](https://www.cockroachlabs.com/enterprise-license-update/) for more information. [#130417][#130417]

<h3 id="v24-2-4-bug-fixes">Bug fixes</h3>

Expand Down
2 changes: 1 addition & 1 deletion src/current/_includes/v23.1/cdc/core-csv.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{{site.data.alerts.callout_info}}
To determine how wide the columns need to be, the default `table` display format in `cockroach sql` buffers the results it receives from the server before printing them to the console. When consuming core changefeed data using `cockroach sql`, it's important to use a display format like `csv` that does not buffer its results. To set the display format, use the [`--format=csv` flag]({% link {{ page.version.version }}/cockroach-sql.md %}#sql-flag-format) when starting the [built-in SQL client]({% link {{ page.version.version }}/cockroach-sql.md %}), or set the [`\set display_format=csv` option]({% link {{ page.version.version }}/cockroach-sql.md %}#client-side-options) once the SQL client is open.
To determine how wide the columns need to be, the default `table` display format in `cockroach sql` buffers the results it receives from the server before printing them to the console. When consuming basic changefeed data using `cockroach sql`, it's important to use a display format like `csv` that does not buffer its results. To set the display format, use the [`--format=csv` flag]({% link {{ page.version.version }}/cockroach-sql.md %}#sql-flag-format) when starting the [built-in SQL client]({% link {{ page.version.version }}/cockroach-sql.md %}), or set the [`\set display_format=csv` option]({% link {{ page.version.version }}/cockroach-sql.md %}#client-side-options) once the SQL client is open.
{{site.data.alerts.end}}
2 changes: 1 addition & 1 deletion src/current/_includes/v23.1/cdc/core-url.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{{site.data.alerts.callout_info}}
Because core changefeeds return results differently than other SQL statements, they require a dedicated database connection with specific settings around result buffering. In normal operation, CockroachDB improves performance by buffering results server-side before returning them to a client; however, result buffering is automatically turned off for core changefeeds. Core changefeeds also have different cancellation behavior than other queries: they can only be canceled by closing the underlying connection or issuing a [`CANCEL QUERY`]({% link {{ page.version.version }}/cancel-query.md %}) statement on a separate connection. Combined, these attributes of changefeeds mean that applications should explicitly create dedicated connections to consume changefeed data, instead of using a connection pool as most client drivers do by default.
Because basic changefeeds return results differently than other SQL statements, they require a dedicated database connection with specific settings around result buffering. In normal operation, CockroachDB improves performance by buffering results server-side before returning them to a client; however, result buffering is automatically turned off for basic changefeeds. Basic changefeeds also have different cancellation behavior than other queries: they can only be canceled by closing the underlying connection or issuing a [`CANCEL QUERY`]({% link {{ page.version.version }}/cancel-query.md %}) statement on a separate connection. Combined, these attributes of changefeeds mean that applications should explicitly create dedicated connections to consume changefeed data, instead of using a connection pool as most client drivers do by default.
{{site.data.alerts.end}}
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
In this example, you'll set up a core changefeed for a single-node cluster that emits Avro records. CockroachDB's Avro binary encoding convention uses the [Confluent Schema Registry](https://docs.confluent.io/current/schema-registry/docs/serializer-formatter.html) to store Avro schemas.
In this example, you'll set up a basic changefeed for a single-node cluster that emits Avro records. CockroachDB's Avro binary encoding convention uses the [Confluent Schema Registry](https://docs.confluent.io/current/schema-registry/docs/serializer-formatter.html) to store Avro schemas.

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 Expand Up @@ -53,7 +53,7 @@ In this example, you'll set up a core changefeed for a single-node cluster that
> INSERT INTO bar VALUES (0);
~~~

1. Start the core changefeed:
1. Start the basic changefeed:

{% include_cached copy-clipboard.html %}
~~~ sql
Expand All @@ -72,13 +72,13 @@ In this example, you'll set up a core changefeed for a single-node cluster that
$ cockroach sql --insecure -e "INSERT INTO bar VALUES (1)"
~~~

1. Back in the terminal where the core changefeed is streaming, the output will appear:
1. Back in the terminal where the basic changefeed is streaming, the output will appear:

~~~
bar,\000\000\000\000\001\002\002,\000\000\000\000\002\002\002\002
~~~

Note that records may take a couple of seconds to display in the core changefeed.
Note that records may take a couple of seconds to display in the basic changefeed.

1. To stop streaming the changefeed, enter **CTRL+C** into the terminal where the changefeed is running.

Expand Down
8 changes: 4 additions & 4 deletions src/current/_includes/v23.1/cdc/create-core-changefeed.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
In this example, you'll set up a core changefeed for a single-node cluster.
In this example, you'll set up a basic changefeed for a single-node cluster.

1. In a terminal window, start `cockroach`:

Expand Down Expand Up @@ -44,7 +44,7 @@ In this example, you'll set up a core changefeed for a single-node cluster.
> INSERT INTO foo VALUES (0);
~~~

1. Start the core changefeed:
1. Start the basic changefeed:

{% include_cached copy-clipboard.html %}
~~~ sql
Expand All @@ -62,13 +62,13 @@ In this example, you'll set up a core changefeed for a single-node cluster.
$ cockroach sql --insecure -e "INSERT INTO foo VALUES (1)"
~~~

1. Back in the terminal where the core changefeed is streaming, the following output has appeared:
1. Back in the terminal where the basic changefeed is streaming, the following output has appeared:

~~~
foo,[1],"{""after"": {""a"": 1}}"
~~~

Note that records may take a couple of seconds to display in the core changefeed.
Note that records may take a couple of seconds to display in the basic changefeed.

1. To stop streaming the changefeed, enter **CTRL+C** into the terminal where the changefeed is running.

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/enterprise-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Feature | Description

Feature | Description
--------+-------------------------
Enterprise [`BACKUP`]({% link {{ page.version.version }}/backup.md %}) and restore capabilities | Taking and restoring [incremental backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}), [backups with revision history]({% link {{ page.version.version }}/take-backups-with-revision-history-and-restore-from-a-point-in-time.md %}), [locality-aware backups](take-and-restore-locality-aware-backups.html), and [encrypted backups](take-and-restore-encrypted-backups.html) require an Enterprise license. [Full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}) do not require an Enterprise license.
[`BACKUP`]({% link {{ page.version.version }}/backup.md %}) and restore capabilities | Taking and restoring [full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}), [incremental backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}), [backups with revision history]({% link {{ page.version.version }}/take-backups-with-revision-history-and-restore-from-a-point-in-time.md %}), [locality-aware backups](take-and-restore-locality-aware-backups.html), and [encrypted backups](take-and-restore-encrypted-backups.html).
[Changefeeds into a Configurable Sink]({% link {{ page.version.version }}/create-changefeed.md %}) | For every change in a configurable allowlist of tables, configure a changefeed to emit a record to a configurable sink: Apache Kafka, cloud storage, Google Cloud Pub/Sub, or a webhook sink. These records can be processed by downstream systems for reporting, caching, or full-text indexing.
[Change Data Capture Queries]({% link {{ page.version.version }}/cdc-queries.md %}) | Use `SELECT` queries to filter and modify change data before sending it to a changefeed's sink.

Expand Down
Loading

0 comments on commit 0dbe86c

Please sign in to comment.