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.

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

en-doc-updates #2151

Merged
merged 1 commit into from
Jul 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,11 @@ Using Docker Compose can quickly deploy NebulaGraph services based on the prepar

{{ ent.ent_begin }}

3. Configure License Manager address (skip this step if you are using the community version).
3. Configure License Manager address.

!!! enterpriseonly

Skip this step if you are using the community version.

1. Edit the `docker-compose.yml` file.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ You can install NebulaGraph by downloading the tar.gz file.
- NebulaGraph is currently only supported for installation on Linux systems, and only CentOS 7.x, CentOS 8.x, Ubuntu 16.04, Ubuntu 18.04, and Ubuntu 20.04 operating systems are supported.

{{ ent.ent_begin }}

## Prerequisites

For NebulaGraph Enterprise, you must have the [license key](../../9.about-license/1.license-overview.md#licensing-process) loaded in [LM](../../9.about-license/2.license-management-suite/3.license-manager.md).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ For now, NebulaGraph does not provide an official deployment tool. Users can dep
- Prepare 5 machines for deploying the cluster.
- Use the NTP service to synchronize time in the cluster.
{{ ent.ent_begin }}
- * For NebulaGraph Enterprise, you must have the [license key](../../9.about-license/1.license-overview.md#licensing-process) loaded in [LM](../../9.about-license/2.license-management-suite/3.license-manager.md).
- For NebulaGraph Enterprise, you must have the [license key](../../9.about-license/1.license-overview.md#licensing-process) loaded in [LM](../../9.about-license/2.license-management-suite/3.license-manager.md).
{{ ent.ent_end }}

## Manual deployment process
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,11 @@ For all parameters and their current values, see [Configurations](1.configuratio

{{ ent.ent_begin }}

## enterprise license configurations
## License configurations

!!! enterpriseonly

The license configurations are for the Enterprise Edition only.

| Name | Predefined value | Description |Whether supports runtime dynamic modifications|
| ----------- | ----------------------- | ---------------------------------------------------- |----------------- |
Expand Down
8 changes: 4 additions & 4 deletions docs-2.0/9.about-license/1.license-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ A license key is an encrypted string containing authorization information and se
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. [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.
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 All @@ -38,8 +38,8 @@ A license key is an encrypted string containing authorization information and se
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).
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.
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
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ License Center (LC) provided by Vesoft is an online platform for managing licens

![lc_homepage](https://docs-cdn.nebula-graph.com.cn/figures/LChome_2023-06-16_17-40-58.png)

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.
To generate a license key, you need to bind the [ID of your License Manager (LM)](#bind_lmid_to_generate_a_license_key) 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 the license key.

## Preparations

[You have purchased a NebulaGraph license](../3.purchase-license.md)
To use LC, you must first purchase a NebulaGraph license. For more information, see [Purchase a license](../3.purchase-license.md).

## Set up an LC account

Expand All @@ -20,7 +20,7 @@ To use LC, you must first set up an LC account.

![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:
The entry to the LC account setup page varies depending on how you purchase 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**.
Expand All @@ -29,7 +29,7 @@ To use LC, you must first set up an LC account.

![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.
3. Fill in your email address, password, and company name, and tick the **I have read and agreed to the Terms of Use and Privacy Policy** box.

!!! caution

Expand All @@ -51,33 +51,34 @@ After you log in to LC, you need bind the ID of your LM to generate a license ke

### 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).
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 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.
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**.

- Online

Select the **Online** mode to generate an online license key.

3. View the license key generated after binding the LMID and click **Close** to complete the binding.
- Offline

Select the **Offline** mode to generate an offline license key. After you enter the offline license key into your LM, the LM service stores fixed license information.

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).
For more information, see [License key](#license_key).

- Online license keys

An online license allows you to obtain the latest license information from LC.
4. Click **BIND LMID** to complete the binding.

When binding your LMID, select the **Online** mode to generate an online license key. After you enter the online key into the LM service, the LM can retrieve the latest license information regularly.
3. View the license key generated after binding the LMID and click **Close** to complete the binding.

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).

- Offline license keys

Compared to an online license key, an offline license key contains 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. After you enter the offline license key into your LM, the LM service stores fixed license information.

!!! note

Expand All @@ -91,16 +92,15 @@ The following describes how to quickly bind the LMID:
If you skip the quick binding, you can still bind the LMID on the license information page.

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).
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).

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

Expand All @@ -122,11 +122,15 @@ After you bind the LMID, a license key is automatically generated and the **Lice

- Online license keys

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.
An online license allows you to obtain the latest license information from LC.

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 [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.
Compared to an online license key, an offline license key contains 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.


### Subscription
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# License Manager

A License Manager (LM) is an essential service that runs on a server for you to manage your license and to license the NebulaGraph enterprise edition database and its associated software. You can use an LM client that communicates with the LM service to load [license keys](2.license-center.md) and view license information, including the license validity period and purchased nodes. By configuring the LM service address in the NebulaGraph database and its associated software, the validity of the license can be verified to ensure the normal use of the NebulaGraph database and its associated software.
A License Manager (LM) is an essential service that runs on a server for you to manage your license and to license the NebulaGraph enterprise edition database and its associated software. You can use an LM client that communicates with the LM service to load [license keys](2.license-center.md#license_key) and view license information, including the license validity period and purchased nodes. By configuring the LM service address in the NebulaGraph database and its associated software, the validity of the license can be verified to ensure the normal use of the NebulaGraph database and its associated software.

This article introduces how to deploy and use an LM service, as well as how to configure it within the Nebula Graph database and its associated software.

## Preparations

To use an LM, you need to make sure the following:

- [You have purchased a NebulaGraph license](../3.purchase-license.md).
- You have obtained the desired LM installation package.

Expand All @@ -21,7 +23,7 @@ An LM is a single-process service. To ensure the reliability and continuity of t

## Install and start LM

An LM can be installed on Linux amd64 or arm64 systems or installed through Dashboard.
An LM can be installed on Linux amd64 or arm64 systems, or installed through Dashboard.

### Using the TAR Package

Expand Down Expand Up @@ -160,7 +162,7 @@ After your LM starts, in the LM installation path you can use the LM CLI to view

### Load a license key

After [generating a license key](2.license-center.md#bind-lmid-to-generate-a-license-key), you need to use the LM client tool to load the license key.
After [generating a license key](2.license-center.md#bind_lmid_to_generate_a_license_key), you need to use the LM client tool to load the license key.

```bash
./nebula-license-manager-cli load --key <license-key> --force
Expand Down Expand Up @@ -198,17 +200,17 @@ The information items of the license in the output are described as follows:

| Items | Description |
| :--- | :--- |
| `LMID` | The ID of your LM. When you obtain a license key, this LMID needs to be bound. For more information, see [Generate a license key](2.license-center.md#bind-lmid-to-generate-a-license-key).|
| `LMID` | The ID of your LM. When you obtain a license key, this LMID needs to be bound. For more information, see [Generate a license key](2.license-center.md#bind_lmid_to_generate_a_license_key).|
| `LicenseStatus` | The status of the license. It includes:<br/>`Normal`: The license can be used normally.<br/>`NotExist`: The license key does not exist.<br/>`Invalid`: The license key is invalid.<br/>`Syncing`: Synchronizing the license information from [LC](2.license-center.md).<br/>`Expiring`: The license is about to expire.<br/>`Expired`: The license has expired.|
| `LicenseKey` | An encrypted string containing authorization information, which is the only credential for you to obtain the authorization of the NebulaGraph database and its associated software. For details, see [License key](2.license-center.md). |
| `LicenseKey` | An encrypted string containing authorization information, which is the only credential for you to obtain the authorization of the NebulaGraph database and its associated software. For details, see [License key](2.license-center.md#license_key). |
| `Type` | The type of resources purchased. Currently, only node-based resources can be purchased.|
| `Query Node` | The number of query nodes purchased|
| `Storage Node` | The number of storage nodes purchased|
| `ExpireAt` | The expiration time of the license. |

### Synchronize license info

When the license key loaded into LM is in online mode, the LM periodically synchronizes the license information from LC every 1 to 2 hours. You can also manually synchronize the license key using the following command.
When the license key loaded into LM is in online mode, the LM periodically synchronizes the license information from LC every one to two hours. You can also manually synchronize the license key using the following command.

```bash
./nebula-license-manager-cli sync
Expand Down Expand Up @@ -238,7 +240,7 @@ For a database administrator (DBA), there may be a need to view the license info

### Configure LM in NebulaGraph

In the NebulaGraph database Meta service configuration file (`nebula-metad.conf`), set the `license_manager_url` value to reflect the IP address of the LM host and port number `9119` in the format like `192.168.8.xxx:9119`. For more information, see [Meta service configuration](../../5.configurations-and-logs/1.configurations/2.meta-config.md).
In the NebulaGraph database Meta service configuration file (`nebula-metad.conf`), set the `license_manager_url` value to reflect the IP address of the LM host and port number `9119` in the format like `192.168.8.xxx:9119`. For more information, see [Meta service configuration](../../5.configurations-and-logs/1.configurations/2.meta-config.md#license_configurations).

After the configuration is complete, [restart the Meta service](../../2.quick-start/5.start-stop-service.md).

Expand All @@ -264,4 +266,5 @@ After the configuration is complete, run `./run_pagerank.sh` in the `scripts` fo
## FAQ

Q: Can I change the host on which my LM is located?

A: No. The LM is bound to the host where it is installed. If you need to change the host, or the host is unable to be used, you need to [contact Vesoft sales](https://www.nebula-graph.io/contact) to rebind the LMID.
Loading