From 7eecd6b2ccd04f5fccca740bb1fc22ebf6795cdd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9C=B1=E6=99=93=E9=9D=92?= <86282370+izhuxiaoqing@users.noreply.github.com> Date: Wed, 10 Nov 2021 11:19:44 +0800 Subject: [PATCH 1/2] add license --- ...bula-graph-by-compiling-the-source-code.md | 8 +-- .../4.install-nebula-graph-from-tar.md | 4 +- .../deploy-license.md | 71 +++++++++++++++++++ ...urce_install-nebula-graph-by-rpm-or-deb.md | 1 + mkdocs.yml | 1 + 5 files changed, 79 insertions(+), 6 deletions(-) create mode 100644 docs-2.0/4.deployment-and-installation/deploy-license.md diff --git a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md index 5d328d6a1c4..ff831b4b944 100644 --- a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md +++ b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md @@ -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 diff --git a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md index b89415c1dc2..3e6d983b1ab 100644 --- a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md +++ b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md @@ -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) diff --git a/docs-2.0/4.deployment-and-installation/deploy-license.md b/docs-2.0/4.deployment-and-installation/deploy-license.md new file mode 100644 index 00000000000..62576a8400b --- /dev/null +++ b/docs-2.0/4.deployment-and-installation/deploy-license.md @@ -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 `inquiry@vesoft.com` 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 `inquiry@vesoft.com` 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 `inquiry@vesoft.com` 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 `inquiry@vesoft.com` 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). diff --git a/docs-2.0/reuse/source_install-nebula-graph-by-rpm-or-deb.md b/docs-2.0/reuse/source_install-nebula-graph-by-rpm-or-deb.md index ce49c491bf7..361caf3d4bc 100644 --- a/docs-2.0/reuse/source_install-nebula-graph-by-rpm-or-deb.md +++ b/docs-2.0/reuse/source_install-nebula-graph-by-rpm-or-deb.md @@ -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.md) - [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/) diff --git a/mkdocs.yml b/mkdocs.yml index fd3a6cc0154..b9e22b0a302 100755 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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: From 0bec55ed721274f4348cd306c1e572f2f7b4b319 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Thu, 11 Nov 2021 10:01:54 +0800 Subject: [PATCH 2/2] Update source_install-nebula-graph-by-rpm-or-deb.md --- docs-2.0/reuse/source_install-nebula-graph-by-rpm-or-deb.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/reuse/source_install-nebula-graph-by-rpm-or-deb.md b/docs-2.0/reuse/source_install-nebula-graph-by-rpm-or-deb.md index 361caf3d4bc..a21a1eb44e3 100644 --- a/docs-2.0/reuse/source_install-nebula-graph-by-rpm-or-deb.md +++ b/docs-2.0/reuse/source_install-nebula-graph-by-rpm-or-deb.md @@ -149,6 +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.md) +- (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/)