1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-02-09 00:18:00 +01:00

docs: Updated and formatted license docs. (#7349)

The license keys are no longer in beta as of v6.
This commit is contained in:
Alvin Bryan 2024-06-11 09:55:07 +01:00 committed by GitHub
parent 44ca447fd2
commit a602768c57
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1,12 +1,12 @@
--- ---
title: License Keys for Unleash Enterprise (BETA) title: License Keys for Unleash Enterprise
--- ---
import VideoContent from '@site/src/components/VideoContent.jsx' import VideoContent from "@site/src/components/VideoContent.jsx";
This document describes all aspects and workflows of license key management in Unleash 5.8 and above. This document describes all aspects and workflows of license key management in Unleash, available from 5.8 and required for self-hosted enterprise plans from v6.0 onwards.
Note that this is beta functionality and as such, these steps should only be followed under the direction of Unleash Customer Success.
*For questions, please reach out to Unleash Customer Success using the [linked address](mailto:customersuccess@getunleash.io)* _For questions, please reach out to Unleash Customer Success using the [linked address](mailto:customersuccess@getunleash.io)_.
:::info Warning :::info Warning
@ -14,6 +14,7 @@ License key management applies only to **self-hosted, Enterprise** versions of U
- For **Unleash hosted** (Pro/Enterprise), license management is not necessary and is handled automatically. - For **Unleash hosted** (Pro/Enterprise), license management is not necessary and is handled automatically.
- For **Unleash Open Source**, no license is necessary and these steps do not apply. - For **Unleash Open Source**, no license is necessary and these steps do not apply.
::: :::
Areas of license key management that will be covered include: Areas of license key management that will be covered include:
@ -27,7 +28,8 @@ Areas of license key management that will be covered include:
- [Admin UI](#admin-ui) - [Admin UI](#admin-ui)
- [Environment Variable](#environment-variable) - [Environment Variable](#environment-variable)
*** ---
## License policy ## License policy
License keys are leveraged for self-hosted Unleash Enterprise instance(s) to be compliant with the following aspects of a customer agreement: License keys are leveraged for self-hosted Unleash Enterprise instance(s) to be compliant with the following aspects of a customer agreement:
@ -43,72 +45,75 @@ Separate license keys are required per Unleash instance, for example, a dev or p
Reusing Unleash keys across multiple installations is prohibited under the terms of your license. Reusing Unleash keys across multiple installations is prohibited under the terms of your license.
::: :::
### Enforcement ### Enforcement
The Unleash UI will display banners in any of the following non-compliant scenarios: The Unleash UI will display banners in any of the following non-compliant scenarios:
- **No installed/missing license key** - **No installed/missing license key**
![Banner showing a missing license](/img/license-banner-missing.png) ![Banner showing a missing license](/img/license-banner-missing.png)
- **Expired license key** - **Expired license key**
![Banner showing an expired license](/img/license-banner-expired.png) ![Banner showing an expired license](/img/license-banner-expired.png)
- **Enroled user count higher than the number of seats supported by the license** - **Enroled user count higher than the number of seats supported by the license**
![Banner showing a high user count](/img/license-banner-highuser.png) ![Banner showing a high user count](/img/license-banner-highuser.png)
***
---
## Obtaining a new or updated license ## Obtaining a new or updated license
### New Customers ### New Customers
If you are a new customer, your account representative will provide required license key(s) as part of your self-hosted instance onboarding. If you are a new customer, your account representative will provide the required license key(s) as part of your self-hosted instance onboarding.
### Existing Customers ### Existing Customers
If you are an existing customer and are making changes to your agreement (changing seat count or the contract expiration), your account representative can be contacted to obtain required license key(s). If you are an existing customer and are making changes to your agreement (changing seat count or the contract expiration), your account representative can be contacted to obtain the required license key(s).
Alternatively, reach out to sales@getunleash.io Alternatively, reach out to sales@getunleash.io
*** ---
## Installing a new or replacing an existing license ## Installing a new or replacing an existing license
Once you have a new or changed key, two methods are available to install a license on an enterprise self-hosted instance: Once you have a new or changed key, two methods are available to install a license on an enterprise self-hosted instance:
1) Through the [**admin UI**](#admin-ui), logged in as an admin privileged user 1. Through the [**admin UI**](#admin-ui), logged in as an admin privileged user
2) Specifying a [**environment variable**](#environment-variable) upon container deployment 2. Specifying a [**environment variable**](#environment-variable) upon container deployment
The process is the same whether you are licensing your self-hosted instance for the first time. The process is the same whether you are licensing your self-hosted instance for the first time.
:::note :::note
After updating a license key, a manual browser refresh may be required for any displayed licensing related banners to be removed from your session. After updating a license key, a manual browser refresh may be required for any displayed licensing related banners to be removed from your session.
::: :::
***
---
### Admin UI ### Admin UI
:::info :::info
This area of the UI can also be used to verify the currently installed key details This area of the UI can also be used to verify the currently installed key details
::: :::
1) Log in to the Unleash UI as an admin privileged user 1. Log in to the Unleash UI as an admin privileged user
2) Navigate to the *admin menu (gear icon) -> License* 2. Navigate to the _admin menu (gear icon) -> License_
3) If a key is already installed, the following details will be shown: 3. If a key is already installed, the following details will be shown:
- Customer name - Customer name
- Plan - Plan
- Seat count - Seat count
- License expiration date - License expiration date
4) Paste the new license key and click *Update license key* 4. Paste the new license key and click _Update license key_
![License overview screen](/img/license-overview.png) ![License overview screen](/img/license-overview.png)
***
---
### Environment Variable ### Environment Variable
License key installation or update through an environment variable on container deployment is also possible, using the format `UNLEASH_LICENSE`. License key installation or update through an environment variable on container deployment is also possible, using the format `UNLEASH_LICENSE`.
For security, if using [helm charts](https://github.com/Unleash/helm-charts) or docker compose to deploy Unleash, a best practice would be to setup the license key as a secret and reference it in the helm configuration [values.yaml](https://github.com/Unleash/helm-charts/blob/main/charts/unleash/values.yaml) or [docker-compose.yml](https://github.com/Unleash/unleash/blob/main/docker-compose.yml). For security, if using [helm charts](https://github.com/Unleash/helm-charts) or docker compose to deploy Unleash, a best practice would be to setup the license key as a secret and reference it in the helm configuration [values.yaml](https://github.com/Unleash/helm-charts/blob/main/charts/unleash/values.yaml) or [docker-compose.yml](https://github.com/Unleash/unleash/blob/main/docker-compose.yml).
:::info :::info
The default image references in the Helm chart point to open-source Unleash resources. To use Unleash Enterprise, you must manually update the image references to point to the appropriate *unleash-enterprise* images The default image references in the Helm chart point to open-source Unleash resources. To use Unleash Enterprise, you must manually update the image references to point to the appropriate _unleash-enterprise_ images
::: :::