From f78968138c18cfaed5520eb9e25fa8c9d578e4fa Mon Sep 17 00:00:00 2001 From: Petri-Johan Last Date: Wed, 14 Feb 2024 09:29:10 +0200 Subject: [PATCH] Update license management page to reflect the upcoming 5.3 changes (#8536) Updates to the license key management page to reflect changes after 5.3 Licensing plans are a lot more simplified after 5.3, and we'd like the docs to reflect this as well, so as part of this we're removing all the "Legacy" parts of the docs here, as they make things seem a lot more complicated than they need to be. --------- Co-authored-by: Erik Seliger Co-authored-by: amenne --- .../ce/process/license_keys.md | 165 ++---------------- 1 file changed, 18 insertions(+), 147 deletions(-) diff --git a/content/departments/technical-success/ce/process/license_keys.md b/content/departments/technical-success/ce/process/license_keys.md index 62fc217a5ca6..199265d7f291 100644 --- a/content/departments/technical-success/ce/process/license_keys.md +++ b/content/departments/technical-success/ce/process/license_keys.md @@ -6,7 +6,7 @@ This page explains how to create and maintain license keys for prospects and cus - [Accessing Site Admin](#accessing-site-admin) - [License Key Mechanics](#license-key-mechanics) - [Plans](#plans) - - [License Key Tags](#feature-tags) + - [Additional Options](#additional-options) - [License Management Processes](#license-management-processes) - [Prospective Customer Trials](#prospective-customer-trials) - [Handling multiple instances for a single customer](#multiple-customer-instances) @@ -61,174 +61,45 @@ Below is an overview of the **current supported plans** and included features: - - - - + + - - - - - - - - - -
Plan NamePlan Tag Included Features
Enterpriseenterprise-1 ACLs (background permissions syncing), Explicit Permissions API (API access for setting repo permissions), SSO (allow non-builtin auth to be used), Private Repositories, SCIM (user management), Batch Changes (unlimited changesets), Code Monitors, NotebooksCode Search EnterpriseCode Search, Batch Changes, Code Insights, Monitoring, Notebooks
Enterprise (Airgapped)enterprise-air-gap-0 Includes all of the same features as Enterprise-1 above but allows explicit ability to operate offline. Advanced approval required!
Freefree-1 For new Free plan (from 4.5 onwards). We should not generate licenses with this plan. This is simply a fallback method.
- -You can read more about legacy plans [below](#legacy-plans). - -#### Feature Tags - -As mentioned above our plans include a standard feature-set; however, you may need to manually add tags to include additional features. This sections provides an overview of current feature tags. - - - - - - - - - - - - - - - - + + - - - - - - - - - - - - - - - - - - - - - - - + +
FeatureTagDescription
Hard cap Hard cap is our default; no tag is required. This means the user limit is a hard, capped limit.
Soft Captrue-up Allows the customer to go over their user limit on the license (soft cap). When this tag appears on a license key, it overrides the default hard cap behavior and allows user counts to exceed the license.Cody EnterpriseCody
MAU Planmau For companies on a monthly usage-based billing model. NOTE: For any MAU-based customers, the `true-up` tag must also be added as we do not have the ability to hard-cap MAU-based plans.
Trialtrial Indicates that this license key is for a trial instance.
Development Environmentdev Indicates that this license key is for a lower-level development environment. Does not affect contractual agreement; however, as a best practice, limit the seat count to 20 users.
QA Environmentqa Indicates that this license key is for a lower-level QA environment. Does not affect contractual agreement; however, as a best practice, limit the seat count to 20 users.
Internal Environmentinternal Indicates that this license key is used for internal sites (dotcom, k8s, etc.) within SourcegraphCode Intelligence PlatformCody, Code Search, Batch Changes, Code Insights, Monitoring, Notebooks
-You can read more about legacy feature tags [below](#legacy-feature-tags). - -#### Legacy Plans +#### Additional Options -You may come across legacy licenses associated to legacy plans. Previously no-longer-used, legacy plans you may encounter are: +Apart from the plan, there are a few additional options that can be added to a license key, depending on the license type. - - - - - - - - + + - - - + + - - - + + - - - - - - - - - - - - - - - - - - + +
Plan NamePlan TagIncluded Features
Enterprise Starter (legacy)old-starter-0 This is a legacy tag that was used for "Enterprise Starter" plans.OptionDescription
Enterprise (legacy)old-enterprise-0 This is a legacy tag that was used for Enterprise plans.TrueUpAllows the instance to go over the user hard cap and be billed based on monthly usage
Team (legacy)team-0 Until 4.0 this was used for customers on a deprecated Team plan. Allow air gappedAllows offline usage of Sourcegraph with no remote license key validation and telemetry off
Enterprise (legacy)enterprise-0 Until 4.0 used for our legacy Enterprise pricing plan; required each feature to be tagged separately.
Business (legacy)business-0 In our 4.0 release this was used for a legacy business plan that's no longer active.
Enterprise Extension (legacy)enterprise-extension In 4.4.2 release some customers required an extended trial. This was used for those situations but is no longer active.
Free (legacy)free-0 For legacy Free plan (until 4.5) customers, for which we need to generate a license to keep them using the existing feature set Allow disable telemetry exportDisables telemetry events export EXCEPT for Cody-related events, which we are always allowed to export as part of our Cody usage terms. To completely disable telemetry, allow air gapped usage
-#### Legacy feature tags - -Below are old, legacy feature tags that you may encounter. These are now handled at the plan level. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Legacy FeatureLegacy TagDescription
Airgapped allow-air-gapped For licenses where periodic license verification is not required and pings are not sent back to sourcegraph.com. This is essential for customers that run Sourcegraph in an air-gapped environment without an external internet connection. NOTE: This is included in the `enterprise-air-gap-0` plan. , this tag is not required as it is included in the plan. Prefer selecting the `enterprise-air-gap-0` plan instead of adding the tag.
PLG Cloud Trial plg-trial Previously we allowed users to sign up for a free trial of Sourcegraph via signup.sourcegraph.com. This is deprecated.
MonitoringmonitoringAdded support for running Grafana monitoring. **DEPRECATED as of Sourcegraph 5.0**
ACLSacls For background permissions syncing from the code host (now included on plans by default).
Batch Changesbatch-changes For unlimited access to the batch changes (now included on plans by default).
Code Insightscode-insights For unlimited access to the code insights (now included on plans by default).
Private Extension Registryprivate-extension-registry Allows for a private Extension registry (now included on plans by default).
Remote Extensionsremote-extensions-allow-disallow Allows the admin to enable / disable remote extensions (now included on plans by default).
- ## License Management Processes ### Prospective Customer Trials @@ -283,7 +154,7 @@ To revoke an active license, follow these steps: The next time the customer's instance performs a license verification check, the verification will fail and the customer's Enterprise features will be disabled. -> [!NOTE] This will not work on special licenses with the `enterprise-air-gap-0` plan, as these licenses do not execute verification checks. +> [!NOTE] This will not work on special licenses with the `allow-air-gapped` tag, as these licenses do not execute verification checks. ## License Policies