Skip to content

Commit

Permalink
analytics add license (#1731)
Browse files Browse the repository at this point in the history
* analytics add license

* update

* update
  • Loading branch information
cooper-lzy authored Nov 2, 2022
1 parent 47c850e commit c2303fd
Show file tree
Hide file tree
Showing 14 changed files with 120 additions and 32 deletions.
8 changes: 4 additions & 4 deletions docs-2.0/4.deployment-and-installation/deploy-license.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ 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 `[email protected]` 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

- If the license file is not deployed, NebulaGraph Enterprise Edition cannot be started.

- Do not modify the license file, otherwise the license will become invalid.

- If the license is about to expire, send email to `[email protected]` 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:

Expand Down Expand Up @@ -70,11 +70,11 @@ The license file contains information such as `issuedDate` and `expirationDate`.

## Deploy the license

1. Send email to `[email protected]` 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 `[email protected]` 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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,6 @@ Lightweight Directory Access Protocol (LDAP) is a lightweight client-server prot

!!! Enterpriseonly

Contact [email protected].
[Contact us](https://www.nebula-graph.io/contact).

{{ ent.ent_end }}
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Follow these steps:

!!! enterpriseonly

Contact our sales team via email ([email protected]) 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 <rpm>` to install the RPM package.
Expand Down
89 changes: 89 additions & 0 deletions docs-2.0/graph-computing/analytics-ent-license.md
Original file line number Diff line number Diff line change
@@ -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.

15 changes: 9 additions & 6 deletions docs-2.0/graph-computing/nebula-analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `[email protected]`.
- 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

Expand Down Expand Up @@ -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.

<!--
### Install NebulaGraph Analytics with the source code
Expand Down
2 changes: 1 addition & 1 deletion docs-2.0/graph-computing/use-explorer.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ For more details, see [Workflows](../nebula-explorer/workflow/workflows.md).

!!! enterpriseonly

To apply for the NebulaGraph Explorer installation package, send mail at `[email protected]`.
To apply for the NebulaGraph Explorer installation package, [contact us](https://www.nebula-graph.io/contact).
6 changes: 3 additions & 3 deletions docs-2.0/nebula-dashboard-ent/11.dashboard-ent-license.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ A license is a software authorization certificate used to authorize the use of a

- Do not modify the license file, otherwise the license will become invalid.

- If the license is about to expire, send email to `[email protected]` 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:

Expand All @@ -21,7 +21,7 @@ A license is a software authorization certificate used to authorize the use of a

## Obtain a NebulaGraph Dashboard Enterprise Edition license

Send email to `[email protected]` to apply for a NebulaGraph Dashboard Enterprise Edition license.
[Contact us](https://www.nebula-graph.io/contact) to apply for a NebulaGraph Dashboard Enterprise Edition license.

!!! note

Expand Down Expand Up @@ -74,7 +74,7 @@ For how to use a NebulaGraph Dashboard Enterprise Edition license, see [Deploy N

Follow the steps below to renew your NebulaGraph Dashboard Enterprise Edition license.

1. Email us at `[email protected]` to apply for a new NebulaGraph Dashboard Enterprise Edition license file `nebula.license`.
1. [Contact us](https://www.nebula-graph.io/contact) to apply for a new NebulaGraph Dashboard Enterprise Edition license file `nebula.license`.

2. In the NebulaGraph Dashboard Enterprise Edition installation directory, such as `/usr/local/nebula-explorer`, replace the old license file with the new one.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Before deploying Dashboard Enterprise Edition, you must do a check of these:

!!! enterpriseonly

You can [apply online](https://nebula-graph.io/visualization-tools-free-trial) for Dashboard Enterprise Edition free trial. To purchase, contact our sales team via email ([email protected]). For features of Dashboard Enterprise Edition, see [Pricing](https://nebula-graph.com.cn/pricing/).
You can [apply online](https://nebula-graph.io/visualization-tools-free-trial) for Dashboard Enterprise Edition free trial. [Contact us](https://www.nebula-graph.io/contact) to purchase. For features of Dashboard Enterprise Edition, see [Pricing](https://nebula-graph.com.cn/pricing/).

2. Use `tar -xzvf` to decompress the TAR package.

Expand Down Expand Up @@ -184,7 +184,7 @@ sudo /dashboard/scripts/dashboard.service restart all #Restart Dashboard.

!!! enterpriseonly

You can [apply online](https://nebula-graph.io/visualization-tools-free-trial) for Dashboard Enterprise Edition free trial. To purchase, contact our sales team via email ([email protected]). For features of Dashboard Enterprise Edition, see [Pricing](https://nebula-graph.com.cn/pricing/).
You can [apply online](https://nebula-graph.io/visualization-tools-free-trial) for Dashboard Enterprise Edition free trial. [Contact us](https://www.nebula-graph.io/contact) to purchase. For features of Dashboard Enterprise Edition, see [Pricing](https://nebula-graph.com.cn/pricing/).


2. Run `sudo rpm -i <rpm>` to install the RPM package.
Expand Down Expand Up @@ -301,7 +301,7 @@ sudo rpm -e <package_name>

!!! enterpriseonly

You can [apply online](https://nebula-graph.io/visualization-tools-free-trial) for Dashboard Enterprise Edition free trial. To purchase, contact our sales team via email ([email protected]). For features of Dashboard Enterprise Edition, see [Pricing](https://nebula-graph.com.cn/pricing/).
You can [apply online](https://nebula-graph.io/visualization-tools-free-trial) for Dashboard Enterprise Edition free trial. [Contact us](https://www.nebula-graph.io/contact) to purchase. For features of Dashboard Enterprise Edition, see [Pricing](https://nebula-graph.com.cn/pricing/).

2. Install the package.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ NebulaGraph Dashboard Enterprise Edition supports managing NebulaGraph installat

- Only the admin user can manage the installation package.

- Do not support downloading enterprise edition installation packages. For downloading Enterprise Edition packages, please send email to **[email protected]**.
- Do not support downloading enterprise edition installation packages. For downloading Enterprise Edition packages, please [contact us](https://www.nebula-graph.io/contact).

## Entry

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ NebulaGraph Explorer (Explorer in short) is a browser-based visualization tool.

!!! enterpriseonly

To apply for the NebulaGraph Explorer installation package, send mail at `[email protected]`.
To apply for the NebulaGraph Explorer installation package, [contact us](https://www.nebula-graph.io/contact).

!!! Note

Expand Down
6 changes: 3 additions & 3 deletions docs-2.0/nebula-explorer/deploy-connect/3.explorer-license.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ A license is a software authorization certificate used to authorize the use of a

- Do not modify the license file, otherwise the license will become invalid.

- If the license is about to expire, send email to `[email protected]` 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:

Expand All @@ -22,7 +22,7 @@ A license is a software authorization certificate used to authorize the use of a

## Obtain a NebulaGraph Explorer license

Send email to `[email protected]` to apply for a NebulaGraph Explorer license.
[Contact us](https://www.nebula-graph.io/contact) to apply for a NebulaGraph Explorer license.

!!! note

Expand Down Expand Up @@ -75,7 +75,7 @@ For how to use a NebulaGraph Explorer license, see [Deploy NebulaGraph Explorer]

Follow the steps below to renew your NebulaGraph Explorer license.

1. Email us at `[email protected]` to apply for a new NebulaGraph Explorer license file `nebula.license`.
1. [Contact us](https://www.nebula-graph.io/contact) to apply for a new NebulaGraph Explorer license file `nebula.license`.

2. In the NebulaGraph Explorer installation directory, such as `/usr/local/nebula-explorer`, replace the old license file with the new one.

Expand Down
4 changes: 2 additions & 2 deletions docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Before deploying Explorer, you must check the following information:

!!! enterpriseonly

You can [apply online](https://nebula-graph.io/visualization-tools-free-trial) for Explorer free trial. To purchase, contact our sales team via email ([email protected]). For features of Explorer, see [Pricing](https://nebula-graph.io/pricing/).
You can [apply online](https://nebula-graph.io/visualization-tools-free-trial) for Explorer free trial. [Contact us](https://www.nebula-graph.io/contact) to purchase. For features of Explorer, see [Pricing](https://nebula-graph.io/pricing/).

2. Use `sudo rpm -i <rpm>` to install RPM package.

Expand Down Expand Up @@ -110,7 +110,7 @@ sudo rpm -e nebula-graph-explorer-<version>.x86_64

!!! enterpriseonly

You can [apply online](https://nebula-graph.io/visualization-tools-free-trial) for Explorer free trial. To purchase, contact our sales team via email ([email protected]). For features of Explorer, see [Pricing](https://nebula-graph.io/pricing/).
You can [apply online](https://nebula-graph.io/visualization-tools-free-trial) for Explorer free trial. [Contact us](https://www.nebula-graph.io/contact) to purchase. For features of Explorer, see [Pricing](https://nebula-graph.io/pricing/).


2. Run `sudo dpkg -i <package_name>` to unpack the DEB package.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ RPM and DEB are common package formats on Linux systems. This topic shows how to
{{ ent.ent_begin }}
!!! enterpriseonly

For the Enterprise Edition, please send email to [email protected].
For the Enterprise Edition, please [contact us](https://www.nebula-graph.io/contact).
{{ ent.ent_end }}
## Prerequisites

Expand Down
6 changes: 1 addition & 5 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -694,13 +694,9 @@ nav:
- Graph computing:

- Algorithm overview: graph-computing/algorithm-description.md

- NebulaGraph Algorithm: graph-computing/nebula-algorithm.md

#ent
- NebulaGraph Analytics: graph-computing/nebula-analytics.md

#ent
- NebulaGraph Analytics License: graph-computing/analytics-ent-license.md
- NebulaGraph Explorer workflow: graph-computing/use-explorer.md

- NebulaGraph Spark Connector: nebula-spark-connector.md
Expand Down

0 comments on commit c2303fd

Please sign in to comment.