From 0ac010df9c7402d0503e228d728c6384467ab46f Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Fri, 5 May 2023 16:05:30 +0800 Subject: [PATCH 01/11] Changes involving LM --- docs-2.0/20.appendix/8.about-license.md | 67 ------ ...bula-graph-by-compiling-the-source-code.md | 14 +- .../4.install-nebula-graph-from-tar.md | 16 +- .../deploy-nebula-graph-cluster.md | 18 +- .../upgrade-nebula-ent-from-3.x-3.4.md | 4 +- .../deploy-license.md | 106 ---------- .../1.configurations/2.meta-config.md | 14 +- .../11.dashboard-ent-license.md | 84 -------- .../11.license-manager.md | 15 ++ .../2.deploy-connect-dashboard-ent.md | 194 ++++++++++-------- .../1.create-cluster.md | 4 +- .../operator/version-upgrade.md | 12 +- docs-2.0/nebula-dashboard-ent/8.faq.md | 2 +- .../deploy-connect/3.explorer-license.md | 85 -------- .../deploy-connect/ex-ug-deploy.md | 41 +--- ...urce_install-nebula-graph-by-rpm-or-deb.md | 11 +- .../replication-between-clusters.md | 12 +- mkdocs.yml | 3 +- 18 files changed, 190 insertions(+), 512 deletions(-) delete mode 100644 docs-2.0/20.appendix/8.about-license.md delete mode 100644 docs-2.0/4.deployment-and-installation/deploy-license.md delete mode 100644 docs-2.0/nebula-dashboard-ent/11.dashboard-ent-license.md create mode 100644 docs-2.0/nebula-dashboard-ent/11.license-manager.md delete mode 100644 docs-2.0/nebula-explorer/deploy-connect/3.explorer-license.md diff --git a/docs-2.0/20.appendix/8.about-license.md b/docs-2.0/20.appendix/8.about-license.md deleted file mode 100644 index ec5a8a966e9..00000000000 --- a/docs-2.0/20.appendix/8.about-license.md +++ /dev/null @@ -1,67 +0,0 @@ -# About NebulaGraph licenses - -A license is an official permission or permit that defines and restricts the rights of users to use the software. NebulaGraph licenses are used to restrict the use of the Enterprise Edition software. This document describes the NebulaGraph products that require a license and information about the license. - -{{ ent.ent_begin }} -## NebulaGraph Enterprise Edition - -NebulaGraph Enterprise Edition is scalable software with high availability and high performance. - -A NebulaGraph Enterprise Edition license is required to deploy a NebulaGraph Enterprise Edition cluster. - -For more information, see [Deploy a license for NebulaGraph Enterprise Edition](../4.deployment-and-installation/deploy-license.md). -{{ ent.ent_end }} - -## NebulaGraph Dashboard Enterprise Edition - -NebulaGraph Dashboard Enterprise Edition is an out-of-the-box visualization tool that monitors and manages the status of cluster machines and services. - -A NebulaGraph Dashboard Enterprise Edition license is required to deploy NebulaGraph Dashboard Enterprise Edition. For more information, see [NebulaGraph Dashboard Enterprise Edition license](../nebula-dashboard-ent/11.dashboard-ent-license.md). - -## NebulaGraph Explorer - -NebulaGraph Explorer, which has the Enterprise Edition only, is a browser-based visualization tool. It is used with the NebulaGraph core to visualize interaction with graph data. Even if there is no experience in graph databases, you can quickly become a graph exploration expert. - -A NebulaGraph Explorer license is required to deploy NebulaGraph Explorer. For more information, see [NebulaGraph Explorer license](../nebula-explorer/deploy-connect/3.explorer-license.md). - - -## FAQ about NebulaGraph licenses - -### Are the Dashboard/Explorer/NebulaGraph Enterprise Edition licenses the same? - -No, the licenses of Dashboard, Explorer, and NebulaGraph Enterprise Editions are independent of each other and cannot be used interchangeably. - - -{{ ent.ent_begin }} -### During the validity period of the NebulaGraph Enterprise Edition license, after replacing the enterprise edition Meta with the community edition Meta, can the community edition Meta be used with the enterprise edition Graph and Storage? - -No, mixed deployments of the enterprise edition services and the community edition services are not supported. - -### After the NebulaGraph Enterprise Edition license expires, is it possible that copy the data in the `data` directory and paste it to the same directory of NebulaGraph Community Edition, and then use NebulaGraph services as normal? - -Yes, it is possible. The data of the Enterprise Edition can be used in the Community Edition. The pasted data will only work properly in the services deployed in the Community Edition. Mixed deployments of the enterprise edition services and the community edition services are not supported. For example, the mixed deployment of the enterprise edition Meta service and the community edition Graph and Storage services is not supported. -{{ ent.ent_end }} - -### Is there any message before the license expires, and how to renew the license after it expires? - -The system will send expiration notifications before the license expires. - -The notification time before the license expires is different for the full version license and the trial version license. - -- For the full version license: - - - Within 30 days before the license expires or on the day the license expires, there is an expiration reminder when NebulaGraph/Dashboard/Explorer is started. - - - There is a 14-day buffer period after expiration. During the buffer period, you will receive expiration notifications and can continue using NebulaGraph/Dashboard/Explorer. After the buffer period ends, the corresponding service will be down and cannot be started. - -- For the trial version license: - - - Within 7 days before the license expires or on the day the license expires, there is an expiration reminder when NebulaGraph/Dashboard/Explorer is started. - - - There is no buffer period after expiration. Once the license expires, the corresponding service will be down and cannot be started. - - -After your license expires, contact us via [inqury@vesoft.com](mailto:inqury@vesoft.com) to renew it. - - - 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 ba0bb29b738..e2e3da26e1b 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 @@ -72,7 +72,13 @@ Installing NebulaGraph from the source code allows you to customize the compilin $ sudo make install ``` -7. The configuration files in the `etc/` directory (`/usr/local/nebula/etc` by default) are references. Users can create their own configuration files accordingly. If you want to use the scripts in the `script` directory to start, stop, restart, and kill the service, and check the service status, the configuration files have to be named as `nebula-graph.conf`, `nebula-metad.conf`, and `nebula-storaged.conf`. +{{ ent.ent_begin }} +7. (Enterprise only) For Enterprise Edition, set the value of `license_manager_url` to the host IP and port number `9119` where the license management tool is located in the Meta service configuration file of NebulaGraph (`nebula-metad.conf`), e.g. `192.168.8.100:9119`. +{{ ent.ent_end }} + +!!! note + + The configuration files in the `etc/` directory (`/usr/local/nebula/etc` by default) are references. Users can create their own configuration files accordingly. If you want to use the scripts in the `script` directory to start, stop, restart, and kill the service, and check the service status, the configuration files have to be named as `nebula-graph.conf`, `nebula-metad.conf`, and `nebula-storaged.conf`. ## Update the master branch @@ -84,11 +90,7 @@ The source code of the master branch changes frequently. If the corresponding Ne ## Next to do -{{ ent.ent_begin }} -- (Enterprise Edition)[Deploy license](../deploy-license.md) -{{ ent.ent_end }} - -- [Manage NebulaGraph services](../../2.quick-start/5.start-stop-service.md) +[Manage NebulaGraph 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 35985eb7fae..f06d645bddd 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 @@ -65,13 +65,19 @@ You can install NebulaGraph by downloading the tar.gz file. 3. Modify the name of the configuration file. - Enter the decompressed directory, rename the files `nebula-graphd.conf.default`, `nebula-metad.conf.default`, and `nebula-storaged.conf.default` in the subdirectory `etc`, and delete `.default` to apply the default configuration of NebulaGraph. To modify the configuration, see [Configurations](../../5.configurations-and-logs/1.configurations/1.configurations.md). + Enter the decompressed directory, rename the files `nebula-graphd.conf.default`, `nebula-metad.conf.default`, and `nebula-storaged.conf.default` in the subdirectory `etc`, and delete `.default` to apply the default configuration of NebulaGraph. + +{{ ent.ent_begin }} +4. (Enterprise only) For Enterprise Edition, set the value of `license_manager_url` to the host IP and port number `9119` where the license management tool is located in the Meta service configuration file of NebulaGraph (`nebula-metad.conf`), e.g. `192.168.8.100:9119`. +{{ ent.ent_end }} + + +!!! note + + To modify the configuration, see [Configurations](../../5.configurations-and-logs/1.configurations/1.configurations.md). So far, you have installed NebulaGraph successfully. ## Next to do -{{ ent.ent_begin }} -- (Enterprise Edition)[Deploy license](../deploy-license.md) -{{ ent.ent_end }} -- [Manage NebulaGraph services](../manage-service.md) +[Manage NebulaGraph services](../manage-service.md) diff --git a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md index c8ac1a60d35..adba421d72f 100644 --- a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md +++ b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md @@ -16,6 +16,9 @@ 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 }} +- The [license management tool](../../9.about-license/2.license-management-suite/3.license-manager.md) is installed and the [license code](../../9.about-license/4.generate-and-load-license-key.md) is loaded. +{{ ent.ent_end }} ## Manual deployment process @@ -27,15 +30,6 @@ Install NebulaGraph on each machine in the cluster. Available approaches of inst * [Install NebulaGraph by compiling the source code](1.install-nebula-graph-by-compiling-the-source-code.md) -{{ ent.ent_begin }} -### Add a license (for the Enterprise Edition only). - -- Adding a license is only required when you deploy a NebulaGraph cluster with the Enterprise Edition. For details, see [Deploy a license for NebulaGraph Enterprise Edition](../../4.deployment-and-installation/deploy-license.md). - -- Skip this step when you deploy a cluster with the Community Edition. - -{{ ent.ent_end }} - ### Modify the configurations To deploy NebulaGraph according to your requirements, you have to modify the configuration files. @@ -62,6 +56,12 @@ Users can refer to the content of the following configurations, which only show - [Storage Service configurations](../../5.configurations-and-logs/1.configurations/4.storage-config.md) +{{ ent.ent_begin }} +!!! enterpriseonly + + For Enterprise Edition, set the value of `license_manager_url` to the host IP and port number `9119` where the license management tool is located in the Meta service configuration file of NebulaGraph (`nebula-metad.conf`), e.g. `192.168.8.100:9119`. +{{ ent.ent_end }} + - Deploy machine A - `nebula-graphd.conf` diff --git a/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md b/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md index 4641d229510..7e4966734f5 100644 --- a/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md +++ b/docs-2.0/4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md @@ -88,9 +88,7 @@ This topic takes the enterprise edition of NebulaGraph v3.1.0 as an example and After the upgrade, a `data` directory will be generated in the v{{nebula.release}} installation directory, containing the upgraded data files. -4. Upload the license file to the `share/resources` directory under the v{{nebula.release}} installation directory. - -5. Start and connect to the NebulaGraph v{{nebula.release}} enterprise edition service and verify that the data is correct. The following commands can be used as reference: +4. Start and connect to the NebulaGraph v{{nebula.release}} enterprise edition service and verify that the data is correct. The following commands can be used as reference: ``` nebula> SHOW HOSTS; diff --git a/docs-2.0/4.deployment-and-installation/deploy-license.md b/docs-2.0/4.deployment-and-installation/deploy-license.md deleted file mode 100644 index f98a474f01d..00000000000 --- a/docs-2.0/4.deployment-and-installation/deploy-license.md +++ /dev/null @@ -1,106 +0,0 @@ -# Deploy a license for NebulaGraph Enterprise Edition - -NebulaGraph 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 [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, [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 the Enterprise Edition 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 Enterprise Edition, and a log will be printed as a reminder. - -## License description - -The example of the content of the license file (`nebula.license`) is as follows: - -```bash -----------License Content Start---------- -{ - "vendor": "vesoft", - "organization": "doc", - "issuedDate": "2022-04-06T16:00:00.000Z", - "expirationDate": "2022-05-31T15:59:59.000Z", - "product": "nebula_graph", - "version": ">3.0.0", - "licenseType": "enterprise", - "gracePeriod": 14, - "graphdSpec": { - "nodes": 3 - }, - "storagedSpec": { - "nodes": 3 - }, - "clusterCode": "BAIAEAiAQAAG" -} -----------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 NebulaGraph is `nebula_graph`.| -|`version`|The version information.| -|`licenseType`|The license type, 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. | -|`graphdSpec`| The max number of graph services in a cluster. NebulaGraph detects the number of active graph services in real-time. You are unable to connect to the cluster once the max number is reached. | -|`storagedSpec`| The max number of storage services in a cluster. NebulaGraph detects the number of active storage services in real-time. You are unable to connect to the cluster once the max number is reached. | -|`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. | - -## Deploy the license - -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. [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. - - !!! 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). - - -## Renew a NebulaGraph Enterprise Edition license - -1. Email us at `inqury@vesoft.com` to apply for a new license file `nebula.license`. - -2. In `share/resources/` under the installation directory of each Meta service, replace the old license file with the new one. - -3. Restart Storage and Graph services. For information about how to restart services, see [Start NebulaGraph](manage-service.md). If your license expires within the buffer period (14 days by default), you do not have to restart Storage and Graph services. - - !!! note - - The Graph and Storage services are automatically stopped when your license expires beyond the buffer period after expiration. To ensure that the service is running properly, please renew your license in time. - -## View the license - -- View the License file directly - - You can use `cat` to view the content of the license file directly. For example: `cat share/resources/nebula.license`. - -- View the License file with HTTP port - - When the NebulaGraph cluster is running normally, you can view the license file with the HTTP port (default port is 19559) of the meta service. For example: `curl -G "http://192.168.10.101:19559/license"`. diff --git a/docs-2.0/5.configurations-and-logs/1.configurations/2.meta-config.md b/docs-2.0/5.configurations-and-logs/1.configurations/2.meta-config.md index d5344a0ab9d..e8c7ec4b289 100644 --- a/docs-2.0/5.configurations-and-logs/1.configurations/2.meta-config.md +++ b/docs-2.0/5.configurations-and-logs/1.configurations/2.meta-config.md @@ -29,18 +29,20 @@ For all parameters and their current values, see [Configurations](1.configuratio | `pid_file` | `pids/nebula-metad.pid` | The file that records the process ID. | No| | `timezone_name` | - | Specifies the NebulaGraph time zone. This parameter is not predefined in the initial configuration files. You can manually set it if you need it. The system default value is `UTC+00:00:00`. For the format of the parameter value, see [Specifying the Time Zone with TZ](https://www.gnu.org/software/libc/manual/html_node/TZ-Variable.html "Click to view the timezone-related content in the GNU C Library manual"). For example, `--timezone_name=UTC+08:00` represents the GMT+8 time zone.|No| +!!! note + + * While inserting property values of [time types](../../3.ngql-guide/3.data-types/4.date-and-time.md), NebulaGraph transforms time types (except TIMESTAMP) to the corresponding UTC according to the time zone specified by `timezone_name`. The time-type values returned by nGQL queries are all UTC time. + * `timezone_name` is only used to transform the data stored in NebulaGraph. Other time-related data of the NebulaGraph processes still uses the default time zone of the host, such as the log printing time. + {{ ent.ent_begin }} +## enterprise license configurations + | Name | Predefined value | Description |Whether supports runtime dynamic modifications| | ----------- | ----------------------- | ---------------------------------------------------- |----------------- | -|`license_path`|`share/resources/nebula.license`| Path of the license of the NebulaGraph Enterprise Edition. Users need to [deploy a license file](../../4.deployment-and-installation/deploy-license.md) before starting the Enterprise Edition. This parameter is required only for the NebulaGraph Enterprise Edition. For details about how to configure licenses for other ecosystem tools, see the deployment documents of the corresponding ecosystem tools.| No| +|`license_manager_url`|-|The address of license manager. Set the value to the host IP and port number `9119` where the license management tool is located in the Meta service configuration file of NebulaGraph (`nebula-metad.conf`), e.g. `192.168.8.100:9119`.|No| {{ ent.ent_end }} -!!! note - - * While inserting property values of [time types](../../3.ngql-guide/3.data-types/4.date-and-time.md), NebulaGraph transforms time types (except TIMESTAMP) to the corresponding UTC according to the time zone specified by `timezone_name`. The time-type values returned by nGQL queries are all UTC time. - * `timezone_name` is only used to transform the data stored in NebulaGraph. Other time-related data of the NebulaGraph processes still uses the default time zone of the host, such as the log printing time. - ## Logging configurations | Name | Predefined value | Description |Whether supports runtime dynamic modifications| diff --git a/docs-2.0/nebula-dashboard-ent/11.dashboard-ent-license.md b/docs-2.0/nebula-dashboard-ent/11.dashboard-ent-license.md deleted file mode 100644 index 27aad621b17..00000000000 --- a/docs-2.0/nebula-dashboard-ent/11.dashboard-ent-license.md +++ /dev/null @@ -1,84 +0,0 @@ -# NebulaGraph Dashboard Enterprise Edition license - -A license is a software authorization certificate used to authorize the use of a software product. When deploying NebulaGraph Dashboard Enterprise Edition, you need to add a license to start it. This document describes the license information on NebulaGraph Dashboard Enterprise Edition. - -## Precautions - -- If the license file is not deployed, NebulaGraph Dashboard Enterprise Edition 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 the Enterprise Edition 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 Enterprise Edition, and a log will be printed as a reminder. - - -## Obtain a NebulaGraph Dashboard Enterprise Edition license - -[Contact us](https://www.nebula-graph.io/contact) to apply for a NebulaGraph Dashboard Enterprise Edition license. - -!!! note - - You can [apply online](https://nebula-graph.io/visualization-tools-free-trial) for a 30-day free trial of NebulaGraph Dashboard Enterprise Edition. - -## License description - -NebulaGraph Dashboard Enterprise Edition license is a file named `nebula.license` that contains the following information: - -```bash -----------License Content Start---------- -{ - "vendor": "vesoft", - "organization": "doc", - "issuedDate": "2022-06-06T16:00:00.000Z", - "expirationDate": "2023-05-31T15:59:59.000Z", - "product": "nebula_graph_dashboard", - "version": ">=3.2.0", - "licenseType": "enterprise", - "gracePeriod": 14, - "clusterCode": "BAIAEAiAQAAG" -} -----------License Content End---------- - -----------License Key Start---------- -Rrjip5cxxxxxxxxxxxxx5zKoQ== -----------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 Dashboard Enterprise Edition is `nebula_graph_dashboard`.| -|`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. | -|`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 Dashboard Enterprise Edition license - -For how to use a NebulaGraph Dashboard Enterprise Edition license, see [Deploy NebulaGraph Dashboard Enterprise Edition](2.deploy-connect-dashboard-ent.md). - -## Renew a NebulaGraph Dashboard Enterprise Edition license - -Follow the steps below to renew your NebulaGraph Dashboard Enterprise Edition 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. - -!!! note - - You cannot log into NebulaGraph Dashboard Enterprise Edition once the license expires. To avoid business interruptions, please renew your license in time. - diff --git a/docs-2.0/nebula-dashboard-ent/11.license-manager.md b/docs-2.0/nebula-dashboard-ent/11.license-manager.md new file mode 100644 index 00000000000..1fe4acc9906 --- /dev/null +++ b/docs-2.0/nebula-dashboard-ent/11.license-manager.md @@ -0,0 +1,15 @@ +# License Manager + +After configuring the license manager (LM) in NebulaGraph and its affiliated software, you can use LM to verify the validity of the licenses and ensure the proper use of the graph database and affiliated software. + +Dashboard currently only provides pages to display license info, license usage and product list. + +## Prerequisites + +- The [license management tool](../9.about-license/2.license-management-suite/3.license-manager.md) is installed and the [license code](../9.about-license/4.generate-and-load-license-key.md) is loaded. + +- The `config.yaml` file has been modified. Set the value of `LicenseManagerURL` to the host IP of LM and port number `9119`, e.g. `192.168.8.100:9119`. + +## Entry + +At the top navigation bar of the Dashboard Enterprise Edition page, click License Manager to view the information. \ No newline at end of file diff --git a/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md b/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md index 23e6f04d8d9..34df724b1b7 100644 --- a/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md +++ b/docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md @@ -6,6 +6,8 @@ This topic will introduce how to deploy Dashboard Enterprise Edition in detail. Before deploying Dashboard Enterprise Edition, you must do a check of these: +- The [license management tool](../9.about-license/2.license-management-suite/3.license-manager.md) is installed and the [license code](../9.about-license/4.generate-and-load-license-key.md) is loaded. + - Select and download Dashboard Enterprise Edition of the correct version. For information about the version correspondence between Dashboard Enterprise Edition and NebulaGraph, see [Version compatibility](1.what-is-dashboard-ent.md). - MySQL and SQLite are supported to store Dashboard metadata. To use MySQL, make sure that the environment of [MySQL](https://www.mysql.com/) is ready and a MySQL database named as `dashboard` is create. Make sure the default character set of the database is `utf8`. @@ -52,19 +54,18 @@ Before deploying Dashboard Enterprise Edition, you must do a check of these: tar -xzvf nebula-dashboard-ent-{{dashboard_ent.release}}.linux-amd64.tar.gz -C /usr/local/ ``` -3. Edit `vim /usr/local/nebula-dashboard-ent/etc/config.yaml` to modify the configuration. +3. Enter the extracted folder and modify the `config.yaml` file in the `etc` directory to set the relevant configuration. ```bash Name: dashboard-api Host: 0.0.0.0 # Specifies the address segment that can access Dashboard. Port: 7005 # The default port used to access Dashboard Enterprise Edition. MaxBytes: 1073741824 # The maximum content length of an Http request that can be accepted. The default value is 1048576. Value range: 0 ~ 8388608. - Timeout: 15000 # Timeout duration of the access. - Debug: # Whether to enable the Debug mode. - Enable: false + Timeout: 60000 # Timeout duration of the access. Log: # Dashboard run log settings. KeepDays: 7 # The number of days for keeping log. - Mode: console # The save mode of logs, including console and file. console means the service logs are logged in webserver.log. file means the service logs are logged in access.log, error.log, severe.log, slow.log, and stat.log respectively. + Mode: file # The save mode of logs, including console and file. console means the service logs are logged in webserver.log. file means the service logs are logged in access.log, error.log, severe.log, slow.log, and stat.log respectively. + Encoding: plain # Log encoding method, plain and json are supported. Database: Dialect: sqlite # The database type used to store metadata. Only support SQLite and MySQL currently. The default value is SQLite. AutoMigrate: true # Whether to automatically create a database table. Defaults to true. @@ -91,34 +92,22 @@ Before deploying Dashboard Enterprise Edition, you must do a check of these: Username: "" # The SMTP server account name. Password: "" # The SMTP server password. + # SlowQuery + SlowQuery: + Enable: true # The switch of slowquery data polling. + MessageStore: 14 # Slow queary data store time (day). + ScrapeInterval: 2m # The interval time for slow query data pulling, eg: 1s, 10s, 2m, 3h + # System information System: WebAddress: http://127.0.0.1:7005 # The external access for Dashboard. It can be set as a hostname, used for interface callbacks. For example, the invitee who is invited by mail can use this link to access Dashboard. MessageStore: 90 # It sets the number of days to keep alert messages, the value of which is 90 by default. - # LDAP information - LDAP: - Server: ldap://127.0.0.1 # The LDAP server address. - BindDN: cn=admin,dc=vesoft,dc=com # The LDAP login username. - BindPassword: "" # The LDAP login password. - BaseDN: dc=vesoft,dc=com # Set the path to query user data. - UserFilter: "&(objectClass=*)" # Set a filter to LDAP search queries. - EmailKey: mail # Set the field name used to restore email in LDAP. + CloudProvider: "" # cloud provider name, used for aliyun now. + LicenseManagerURL: http://192.168.8.166:9119 # license manager url. ``` -4. Copy the license file to the `nebula-dashboard-ent` directory. - - ```bash - cp -r - ``` - - For example: - - ```bash - cp -r nebula.license /usr/local/nebula-dashboard-ent - ``` - -5. Start Dashboard. +4. Start Dashboard. You can use the following command to start the Dashboard with one click. @@ -166,19 +155,60 @@ Before deploying Dashboard Enterprise Edition, you must do a check of these: sudo rpm -i nebula-dashboard-ent-xxx.rpm --prefix= ``` -3. Copy the license file to the `nebula-dashboard-ent` directory. +3. Enter the extracted folder and modify the `config.yaml` file in the `etc` directory to set the relevant configuration. ```bash - cp -r - ``` + Name: dashboard-api + Host: 0.0.0.0 # Specifies the address segment that can access Dashboard. + Port: 7005 # The default port used to access Dashboard Enterprise Edition. + MaxBytes: 1073741824 # The maximum content length of an Http request that can be accepted. The default value is 1048576. Value range: 0 ~ 8388608. + Timeout: 60000 # Timeout duration of the access. + Log: # Dashboard run log settings. + KeepDays: 7 # The number of days for keeping log. + Mode: file # The save mode of logs, including console and file. console means the service logs are logged in webserver.log. file means the service logs are logged in access.log, error.log, severe.log, slow.log, and stat.log respectively. + Encoding: plain # Log encoding method, plain and json are supported. + Database: + Dialect: sqlite # The database type used to store metadata. Only support SQLite and MySQL currently. The default value is SQLite. + AutoMigrate: true # Whether to automatically create a database table. Defaults to true. + Host: 127.0.0.1 # The IP address of the connected MySQL database. + Port: 3306 # The port of the connected MySQL database. + Username: root # The username to log in MySQL. + Password: nebula # The password to log in MySQL. + Name: dashboard # The name of the corresponding database. - For example: + # Information about the exporter port + Exporter: + NodePort: 9100 # The port of the node-exporter service. + NebulaPort: 9200 # The port of the nebula-stats-exporter service. - ```bash - cp -r nebula.license /usr/local/nebula-dashboard-ent - ``` + # Information of services + Proxy: + PrometheusAddr: 127.0.0.1:9090 # The IP address and port of the prometheus service. + AlertmanagerAddr: 127.0.0.1:9093 # The IP address and port of the Alertmanager service. + + # Information of the sender's Email used to invite LDAP accounts. + Mail: + Host: smtp.office365.com # The SMTP server address. + Port: 587 # The port number of the SMTP server. + Username: "" # The SMTP server account name. + Password: "" # The SMTP server password. -4. (Optional) Run the following commands to view the status of and start all the services. + # SlowQuery + SlowQuery: + Enable: true # The switch of slowquery data polling. + MessageStore: 14 # Slow queary data store time (day). + ScrapeInterval: 2m # The interval time for slow query data pulling, eg: 1s, 10s, 2m, 3h + + # System information + System: + WebAddress: http://127.0.0.1:7005 # The external access for Dashboard. It can be set as a hostname, used for interface callbacks. For example, the invitee who is invited by mail can use this link to access Dashboard. + MessageStore: 90 # It sets the number of days to keep alert messages, the value of which is 90 by default. + + CloudProvider: "" # cloud provider name, used for aliyun now. + LicenseManagerURL: http://192.168.8.166:9119 # license manager url. + ``` + +4. Run the following commands to view the status of and start all the services. ``` sudo systemctl list-dependencies nebula-dashboard.target # View the status of all the services. @@ -191,30 +221,6 @@ Before deploying Dashboard Enterprise Edition, you must do a check of these: sudo systemctl {status|stop|start} {nbd-prometheus.service|nbd-alert-manager.service|nbd-stats-exporter.service|nbd-webserver.service} ``` - -5. (Optional) To configure recipients of cluster alert notifications and to configure LDAP accounts, run `vim /usr/local/nebula-dashboard-ent/etc/config.yaml` and add the following settings. - - ``` - # Information of the sender's Email used to invite LDAP accounts. - mail: - host: smtp.office365.com # The SMTP server address. - port: 587 # The port number of the SMTP server. - username: "" # The SMTP server account name. - password: "" # The SMTP server password. - # System information - system: - webAddress: http://127.0.0.1:7005 # The address to access Dashboard for the invitee who is invited by mail. - messageStore: 90 # It sets the number of days to keep alert messages, the value of which is 90 by default. - # LDAP information - ldap: - server: ldap://127.0.0.1 # The LDAP server address. - bindDN: cn=admin,dc=vesoft,dc=com # The LDAP login username. - bindPassword: "" # The LDAP login password. - baseDN: dc=vesoft,dc=com # Set the path to query user data. - userFilter: "&(objectClass=*)" # Set a filter to LDAP search queries. - emailKey: mail # Set the field name used to restore email in LDAP. - ``` - ### Uninstallation To uninstall Dashboard Enterprise Edition deployed with RPM, run the following command. @@ -249,19 +255,60 @@ sudo rpm -e sudo dpkg -i nebula-dashboard-ent-{{dashboard_ent.release}}.ubuntu1804.amd64.deb ``` -3. Copy the license file to the `nebula-dashboard-ent` directory. +3. Enter the extracted folder and modify the `config.yaml` file in the `etc` directory to set the relevant configuration. ```bash - cp -r - ``` + Name: dashboard-api + Host: 0.0.0.0 # Specifies the address segment that can access Dashboard. + Port: 7005 # The default port used to access Dashboard Enterprise Edition. + MaxBytes: 1073741824 # The maximum content length of an Http request that can be accepted. The default value is 1048576. Value range: 0 ~ 8388608. + Timeout: 60000 # Timeout duration of the access. + Log: # Dashboard run log settings. + KeepDays: 7 # The number of days for keeping log. + Mode: file # The save mode of logs, including console and file. console means the service logs are logged in webserver.log. file means the service logs are logged in access.log, error.log, severe.log, slow.log, and stat.log respectively. + Encoding: plain # Log encoding method, plain and json are supported. + Database: + Dialect: sqlite # The database type used to store metadata. Only support SQLite and MySQL currently. The default value is SQLite. + AutoMigrate: true # Whether to automatically create a database table. Defaults to true. + Host: 127.0.0.1 # The IP address of the connected MySQL database. + Port: 3306 # The port of the connected MySQL database. + Username: root # The username to log in MySQL. + Password: nebula # The password to log in MySQL. + Name: dashboard # The name of the corresponding database. - For example: + # Information about the exporter port + Exporter: + NodePort: 9100 # The port of the node-exporter service. + NebulaPort: 9200 # The port of the nebula-stats-exporter service. - ```bash - cp -r nebula.license /usr/local/nebula-dashboard-ent - ``` + # Information of services + Proxy: + PrometheusAddr: 127.0.0.1:9090 # The IP address and port of the prometheus service. + AlertmanagerAddr: 127.0.0.1:9093 # The IP address and port of the Alertmanager service. + + # Information of the sender's Email used to invite LDAP accounts. + Mail: + Host: smtp.office365.com # The SMTP server address. + Port: 587 # The port number of the SMTP server. + Username: "" # The SMTP server account name. + Password: "" # The SMTP server password. + + # SlowQuery + SlowQuery: + Enable: true # The switch of slowquery data polling. + MessageStore: 14 # Slow queary data store time (day). + ScrapeInterval: 2m # The interval time for slow query data pulling, eg: 1s, 10s, 2m, 3h -4. (Optional) Run the following commands to view the status of and start all the services. + # System information + System: + WebAddress: http://127.0.0.1:7005 # The external access for Dashboard. It can be set as a hostname, used for interface callbacks. For example, the invitee who is invited by mail can use this link to access Dashboard. + MessageStore: 90 # It sets the number of days to keep alert messages, the value of which is 90 by default. + + CloudProvider: "" # cloud provider name, used for aliyun now. + LicenseManagerURL: http://192.168.8.166:9119 # license manager url. + ``` + +4. Run the following commands to view the status of and start all the services. ``` sudo systemctl list-dependencies nebula-dashboard.target # View the status of all the services. @@ -274,21 +321,6 @@ sudo rpm -e sudo systemctl {status|stop|start} {nbd-prometheus.service|nbd-alert-manager.service|nbd-stats-exporter.service|nbd-webserver.service} ``` -5. (Optional) To configure the sender's email address used to invite LDAP and OAuth2.0 accounts and configure the duration for storing alert messages, run `vim /usr/local/nebula-dashboard-ent/etc/config.yaml` and add the following settings. - - ``` - # Information of the sender's Email used to invite LDAP accounts. - mail: - host: smtp.office365.com # The SMTP server address. - port: 587 # The port number of the SMTP server. - username: "" # The SMTP server account name. - password: "" # The SMTP server password. - # System information - system: - webAddress: http://127.0.0.1:7005 # The address to access Dashboard for the invitee who is invited by mail. - messageStore: 90 # It sets the number of days to keep alert messages, the value of which is 90 by default. - ``` - ### Uninstallation To uninstall Dashboard Enterprise Edition, run the following command. diff --git a/docs-2.0/nebula-dashboard-ent/3.create-import-dashboard/1.create-cluster.md b/docs-2.0/nebula-dashboard-ent/3.create-import-dashboard/1.create-cluster.md index b3b5fab65e2..433cf2929a7 100644 --- a/docs-2.0/nebula-dashboard-ent/3.create-import-dashboard/1.create-cluster.md +++ b/docs-2.0/nebula-dashboard-ent/3.create-import-dashboard/1.create-cluster.md @@ -17,11 +17,9 @@ You can create a cluster following these steps: Only one Enterprise Edition of NebulaGraph is provided for you to choose from on the **Create cluster** page. To install other versions of NebulaGraph, you can download or upload the corresponding installer package on the **Package Management** page. For details, see [Package management](../system-settings/manage-package.md). - - Click **Upload License**. - !!! note - For the creation of a Community version of NebulaGraph, skip this step to upload the License file. + When creating a cluster with versions below 3.5.0, you need to upload the license certificate manually. - **Add nodes**. Enter the following information, the Host, SSH port, SSH user, authentication type, NebulaGraph package, etc. diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/version-upgrade.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/version-upgrade.md index 0339abc6e91..f4e4c164c44 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/version-upgrade.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/version-upgrade.md @@ -12,7 +12,7 @@ NebulaGraph Dashboard Enterprise Edition supports upgrading the version of the e - Only supports upgrading the NebulaGraph cluster that version greater than **3.0.0** to the version equal to or lower than **3.2.1**. To upgrade to **3.3.0**, see [manual upgrade](../../../4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-300-to-latest.md). - Do not support upgrading clusters across the major version. - - The community edition can be upgraded to the enterprise edition by uploading and verifying licenses, and the enterprise edition can be upgraded to the community edition. + - The community edition can be upgraded to the enterprise edition, and the enterprise edition can be upgraded to the community edition. - The cluster can be upgraded to a minor version in the current major version, including a smaller version than the current minor version. 1. At the top navigation bar of the Dashboard Enterprise Edition page, click **Cluster Management**. @@ -25,16 +25,14 @@ NebulaGraph Dashboard Enterprise Edition supports upgrading the version of the e If you do not find the suitable version, click **Package Management** to download or upload the required version installation package. For details, see [Package management](../../system-settings/manage-package.md). {{ent.ent_begin}} -5. Click **Upload License** to upload the NebulaGraph Dashboard license (skip this step if upgrading a NebulaGraph cluster of the Community Edition). - - !!! enterpriseonly + !!! note - This step is for NebulaGraph Enterprise Edition clusters. + When upgrading Enterprise Edition clusters with version below 3.5.0, you need to click **Upload Certificate** to upload license. {{ent.ent_end}} -6. Click **Next** to perform the upgrade check, and then click **Next**. +5. Click **Next** to perform the upgrade check, and then click **Next**. The cluster will be shut down during the upgrade and automatically restart the services after the upgrade. You can use the **diagnostics report** to help you judge whether the timing to upgrade is suitable. -7. Confirm the upgrade information again, including **Cluster Name**, **Current NebulaGraph Version**, and **Upgrade NebulaGraph Version**, and then click **Upgrade**. +6. Confirm the upgrade information again, including **Cluster Name**, **Current NebulaGraph Version**, and **Upgrade NebulaGraph Version**, and then click **Upgrade**. Users can view the upgrade task information in [task center](../../10.tasks.md), the task type is `version update`. \ No newline at end of file diff --git a/docs-2.0/nebula-dashboard-ent/8.faq.md b/docs-2.0/nebula-dashboard-ent/8.faq.md index 99d66216695..48e3290a958 100644 --- a/docs-2.0/nebula-dashboard-ent/8.faq.md +++ b/docs-2.0/nebula-dashboard-ent/8.faq.md @@ -41,7 +41,7 @@ The Metad service stores the metadata of the NebulaGraph database. Once the Meta ## "Why Dashboard Enterprise Edition cannot be started?" -- Make sure that the license file is copied to the Dashboard directory and `sudo ./dashboard.service start all` is executed. +- Make sure that the [license management tool](../9.about-license/2.license-management-suite/3.license-manager.md) is installed and the [license code](../9.about-license/4.generate-and-load-license-key.md) is loaded. - Make sure that the license is not expired. diff --git a/docs-2.0/nebula-explorer/deploy-connect/3.explorer-license.md b/docs-2.0/nebula-explorer/deploy-connect/3.explorer-license.md deleted file mode 100644 index d3d129eba07..00000000000 --- a/docs-2.0/nebula-explorer/deploy-connect/3.explorer-license.md +++ /dev/null @@ -1,85 +0,0 @@ -# NebulaGraph Explorer license - -A license is a software authorization certificate used to authorize the use of a software product. When deploying NebulaGraph Explorer, you need to add a license to start it. This document describes the license information on NebulaGraph Explorer. - - -## Precautions - -- If the license file is not deployed, NebulaGraph Explorer 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 the Enterprise Edition 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 Enterprise Edition, and a log will be printed as a reminder. - - -## Obtain a NebulaGraph Explorer license - -[Contact us](https://www.nebula-graph.io/contact) to apply for a NebulaGraph Explorer license. - -!!! note - - You can [apply online](https://nebula-graph.io/visualization-tools-free-trial) for a 30-day free trial of NebulaGraph Explorer. - -## License description - -NebulaGraph Explorer license is a file named `nebula.license` that contains the following information: - -```bash -----------License Content Start---------- -{ - "vendor": "vesoft", - "organization": "doc", - "issuedDate": "2022-06-06T16:00:00.000Z", - "expirationDate": "2023-05-31T15:59:59.000Z", - "product": "nebula_graph_explorer", - "version": ">=3.2.0", - "licenseType": "enterprise", - "gracePeriod": 14, - "clusterCode": "BAIAEAiAQAAG" -} -----------License Content End---------- - -----------License Key Start---------- -Rrjip5cxxxxxxxxxxxxx5zKoQ== -----------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 Explorer is `nebula_graph_explorer`.| -|`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. | -|`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 Explorer license - -For how to use a NebulaGraph Explorer license, see [Deploy NebulaGraph Explorer](ex-ug-deploy.md). - -## Renew a NebulaGraph Explorer license - -Follow the steps below to renew your NebulaGraph Explorer 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. - -!!! note - - You cannot log into NebulaGraph Explorer once the license expires. To avoid business interruptions, please renew your license in time. - \ No newline at end of file diff --git a/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md b/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md index a3d7016c83a..882fd6bf9b9 100644 --- a/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md +++ b/docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md @@ -10,6 +10,8 @@ The Dag Controller installation package is built in Explorer starting from versi Before deploying Explorer, you must check the following information: +- The [license management tool](../../9.about-license/2.license-management-suite/3.license-manager.md) is installed and the [license code](../../9.about-license/4.generate-and-load-license-key.md) is loaded. + - The NebulaGraph services are deployed and started. For more information, see [NebulaGraph Database Manual](../../2.quick-start/1.quick-start-workflow.md). - Before the installation starts, the following ports are not occupied. @@ -23,11 +25,6 @@ Before deploying Explorer, you must check the following information: By default, Explorer uses the port `7002`. You can modify the `httpport` in the `conf/app.conf` file in the installation directory and restart the service. - The Linux distribution is CentOS. -- The [license](3.explorer-license.md) is ready. - - !!! enterpriseonly - - License is only available in the Enterprise Edition. To obtain the license, apply for [NebulaGraph Explorer Free Trial](https://nebula-graph.io/visualization-tools-free-trial). - The HDFS services are deployed if graph computing is required. The namenode uses port 8020 by default, and the datanode uses port 50010 by default. @@ -58,16 +55,7 @@ Before deploying Explorer, you must check the following information: sudo rpm -i nebula-explorer-.x86_64.rpm --prefix= ``` -3. Copy the license to the installation path. - - ```bash - sudo cp -r - ``` - - For example: - ```bash - sudo cp -r nebula.license /usr/local/nebula-explorer - ``` +3. Enter the extracted folder, modify the `app-config.yaml` file in the `config` directory, set the value of `LicenseManagerURL` to the host IP of LM and the port number `9119`, for example `192.168.8.100:9119`. 4. (Optional) Configure the Dag Controller. See the **Configure Dag Controller** section below. @@ -131,17 +119,7 @@ sudo rpm -e nebula-graph-explorer-.x86_64 You cannot customize the installation path of Explorer when installing a DEB package. -3. Copy the license to the Explorer installation path. - - ```bash - Sudo cp -r - ``` - - For example: - - ```bash - Sudo cp -r nebula.license /usr/local/nebula-explorer - ``` +3. Enter the extracted folder, modify the `app-config.yaml` file in the `config` directory, set the value of `LicenseManagerURL` to the host IP of LM and the port number `9119`, for example `192.168.8.100:9119`. 4. (Optional) Configure the Dag Controller. See the **Configure Dag Controller** section below. @@ -191,16 +169,7 @@ sudo dpkg -r nebula-explorer tar -xvf nebula-explorer-.tar.gz ``` -3. Copy the license to the `nebula-explorer` directory. - - ```bash - cp -r - ``` - - For example: - ```bash - cp -r nebula.license /usr/local/nebula-explorer - ``` +3. Enter the extracted folder, modify the `app-config.yaml` file in the `config` directory, set the value of `LicenseManagerURL` to the host IP of LM and the port number `9119`, for example `192.168.8.100:9119`. 4. (Optional) Configure the Dag Controller. See the **Configure Dag Controller** section below. 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 4718f01cf35..ea958406198 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 @@ -11,7 +11,8 @@ RPM and DEB are common package formats on Linux systems. This topic shows how to {{ ent.ent_end }} ## Prerequisites -Wget installed. +- The tool `wget` is installed. +- The [license management tool](https://docs.nebula-graph.io/{{nebula.release}}/9.about-license/2.license-management-suite/3.license-manager/) is installed and the [license code](https://docs.nebula-graph.io/{{nebula.release}}/9.about-license/4.generate-and-load-license-key/) is loaded. ## Download the package from cloud service @@ -158,12 +159,14 @@ Wget installed. The default installation path is `/usr/local/nebula/`. -## Next to do - {{ ent.ent_begin }} -- (Enterprise Edition)[Deploy license](https://docs.nebula-graph.com.cn/{{nebula.release}}/4.deployment-and-installation/deploy-license) +## Configure the address of license management + +In the Meta service configuration file (`nebula-metad.conf`) of NebulaGraph, set the value of `license_manager_url` to the host IP and port number `9119` where the license management tool is located, e.g. `192.168.8.100:9119`. {{ ent.ent_end }} +## Next to do + - [Start NebulaGraph](https://docs.nebula-graph.io/{{nebula.release}}/2.quick-start/5.start-stop-service/) - [Connect to NebulaGraph](https://docs.nebula-graph.io/{{nebula.release}}/2.quick-start/3.connect-to-nebula-graph/) diff --git a/docs-2.0/synchronization-and-migration/replication-between-clusters.md b/docs-2.0/synchronization-and-migration/replication-between-clusters.md index 7fcb947940d..e51eecaed55 100644 --- a/docs-2.0/synchronization-and-migration/replication-between-clusters.md +++ b/docs-2.0/synchronization-and-migration/replication-between-clusters.md @@ -60,8 +60,6 @@ The synchronization works as follows: The listener and drainer can be deployed in a standalone way, or on the machines hosting the primary and secondary clusters. The latter way can increase the machine load and decrease the service performance. -- Prepare the license file for the NebulaGraph Enterprise Edition. - ## Test environment The test environment for the operation example in this topic is as follows: @@ -90,6 +88,8 @@ The test environment for the operation example in this topic is as follows: !!! note For newly installed services, remove the suffix `.default` or `.production` of a configuration template file in the `conf` directory to make it take effect. + - In the Meta service configuration file (`nebula-metad.conf`) of NebulaGraph, set the value of `license_manager_url` to the host IP and port number `9119` where the license management tool is located, e.g. `192.168.8.100:9119`. + - On the primary and secondary cluster machines, modify `nebula-graphd.conf`, `nebula-metad.conf`, and `nebula-storaged.conf`. In all three files, set real IP addresses for `local_ip` instead of `127.0.0.1`, and set the IP addresses and ports for their own nebula-metad processes as the `meta_server_addrs` values. In `nebula-graphd.conf`, set `enable_authorize=true`. - On the primary cluster, set `--snapshot_send_files=false` in both the `nebula-storaged.conf` file and the `nebula-metad.conf` file. @@ -102,9 +102,7 @@ The test environment for the operation example in this topic is as follows: For more information about the configurations, see [Configurations](../5.configurations-and-logs/1.configurations/1.configurations.md). -3. On the machines of the primary cluster, secondary cluster, and listeners, upload the license files into the `share/resources/` directories in the NebulaGraph installation directories. - -4. Go to the NebulaGraph installation directories on the machines and start the needed services. +3. Go to the NebulaGraph installation directories on the machines and start the needed services. - On the primary and secondary machines, run `sudo scripts/nebula.service start all`. @@ -114,7 +112,7 @@ The test environment for the operation example in this topic is as follows: - On the drainer machine, run `sudo scripts/nebula-drainerd.service start`. -5. Log into the primary cluster, add the Storage hosts, and check the status of the listeners. +4. Log into the primary cluster, add the Storage hosts, and check the status of the listeners. ```ngql # Add the Storage hosts first. @@ -143,7 +141,7 @@ The test environment for the operation example in this topic is as follows: +------------------+------+----------+-----------------+--------------+----------------------+ ``` -6. Log into the secondary cluster, add the Storage hosts, and check the status of the drainer. +5. Log into the secondary cluster, add the Storage hosts, and check the status of the drainer. ```ngql nebula> ADD HOSTS 192.168.10.102:9779; diff --git a/mkdocs.yml b/mkdocs.yml index d5515bf9904..bb9040c5cb4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -612,6 +612,7 @@ nav: - Other settings: nebula-dashboard-ent/4.cluster-operator/6.settings.md - Authority management: nebula-dashboard-ent/5.account-management.md - Task center: nebula-dashboard-ent/10.tasks.md + - License manager: nebula-dashboard-ent/11.license-manager.md - System settings: - System settings: nebula-dashboard-ent/system-settings/system-settings.md - Notification endpoint: nebula-dashboard-ent/system-settings/notification-endpoint.md @@ -625,7 +626,6 @@ nav: - Deploy and connect: - Deploy Explorer: nebula-explorer/deploy-connect/ex-ug-deploy.md - Connect to NebulaGraph: nebula-explorer/deploy-connect/ex-ug-connect.md - - NebulaGraph Explorer License: nebula-explorer/deploy-connect/3.explorer-license.md - Page overview: nebula-explorer/ex-ug-page-overview.md - Database management: - Schema drafting: nebula-explorer/db-management/draft.md @@ -741,7 +741,6 @@ nav: - NebulaGraph Dashboard Enterprise Edition: 20.appendix/release-notes/dashboard-ent-release-note.md - NebulaGraph Explorer: 20.appendix/release-notes/explorer-release-note.md - Learning path: 20.appendix/learning-path.md - - About NebulaGraph licenses: 20.appendix/8.about-license.md - FAQ: 20.appendix/0.FAQ.md - Ecosystem tools: 20.appendix/6.eco-tool-version.md - Write tools: 20.appendix/write-tools.md From 5036e373c14dbdeb770014370331755adf19bb0d Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Fri, 5 May 2023 16:15:56 +0800 Subject: [PATCH 02/11] update --- .../1.install-nebula-graph-by-compiling-the-source-code.md | 4 ++-- .../4.install-nebula-graph-from-tar.md | 4 ++-- .../4.cluster-operator/operator/version-upgrade.md | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) 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 e2e3da26e1b..585a33b3741 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 @@ -72,9 +72,9 @@ Installing NebulaGraph from the source code allows you to customize the compilin $ sudo make install ``` -{{ ent.ent_begin }} + {{ ent.ent_begin }} 7. (Enterprise only) For Enterprise Edition, set the value of `license_manager_url` to the host IP and port number `9119` where the license management tool is located in the Meta service configuration file of NebulaGraph (`nebula-metad.conf`), e.g. `192.168.8.100:9119`. -{{ ent.ent_end }} + {{ ent.ent_end }} !!! note 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 f06d645bddd..39eeaa83850 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 @@ -67,9 +67,9 @@ You can install NebulaGraph by downloading the tar.gz file. Enter the decompressed directory, rename the files `nebula-graphd.conf.default`, `nebula-metad.conf.default`, and `nebula-storaged.conf.default` in the subdirectory `etc`, and delete `.default` to apply the default configuration of NebulaGraph. -{{ ent.ent_begin }} + {{ ent.ent_begin }} 4. (Enterprise only) For Enterprise Edition, set the value of `license_manager_url` to the host IP and port number `9119` where the license management tool is located in the Meta service configuration file of NebulaGraph (`nebula-metad.conf`), e.g. `192.168.8.100:9119`. -{{ ent.ent_end }} + {{ ent.ent_end }} !!! note diff --git a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/version-upgrade.md b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/version-upgrade.md index f4e4c164c44..17389af369c 100644 --- a/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/version-upgrade.md +++ b/docs-2.0/nebula-dashboard-ent/4.cluster-operator/operator/version-upgrade.md @@ -24,11 +24,11 @@ NebulaGraph Dashboard Enterprise Edition supports upgrading the version of the e If you do not find the suitable version, click **Package Management** to download or upload the required version installation package. For details, see [Package management](../../system-settings/manage-package.md). -{{ent.ent_begin}} + {{ent.ent_begin}} !!! note When upgrading Enterprise Edition clusters with version below 3.5.0, you need to click **Upload Certificate** to upload license. -{{ent.ent_end}} + {{ent.ent_end}} 5. Click **Next** to perform the upgrade check, and then click **Next**. From 4e509ee877c7da62a71a75c8e0ef6305a9f81431 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Sat, 6 May 2023 09:52:35 +0800 Subject: [PATCH 03/11] update --- .../graph-computing/analytics-ent-license.md | 89 ------------------- docs-2.0/graph-computing/nebula-analytics.md | 4 +- 2 files changed, 2 insertions(+), 91 deletions(-) delete mode 100644 docs-2.0/graph-computing/analytics-ent-license.md diff --git a/docs-2.0/graph-computing/analytics-ent-license.md b/docs-2.0/graph-computing/analytics-ent-license.md deleted file mode 100644 index c4bf120a273..00000000000 --- a/docs-2.0/graph-computing/analytics-ent-license.md +++ /dev/null @@ -1,89 +0,0 @@ -# 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 7dd0320019a..f32e4018c5e 100644 --- a/docs-2.0/graph-computing/nebula-analytics.md +++ b/docs-2.0/graph-computing/nebula-analytics.md @@ -6,7 +6,7 @@ NebulaGraph Analytics is a high-performance graph computing framework tool that - 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. +- The [license management tool](../9.about-license/2.license-management-suite/3.license-manager.md) is installed and the [license code](../9.about-license/4.generate-and-load-license-key.md) is loaded. - The [HDFS](https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-common/ClusterSetup.html) 2.2.x or later has been deployed. @@ -88,7 +88,7 @@ NebulaGraph Analytics supports the following graph algorithms. export JAVA_HOME= ``` -3. Copy the license into the directory `scripts` of the NebulaGraph Analytics installation path on all machines. +3. Configure the `analytics.conf` file with the path `nebula-analytics/scripts/analytics.conf`. Set the value of `license_manager_url` to the host IP and port number `9119` where the license management tool is located, e.g. `192.168.8.100:9119`.