Skip to content

Commit

Permalink
Remove most mentions of Core license from docs (#19001)
Browse files Browse the repository at this point in the history
* Remove most mentions of Core license from docs

Addresses DOC-10665

Summary of changes:

- Review and remove all mentions of Core license from docs, with the
  following exceptions (which will be later work):

  - Licensing FAQs page, which will be updated via DOC-11203

  - Mentions of Core Changefeeds, about which the method of removal from
    docs is TBD

PS As part of the review process on this PR, we also removed lots of "This is an 'Enterprise feature'" language since ~everything is now an Enterprise feature.
  • Loading branch information
rmloveland authored Oct 17, 2024
1 parent b88a7d8 commit 5df409b
Show file tree
Hide file tree
Showing 63 changed files with 97 additions and 273 deletions.
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.3/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.3/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
6 changes: 0 additions & 6 deletions src/current/v24.3/alter-backup-schedule.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,6 @@ toc: true
docs_area: reference.sql
---

{{site.data.alerts.callout_info}}
Core users can only use backup scheduling for [full backups]({% link {{ page.version.version }}/create-schedule-for-backup.md %}#create-a-schedule-for-full-backups-only-core) of clusters, databases, or tables. If you do not specify the `FULL BACKUP ALWAYS` clause when you schedule a backup, you will receive a warning that the schedule will only run full backups.

To use the other backup features, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}).
{{site.data.alerts.end}}

The `ALTER BACKUP SCHEDULE` statement modifies an existing [backup schedule]({% link {{ page.version.version }}/manage-a-backup-schedule.md %}). You can use `ALTER BACKUP SCHEDULE` to do the following:

