-
Notifications
You must be signed in to change notification settings - Fork 459
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update Licensing FAQs for v24.3 release
Fixes: - DOC-11203 - DOC-11048 - DOC-11049 Summary of changes: - Update 'Licensing FAQs' with the following: - Information about the new licensing tiers - Instructions for self-serve Enterprise Trial and Enterprise Free licenses in Cloud Console - Updated information about how to monitor for license expiry in DB Console (with a link to updated UI docs that include the exact messages) - A description of what throttling is and how it works - A note that single-node developer clusters do not require a license key - Update 'DB Console Overview > License expiration message' with the specific messages that may be emitted by Console depending on the status of the cluster's license - XXX: UPDATE CLOUD CONSOLE DOCS WITH THE MESSAGES, AND CONFIRM IF THE MESSAGES DO IN FACT APPEAR IN DB CONSOLE AS WELL?
- Loading branch information
1 parent
fa250b4
commit 846a969
Showing
9 changed files
with
178 additions
and
220 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
Depending on the status of your cluster's [license]({% link {{ page.version.version }}/licensing-faqs.md %}), the following messages may be displayed in the DB Console: | ||
|
||
- If the license will expire soon, the message is: _This cluster will require a license key by ${DATE} or the cluster will be throttled._ | ||
- If the license is no longer valid, the message is: _Your license key expired on ${DATE} and the cluster was throttled. Please add a license key to continue using this cluster._ | ||
- If the cluster is required to send telemetry but has not been sending it, the message is: _Telemetry has not been received from some nodes in this cluster since ${DATE}. These nodes will be throttled on ${DATE} unless telemetry is received._ | ||
|
||
For instructions on how to obtain and set a license, see [Obtain a license]({% link {{ page.version.version }}/licensing-faqs.md %}#obtain-a-license). | ||
|
||
For more information about throttling and telemetry, see [What is throttling and how does it work?]({% link {{ page.version.version }}/licensing-faqs.md %}#throttling) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,153 @@ | ||
CockroachDB is made available under the [CockroachDB Software License][csl]. | ||
|
||
## Types of licenses | ||
|
||
The table of licenses below refers to options for {{ site.data.products.core }} deployments. All {{ site.data.products.cloud }} deployments automatically have a valid **Enterprise** license. | ||
|
||
Type | Description | ||
-------------|------------ | ||
**Enterprise** <a name="enterprise"></a> | This paid license allows usage of all CockroachDB features with no restrictions under the terms specified in the [CockroachDB Software License][csl]. License must be renewed annually or as negotiated. Support levels available include [Enterprise][support] or [Essential][support]. | ||
**Enterprise Free** <a name="enterprise-free"></a> | Same functionality as **Enterprise**, but free of charge for businesses with less than $10M in annual revenue, and telemetry is required except for ephemeral clusters (7 days or less). Clusters will be [throttled](#throttling) after 7 days without sending telemetry. License must be renewed annually. Support level available is Community (i.e., [Docs]({% link {{ page.version.version }}/index.md %}), [Forum][forum], [Slack][slack]). | ||
**Enterprise Trial** <a name="enterprise-trial"></a> | A 30 day self-service trial license. Telemetry is required during the trial (with negotiated exceptions). Telemetry can be disabled once the cluster is upgraded to a paid **Enterprise** license. Support level available during trials is Community (i.e., [Docs]({% link {{ page.version.version }}/index.md %}), [Forum][forum], [Slack][slack]). | ||
|
||
{{site.data.alerts.callout_success}} | ||
Note that no license key is required for developers running [single-node clusters](#single-node-clusters). | ||
{{site.data.alerts.end}} | ||
|
||
## Obtain a license | ||
|
||
To obtain a paid **Enterprise** license, <a href="mailto:[email protected]">contact Sales</a>. | ||
|
||
To obtain an **Enterprise Free** or **Enterprise Trial** license, take the following steps: | ||
|
||
1. Point your web browser to the [CockroachDB {{ site.data.products.cloud }} Console](https://cockroachlabs.cloud) and [log in]({% link cockroachcloud/authentication.md %}#console-ui-authentication). | ||
1. Select **Organization » Enterprise Licenses** from the nav bar dropdown. This will bring you to the **Enterprise Licenses** page, which shows a (possibly empty) list of licenses and their keys, with information about the status of each. | ||
1. Click the **Create License** button. This will bring you to a page called **Get started with CockroachDB Enterprise**. | ||
1. On this page, you will create an **Enterprise Trial** license or an **Enterprise Free** license. | ||
1. To create an **Enterprise Trial** license: | ||
1. Fill in the form with the required information. | ||
1. Click the **Continue** button. | ||
1. Select the checkbox to agree to the Terms & Conditions of the [CockroachDB Software License][csl]. | ||
1. Click the **Generate License Key** button. You will be redirected to the **Enterprise Licenses** page, where you can [start using the key](#set-a-license). | ||
1. To create an **Enterprise Free** license: | ||
1. Fill in the form with the required information. | ||
1. Toggle the switch called **Find out if my company qualifies for an Enterprise Free license**. *By toggling this switch you are legally attesting to the fact that your company revenue meets the requirements of the license*. | ||
1. Click the **Continue** button. | ||
1. Select the checkbox to agree to the Terms & Conditions of the [CockroachDB Software License][csl]. | ||
1. Click the **Generate License Key** button. You will be redirected to the **Enterprise Licenses** page, where you can [start using the key](#set-a-license). | ||
|
||
{{site.data.alerts.callout_danger}} | ||
You will not be able to create more than one **Enterprise Trial** license per day. If you try, the UI will prevent you from proceeding, and the following message will be displayed: | ||
|
||
> A new Enterprise Trial license cannot be created at this time because one was recently created. Tell us more about your intended use to find out if you qualify for an Enterprise Free license, or create a new one after October 16, 2024 at 10:49 AM EDT. | ||
{{site.data.alerts.end}} | ||
|
||
{{site.data.alerts.callout_success}} | ||
For quick local testing of Enterprise features, you can [run a single-node cluster](#single-node-clusters). | ||
{{site.data.alerts.end}} | ||
|
||
## Set a license | ||
|
||
{% include common/set-enterprise-license.md %} | ||
|
||
## Verify a license | ||
|
||
To verify a license, open the [built-in SQL shell]({% link {{ page.version.version }}/cockroach-sql.md %}) and use the [`SHOW CLUSTER SETTING`]({% link {{ page.version.version }}/show-cluster-setting.md %}) command to check the organization name and license key: | ||
|
||
{% include_cached copy-clipboard.html %} | ||
~~~ sql | ||
> SHOW CLUSTER SETTING cluster.organization; | ||
~~~ | ||
~~~ | ||
cluster.organization | ||
+----------------------+ | ||
Acme Company | ||
(1 row) | ||
~~~ | ||
|
||
{% include_cached copy-clipboard.html %} | ||
~~~ sql | ||
> SHOW CLUSTER SETTING enterprise.license; | ||
~~~ | ||
~~~ | ||
enterprise.license | ||
+-------------------------------------------+ | ||
crl-0-ChB1x... | ||
(1 row) | ||
~~~ | ||
|
||
The license setting is also logged in the cockroach.log on the node where the command is run: | ||
|
||
{% include_cached copy-clipboard.html %} | ||
~~~ sql | ||
$ cat cockroach.log | grep license | ||
~~~ | ||
~~~ | ||
I171116 18:11:48.279604 1514 sql/event_log.go:102 [client=[::1]:56357,user=root,n1] Event: "set_cluster_setting", target: 0, info: {SettingName:enterprise.license Value:xxxxxxxxxxxx User:root} | ||
~~~ | ||
|
||
## Monitor for license expiry | ||
|
||
You can monitor the time until your license expires in the following ways: | ||
|
||
1. [Prometheus]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}): The `seconds_until_enterprise_license_expiry` metric reports the number of seconds until the license on a cluster expires. It will report `0` if there is no license, and a negative number if the license has already expired. For more information, see [Monitoring and Alerting]({% link {{ page.version.version }}/monitoring-and-alerting.md %}). | ||
1. [DB console]({% link {{ page.version.version }}/ui-overview.md %}): Several [license expiration messages]({% link {{ page.version.version }}/ui-overview.md %}#license-expiration-message) may be displayed, depending on the status of your cluster's license. | ||
|
||
## Renew an expired license | ||
|
||
To renew an expired **Enterprise** license, <a href="mailto:[email protected]">contact Sales</a> and then [set](#set-a-license) the new license. | ||
|
||
To renew an expired **Enterprise Free** license, follow the steps in [Obtain a license](#obtain-a-license). | ||
|
||
## FAQs | ||
|
||
### Can I host CockroachDB as a service for internal use at my organization? | ||
|
||
Yes, employees and contractors can use your internal CockroachDB instance as a service, but no people outside of your organization will be able to use it without purchasing a license. Use of Enterprise features will always require a license. | ||
|
||
### What constitutes hosting CockroachDB as a service? | ||
|
||
Hosting CockroachDB as a service means creating an offering that allows third parties (other than your employees and contractors) to operate a database. Specifically, third parties cannot modify table schemas. | ||
|
||
<a name="throttling"></a> | ||
|
||
### What is throttling and how does it work? | ||
|
||
When a cluster is being throttled, the number of concurrent open [SQL transactions]({% link {{ page.version.version }}/transactions.md %}) limited to 5. | ||
|
||
This will only happen in the following cases: | ||
|
||
- The cluster has no [valid license key](#obtain-a-license). | ||
- The cluster is not following telemetry requirements. | ||
|
||
There is a 7 day grace period for new **Enterprise Free** clusters to start sending telemetry. | ||
|
||
Single node clusters for development use are [not throttled](#single-node-clusters). | ||
|
||
### Can I use CockroachDB for academic research? | ||
|
||
Cockroach Labs encourages non-commercial academic research involving CockroachDB. For such projects, please [contact us][support] to discuss a possible licensing arrangement. | ||
|
||
<a name="single-node-clusters"></a> | ||
|
||
### Do I need a license key for running a single node cluster? | ||
|
||
No license key is required for developers running [single-node clusters]({% link {{ page.version.version }}/cockroach-start-single-node.md %}) using the following [`cockroach` commands]({% link {{ page.version.version }}/cockroach-commands.md %}): | ||
|
||
- [`cockroach start-single-node`]({% link {{ page.version.version }}/cockroach-start-single-node.md %}) | ||
- [`cockroach demo`]({% link {{ page.version.version }}/cockroach-demo.md %}) | ||
|
||
Single node clusters are not [throttled](#throttling). | ||
|
||
## See also | ||
|
||
- [CockroachDB Software License][csl] | ||
- [Enterprise support][support] | ||
- <a href="mailto:[email protected]">Contact Sales</a> | ||
|
||
<!-- Reference Links --> | ||
|
||
[csl]: https://www.cockroachlabs.com/cockroachdb-software-license | ||
[support]: https://www.cockroachlabs.com/support | ||
[forum]: https://forum.cockroachlabs.com | ||
[slack]: https://www.cockroachlabs.com/join-community |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
Start the [`cockroach sql` shell]({% link {{ page.version.version }}/cockroach-sql.md %}). As the [`root` user]({% link {{ page.version.version }}/security-reference/authorization.md %}#root-user), use the [`SET CLUSTER SETTING`]({% link {{ page.version.version }}/set-cluster-setting.md %}) statement to set the name of your organization and the license key: | ||
|
||
{% include_cached copy-clipboard.html %} | ||
~~~ sql | ||
> SET CLUSTER SETTING cluster.organization = 'Acme Company'; | ||
~~~ | ||
|
||
{% include_cached copy-clipboard.html %} | ||
~~~ sql | ||
> SET CLUSTER SETTING enterprise.license = 'xxxxxxxxxxxx'; | ||
~~~ |
16 changes: 0 additions & 16 deletions
16
src/current/_includes/v24.3/misc/set-enterprise-license.md
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.