diff --git a/docs-2.0/4.deployment-and-installation/deploy-license.md b/docs-2.0/4.deployment-and-installation/deploy-license.md index 484cb52da30..faff3e3a936 100644 --- a/docs-2.0/4.deployment-and-installation/deploy-license.md +++ b/docs-2.0/4.deployment-and-installation/deploy-license.md @@ -4,7 +4,7 @@ NebulaGraph Enterprise Edition requires the user to deploy a license file before !!! enterpriseonly - License is a software authorization certificate provided for users of the Enterprise Edition. Users of the Enterprise Edition can send email to `inquiry@vesoft.com` to apply for a license file. + License is a software authorization certificate provided for users of the Enterprise Edition. Users of the Enterprise Edition can [contact us](https://www.nebula-graph.io/contact) to apply for a license file. ## Precautions @@ -12,7 +12,7 @@ NebulaGraph Enterprise Edition requires the user to deploy a license file before - Do not modify the license file, otherwise the license will become invalid. -- If the license is about to expire, send email to `inquiry@vesoft.com` to apply for renewal. +- If the license is about to expire, [contact us](https://www.nebula-graph.io/contact) to apply for renewal. - The transition period after the license expires is 14 days: @@ -70,11 +70,11 @@ The license file contains information such as `issuedDate` and `expirationDate`. ## Deploy the license -1. Send email to `inquiry@vesoft.com` to apply for the NebulaGraph Enterprise Edition package. +1. [Contact us](https://www.nebula-graph.io/contact) to apply for the NebulaGraph Enterprise Edition package. 2. Install NebulaGraph Enterprise Edition. The installation method is the same as the Community Edition. See [Install NebulaGraph with RPM or DEB package](2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md). -3. Send email to `inquiry@vesoft.com` to apply for the license file `nebula.license`. +3. [Contact us](https://www.nebula-graph.io/contact) to apply for the license file `nebula.license`. 4. Upload the license file to all hosts that contain Meta services. The path is in the `share/resources/` of each Meta service installation directory. diff --git a/docs-2.0/7.data-security/1.authentication/1.authentication.md b/docs-2.0/7.data-security/1.authentication/1.authentication.md index 12cf056e148..cafe264fc89 100644 --- a/docs-2.0/7.data-security/1.authentication/1.authentication.md +++ b/docs-2.0/7.data-security/1.authentication/1.authentication.md @@ -41,6 +41,6 @@ Lightweight Directory Access Protocol (LDAP) is a lightweight client-server prot !!! Enterpriseonly - Contact inquiry@vesoft.com. + [Contact us](https://www.nebula-graph.io/contact). {{ ent.ent_end }} diff --git a/docs-2.0/backup-and-restore/nebula-br-ent/2.install-tools.md b/docs-2.0/backup-and-restore/nebula-br-ent/2.install-tools.md index b0c2f382d5d..e421921bd7a 100644 --- a/docs-2.0/backup-and-restore/nebula-br-ent/2.install-tools.md +++ b/docs-2.0/backup-and-restore/nebula-br-ent/2.install-tools.md @@ -22,7 +22,7 @@ Follow these steps: !!! enterpriseonly - Contact our sales team via email (inquiry@vesoft.com) to obtain the BR Enterprise Edition installation package. + [Contact us](https://www.nebula-graph.io/contact) to obtain the BR Enterprise Edition installation package. 2. Run `sudo rpm -i ` to install the RPM package. diff --git a/docs-2.0/graph-computing/analytics-ent-license.md b/docs-2.0/graph-computing/analytics-ent-license.md new file mode 100644 index 00000000000..c4bf120a273 --- /dev/null +++ b/docs-2.0/graph-computing/analytics-ent-license.md @@ -0,0 +1,89 @@ +# NebulaGraph Analytics license + +A license is a software authorization certificate used to authorize the use of a software product. When deploying NebulaGraph Analytics, you need to add a license to start it. This document describes the license information on NebulaGraph Analytics. + +## Precautions + +- If the license file is not deployed, NebulaGraph Analytics cannot be started. + +- Do not modify the license file, otherwise the license will become invalid. + +- If the license is about to expire, [contact us](https://www.nebula-graph.io/contact) to apply for renewal. + +- The transition period after the license expires is 14 days: + + - If you start NebulaGraph Analytics within 30 days before the license expires or on the day the license expires, a log will be printed as a reminder. + + - The license can still be used for 14 days after it expires. + + - If the license has expired for 14 days, you will not be able to start the NebulaGraph Analytics, and a log will be printed as a reminder. + + +## Obtain a NebulaGraph Analytics license + +[Contact us](https://www.nebula-graph.io/contact) to apply for a NebulaGraph Analytics license. + +!!! note + + You can [apply online](https://nebula-graph.io/visualization-tools-free-trial) for a 30-day free trial of NebulaGraph Analytics. + +## License description + +NebulaGraph Analytics license is a file named `nebula.license` that contains the following information: + +```bash +----------License Content Start---------- +{ + "vendor": "vesoft", + "organization": "vesoft", + "issuedDate": "2022-11-01T16:00:00.000Z", + "expirationDate": "2023-11-01T15:59:59.000Z", + "product": "nebula_graph_analytics", + "version": ">3.0.0", + "licenseType": "enterprise", + "gracePeriod": 14, + "analytics": { + "nodes": 3, + "vcpu": 3 + } + "clusterCode": "BAIAEAiAQAAG" +} +----------License Content End---------- + +----------License Key Start---------- +Rrjip5c+xxxxxxxxxxxxxk5Yg== +----------License Key End---------- +``` + +The license file contains information such as `issuedDate` and `expirationDate`. The description is as follows. + +|Parameter|Description| +|:---|:---| +|`vendor`|The supplier.| +|`organization`|The username.| +|`issuedDate`|The date that the license is issued. | +|`expirationDate`|The date that the license expires.| +|`product`|The product type. The product type of NebulaGraph Analytics is `nebula_graph_analytics`.| +|`version`|The version information.| +|`licenseType`|The license type (a reserved parameter), including `enterprise`, `samll_bussiness`, `pro`, and `individual`. | +|`gracePeriod`| The buffer time (in days) for the service to continue to be used after the license expires, and the service will be stopped after the buffer period. The trial version of license has no buffer period after expiration and the default value of this parameter is 0. | +|`nodes`|The max number of Analytics services in the cluster. | +|`vcpu`|The max number of threads for the Analytics services in the cluster.| +|`clusterCode`| The user's hardware information, which is also the unique identifier of the cluster. This parameter is not available in the trial version of the license. | + +## Use a NebulaGraph Analytics license + +For how to use a NebulaGraph Analytics license, see [NebulaGraph Analytics](nebula-analytics.md). + +## Renew a NebulaGraph Analytics license + +Follow the steps below to renew your NebulaGraph Analytics license. + +1. [Contact us](https://www.nebula-graph.io/contact) to apply for a new NebulaGraph Analytics license file `nebula.license`. + +2. In the NebulaGraph Analytics installation directory, such as `/usr/local/nebula-analytics/scripts/`, replace the old license file with the new one. + +!!! note + + You cannot use NebulaGraph Analytics once the license expires. To avoid business interruptions, please renew your license in time. + diff --git a/docs-2.0/graph-computing/nebula-analytics.md b/docs-2.0/graph-computing/nebula-analytics.md index c06eac1e61a..3bc670f6e76 100644 --- a/docs-2.0/graph-computing/nebula-analytics.md +++ b/docs-2.0/graph-computing/nebula-analytics.md @@ -2,9 +2,10 @@ NebulaGraph Analytics is a high-performance graph computing framework tool that performs graph analysis of data in the NebulaGraph database. -!!! enterpriseonly +## Prerequisites - To apply for the NebulaGraph Analytics installation package, send mail at `inquiry@vesoft.com`. +- The NebulaGraph Analytics installation package has been obtained. [Contact us](https://www.nebula-graph.io/contact) to apply. +- The [license](analytics-ent-license.md) is ready. ## Scenarios @@ -56,11 +57,13 @@ NebulaGraph Analytics supports the following graph algorithms. ## Install NebulaGraph Analytics -When installing a cluster of multiple NebulaGraph Analytics on multiple nodes, you need to install NebulaGraph Analytics to the same path and set up SSH-free login between nodes. +1. When installing a cluster of multiple NebulaGraph Analytics on multiple nodes, you need to install NebulaGraph Analytics to the same path and set up SSH-free login between nodes. -```bash -sudo rpm -i nebula-analytics-{{plato.release}}-centos.x86_64.rpm --prefix /home/xxx/nebula-analytics -``` + ```bash + sudo rpm -i nebula-analytics-{{plato.release}}-centos.x86_64.rpm --prefix /home/xxx/nebula-analytics + ``` + +2. Copy the license into the directory `scripts` of the NebulaGraph Analytics installation path on all machines.