Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

LM/LC-updates #2129

Merged
merged 3 commits into from
Jun 25, 2023
Merged

LM/LC-updates #2129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6cee6b0
LM/LC-updates
abby-cyber Jun 17, 2023
dcaebdc
new updates&opts
abby-cyber Jun 25, 2023
4a0c748
Update mkdocs.yml
abby-cyber Jun 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 17 additions & 13 deletions docs-2.0/9.about-license/1.license-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,36 +4,40 @@

NebulaGraph licenses are the legal permissions granted by Vesoft Co., Ltd., allowing you to utilize the capabilities of a NebulaGraph Enterprise Edition database and its associated software. You can buy a NebulaGraph license on a cloud marketplace or by contacting Vesoft's sales team. Currently, the only cloud marketplace available is the AWS Marketplace. You can purchase a NebulaGraph license from [NebulaGraph Enterprise (by Node)](https://aws.amazon.com/marketplace/pp/prodview-kvpxjh5b4dfno) on the AWS Marketplace.

After purchasing a NebulaGraph license, you must obtain a [license key](2.license-management-suite/2.license-center.md) by [binding an LMID through the LC](2.license-management-suite/2.license-center.md). Once the license key is obtained, you need to use the [LM](2.license-management-suite/3.license-manager.md) service to load the license key. When starting the NebulaGraph database and associated software, the LM service will check the validity of the license. If the license is valid, then the graph database and associated software will function normally. Otherwise, the graph database and associated software will not be functional.
After purchasing a NebulaGraph license, you must obtain a [license key](#license-key) by [binding an LMID through the LC](2.license-management-suite/2.license-center.md). Once the license key is obtained, you need to use the [LM](2.license-management-suite/3.license-manager.md) service to load the license key. When starting the NebulaGraph Enterprise and associated software, the LM service will check the validity of the license. If the license is valid, then the graph database and associated software will function normally. Otherwise, the graph database and associated software will not be functional.

You can view the license information, including the expiration date, nodes purchased, and license key on the [LC](2.license-management-suite/2.license-center.md) or by using the [LM](2.license-management-suite/3.license-manager.md) client to query the license information via the command line.

## License key

A license key is an encrypted string containing authorization information and serves as the unique credential for you to obtain access to the NebulaGraph Enterprise and its associated software features. There are two forms of License keys: online license keys and offline license keys. For more information, see [License key](2.license-management-suite/2.license-center.md#license-key).

## Licensing process flowchart

![process flow](https://docs-cdn.nebula-graph.com.cn/figures/licensing_flowchart_2023-04-28_10-13-38-en.png)
![process flow](https://docs-cdn.nebula-graph.com.cn/figures/licensing_flowchart_2023-06-16_10-13-38-en.png)

## Licensing process

### Purchasing licenses on cloud marketplaces

1. [Create a contract for the purchase of a NebulaGraph license through a cloud marketplace service](3.purchase-license.md).
2. [Follow the setup account link to set up your LC account](2.license-management-suite/2.license-center.md).
2. [Follow the setup account link to set up your LC account](2.license-management-suite/2.license-center.md#set-up-an-lc-account).
3. Receive email attachments that contain NebulaGraph Edition and LM installation packages.
4. [Check the LMID on your LM](2.license-management-suite/3.license-manager.md).
5. [Bind the LMID on the LC](2.license-management-suite/2.license-center.md).
6. [Generate and load the license key](4.generate-and-load-license-key.md).
7. [Configure the LM address in the NebulaGraph and associated software](2.license-management-suite/3.license-manager.md).
8. Start NebulaGraph and associated software.
4. [View and copy the LMID](2.license-management-suite/3.license-manager.md#view-license-information) on your LM.
5. [Bind the LMID to generate a license key](2.license-management-suite/2.license-center.md#bind-lmid-to-generate-a-license-key) on LC.
6. [Load the license key](2.license-management-suite/3.license-manager.md#load-a-license-key) on LM.
7. [Configure the LM address](2.license-management-suite/3.license-manager.md#configure-lm) in the NebulaGraph and associated software.
8. [Start NebulaGraph](../4.deployment-and-installation/manage-service.md) and associated software.

### Purchasing licenses through Vesoft sales personnel

1. Contact Vesoft's sales personnel to purchase a NebulaGraph license and obtain NebulaGraph and LM installation packages.
2. [Receive an email to set up your LC account](2.license-management-suite/2.license-center.md).
3. [Check the LMID on your LM](2.license-management-suite/3.license-manager.md).
4. [Bind the LMID on LC](2.license-management-suite/2.license-center.md).
5. [Generate and load the license key](4.generate-and-load-license-key.md).
6. [Configure the LM address in NebulaGraph and associated software](2.license-management-suite/3.license-manager.md).
7. Start NebulaGraph and associated software.
4. [View and copy the LMID](2.license-management-suite/3.license-manager.md#view-license-information) on your LM.
5. [Bind the LMID to generate a license key](2.license-management-suite/2.license-center.md#bind-lmid-to-generate-a-license-key) on LC.
6. [Load the license key](2.license-management-suite/3.license-manager.md#load-a-license-key) on LM.
7. [Configure the LM address](2.license-management-suite/3.license-manager.md#configure-lm) in the NebulaGraph and associated software.
8. [Start NebulaGraph](../4.deployment-and-installation/manage-service.md) and associated software.



Expand Down
82 changes: 57 additions & 25 deletions docs-2.0/9.about-license/2.license-management-suite/2.license-center.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,32 @@

License Center (LC) provided by Vesoft is an online platform for managing licenses that is accessible through public networks. On the LC platform, you can track all your purchased license information, including details such as license type, number of purchased resources, the status of the license, and expiration date.

On LC, you can bind an [LMID](3.license-manager.md) to generate a license key. The license key must then be loaded into the installed LM service. And after specifying the LM access address in the software, you can authorize the license which enables you to use the software NebulaGraph Enterprise Edition.
![lc_homepage](https://docs-cdn.nebula-graph.com.cn/figures/LChome_2023-06-16_17-40-58.png)

This article introduces the setup, homepage, license details page of LC, and how to bind an LMID on LC.
To generate a license key, you need to bind the [ID of your License Manager (LM)](#bind-lmid) on LC. The license key must then be loaded into the installed LM service. And after specifying the LM access address in the software, you can authorize the license which enables you to use NebulaGraph Enterprise.

This article introduces how to set up an LC account, bind the LMID, and generate and load the license key.

## Preparations

[You have purchased a Vesoft license](../3.purchase-license.md)

## Set up an LC account

To use LC, you must first set up an LC account.

1. Go to the LC account setup page.

![lc_login](https://docs-cdn.nebula-graph.com.cn/figures/LClogin_2023-06-16_15-05-01.png)

The entry to the LC account setup page varies depending on how you purchased your license:

- For purchasing a license on a cloud marketplace, go to the cloud marketplace service page and then click **Click here to set up your account**.
- For purchasing a license through Vesoft sales personnel, go to the email sent by Vesoft and then click **Setup License**.

2. Click **Register**.

![lc_register](https://docs-cdn.nebula-graph.com.cn/figures/LCregister_2023-06-16_15-06-40.png)

3. Fill in your email address, password, and company name, and tick the **I have read and agree to the Terms of Use and Privacy Policy** box.

Expand All @@ -31,55 +40,78 @@ This article introduces the setup, homepage, license details page of LC, and how
5. Open the verification email you received, and click on **Activate** to go to the LC login page.
6. Enter your email address and password, and click **Login** to log in to LC.

## LC homepage

The LC homepage displays the entrance to the cloud marketplace where licenses can be purchased, as well as lists of purchased licenses.
## Bind LMID to generate a license key

After you log in to LC, you can bind the ID of your LM to generate a license key.

!!! caution

Each license can only be bound to one LMID, and the unbinding of LMIDs is not supported.

### Quickly bind LMID

You are guided to bind the [LMID](3.license-manager.md#view-license-information) every time you log in to LC after you buy a new license. Binding the LMID is a prerequisite to generate a license key for using the license. You can also skip the quick binding and [bind the LMID on the license information page](#bind-lmid-on-the-license-information-page).

The **LICENSES LIST** section displays the information of all purchased licenses, including LMID (displayed as blank if LMID is not bound) and expiration date. If no licenses have been purchased, the list will be empty.
The following describes how to quickly bind the LMID:

1. On the quick binding page, check the information of the purchased license, and click **Next**.

2. Bind the LMID by the following steps and then click **Next**.
1. Install the LM service. For how to install the LM service, see [LM](3.license-manager.md#install-and-start-lm).
2. View the LMID. For how to view the LMID, see [LM](3.license-manager.md#view-license-information).
3. Fill in the LMID and select **Online** or **Offline**. For more information, see [License details](#license-key).
4. Click **BIND LMID** to complete the binding.

## License details
3. View the license key generated after binding the LMID and click **Close** to complete the binding.

In the **LICENSES LIST** section of the LC homepage, click **VIEW DETAILS** to access the license details page.
4. (Optional) Copy the license key and load it into the LM service. For how to load the license key, see [LM](3.license-manager.md#load-a-license-key).

### Bind LMID on the license information page

1. On the targeted **License Info** page, click **Bind License Manager ID**.
2. In the pop-up panel, enter the ID of your LM. For how to view LMID, see [LM](3.license-manager.md).
3. Select **Online** or **Offline**, and then click **CONFIRM** to bind the LMID.

- Select **Online** to generate an online license key, so that LM can get the latest license information from LC every 1 ~ 2 hours.

- Select **Offline** to generate an offline license key, which means LM obtains fixed license information. If you need to update the license information, you must obtain a new offline license key.

4. In the **License Key** section, view the license key generated after binding the LMID.
5. (Optional) Copy the license key and load it into the LM service. For how to load the license key, see [LM](3.license-manager.md#load-a-license-key).


## License information

In the **LICENSES LIST** section of the LC homepage, click **VIEW DETAILS** to access the **License Info** page.

### Basic information

- **LMID**：Indicates the ID of the [LM](3.license-manager.md) service that you installed (If not bound, this field will be empty).
- **License Type**: Currently limited to the purchase of node-based resources.
- **Start At** and **Expire Time**: Indicates the active and expiry dates of the license.

### Purchased resources
### Resources

In the **Purchased Resources** section, you can view the purchased query and storage node quantities and statuses, as well as the complimentary software names and statuses.

### License key

A license key is an encrypted string containing authorization information and serves as the unique credential for you to obtain access to the NebulaGraph Enterprise Edition database and its associated software features. There are two forms of License keys: online license keys and offline license keys.
After you bind the LMID, a license key is automatically generated and the **License Key** section displays the license key information.

- Online license keys
When binding your LMID, select the **Online** mode to generate an online license key. After you enter the key into the LM service, the LM can retrieve the latest license information regularly".
When binding your LMID, select the **Online** mode to generate an online license key. After you [load the key into the LM service](3.license-manager.md#load-a-license-key), the LM can retrieve the latest license information regularly.

- Offline license keys
When binding your LMID, select the **Offline** mode to generate an offline license key. Compared to an online license key, after you enter an offline license key into your LM, the LM service stores fixed license information. If the license information is updated, a new offline license key must be obtained.
When binding your LMID, select the **Offline** mode to generate an offline license key. Compared to an online license key, after you [load an offline license key into your LM](3.license-manager.md#load-a-license-key), the LM service stores fixed license information. If the license information is updated, a new offline license key must be obtained.

For information about how to bind the ID of your LM, see the following section **Bind LMID**.
### Subscription

### Subscriptions
This section is only displayed when you purchase a license on a cloud marketplace. the subscription ID of the cloud marketplace where your license is purchased, your subscription platform account, product ID, and subscription details.

This section displays the subscription ID of the cloud marketplace where your license is purchased, your subscription platform account, product ID, and subscription details.

## Bind LMID

1. On the targeted license details page, click **Bind License Manager ID**.
2. In the pop-up panel, enter the ID of your LM. For how to view LMID, see [LM](3.license-manager.md).
3. Select **Online** or **Offline**, and then click **CONFIRM** to bind the LMID.

- Select **Online** to generate an online license key, so that LM can get the latest license information from LC every 1 ~ 2 hours.

- Select **Offline** to generate an offline license key, which means LM obtains fixed license information. If you need to update the license information, you must obtain a new offline license key.

!!! caution

Each license can only be bound to one LMID, and the unbinding of LMIDs is not supported.



Loading