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

add license #903

Merged
merged 2 commits into from
Nov 11, 2021
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 @@ -80,13 +80,11 @@ The source code of the master branch changes frequently. If the corresponding Ne

2. In the `nebula/build` directory, run `make -j{N}` and `make install` again.

## Next
## Next to do

- [Manage Nebula Graph services](../../2.quick-start/5.start-stop-service.md)

- [Connect to Nebula Graph](../../2.quick-start/3.connect-to-nebula-graph.md)
- (Enterprise Edition)[Deploy license](../deploy-license.md)

- [Nebula Graph CRUD](../../2.quick-start/4.nebula-graph-crud.md)
- [Manage Nebula Graph services](../../2.quick-start/5.start-stop-service.md)

## CMake variables

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,6 @@ So far, you have installed Nebula Graph successfully.

## Next to do

Use the `nebula.service` file in the `scripts` directory to start Nebula Graph. For details, see [Manage Nebula Graph Service](../manage-service.md).
- (Enterprise Edition)[Deploy license](../deploy-license.md)

- [Manage Nebula Graph services](../manage-service.md)
71 changes: 71 additions & 0 deletions docs-2.0/4.deployment-and-installation/deploy-license.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Deploy license

Nebula Graph Enterprise Edition requires the user to deploy a license file before starting the Enterprise Edition. This topic describes how to deploy a license file for the Enterprise Edition.

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

## Precautions

- If the license file is not deployed, Nebula Graph 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.

- The transition period after the license expires is 3 days:

- If you start the Enterprise Edition within 7 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 3 days after it expires.

- If the license has expired for 3 days, you will not be able to start the Enterprise Edition, and a log will be printed as a reminder.

## License description

You can use `cat` to view the content of the license file (`nebula.license`). The example is as follows:

```bash
----------License Content Start----------
{
"vendor": "Vesoft_Inc",
"organization": "doc",
"issuedDate": "2021-11-07T16:00:00.000Z",
"expirationDate": "2021-11-30T15:59:59.000Z",
"product": "nebula_graph",
"version": ">2.6.1",
"licenseType": "enterprise"
}
----------License Content End----------

----------License Key Start----------
cofFcOxxxxxxxxxxxxxhnZgaxrQ==
----------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 Nebula Graph is `nebula_graph`.|
|`version`|The version information.|
|`licenseType`|The license type, including `enterprise`, `samll_bussiness`, `pro`, and `individual`. |

## Steps

1. Send email to `[email protected]` to apply for the Nebula Graph Enterprise Edition package.

2. Install Nebula Graph Enterprise Edition. The installation method is the same as the Community Edition. See [Install Nebula Graph 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`.

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.

!!! note

For the upload address of the license file for ecosystem tools, refer to the document of [Ecosystem tools overview](../20.appendix/6.eco-tool-version.md).
Original file line number Diff line number Diff line change
Expand Up @@ -149,5 +149,6 @@ Prepare the right [resources](https://docs.nebula-graph.io/{{nebula.release}}/4.

## What's next

- (Enterprise Edition)[Deploy license](https://docs.nebula-graph.com.cn/{{nebula.release}}/4.deployment-and-installation/deploy-license)
- [start Nebula Graph](https://docs.nebula-graph.io/{{nebula.release}}/2.quick-start/5.start-stop-service/) <!--这里用外链。-->
- [connect to Nebula Graph](https://docs.nebula-graph.io/{{nebula.release}}/2.quick-start/3.connect-to-nebula-graph/)<!--这里用外链。-->
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -298,6 +298,7 @@ nav:
- Install Nebula Graph with the tar.gz file: 4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md
- Deploy Nebula Graph with Docker Compose: 4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md
- Deploy a Nebula Graph cluster on multiple servers: 4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md
- Deploy license: 4.deployment-and-installation/deploy-license.md
- Manage Service: 4.deployment-and-installation/manage-service.md
- Connect to Service: 4.deployment-and-installation/connect-to-nebula-graph.md
- Upgrade:
Expand Down