- Set a different name for a backup schedule.
Expand Down
20 changes: 10 additions & 10 deletions src/current/v24.3/alter-database.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,21 +33,21 @@ Additional parameters are documented for the respective [subcommands](#subcomman

Subcommand | Description
-----------|------------
[`ADD REGION`](#add-region) | Add a region to a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).)
[`ADD SUPER REGION`](#add-super-region) | Add a super region made up of a set of [database regions]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions) such that data from [regional tables]({% link {{ page.version.version }}/regional-tables.md %}) will be stored in only those regions. ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).)
[`ADD REGION`](#add-region) | Add a region to a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}).
[`ADD SUPER REGION`](#add-super-region) | Add a super region made up of a set of [database regions]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions) such that data from [regional tables]({% link {{ page.version.version }}/regional-tables.md %}) will be stored in only those regions.
[`ALTER LOCALITY`](#alter-locality) | Persistently modify the configuration generated by the standard [multi-region SQL abstractions]({% link {{ page.version.version }}/multiregion-overview.md %}) on a per-region basis. For advanced users who want to customize their multi-region setup using [Zone Config Extensions]({% link {{ page.version.version }}/zone-config-extensions.md %}), a persistent, composable alternative to low-level [zone configs]({% link {{ page.version.version }}/configure-replication-zones.md %}).
[`ALTER SUPER REGION`](#alter-super-region) | Alter an existing [super region]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions) to include a different set of regions. A super region is made up of a set of regions added with [`ADD REGION`](#add-region) such that data from [regional tables]({% link {{ page.version.version }}/regional-tables.md %}) will be stored in only those regions. ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).)
[`ALTER SUPER REGION`](#alter-super-region) | Alter an existing [super region]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions) to include a different set of regions. A super region is made up of a set of regions added with [`ADD REGION`](#add-region) such that data from [regional tables]({% link {{ page.version.version }}/regional-tables.md %}) will be stored in only those regions.
[`CONFIGURE ZONE`](#configure-zone) | [Replication Controls]({% link {{ page.version.version }}/configure-replication-zones.md %}) for a database.
[`DROP REGION`](#drop-region) | Drop a region from a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).)
[`DROP SECONDARY REGION`](#drop-secondary-region) | Drop a [secondary region]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) from a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).)
[`DROP SUPER REGION`](#drop-super-region) | Drop a super region made up of a set of [database regions]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions). ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).)
[`DROP REGION`](#drop-region) | Drop a region from a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}).
[`DROP SECONDARY REGION`](#drop-secondary-region) | Drop a [secondary region]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) from a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}).
[`DROP SUPER REGION`](#drop-super-region) | Drop a super region made up of a set of [database regions]({% link {{ page.version.version }}/multiregion-overview.md %}#super-regions).
[`OWNER TO`](#owner-to) | Change the owner of a database.
[`PLACEMENT`](#placement) | Configure the replica placement policy for a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}).
[`RENAME TO`](#rename-to) | Change the name of a database.
[`RESET {session variable}`](#reset-session-variable) | Reset the session variable values for the database to the system defaults. This syntax is identical to [`ALTER ROLE ALL IN DATABASE ... RESET {session variable}`]({% link {{ page.version.version }}/alter-role.md %}).
[`SET {session variable}`](#set-session-variable) | Set the default session variable values for the database. This syntax is identical to [`ALTER ROLE ALL IN DATABASE ... SET {session variable}`]({% link {{ page.version.version }}/alter-role.md %}).
[`SET PRIMARY REGION`](#set-primary-region) | Set the primary region of a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).)
[`SET SECONDARY REGION`](#set-secondary-region) | Set the [secondary region of a multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) for failover purposes. ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).)
[`SET PRIMARY REGION`](#set-primary-region) | Set the primary region of a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}).
[`SET SECONDARY REGION`](#set-secondary-region) | Set the [secondary region of a multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) for failover purposes.
[`SURVIVE {ZONE,REGION} FAILURE`](#survive-zone-region-failure) | Add a survival goal to a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}).

### `ADD REGION`
Expand Down Expand Up @@ -282,7 +282,7 @@ For usage, see [Synopsis](#synopsis).

### `PLACEMENT`

`ALTER DATABASE ... PLACEMENT` is used to set the replica placement policy (`DEFAULT` or `RESTRICTED`) for a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %})'s [regional tables]({% link {{ page.version.version }}/regional-tables.md %}). [Regional tables]({% link {{ page.version.version }}/regional-tables.md %}) are those with [`REGIONAL BY ROW`]({% link {{ page.version.version }}/table-localities.md %}#regional-by-row-tables) or [`REGIONAL BY TABLE`]({% link {{ page.version.version }}/table-localities.md %}#regional-tables) localities.
`ALTER DATABASE ... PLACEMENT` is used to set the replica placement policy (`DEFAULT` or `RESTRICTED`) for a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %})'s [regional tables]({% link {{ page.version.version }}/regional-tables.md %}). [Regional tables]({% link {{ page.version.version }}/regional-tables.md %}) are those with [`REGIONAL BY ROW`]({% link {{ page.version.version }}/table-localities.md %}#regional-by-row-tables) or [`REGIONAL BY TABLE`]({% link {{ page.version.version }}/table-localities.md %}#regional-tables) localities.

`ALTER DATABASE ... PLACEMENT RESTRICTED` constrains the voting and non-voting replica placement for the database's tables to the [home regions]({% link {{ page.version.version }}/alter-table.md %}#crdb_region) associated with those tables. This is a way of opting out of [non-voting replicas]({% link {{ page.version.version }}/architecture/replication-layer.md %}#non-voting-replicas) for [regional tables]({% link {{ page.version.version }}/regional-tables.md %}) to accomplish one or more of the following goals:

Expand Down Expand Up @@ -783,7 +783,7 @@ ALTER DATABASE movr ADD REGION "europe-west1";

#### Override specific fields of a schema object's zone configs

In this example we will configure a multi-region [MovR]({% link {{ page.version.version }}/movr.md %}) database to update its [`lease_preferences`]({% link {{ page.version.version }}/configure-replication-zones.md %}#lease_preferences) field.
In this example we will configure a multi-region [MovR]({% link {{ page.version.version }}/movr.md %}) database to update its [`lease_preferences`]({% link {{ page.version.version }}/configure-replication-zones.md %}#lease_preferences) field.

Setting the [primary region](#set-primary-region) to `us-east1` [during the setup steps](#use-zone-config-extensions) added `us-east1` to `lease_preferences`.

Expand Down
4 changes: 2 additions & 2 deletions src/current/v24.3/alter-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ Additional parameters are documented for the respective [subcommands](#subcomman

Subcommand | Description |
-----------|-------------|
[`CONFIGURE ZONE`](#configure-zone) | [Replication Controls]({% link {{ page.version.version }}/configure-replication-zones.md %}) for an index. ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) |
[`PARTITION BY`](#partition-by) | Partition, re-partition, or un-partition an index. ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).)
[`CONFIGURE ZONE`](#configure-zone) | [Replication Controls]({% link {{ page.version.version }}/configure-replication-zones.md %}) for an index. |
[`PARTITION BY`](#partition-by) | Partition, re-partition, or un-partition an index.
[`RENAME TO`](#rename-to) | Change the name of an index.
[`SPLIT AT`](#split-at) | Force a [range split]({% link {{ page.version.version }}/architecture/distribution-layer.md %}#range-splits) at the specified row in the index.
[`UNSPLIT AT`](#unsplit-at) | Remove a range split enforcement in the index.
Expand Down
2 changes: 1 addition & 1 deletion src/current/v24.3/alter-table.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Subcommand | Description | Can combine with other subcommands?
[`DROP CONSTRAINT`](#drop-constraint) | Remove constraints from columns. | Yes
[`EXPERIMENTAL_AUDIT`](#experimental_audit) | Enable per-table audit logs, for security purposes. | Yes
[`OWNER TO`](#owner-to) | Change the owner of the table. | No
[`PARTITION BY`](#partition-by) | Partition, re-partition, or un-partition a table. ([Enterprise-only]({% link {{ page.version.version }}/enterprise-licensing.md %}).) | Yes
[`PARTITION BY`](#partition-by) | Partition, re-partition, or un-partition a table. | Yes
[`RENAME COLUMN`](#rename-column) | Change the names of columns. | Yes
[`RENAME CONSTRAINT`](#rename-constraint) | Change constraints columns. | Yes
[`RENAME TO`](#rename-to) | Change the names of tables. | No
Expand Down
4 changes: 2 additions & 2 deletions src/current/v24.3/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,9 @@ CockroachDB offers the following methods for client authentication:
Enter password:
~~~
- [**Single sign-on authentication to DB Console**]({% link {{ page.version.version }}/sso-db-console.md %}), which is available to [Enterprise users]({% link {{ page.version.version }}/enterprise-licensing.md %}).
- [**Single sign-on authentication to DB Console**]({% link {{ page.version.version }}/sso-db-console.md %}).
- [**GSSAPI authentication**]({% link {{ page.version.version }}/gssapi_authentication.md %}), which is available to [Enterprise users]({% link {{ page.version.version }}/enterprise-licensing.md %}).
- [**GSSAPI authentication**]({% link {{ page.version.version }}/gssapi_authentication.md %}).
### Using `cockroach cert` or `openssl` commands
Expand Down
Loading

0 comments on commit 5df409b

Please sign in to comment.