diff --git a/docs-2.0/2.quick-start/6.cheatsheet-for-ngql.md b/docs-2.0/2.quick-start/6.cheatsheet-for-ngql.md index fa20beaacd7..b2a4df93a6f 100644 --- a/docs-2.0/2.quick-start/6.cheatsheet-for-ngql.md +++ b/docs-2.0/2.quick-start/6.cheatsheet-for-ngql.md @@ -228,9 +228,9 @@ | Retrieve vertices | `LOOKUP ON player WHERE player.name == "Tony Parker" YIELD player.name AS name, player.age AS age` | The following example returns vertices whose `name` is `Tony Parker` and the tag is `player`. | | Retrieve edges | `LOOKUP ON follow WHERE follow.degree == 90 YIELD follow.degree` | Returns edges whose `degree` is `90` and the edge type is `follow`. | | List vertices with a tag | `LOOKUP ON player YIELD properties(vertex),id(vertex)` | Shows how to retrieve the VID of all vertices tagged with `player`. | - | List edges with an edge types | `LOOKUP ON like YIELD edge AS e` | Shows how to retrieve the source Vertex IDs, destination vertex IDs, and ranks of all edges of the `like` edge type. | + | List edges with an edge types | `LOOKUP ON follow YIELD edge AS e` | Shows how to retrieve the source Vertex IDs, destination vertex IDs, and ranks of all edges of the `follow` edge type. | | Count the numbers of vertices or edges | `LOOKUP ON player YIELD id(vertex)| YIELD COUNT(*) AS Player_Count` | Shows how to count the number of vertices tagged with `player`. | - | Count the numbers of edges | `LOOKUP ON like YIELD id(vertex)| YIELD COUNT(*) AS Like_Count` | Shows how to count the number of edges of the `like` edge type. | + | Count the numbers of edges | `LOOKUP ON follow YIELD edge as e| YIELD COUNT(*) AS Like_Count` | Shows how to count the number of edges of the `follow` edge type. | diff --git a/docs-2.0/3.ngql-guide/8.clauses-and-options/return.md b/docs-2.0/3.ngql-guide/8.clauses-and-options/return.md index adb726af0ba..422fed469fa 100644 --- a/docs-2.0/3.ngql-guide/8.clauses-and-options/return.md +++ b/docs-2.0/3.ngql-guide/8.clauses-and-options/return.md @@ -126,22 +126,24 @@ nebula> MATCH (v:player{name:"Tim Duncan"}) \ ## Return properties -To return a vertex or edge property, use the `{|}.` syntax. +When returning properties of a vertex, it is necessary to specify the tag to which the properties belong because a vertex can have multiple tags and the same property name can appear on different tags. + +It is possible to specify the tag of a vertex to return all properties of that tag, or to specify both the tag and a property name to return only that property of the tag. ```ngql nebula> MATCH (v:player) \ - RETURN v.player.name, v.player.age \ + RETURN v.player, v.player.name, v.player.age \ LIMIT 3; -+------------------+--------------+ -| v.player.name | v.player.age | -+------------------+--------------+ -| "Danny Green" | 31 | -| "Tiago Splitter" | 34 | -| "David West" | 38 | -+------------------+--------------+ ++--------------------------------------+---------------------+--------------+ +| v.player | v.player.name | v.player.age | ++--------------------------------------+---------------------+--------------+ +| {age: 33, name: "LaMarcus Aldridge"} | "LaMarcus Aldridge" | 33 | +| {age: 25, name: "Kyle Anderson"} | "Kyle Anderson" | 25 | +| {age: 40, name: "Kobe Bryant"} | "Kobe Bryant" | 40 | ++--------------------------------------+---------------------+--------------+ ``` -Use the syntax `..` to return the property of a vertex; use the syntax `.` to return the property of an edge. +When returning edge properties, it is not necessary to specify the edge type to which the properties belong, because an edge can only have one edge type. ```ngql // Return the property of a vertex 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..ea0dd7425f4 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 @@ -12,6 +12,10 @@ Installing NebulaGraph from the source code allows you to customize the compilin - The host to be installed with NebulaGraph has access to the Internet. +{{ ent.ent_begin }} +- The [license key](../../9.about-license/2.license-management-suite/3.license-manager.md) is loaded. +{{ ent.ent_end }} + ## Installation steps 1. Use Git to clone the source code of NebulaGraph to the host. @@ -72,7 +76,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 +94,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/3.deploy-nebula-graph-with-docker-compose.md b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md index 96251d18cd5..a4e9cfedabe 100644 --- a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md +++ b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md @@ -20,6 +20,7 @@ Using Docker Compose can quickly deploy NebulaGraph services based on the prepar ## Deploy NebulaGraph + 1. Clone the `{{dockercompose.release}}` branch of the `nebula-docker-compose` repository to your host with Git. !!! danger @@ -34,13 +35,47 @@ Using Docker Compose can quickly deploy NebulaGraph services based on the prepar The `x.y` version of Docker Compose aligns to the `x.y` version of NebulaGraph. For the NebulaGraph `z` version, Docker Compose does not publish the corresponding `z` version, but pulls the `z` version of the NebulaGraph image. + !!! note + For installation of the NebulaGraph enterprise version, [contact us](https://www.nebula-graph.io/contact). + 2. Go to the `nebula-docker-compose` directory. ```bash $ cd nebula-docker-compose/ ``` -3. Run the following command to start all the NebulaGraph services. + {{ ent.ent_begin }} + +3. Configure License Manager address (skip this step if you are using the community version). + + 1. Edit the `docker-compose.yml` file. + + ```bash + $ cd nebula-docker-compose/ + $ vim docker-compose.yml + ``` + + 2. Add the `license_manager_url` field under all `services.metad{number}.command` and set its value to the access address of LM. + + ```yaml + ... + services: + metad0: + command: + - --license_manager_url=: // is the address of the LM service, and is the port of the LM service, which is 9119 by default. + metad1: + command: + - --license_manager_url=: + ... + ``` + + 3. Save and exit. + + + {{ ent.ent_end }} + + +4. Run the following command to start all the NebulaGraph services. !!! 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 35985eb7fae..da9cc017b36 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 @@ -8,6 +8,11 @@ You can install NebulaGraph by downloading the tar.gz file. - NebulaGraph is currently only supported for installation on Linux systems, and only CentOS 7.x, CentOS 8.x, Ubuntu 16.04, Ubuntu 18.04, and Ubuntu 20.04 operating systems are supported. +{{ ent.ent_begin }} +## Prerequisites + +- The [license key](../../9.about-license/2.license-management-suite/3.license-manager.md) is loaded. +{{ ent.ent_end }} ## Installation steps @@ -65,13 +70,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..551627c7605 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 key](../../9.about-license/2.license-management-suite/3.license-manager.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/9.about-license/1.license-overview.md b/docs-2.0/9.about-license/1.license-overview.md index 8d23f006d53..85319f53f8f 100644 --- a/docs-2.0/9.about-license/1.license-overview.md +++ b/docs-2.0/9.about-license/1.license-overview.md @@ -1,5 +1,9 @@ # About NebulaGraph licenses +!!! enterpriseonly + + NebulaGraph licenses applies only to the NebulaGraph Enterprise Edition. + ## What NebulaGraph licenses do NebulaGraph licenses are the legal permissions granted by Vesoft Co., Ltd., allowing you to utilize the capabilities of a NebulaGraph Enterprise Edition database and its associated software. You can buy a NebulaGraph license on a cloud marketplace or by contacting Vesoft's sales team. Currently, the only cloud marketplace available is the AWS Marketplace. You can purchase a NebulaGraph license from [NebulaGraph Enterprise (by Node)](https://aws.amazon.com/marketplace/pp/prodview-kvpxjh5b4dfno) on the AWS Marketplace. diff --git a/docs-2.0/9.about-license/2.license-management-suite/2.license-center.md b/docs-2.0/9.about-license/2.license-management-suite/2.license-center.md index 0e8dfc1ce99..ee6f3aed809 100644 --- a/docs-2.0/9.about-license/2.license-management-suite/2.license-center.md +++ b/docs-2.0/9.about-license/2.license-management-suite/2.license-center.md @@ -10,7 +10,7 @@ This article introduces how to set up an LC account, bind the LMID, and generate ## Preparations -[You have purchased a Vesoft license](../3.purchase-license.md) +[You have purchased a NebulaGraph license](../3.purchase-license.md) ## Set up an LC account @@ -100,11 +100,14 @@ In the **Purchased Resources** section, you can view the purchased query and sto After you bind the LMID, a license key is automatically generated and the **License Key** section displays the license key information. - Online license keys + When binding your LMID, select the **Online** mode to generate an online license key. After you [load the key into the LM service](3.license-manager.md#load-a-license-key), the LM can retrieve the latest license information regularly. - Offline license keys + When binding your LMID, select the **Offline** mode to generate an offline license key. Compared to an online license key, after you [load an offline license key into your LM](3.license-manager.md#load-a-license-key), the LM service stores fixed license information. If the license information is updated, a new offline license key must be obtained. + ### Subscription This section is only displayed when you purchase a license on a cloud marketplace. the subscription ID of the cloud marketplace where your license is purchased, your subscription platform account, product ID, and subscription details. diff --git a/docs-2.0/9.about-license/2.license-management-suite/3.license-manager.md b/docs-2.0/9.about-license/2.license-management-suite/3.license-manager.md index d10937d29ed..3d3a25b54fd 100644 --- a/docs-2.0/9.about-license/2.license-management-suite/3.license-manager.md +++ b/docs-2.0/9.about-license/2.license-management-suite/3.license-manager.md @@ -6,7 +6,7 @@ This article introduces how to deploy and use an LM service, as well as how to c ## Preparations -- [You have purchased a Vesoft license](../3.purchase-license.md). +- [You have purchased a NebulaGraph license](../3.purchase-license.md). - You have obtained the desired LM installation package. !!! note 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 b5ecc31a533..7357923d0d3 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 key](../9.about-license/2.license-management-suite/3.license-manager.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. @@ -89,7 +89,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`. - [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 d084cfa199b..450f7d9ed6d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -289,6 +289,7 @@ nav: #ent - License Manager: 9.about-license/2.license-management-suite/3.license-manager.md #ent - Purchase licenses: 9.about-license/3.purchase-license.md #ent - Manage licenses: 9.about-license/5.manage-license.md + - Quick start: - Getting started with NebulaGraph: 2.quick-start/1.quick-start-workflow.md - Step 1 Install NebulaGraph: 2.quick-start/2.install-nebula-graph.md