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
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! |
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?
yayyy thanks
I added a line to reference this in the 'Types of Licenses' section, PTAL
|
| @@ -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._ | |||
There was a problem hiding this comment.
I believe this error is only displayed if there is no license key in the first place (not is expiring soon)
There was a problem hiding this comment.
We don't actually display a message when the cluster is expiring soon. We only display the banner alerts when the license has actually expired and the cluster is in a grace period before clusters are throttled:
"Your license key expired on . The cluster will be throttled on unless a new license key is added. Learn more"
There was a problem hiding this comment.
I believe this error is only displayed if there is no license key in the first place (not is expiring soon)
We don't actually display a message when the cluster is expiring soon.
Ah ok, i took these from some UI screenshots that were shared a while back. Makes sense that they got out of date, thanks for the updated info
We only display the banner alerts when the license has actually expired and the cluster is in a grace period before clusters are throttled:
"Your license key expired on . The cluster will be throttled on unless a new license key is added. Learn more"
Ok, updated to the following:
- If your cluster has an invalid license key and the cluster is still in the grace period, the message is: Your license key expired on ${DATE1}. The cluster will be throttled on ${DATE2} unless a new license key is added.
There was a problem hiding this comment.
@jaiayu OK with these changes? OK to resolve this convo?
|
|
||
| - 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._ |
There was a problem hiding this comment.
There is a separate message displayed after the throttling occurs due to telemetry requirements:
"Telemetry has not been received from some nodes in this cluster since . These nodes were throttled on July . Learn more"
There was a problem hiding this comment.
OK, added another bullet and ordered them together as follows:
- If the cluster is required to send telemetry but has not been sending it, and is not yet being throttled, 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.
- If the cluster is required to send telemetry but has not been sending it, and is currently being throttled, the message is: Telemetry has not been received from some nodes in this cluster since ${DATE1}. These nodes were throttled on ${DATE2}.
There was a problem hiding this comment.
@jaiayu ok with the updates i made here to resolve this?
|
@taroface FYI this has completed legal review and is 100% ready for your review i know i have 1000000 things in your queue, but this is the number 1 thing i'd say |
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
28ff22e to
10bcfca
Compare
* 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]>
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.