Update Licensing FAQs for v24.3 release #19002
Conversation
Files changed:
|
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
❌ Deploy Preview for cockroachdb-docs failed. Why did it fail? →
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify site configuration. |
rmloveland
force-pushed
the
20241010-DOC-11203-update-licensing-faq
branch
from
df3f405
to
836c8ca
Compare
rmloveland
force-pushed
the
20241010-DOC-11203-update-licensing-faq
branch
5 times, most recently
from
846a969
to
e66bbd2
Compare
Addresses: - 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
rmloveland
force-pushed
the
20241010-DOC-11203-update-licensing-faq
branch
from
e66bbd2
to
681e7dc
Compare
|
@jaiayu could use your feedback on basically this whole PR. This is a first step; next I'll plan to add an 'Enterprise Licensing Workflows' page which contains the self-serve license info as well for easier finding / sharing, probably with more info too. Also a 'Telemetry' page. But this at least gets the basic instructions and info written down (I hope) - but please let me know if you see something wrong or missing @spilchen please look at the stuff about throttling and developer single-node clusters and let me know if anything is wrong or missing @dhartunian please look at the changes to the 'DB Console Overview > License expiration message', I've updated it to match the telemetry notices/warnings shown in DB Console based on some screenshots you shared a while back. I'm adding it here so folks can search for the exact strings in docs. Please let me know if the text of the messages has changed. Also i'm open to any other feedback re: stuff that is wrong or missing Thank you! |
|
|
||
| This will only happen in the following cases: | ||
|
|
||
| - The cluster has no [valid license key](#obtain-a-license). |
There was a problem hiding this comment.
Does "valid" simply mean the license doesn't exist? Throttling can also occur if you're operating with an expired license beyond the grace period:
- Free: throttles 30 days after expiration
- Trial: throttles 7 days after expiration
- None: throttles 7 days after cluster initialization
- Enterprise: never throttles
There was a problem hiding this comment.
thanks for laying this out explicitly, i have updated this section a bit to try to add the info and hopefully make things clearer - please let me know what you think
This will only happen in the following cases:
- The cluster is not following telemetry requirements.
- There is a 7 day grace period for new Enterprise Free and Enterprise Trial clusters to start sending telemetry.
- The cluster has an expired license key; depending on the type of expired license, the cluster will be throttled after the following time periods:
- Enterprise: Never throttles
- Enterprise Free: Throttles 30 days after expiration
- Enterprise Trial: Throttles 7 days after expiration
- No license: Throttles 7 days after cluster initialization
|
|
||
| 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 |
There was a problem hiding this comment.
We left out any mention of evaluation licenses. Was that intentional?
There was a problem hiding this comment.
what are "evaluation licenses" - is that something different than the self-serve Enterprise Trial license? perhaps something that is handed out directly by sales? I'm not seeing the text "evaluation" or "evaluation license" in the product brief
There was a problem hiding this comment.
The evaluation license type existed previously (see 1.1.3 in the product brief). My understanding is that they are used for POCs.
There was a problem hiding this comment.
thanks @spilchen for the catch, i just reviewed that list again, it seems we are missing multiple items from that list, my bad
@jaiayu do you want me to replicate here all of the license types from the product brief? specifically, it looks like we're missing:
- Evaluation
- Development
- Pre-production
Or is it our preference that those license types are described and managed via interactions with a Sales process vs. being described in the public user documentation?
I'm asking because up until now we have not listed out such licenses - current FAQ says there is:
- Apache
- BSL
- CCL
And doesn't talk about dev, eval etc licenses.
Presumably dev, eval, etc. licenses also existed under the previous regime, but we never documented them before
Happy to do it now if you want, please let me know
There was a problem hiding this comment.
DB Console text LGTM.
We will enforce the sending of telemetry within the DB if the customer has a Free/Trial license (they can't disable via the cluster setting), so if they get a telemetry send error, it will be due to a firewall configuration or a network issue. Is it worth mentioning that somewhere?
| -------------|------------ | ||
| **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]). |
There was a problem hiding this comment.
@spilchen and @dhartunian - elsewhere you each commented that Enterprise Trial clusters must send telemetry - i also just reviewed the product brief - not sure why I wrote this "(with negotiated exceptions)" clause but I'm removing it FYI
yayyy thanks
I added a line to reference this in the 'Types of Licenses' section, PTAL
|
Addresses:
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
Rendered previews:
NB. These changes only apply to v24.3 docs right now, but once reviewed and approved, these changes will also be backported to v23.1+ docs and sit on a branch awaiting the relevant point releases of those versions in November.