Skip to content
This repository has been archived by the owner on Jul 2, 2024. It is now read-only.

Commit

Permalink
squash! Prettier
Browse files Browse the repository at this point in the history
  • Loading branch information
amenne authored and actions-user committed Jan 28, 2024
1 parent b5f6fdb commit 58ce4ce
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

This page is a dedicated deep-dive walkthrough for how to create a new license key.


> [!NOTE] CEs should always consult with Sales before creating license keys for prospects (i.e., companies that have not yet officially become customers).
> [!NOTE] Starting with Sourcegraph 5.1+, we require each customer instance to have a unique site_id and license key pair. Each instance should also have it's own subscription created. See [internal licensing FAQ](https://docs.google.com/document/d/1xzlkJd3HXGLzB67N7o-9T1s1YXhc1LeGDdJyKDyqfbI) for more details.
Expand All @@ -11,17 +10,16 @@ This page is a dedicated deep-dive walkthrough for how to create a new license k
The CE should first create a Sourcegraph.com user account for the prospect/customer. Assuming there is not one already. The username of the account should have the following format `CompanyName-UniqueId`. This is format is described below. The email of the account should be left blank. Once that is available, follow the steps below.


1. Sign in to [site admin](license_keys.md#accessing-site-admin).
1. Assuming this is the first time creating a license for this account you must first create a user by navigating to the [users page](https://sourcegraph.com/site-admin/users) and create new user account.
* You can also check for a user already exists by searching for a valid account (the uniqueID should match the Salesforce Account ID).
- You can also check for a user already exists by searching for a valid account (the uniqueID should match the Salesforce Account ID).
1. Creating a new user: we no longer create user-level accounts, instead we create a user for the Account itself. The username of the new user should utilize the following naming convention: `Company_Name-SFDC_Unique_Account_ID`.
* Replace `Company_Name` with the name of the company from Salesforce
* Separate these components with a hyphen: `-`
* The `SFDC_Unique_Account_ID` should be taken from the Unique Account ID field on the Account record in Salesforce.
- Replace `Company_Name` with the name of the company from Salesforce
- Separate these components with a hyphen: `-`
- The `SFDC_Unique_Account_ID` should be taken from the Unique Account ID field on the Account record in Salesforce.
1. Once the user account is created navigate to the [subscriptions page](https://sourcegraph.com/site-admin/dotcom/product/subscriptions).
1. Click **Create product subscription**.
* **Note: You must create a new subscription for each customer instance as well**.
- **Note: You must create a new subscription for each customer instance as well**.
1. Search for the user account that was created above in step 3 and click **Create new subscription**.
1. From the Product Subscription page for that user account, click **Generate new license manually**.
1. Fill out the license details:
Expand All @@ -40,9 +38,9 @@ The CE should first create a Sourcegraph.com user account for the prospect/custo
1. NOTE: if you added the `true-up` tag, the customer **will** be able to exceed this count (soft cap), but administrators will see a warning.
1. NOTE: If this is a license key for a lower-level environment the user count should not exceed 20.
1. Select the license expiration date. For production keys, this needs to match the end date of the contract itself.
1. NOTE: Licenses expire at midnight of the date selected based on _the timezone of the browser where the license is being generated from_. It is important to consider this as depending on the teammate location and the customer location you may need to actually set the expiration date to lag by a day.
1. NOTE: Licenses expire at midnight of the date selected based on _the timezone of the browser where the license is being generated from_. It is important to consider this as depending on the teammate location and the customer location you may need to actually set the expiration date to lag by a day.
1. Click **Generate license**.
1. If the customer should have **Cody Access** once you generate an active license you are now able to toggle on `Access to hosted Cody Services`. Click Enable when the warning shows.
1. Everything should fill in for you; however if you need to modify the rate limit of chat requests per day or code completions per day you can do so by clicking on the pencil icon.
1. Everything should fill in for you; however if you need to modify the rate limit of chat requests per day or code completions per day you can do so by clicking on the pencil icon.
1. Follow our [key sharing policy](license_keys.md#license-key-sharing-policy) for sharing this license key with your prospect or customer. You can link them to the following docs for instructions on where to add the key: [Updating your license key](https://sourcegraph.com/docs/admin/subscriptions#updating-your-license-key)
1. Finally, a new customer, you must map the license key to the Salesforce instance for usage data tracking following [these directions](https://docs.google.com/document/d/12W85VTKLJg2Os74PWADxwOPfpMozB0mUm4Do6fN9dFs/edit?usp=sharing).
1. Finally, a new customer, you must map the license key to the Salesforce instance for usage data tracking following [these directions](https://docs.google.com/document/d/12W85VTKLJg2Os74PWADxwOPfpMozB0mUm4Do6fN9dFs/edit?usp=sharing).
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ License keys can only be generated by site administrators on sourcegraph.com. To
We require a unique license for every discrete instance. Non-production instances are supported but require a separate key (more on this below).

A license is comprised of the following components, we'll go into each more in depth below:

- **User Account**: every license needs associated to a "user account". We create a company-level account for this.
- **Customer**: this auto-populates based on the user account created above.
- **Salesforce Subscription ID**: the ID of the active subscription (if relevant)
Expand Down Expand Up @@ -130,7 +131,6 @@ As mentioned above our plans include a standard feature-set; however, you may ne

You can read more about legacy feature tags [below](#legacy-feature-tags).


#### Legacy Plans

You may come across legacy licenses associated to legacy plans. Previously no-longer-used, legacy plans you may encounter are:
Expand Down Expand Up @@ -178,7 +178,6 @@ You may come across legacy licenses associated to legacy plans. Previously no-lo
</tr>
</table>


#### Legacy feature tags

Below are old, legacy feature tags that you may encounter. These are now handled at the plan level.
Expand Down

0 comments on commit 58ce4ce

Please sign in to comment.