From 98e1db1b58b45df1b305be2e3935007bb79fed70 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Thu, 4 May 2023 14:56:28 +0800 Subject: [PATCH 01/19] Changes involving LM --- docs-2.0/20.appendix/8.about-license.md | 50 ----- ...bula-graph-by-compiling-the-source-code.md | 15 +- .../4.install-nebula-graph-from-tar.md | 18 +- .../deploy-nebula-graph-cluster.md | 15 +- .../upgrade-nebula-ent-from-3.x-3.4.md | 4 +- .../deploy-license.md | 109 ---------- .../1.configurations/2.meta-config.md | 14 +- .../11.dashboard-ent-license.md | 81 -------- .../11.license-manager.md | 15 ++ .../2.deploy-connect-dashboard-ent.md | 193 +++++++++++------- .../1.create-cluster.md | 6 +- .../operator/version-upgrade.md | 14 +- docs-2.0/nebula-dashboard-ent/8.faq.md | 5 +- .../deploy-connect/3.explorer-license.md | 81 -------- .../deploy-connect/ex-ug-deploy.md | 40 +--- .../3.1create-cluster-with-kubectl.md | 8 - ...urce_install-nebula-graph-by-rpm-or-deb.md | 11 +- .../replication-between-clusters.md | 16 +- mkdocs.yml | 6 +- 19 files changed, 196 insertions(+), 505 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 22c15e98c40..00000000000 --- a/docs-2.0/20.appendix/8.about-license.md +++ /dev/null @@ -1,50 +0,0 @@ -# 关于 License - -License 是一种软件许可证，用以规定和限制用户使用软件的权利。在{{nebula.name}}内核及生态工具中，License 被用于限制企业版软件的使用权限。本文介绍需设置 License 的产品及 License 的相关信息。 - -{{ ent.ent_begin }} -## {{nebula.name}} - -部署{{nebula.name}}时，用户需设置 License。 - -更多信息，参见[设置 License](../4.deployment-and-installation/deploy-license.md)。 - -{{ ent.ent_end }} - -## {{dashboard_ent.name}} - -{{dashboard_ent.name}}是一款开箱即用的多集群可视化运维工具，支持可视化集群操作和多维度监控集群。 - -部署{{dashboard_ent.name}}时，用户需设置{{dashboard_ent.name}} License。更多信息，参见 [{{dashboard_ent.name}} License](../nebula-dashboard-ent/11.dashboard-ent-license.md)。 - -## {{explorer.name}} - -{{explorer.name}}是一款通过 Web 访问的图探索可视化工具，搭配{{nebula.name}}内核使用，无需掌握图查询语言即可对大规模业务数据进行查找分析，分析结果直接可视化展示，可轻松快速挖掘数据的业务价值。 - -部署{{explorer.name}}时，用户需设置{{explorer.name}} License。更多信息，参见 [{{explorer.name}} License](../nebula-explorer/deploy-connect/3.explorer-license.md)。 - -## License 常见问题 - -### {{dashboard_ent.name}}/{{explorer.name}}/{{nebula.name}}的 License 一样吗？ - -不一样，{{dashboard_ent.name}、{{explorer.name}}、{{nebula.name}}的 License 相互独立，不可互用。 - -### License 过期前，是否有信息提示？License 过期后如何续期？ - -License 过期前，系统会发送过期提醒信息。 - -正式版的 License 和试用版的 License 的过期前的提醒时间不同。 - -- 正式版的 License 过期提醒： - - - 过期前 30 天和过期当天，在启动服务时有过期提醒。 - - - 到期后有 14 天缓冲期。在缓冲期期间，有过期提示，用户能继续使用{{nebula.name}}/{{dashboard_ent.name}/{{explorer.name}}。缓冲期结束后，服务会停机并无法启动。 - -- 试用版的 License 过期提醒： - - - 过期前 7 天和过期当天，在启动服务时有过期提醒。 - - - 无缓冲期。License 到期后，无法启动服务。 - -License 过期后，请及时联系销售（[inqury@vesoft.com](mailto:inqury@vesoft.com)）更换新的证书。 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 642968a7a7b..5f61830b0b3 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,14 @@ $ sudo make install ``` -7. 安装目录下`etc/`目录中（默认为`/usr/local/nebula/etc`）的配置文件为参考模版，用户可以根据需要创建自己的配置文件。如果要使用 `script` 目录下的脚本，启动、停止、重启、中止和查看服务，配置文件需要命名为 `nebula-graph.conf`，`nebula-metad.conf`和`nebula-storaged.conf`。 +{{ ent.ent_begin }} +7. 在{{nebula.name}}的 Meta 服务配置文件（`nebula-metad.conf`）中，设置`license_manager_url`的值为许可证管理工具所在的主机 IP 和端口号`9119`，例如`192.168.8.100:9119`。 + +{{ ent.ent_end }} + +!!! note + + 安装目录下`etc/`目录中（默认为`/usr/local/nebula/etc`）的配置文件为参考模版，用户可以根据需要创建自己的配置文件。如果要使用 `script` 目录下的脚本，启动、停止、重启、中止和查看服务，配置文件需要命名为 `nebula-graph.conf`，`nebula-metad.conf`和`nebula-storaged.conf`。 ## 更新 master 版本 @@ -84,11 +91,7 @@ master 分支的代码更新速度快，如果安装了 master 分支对应的 ## 下一步 -{{ ent.ent_begin }} -- （企业版）[设置 License](../deploy-license.md) -{{ ent.ent_end }} - -- [管理{{nebula.name}}服务](../../2.quick-start/3.quick-start-on-premise/5.start-stop-service.md) +[管理{{nebula.name}}服务](../../2.quick-start/3.quick-start-on-premise/5.start-stop-service.md) ## CMake 参数 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 ef0a51e645e..83b69ec5d21 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,15 +67,19 @@ 3. 修改配置文件名以应用配置。 - 进入解压出的目录，将子目录`etc`中的文件`nebula-graphd.conf.default`、`nebula-metad.conf.default`和`nebula-storaged.conf.default`重命名，删除`.default`，即可应用{{nebula.name}}的默认配置。如需修改配置，参见[配置管理](../../5.configurations-and-logs/1.configurations/1.configurations.md)。 - -至此，{{nebula.name}}安装完毕。 - -## 下一步 + 进入解压出的目录，将子目录`etc`中的文件`nebula-graphd.conf.default`、`nebula-metad.conf.default`和`nebula-storaged.conf.default`重命名，删除`.default`，即可应用{{nebula.name}}的默认配置。 {{ ent.ent_begin }} -- [设置 License](../deploy-license.md) +4. 在{{nebula.name}}的 Meta 服务配置文件（`nebula-metad.conf`）中，设置`license_manager_url`的值为许可证管理工具所在的主机 IP 和端口号`9119`，例如`192.168.8.100:9119`。 {{ ent.ent_end }} -- [管理{{nebula.name}}服务](../manage-service.md) +!!! note + + 如需修改更多配置，参见[配置管理](../../5.configurations-and-logs/1.configurations/1.configurations.md)。 + +至此，{{nebula.name}}安装完毕。 + +## 下一步 + +[管理{{nebula.name}}服务](../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 10d2c749a0b..7cc51e8b710 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 @@ -20,6 +20,9 @@ - 准备 5 台用于部署集群的机器。 - 在集群中通过 NTP 服务同步时间。 +{{ ent.ent_begin }} +- 已安装[许可证管理工具](../../9.about-license/2.license-management-suite/3.license-manager.md)并且[加载授权码](../../9.about-license/4.generate-and-load-license-key.md)。 +{{ ent.ent_end }} ## 手动部署流程 @@ -31,12 +34,6 @@ - [使用源码安装{{nebula.name}}](1.install-nebula-graph-by-compiling-the-source-code.md) -{{ ent.ent_begin }} -### 设置 License。 - -如果部署{{nebula.name}}，需要设置 License。详情请参见[设置{{nebula.name}} License](../../4.deployment-and-installation/deploy-license.md)。 - -{{ ent.ent_end }} ### 修改配置文件 修改每个服务器上的{{nebula.name}}配置文件。 @@ -63,6 +60,12 @@ - [Storage 服务配置](../../5.configurations-and-logs/1.configurations/4.storage-config.md) +{{ ent.ent_begin }} +!!! note + + Meta 服务配置文件中，需要设置`license_manager_url`的值为 LM 所在的主机 IP 和端口号`9119`，例如`192.168.8.100:9119`。 +{{ ent.ent_end }} + - 机器 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 5a7e4acfcba..a0127b7213f 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 @@ -89,9 +89,7 @@ 服务升级完成后，会在 v{{nebula.release}} 的安装目录下生成`data`目录，其中包含升级后的数据文件。 -4. 上传 License 文件至 v{{nebula.release}} 的安装目录下的`share/resources`内。 - -5. 启动和连接{{nebula.name}} v{{nebula.release}} 服务后，验证数据是否正确。参考命令如下： +4. 启动和连接{{nebula.name}} v{{nebula.release}} 服务后，验证数据是否正确。参考命令如下： ``` 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 8caf30b3072..00000000000 --- a/docs-2.0/4.deployment-and-installation/deploy-license.md +++ /dev/null @@ -1,109 +0,0 @@ -# 设置{{nebula.name}} License - -{{nebula.name}}需要用户设置 License 才可以正常启动并使用企业版功能，本文介绍如何设置企业版的 License 文件。 - -!!! enterpriseonly - - License 是为企业版用户提供的软件授权证书，企业版用户可以[联系我们](https://www.nebula-graph.com.cn/contact)申请 License 文件。 - -## 注意事项 - -- 没有设置 License 时，{{nebula.name}}无法启动。 - -- 请勿修改 License 文件，否则会导致 License 失效。 - -- License 快过期时，请[联系我们](https://www.nebula-graph.com.cn/contact)申请续期。 - -- License 的过期缓冲为 14 天： - - - 过期前 30 天和过期当天，服务启动时会打印日志进行提醒。 - - - 过期后仍可继续使用 14 天。 - - - 过期 14 天后，服务无法启动，并会打印日志进行提醒。 - -## {{nebula.name}} License 说明 - -License 文件（`nebula.license`）内容示例如下： - -```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---------- -``` - -License 文件包含生效时间、过期时间等信息。说明如下。 - -|参数|说明| -|:---|:---| -|`vendor`| 发放渠道。| -|`organization`| 用户名称。| -|`issuedDate`| License 生效时间。| -|`expirationDate`| License 过期时间。| -|`product`| 产品类型。{{nebula.name}}的产品类型为`nebula_graph`。| -|`version`| 版本支持的信息。| -|`licenseType`| License 类型。包括`enterprise`、`samll_bussiness`、`pro`、`individual`。预留参数。| -|`gracePeriod`| 证书过期后可继续使用服务的缓冲时间（单位天），超过缓冲期后停止服务。试用版的 License 过期后无缓冲期，默认值为 0。 | -|`graphdSpec`| 集群中 Graph 服务的数量限制。{{nebula.name}}会实时监测当前活动的 Graph 服务数量，超过限制的 Graph 服务无法连接集群。| -|`storagedSpec`| 集群中 Storage 服务的数量限制。{{nebula.name}}会实时监测当前活动的 Storage 服务数量，超过限制的 Storage 服务无法连接集群。| -|`clusterCode`| 用户的硬件信息，也是集群的唯一标识码。试用版的 License 中无此参数。 | - -## 设置{{nebula.name}} License - -1. [联系我们](https://www.nebula-graph.com.cn/contact)申请{{nebula.name}}安装包。 - -2. 安装{{nebula.name}}。安装方式与社区版相同，请参见[使用 RPM 或 DEB 包安装{{nebula.name}}](2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md)。 - -3. [联系我们](https://www.nebula-graph.com.cn/contact)申请 License 文件`nebula.license`。 - -4. 将 License 文件上传到所有包含 Meta 服务的机器上，路径为每个 Meta 服务安装目录的`share/resources/`内。 - - !!! note - - 周边工具的 License 文件上传位置，请参见[具体周边工具](../20.appendix/6.eco-tool-version.md)的说明文档。 - -## 续期{{nebula.name}} License - -1. 发送邮件至`inqury@vesoft.com`申请新的{{nebula.name}} License。 - -2. 在所有包含 Meta 服务的机器上，路径为每个 Meta 服务安装目录的`share/resources/`内，使用新的 License 文件`nebula.license`替换旧的 License 文件。 - -3. 重启 Storage 和 Graph 服务。关于重启操作，参见[启动服务](manage-service.md)。如果用户的 License 的过期时间在到期后的缓冲期内（默认 14 天），则无需重启 Storage 和 Graph 服务。 - - !!! note - - 当用户的 License 过期时间超过到期后的缓冲期，Graph 和 Storage 服务会自动停止。为了确保服务正常运行，请及时更新 License。 - -## 查看{{nebula.name}} License - -- 直接查看 License 文件 - - 可以使用 cat 等命令直接查看 License 文件，例如`cat share/resources/nebula.license`。 - -- 通过 HTTP 接口查看 License 文件 - - 当{{nebula.name}}正常运行时，可以请求 Meta 服务的 HTTP 接口（默认为19559）获取 License 文件内容。例如`curl -G "http://192.168.10.101:19559/license"`。 - -## 下一步 - -[启动{{nebula.name}}](manage-service.md) 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 30f14843a49..6d8032ffbd9 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,19 +29,21 @@ Meta 服务提供了两份初始配置文件`nebula-metad.conf.default`和`nebul | `pid_file` | `pids/nebula-metad.pid` | 记录进程 ID 的文件。 |不支持| | `timezone_name` | - | 指定{{nebula.name}}的时区。初始配置文件中未设置该参数，如需使用请手动添加。系统默认值为`UTC+00:00:00`。格式请参见 [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")。例如，东八区的设置方式为`--timezone_name=UTC+08:00`。 |不支持| +!!! Note + + * 在插入[时间类型](../../3.ngql-guide/3.data-types/4.date-and-time.md)的属性值时，{{nebula.name}}会根据`timezone_name`设置的时区将该时间值（TIMESTAMP 类型例外）转换成相应的 UTC 时间，因此在查询中返回的时间类型属性值为 UTC 时间。 + * `timezone_name`参数只用于转换{{nebula.name}}中存储的数据，{{nebula.name}}进程中其它时区相关数据，例如日志打印的时间等，仍然使用主机系统默认的时区。 + {{ ent.ent_begin }} +## enterprise license 配置 + | 名称 | 预设值 | 说明 |是否支持运行时动态修改| | :----------- | :----------------------- | :------------------|:------------------| -|`license_path`|`share/resources/nebula.license`|企业版 License 路径。企业版需要用户[设置 License](../../4.deployment-and-installation/deploy-license.md) 才可以正常启动并使用企业版功能。仅{{nebula.name}}需要设置本参数，其他周边工具如何设置 License，请参见相应周边工具的部署文档。|不支持| +|`license_manager_url`|-|License Manager 地址。设置为 LM 所在的主机 IP 和端口号`9119`，例如`192.168.8.100:9119`。|不支持| {{ ent.ent_end }} -!!! Note - - * 在插入[时间类型](../../3.ngql-guide/3.data-types/4.date-and-time.md)的属性值时，{{nebula.name}}会根据`timezone_name`设置的时区将该时间值（TIMESTAMP 类型例外）转换成相应的 UTC 时间，因此在查询中返回的时间类型属性值为 UTC 时间。 - * `timezone_name`参数只用于转换{{nebula.name}}中存储的数据，{{nebula.name}}进程中其它时区相关数据，例如日志打印的时间等，仍然使用主机系统默认的时区。 - ## logging 配置 | 名称 | 预设值 | 说明 |是否支持运行时动态修改| 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 913ace920ff..00000000000 --- a/docs-2.0/nebula-dashboard-ent/11.dashboard-ent-license.md +++ /dev/null @@ -1,81 +0,0 @@ -# {{dashboard_ent.name} License - -License 是为用户提供的软件授权证书。用户在部署{{dashboard_ent.name}时，需要设置 License 才能正常启动{{dashboard_ent.name}。本文介绍{{dashboard_ent.name}的 License 相关信息。 - - -## 注意事项 - -- 没有设置 License 时，{{dashboard_ent.name}无法启动。 - -- 请勿修改 License，否则会导致 License 失效。 - -- License 快过期时，请[联系我们](https://www.nebula-graph.com.cn/contact)申请续期。 - -- License 的过期缓冲为 14 天： - - - 过期前 30 天和过期当天，服务启动时会打印日志进行提醒。 - - - 过期后仍可继续使用 14 天。 - - - 过期 14 天后，服务无法启动，并会打印日志进行提醒。 - -## 获取方式 - -[联系我们](https://www.nebula-graph.com.cn/contact)申请{{dashboard_ent.name} License。 - -!!! note - - 填写 [{{dashboard_ent.name}试用申请](https://wj.qq.com/s2/10158890/69a8)可获取 30 天免费试用的 License。 - -## {{dashboard_ent.name} License 说明 - -{{dashboard_ent.name} License 是一个名为`nebula.license`的文件，内容示例如下： - -```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---------- -``` - -License 文件包含生效时间、过期时间等信息。说明如下。 - -|参数|说明| -|:---|:---| -|`vendor`| 发放渠道。| -|`organization`| 用户名称。| -|`issuedDate`| License 生效时间。| -|`expirationDate`| License 过期时间。| -|`product`| 产品类型。{{dashboard_ent.name}的产品类型为`nebula_graph_dashboard`。| -|`version`| 版本支持的信息。| -|`licenseType`| License 类型（预留参数）。包括`enterprise`、`samll_bussiness`、`pro`、`individual`。| -|`gracePeriod`| 证书过期后可继续使用服务的缓冲时间（单位天），超过缓冲期后停止服务。试用版的 License 过期后无缓冲期，默认值为 0。 | -|`clusterCode`| 用户的硬件信息，也是集群的唯一标识码。试用版的 License 中无此参数。 | - -## 使用方式 - -关于如何使用{{dashboard_ent.name} License，参见[部署{{dashboard_ent.name}](2.deploy-connect-dashboard-ent.md)。 - -## 续期操作 - -按照以下操作续期{{dashboard_ent.name} License。 - -1. [联系我们](https://www.nebula-graph.com.cn/contact)申请新的{{dashboard_ent.name} License 文件`nebula.license`。 -2. 在{{dashboard_ent.name}的安装目录下（例如，`/usr/local/nebula-dashboard-ent`），使用新的 License 文件替换旧的 License 文件。 - -!!! note - - License 过期后，用户无法登录{{dashboard_ent.name}。为了保证业务正常运行，请及时更新 License。 \ No newline at end of file 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..0858340031f --- /dev/null +++ b/docs-2.0/nebula-dashboard-ent/11.license-manager.md @@ -0,0 +1,15 @@ +# 许可证管理 + +在悦数图数据库及附属软件中配置许可证管理工具（License Manager，LM）后，可通过 LM 校验许可证的有效性，从而保证悦数图数据库及附属软件的正常使用。 + +{{dashboard_ent.name}目前仅提供页面展示许可证信息、许可证使用情况和产品列表。 + +## 前提条件 + +- 已安装[许可证管理工具](../9.about-license/2.license-management-suite/3.license-manager.md)并且[加载授权码](../9.about-license/4.generate-and-load-license-key.md)。 + +- 已修改`config.yaml`文件，设置`LicenseManagerURL`的值为 LM 所在的主机 IP 和端口号`9119`，例如`192.168.8.100:9119`。 + +## 入口 + +在{{dashboard_ent.name}顶部导航栏中，单击**许可证管理**即可查看相关信息。 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 83f1d4c8acd..b0ba18208a2 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 @@ 在部署{{dashboard_ent.name}之前，用户需要确认以下信息： +- 已安装[许可证管理工具](../9.about-license/2.license-management-suite/3.license-manager.md)并且[加载授权码](../9.about-license/4.generate-and-load-license-key.md)。 + - 选择并下载符合版本的{{dashboard_ent.name}。关于{{dashboard_ent.name}和{{nebula.name}}的版本对应关系，参见[版本兼容性](1.what-is-dashboard-ent.md)。 - {{dashboard_ent.name}支持 SQLite 和 MySQL 存储{{dashboard_ent.name}元数据。如果用户使用 MySQL，需准备版本为 5.7 以上的 [MySQL](https://www.mysql.com/cn/) 环境，创建名称为`dashboard`的数据库，字符集为`utf8`。 @@ -52,19 +54,18 @@ $ tar -xzvf nebula-dashboard-ent-{{dashboard_ent.release}}.linux-amd64.tar.gz -C /usr/local/ ``` -3. 使用`vim /usr/local/nebula-dashboard-ent/etc/config.yaml`命令设置配置文件。 +3. 进入解压后的文件夹，在`etc`目录内修改`config.yaml`文件，设置相关配置。 ```bash Name: dashboard-api Host: 0.0.0.0 # 指定能访问{{dashboard_ent.name}的地址。 - Port: 7005 # 访问{{dashboard_ent.name}企业版服务的默认端口。 + Port: 7005 # 访问{{dashboard_ent.name}的默认端口。 MaxBytes: 1073741824 # Http 可接受请求的最大 ContentLength，默认为 1048576。取值范围：0 ~ 8388608。 - Timeout: 15000 # 访问超时时间。 - Debug: # 是否开启Debug模式。 - Enable: false + Timeout: 60000 # 访问超时时间。 Log: # {{dashboard_ent.name}运行日志设置。 KeepDays: 7 # 日志保留天数。 - Mode: console # 日志保存方式，支持 console 和 file。console 表示服务日志会记录在 webserver.log里；file 表示服务日志会分别记录在 access.log、error.log、severe.log、slow.log 和 stat.log 里。 + Mode: file # 日志保存方式，支持 console 和 file。console 表示服务日志会记录在 webserver.log里；file 表示服务日志会分别记录在 access.log、error.log、severe.log、slow.log 和 stat.log 里。 + Encoding: plain # 日志编码方式，支持 plain 和 json。 Database: Dialect: sqlite # 使用的数据库类型，目前支持 SQLite 和 MySQL，默认使用 SQLite。 AutoMigrate: true # 自动创建数据库表，默认为 true。 @@ -91,33 +92,23 @@ Username: "" # SMTP 服务器的用户名。 Password: "" # SMTP 服务器的密码。 + # 慢查询设置 + SlowQuery: + Enable: true # 慢查询数据轮询开关。 + MessageStore: 14 # 慢查询数据存储时长。单位：天。 + ScrapeInterval: 2m # 拉取慢查询数据的间隔时间，例如:1s、10s、2m、3h。 + # 系统信息 System: WebAddress: http://127.0.0.1:7005 # 外网访问{{dashboard_ent.name}的地址，也可以设置为域名。用于一些接口回调，例如邮件被邀请人可以使用此链接访问{{dashboard_ent.name}。 MessageStore: 90 # 保存告警消息的天数，默认 90 天。 - # LDAP 信息 - LDAP: - Server: ldap://127.0.0.1 # LDAP 服务器地址。 - BindDN: cn=admin,dc=vesoft,dc=com # LDAP 服务器登录用户名。 - BindPassword: "" # LDAP 服务器登录密码。 - BaseDN: dc=vesoft,dc=com # 查询用户数据的路径。 - UserFilter: "&(objectClass=*)" # 查询条件。 - EmailKey: mail # LDAP 数据库存放邮箱信息的字段名。 - ``` - -4. 拷贝 License 至`nebula-dashboard-ent`目录下。 + CloudProvider: "" # 云提供商名称。 - ```bash - $ cp -r + LicenseManagerURL: http://192.168.8.166:9119 # License Manager 所在的主机 IP，端口默认为9119。 ``` - 例如： - ```bash - $ cp -r nebula.license /usr/local/nebula-dashboard-ent - ``` - -5. 启动{{dashboard_ent.name}。 +4. 启动{{dashboard_ent.name}。 可以使用以下命令一键启动{{dashboard_ent.name}。 @@ -164,18 +155,61 @@ sudo rpm -ivh nebula-dashboard-ent-xxx.rpm --prefix= ``` -3. 拷贝 License 至`nebula-dashboard-ent`目录下。 +3. 进入解压后的文件夹，在`etc`目录内修改`config.yaml`文件，设置相关配置。 ```bash - $ cp -r - ``` + Name: dashboard-api + Host: 0.0.0.0 # 指定能访问{{dashboard_ent.name}的地址。 + Port: 7005 # 访问{{dashboard_ent.name}的默认端口。 + MaxBytes: 1073741824 # Http 可接受请求的最大 ContentLength，默认为 1048576。取值范围：0 ~ 8388608。 + Timeout: 60000 # 访问超时时间。 + Log: # {{dashboard_ent.name}运行日志设置。 + KeepDays: 7 # 日志保留天数。 + Mode: file # 日志保存方式，支持 console 和 file。console 表示服务日志会记录在 webserver.log里；file 表示服务日志会分别记录在 access.log、error.log、severe.log、slow.log 和 stat.log 里。 + Encoding: plain # 日志编码方式，支持 plain 和 json。 + Database: + Dialect: sqlite # 使用的数据库类型，目前支持 SQLite 和 MySQL，默认使用 SQLite。 + AutoMigrate: true # 自动创建数据库表，默认为 true。 + Host: 127.0.0.1 # 连接的 MySQL 数据库的 IP 地址。 + Port: 3306 # 连接的 MySQL 数据库的端口号。 + Username: root # 登录 MySQL 的账户。 + Password: nebula # 登录 MySQL 的密码。 + Name: dashboard # 对应的数据库名称。 - 例如： - ```bash - $ cp -r nebula.license /usr/local/nebula-dashboard-ent + # exporter 端口信息 + Exporter: + NodePort: 9100 # node-exporter 服务的端口。 + NebulaPort: 9200 # nebula-stats-exporter 服务的端口。 + + # 服务信息 + Proxy: + PrometheusAddr: 127.0.0.1:9090 # prometheus 服务的 IP 地址和端口。 + AlertmanagerAddr: 127.0.0.1:9093 # alertmanager 服务的 IP 地址和端口。 + + # 邀请 LDAP 账号的发件人邮箱信息 + Mail: + Host: smtp.office365.com # SMTP 服务器地址。 + Port: 587 # SMTP 服务器的端口号。 + Username: "" # SMTP 服务器的用户名。 + Password: "" # SMTP 服务器的密码。 + + # 慢查询设置 + SlowQuery: + Enable: true # 慢查询数据轮询开关。 + MessageStore: 14 # 慢查询数据存储时长。单位：天。 + ScrapeInterval: 2m # 拉取慢查询数据的间隔时间，例如:1s、10s、2m、3h。 + + # 系统信息 + System: + WebAddress: http://127.0.0.1:7005 # 外网访问{{dashboard_ent.name}的地址，也可以设置为域名。用于一些接口回调，例如邮件被邀请人可以使用此链接访问{{dashboard_ent.name}。 + MessageStore: 90 # 保存告警消息的天数，默认 90 天。 + + CloudProvider: "" # 云提供商名称。 + + LicenseManagerURL: http://192.168.8.166:9119 # License Manager 所在的主机 IP，端口默认为9119。 ``` -4. （可选）使用以下命令查看所有服务状态、启动服务。 +4. 使用以下命令查看所有服务状态、启动服务。 ``` sudo systemctl list-dependencies nebula-dashboard.target # 查看状态 @@ -188,29 +222,6 @@ sudo systemctl {status|stop|start}  {nbd-prometheus.service|nbd-alert-manager.service|nbd-stats-exporter.service|nbd-webserver.service} ``` -5. （可选）如需配置集群告警信息的接收人及配置 LDAP 账户，使用`vim /usr/local/nebula-dashboard-ent/etc/config.yaml`命令添加以下配置。 - - ``` - # 邀请 LDAP 账号的发件人邮箱信息 - mail: - host: smtp.office365.com # SMTP 服务器地址。 - port: 587 # SMTP 服务器的端口号。 - username: "" # SMTP 服务器的用户名。 - password: "" # SMTP 服务器的密码。 - # 系统信息 - system: - webAddress: http://127.0.0.1:7005 # 邮件被邀请人连接{{dashboard_ent.name}的访问地址。 - messageStore: 90 # 保存告警消息的天数，默认 90 天。 - # LDAP 信息 - ldap: - server: ldap://127.0.0.1 # LDAP 服务器地址。 - bindDN: cn=admin,dc=vesoft,dc=com # LDAP 服务器登录用户名。 - bindPassword: "" # LDAP 服务器登录密码。 - baseDN: dc=vesoft,dc=com # 查询用户数据的路径。 - userFilter: "&(objectClass=*)" # 查询条件。 - emailKey: mail # LDAP 数据库存放邮箱信息的字段名。 - ``` - ### 卸载 执行以下命令卸载通过 RPM 包部署的{{dashboard_ent.name}。 @@ -242,18 +253,61 @@ sudo rpm -e 使用 DEB 包安装{{dashboard_ent.name}时不支持自定义安装路径。 -3. 拷贝 License 至`nebula-dashboard-ent`目录下。 +3. 进入解压后的文件夹，在`etc`目录内修改`config.yaml`文件，设置相关配置。 ```bash - $ cp -r - ``` + Name: dashboard-api + Host: 0.0.0.0 # 指定能访问{{dashboard_ent.name}的地址。 + Port: 7005 # 访问{{dashboard_ent.name}的默认端口。 + MaxBytes: 1073741824 # Http 可接受请求的最大 ContentLength，默认为 1048576。取值范围：0 ~ 8388608。 + Timeout: 60000 # 访问超时时间。 + Log: # {{dashboard_ent.name}运行日志设置。 + KeepDays: 7 # 日志保留天数。 + Mode: file # 日志保存方式，支持 console 和 file。console 表示服务日志会记录在 webserver.log里；file 表示服务日志会分别记录在 access.log、error.log、severe.log、slow.log 和 stat.log 里。 + Encoding: plain # 日志编码方式，支持 plain 和 json。 + Database: + Dialect: sqlite # 使用的数据库类型，目前支持 SQLite 和 MySQL，默认使用 SQLite。 + AutoMigrate: true # 自动创建数据库表，默认为 true。 + Host: 127.0.0.1 # 连接的 MySQL 数据库的 IP 地址。 + Port: 3306 # 连接的 MySQL 数据库的端口号。 + Username: root # 登录 MySQL 的账户。 + Password: nebula # 登录 MySQL 的密码。 + Name: dashboard # 对应的数据库名称。 - 例如： - ```bash - $ cp -r nebula.license /usr/local/nebula-dashboard-ent + # exporter 端口信息 + Exporter: + NodePort: 9100 # node-exporter 服务的端口。 + NebulaPort: 9200 # nebula-stats-exporter 服务的端口。 + + # 服务信息 + Proxy: + PrometheusAddr: 127.0.0.1:9090 # prometheus 服务的 IP 地址和端口。 + AlertmanagerAddr: 127.0.0.1:9093 # alertmanager 服务的 IP 地址和端口。 + + # 邀请 LDAP 账号的发件人邮箱信息 + Mail: + Host: smtp.office365.com # SMTP 服务器地址。 + Port: 587 # SMTP 服务器的端口号。 + Username: "" # SMTP 服务器的用户名。 + Password: "" # SMTP 服务器的密码。 + + # 慢查询设置 + SlowQuery: + Enable: true # 慢查询数据轮询开关。 + MessageStore: 14 # 慢查询数据存储时长。单位：天。 + ScrapeInterval: 2m # 拉取慢查询数据的间隔时间，例如:1s、10s、2m、3h。 + + # 系统信息 + System: + WebAddress: http://127.0.0.1:7005 # 外网访问{{dashboard_ent.name}的地址，也可以设置为域名。用于一些接口回调，例如邮件被邀请人可以使用此链接访问{{dashboard_ent.name}。 + MessageStore: 90 # 保存告警消息的天数，默认 90 天。 + + CloudProvider: "" # 云提供商名称。 + + LicenseManagerURL: http://192.168.8.166:9119 # License Manager 所在的主机 IP，端口默认为9119。 ``` -4. （可选）使用以下命令查看所有服务状态、启动服务。 +4. 使用以下命令查看所有服务状态、启动服务。 ``` sudo systemctl list-dependencies nebula-dashboard.target # 查看状态 @@ -266,21 +320,6 @@ sudo rpm -e sudo {systemctl status|stop|start}  {nbd-prometheus.service|nbd-alert-manager.service|nbd-stats-exporter.service|nbd-webserver.service} ``` -5. （可选）如需配置 LDAP 和 OAuth2.0 账号的发件人邮箱信息以及告警消息保存天数，使用`vim /usr/local/nebula-dashboard-ent/etc/config.yaml`命令添加以下配置。 - - ``` - # 邀请 LDAP 和 OAuth2.0 账号的发件人邮箱信息 - mail: - host: smtp.office365.com # SMTP 服务器地址。 - port: 587 # SMTP 服务器的端口号。 - username: "" # SMTP 服务器的用户名。 - password: "" # SMTP 服务器的密码。 - # 系统信息 - system: - webAddress: http://127.0.0.1:7005 # 邮件被邀请人连接{{dashboard_ent.name}的访问地址。 - messageStore: 90 # 告警消息保存的天数，默认 90 天。 - ``` - ### 卸载 执行以下命令卸载通过 DEB 包部署的{{dashboard_ent.name}。 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 cc2bce593a9..3ff01214799 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 @@ -16,14 +16,12 @@ {{dashboard_ent.name}默认内置企业版的{{nebula.name}}安装包。如果用户需要安装其他版本的{{nebula.name}}，可以在**安装包管理**页面下载或上传，详情参见[安装包管理](../system-settings/manage-package.md)。 - - 单击**上传证书**。 - !!! note - 如果创建社区版的{{nebula.name}}，则不需要上传 License 证书，忽略此步骤。 + 创建 3.5.0 以下版本的集群时，需要手动上传 License 证书。 - 添加节点信息，提供两种方式： - + - **添加节点**，输入待添加节点的 Host 信息、SSH 端口号、SSH 用户、认证方式、安装包等。 关于认证方式的说明如下： 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 d485377dde0..c56131c0356 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 @@ - 仅支持升级版本不低于 **3.0.0** 的{{nebula.name}}集群，且最高升级至 **3.2.1** 版本。如需升级至 **3.3.0**，请参见[手动升级文档](../../..//4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-300-to-latest.md)。 - 不支持跨大版本升级集群。 - - 支持社区版升级为企业版（需要上传校验 License）或企业版升级为社区版。 + - 支持社区版升级为企业版或企业版升级为社区版。 - 支持升级为当前大版本内的任意小版本（包括比当前版本低的小版本）。 ## 操作说明 @@ -25,17 +25,15 @@ !!! note 如果没有找到合适的版本，单击**包管理中心**，下载或上传所需的版本安装包。详情参见[安装包管理](../../system-settings/manage-package.md)。 - -5. 单击**上传证书**上传{{dashboard_ent.name}} License（如升级社区版{{nebula.name}}集群，忽略此步）。 - !!! enterpriseonly - - 此步骤仅针对升级企业版{{nebula.name}}集群。 + !!! note + + 升级 3.5.0 以下版本的企业版集群时，需要单击**上传证书**上传{{dashboard_ent.name}} License。 -6. 单击**下一步**，进行升级检查，然后再单击**下一步**。 +5. 单击**下一步**，进行升级检查，然后再单击**下一步**。 集群在升级期间将会停机，升级完成后会自动重启服务。升级前您可以通过**查看诊断报告**了解集群线上运行情况，从而帮助您判断当前集群停机升级是否合适。 -7. 再次确认升级信息，包括**集群名称**、**当前{{nebula.name}}版本**和**待升级{{nebula.name}}版本**，然后单击**升级**。 +6. 再次确认升级信息，包括**集群名称**、**当前{{nebula.name}}版本**和**待升级{{nebula.name}}版本**，然后单击**升级**。 用户可以在在[任务中心](../../10.tasks.md)查看升级任务信息，类型为`version update`。 diff --git a/docs-2.0/nebula-dashboard-ent/8.faq.md b/docs-2.0/nebula-dashboard-ent/8.faq.md index c8679580409..40bdc0b0f87 100644 --- a/docs-2.0/nebula-dashboard-ent/8.faq.md +++ b/docs-2.0/nebula-dashboard-ent/8.faq.md @@ -36,10 +36,7 @@ Meta 服务主要存储{{nebula.name}}数据库中的元数据。一旦 Meta 服 ## 为什么无法启动{{dashboard_ent.name}？ -- 确保 License 已拷贝至{{dashboard_ent.name}目录中，且执行了`sudo ./dashboard.service start all`命令。 -- 确保 License 未过期。 - -用户也可以在{{dashboard_ent.name}目录中执行`cat logs/webserver.log`查看各个模块的启动信息。如果满足以上条件，仍无法启动{{dashboard_ent.name}，请前往 [{{nebula.name}}官方论坛](https://discuss.nebula-graph.com.cn/ "点击前往{{nebula.name}}官方论坛")咨询。 +确保已安装[许可证管理工具](../9.about-license/2.license-management-suite/3.license-manager.md)并且[加载授权码](../9.about-license/4.generate-and-load-license-key.md)。 ## 是否可以手动添加{{nebula.name}}安装包？ 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 81e57902e4d..00000000000 --- a/docs-2.0/nebula-explorer/deploy-connect/3.explorer-license.md +++ /dev/null @@ -1,81 +0,0 @@ -# {{explorer.name}} License - -License 是为用户提供的软件授权证书。用户在部署{{explorer.name}}时，需要设置 License 才能正常启动。本文介绍{{explorer.name}}的 License 相关信息。 - - -## 注意事项 - -- 没有设置 License 时，{{explorer.name}}无法启动。 - -- 请勿修改 License，否则会导致 License 失效。 - -- License 快过期时，请[联系我们](https://www.nebula-graph.com.cn/contact)申请续期。 - -- License 的过期缓冲为 14 天： - - - 过期前 30 天和过期当天，服务启动时会打印日志进行提醒。 - - - 过期后仍可继续使用 14 天。 - - - 过期 14 天后，服务无法启动，并会打印日志进行提醒。 - -## 获取方式 - -[联系我们](https://www.nebula-graph.com.cn/contact)申请{{explorer.name}} License。 - -!!! note - - 填写 [{{explorer.name}}试用申请](https://wj.qq.com/s2/10158890/69a8)可获取 30 天免费试用的 License。 - -## {{explorer.name}} License 说明 - -{{explorer.name}} License 是一个名为`nebula.license`的文件，内容示例如下： - -```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---------- -``` - -License 文件包含生效时间、过期时间等信息。说明如下。 - -|参数|说明| -|:---|:---| -|`vendor`| 发放渠道。| -|`organization`| 用户名称。| -|`issuedDate`| License 生效时间。| -|`expirationDate`| License 过期时间。| -|`product`| 产品类型。{{explorer.name}}的产品类型为`nebula_graph_explorer`。| -|`version`| 版本支持的信息。| -|`licenseType`| License 类型（预留参数）。包括`enterprise`、`samll_bussiness`、`pro`、`individual`。| -|`gracePeriod`| 证书过期后可继续使用服务的缓冲时间（单位天），超过缓冲期后停止服务。试用版的 License 过期后无缓冲期，默认值为 0。 | -|`clusterCode`| 用户的硬件信息，也是集群的唯一标识码。试用版的 License 中无此参数。 | - -## 使用方式 - -关于如何使用{{explorer.name}}，参见[部署{{explorer.name}}](ex-ug-deploy.md)。 - -## 续期操作 - -按照以下操作续期{{explorer.name}} License。 - -1. [联系我们](https://www.nebula-graph.com.cn/contact)申请新的{{explorer.name}} License 文件`nebula.license`。 -2. 在{{explorer.name}}的安装目录下（例如，`/usr/local/nebula-explorer`），使用新的 License 文件替换旧的 License 文件。 - -!!! note - - License 过期后，用户无法登录{{explorer.name}}。为了保证业务正常运行，请及时更新 License。 \ 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 01b0528b339..329caf55daf 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 @@ -6,6 +6,8 @@ 在部署{{explorer.name}}之前，用户需要确认以下信息： +- 已安装[许可证管理工具](../../9.about-license/2.license-management-suite/3.license-manager.md)并且[加载授权码](../../9.about-license/4.generate-and-load-license-key.md)。 + - {{nebula.name}} 服务已经部署并启动。详细信息参考 [{{nebula.name}}安装部署](../../4.deployment-and-installation/1.resource-preparations.md "点击前往{{nebula.name}}安装部署")。 - 以下端口未被使用。 @@ -19,11 +21,6 @@ {{explorer.name}}默认使用的端口号为 7002，用户可以在安装目录下的 `conf/app.conf` 文件中修改 `httpport`，并重启服务。 - 使用的 Linux 发行版为 CentOS。 -- [准备 License](3.explorer-license.md)。 - - !!! enterpriseonly - - License 仅在企业版提供，申请 License 需填写 [{{explorer.name}}试用申请](https://wj.qq.com/s2/10158890/69a8)。 - 如果需要使用图计算，需要部署 HDFS。namenode 默认使用 8020 端口，datanode 默认使用 50010 端口。 @@ -58,16 +55,7 @@ sudo rpm -i nebula-explorer-.x86_64.rpm --prefix= ``` -3. 拷贝 License 至安装路径下。 - - ```bash - sudo cp -r - ``` - - 例如： - ```bash - sudo cp -r nebula.license /usr/local/nebula-explorer - ``` +3. 进入解压后的文件夹，在`config`目录内修改`app-config.yaml`文件，设置`LicenseManagerURL`的值为 LM 所在的主机 IP 和端口号`9119`，例如`192.168.8.100:9119`。 4. （可选）配置 Dag Controller。参见下文 **配置 Dag Controller** 部分。 @@ -133,16 +121,7 @@ sudo rpm -e nebula-explorer-.x86_64 使用 DEB 包安装{{explorer.name}}时不支持自定义安装路径。 -3. 拷贝 License 至`nebula-explorer`目录下。 - - ```bash - sudo cp -r - ``` - - 例如： - ```bash - sudo cp -r nebula.license /usr/local/nebula-explorer - ``` +3. 进入解压后的文件夹，在`config`目录内修改`app-config.yaml`文件，设置`LicenseManagerURL`的值为 LM 所在的主机 IP 和端口号`9119`，例如`192.168.8.100:9119`。 4. （可选）配置 Dag Controller。参见下文 **配置 Dag Controller** 部分。 @@ -194,16 +173,7 @@ sudo dpkg -r nebula-explorer tar -xvf nebula-explorer-.tar.gz ``` -3. 拷贝 License 至`nebula-explorer`目录下。 - - ```bash - cp -r - ``` - - 例如： - ```bash - cp -r nebula.license /usr/local/nebula-explorer - ``` +3. 进入解压后的文件夹，在`config`目录内修改`app-config.yaml`文件，设置`LicenseManagerURL`的值为 LM 所在的主机 IP 和端口号`9119`，例如`192.168.8.100:9119`。 4. （可选）配置 Dag Controller。参见下文 **配置 Dag Controller** 部分。 diff --git a/docs-2.0/nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md b/docs-2.0/nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md index 7acfd01da70..1bde87045c1 100644 --- a/docs-2.0/nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md +++ b/docs-2.0/nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md @@ -9,14 +9,6 @@ - [安装 NebulaGraph Operator](../2.deploy-nebula-operator.md) - [已创建 StorageClass](https://kubernetes.io/docs/concepts/storage/storage-classes/) -{{ ent.ent_begin }} -- 准备相应的 License 文件 - - !!! enterpriseonly - - 只有当创建的{{nebula.name}}集群是企业版本时，才需要提供 License 文件。 -{{ ent.ent_end }} - ## 创建集群 本文以创建名为`nebula`的集群为例，说明如何部署{{nebula.name}}集群。 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 4be7a0c9f46..95f345ec0d2 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 @@ -14,7 +14,8 @@ RPM 和 DEB 是 Linux 系统下常见的两种安装包格式，本文介绍如 ## 前提条件 -安装 wget +- 安装`wget`工具。 +- 已安装[许可证管理工具](https://docs.nebula-graph.com.cn/{{nebula.release}}/9.about-license/2.license-management-suite/3.license-manager/)并且[加载授权码](https://docs.nebula-graph.com.cn/{{nebula.release}}/9.about-license/4.generate-and-load-license-key/)。 ## 下载安装包 @@ -130,12 +131,14 @@ RPM 和 DEB 是 Linux 系统下常见的两种安装包格式，本文介绍如 sudo dpkg -i nebula-graph-{{nebula.release}}.ubuntu1804.amd64.deb ``` -## 后续操作 - {{ ent.ent_begin }} -- （企业版）[设置 License](https://docs.nebula-graph.com.cn/{{nebula.release}}/4.deployment-and-installation/deploy-license) +## 配置许可证管理工具地址 + +在{{nebula.name}}的 Meta 服务配置文件（`nebula-metad.conf`）中，设置`license_manager_url`的值为许可证管理工具所在的主机 IP 和端口号`9119`，例如`192.168.8.100:9119`。 {{ ent.ent_end }} +## 后续操作 + - [启动{{nebula.name}}](https://docs.nebula-graph.com.cn/{{nebula.release}}/2.quick-start/3.quick-start-on-premise/5.start-stop-service/) - [连接{{nebula.name}}](https://docs.nebula-graph.com.cn/{{nebula.release}}/2.quick-start/3.quick-start-on-premise/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 71490a1f301..fda7e9f6c3e 100644 --- a/docs-2.0/synchronization-and-migration/replication-between-clusters.md +++ b/docs-2.0/synchronization-and-migration/replication-between-clusters.md @@ -2,10 +2,6 @@ {{nebula.name}}支持在集群间进行数据同步，即主集群 A 的数据可以近实时地复制到从集群 B 中，方便用户进行异地灾备或分流，降低数据丢失的风险，保证数据安全。 -!!! enterpriseonly - - 仅企业版支持本功能。 - ## 背景 ![replication between clusters](https://docs-cdn.nebula-graph.com.cn/figures/replication-between-clusters.png) @@ -51,8 +47,6 @@ - 准备至少 2 台部署服务的机器。主从集群需要分开部署，listener 和 drainer 可以单独部署，也可以分别部署在主从集群所在机器上，但是会增加集群负载。 -- 准备企业版 License 文件。 - ### 示例环境 主集群A：机器 IP 地址为`192.168.10.101`，只启动 Graph、Meta、Storage 服务。 @@ -79,6 +73,8 @@ drainer：机器 IP 地址为`192.168.10.104`，只启动 drainer 服务。 - 将配置文件的后缀`.default`或`.production`删除。 + - Meta 服务的配置文件（`nebula-metad.conf`）中，设置`license_manager_url`的值为许可证管理工具所在的主机 IP 和端口号`9119`，例如`192.168.8.xxx:9119`。 + - 所有配置文件里都需要用真实的机器 IP 地址替换`local_ip`的`127.0.0.1`。 - 所有`nebula-graphd.conf`配置文件里设置`enable_authorize=true`。 @@ -93,9 +89,7 @@ drainer：机器 IP 地址为`192.168.10.104`，只启动 drainer 服务。 更多配置说明，请参见[配置管理](../5.configurations-and-logs/1.configurations/1.configurations.md)。 -2. 在主从集群和 listener 服务的机器上放置 License 文件，路径为安装目录的`share/resources/`内。 - -3. 在所有机器的{{nebula.name}}安装目录内启动对应的服务： +1. 在所有机器的{{nebula.name}}安装目录内启动对应的服务： - 主、从集群启动命令：`sudo scripts/nebula.service start all`。 @@ -107,7 +101,7 @@ drainer：机器 IP 地址为`192.168.10.104`，只启动 drainer 服务。 - drainer 启动命令：`sudo scripts/nebula-drainerd.service start`。 -4. 登录主集群增加 Storage 主机，检查 listener 服务状态。 +3. 登录主集群增加 Storage 主机，检查 listener 服务状态。 ``` nebula> ADD HOSTS 192.168.10.101:9779; @@ -133,7 +127,7 @@ drainer：机器 IP 地址为`192.168.10.104`，只启动 drainer 服务。 +------------------+------+----------+-----------------+--------------+----------------------+ ``` -5. 登录从集群增加 Storage 主机，检查 drainer 服务状态。 +4. 登录从集群增加 Storage 主机，检查 drainer 服务状态。 ``` nebula> ADD HOSTS 192.168.10.102:9779; diff --git a/mkdocs.yml b/mkdocs.yml index c90a30a2797..b8857a84499 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -114,7 +114,6 @@ plugins: - 20.appendix/release-notes/nebula-ent-release-note.md - 20.appendix/release-notes/dashboard-ent-release-note.md - 20.appendix/release-notes/explorer-release-note.md - - 20.appendix/8.about-license.md - 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-ent-from-3.x-3.4.md # exclude.ent.end # exclude.comm.begin @@ -725,6 +724,7 @@ nav: - 其他设置: nebula-dashboard-ent/4.cluster-operator/6.settings.md - 权限管理: nebula-dashboard-ent/5.account-management.md - 任务中心: nebula-dashboard-ent/10.tasks.md + - 许可证管理: nebula-dashboard-ent/11.license-manager.md - 平台设置: - 系统设置: nebula-dashboard-ent/system-settings/system-settings.md - 通知设置: nebula-dashboard-ent/system-settings/notification-endpoint.md @@ -740,7 +740,6 @@ nav: - 安装与登录: - 部署悦数图探索: nebula-explorer/deploy-connect/ex-ug-deploy.md - 连接数据库: nebula-explorer/deploy-connect/ex-ug-connect.md - - 悦数图探索 License: nebula-explorer/deploy-connect/3.explorer-license.md - 页面概览: nebula-explorer/ex-ug-page-overview.md - 数据库管理: - Schema 草图: nebula-explorer/db-management/draft.md @@ -889,9 +888,6 @@ nav: - 悦数图探索: 20.appendix/release-notes/explorer-release-note.md # nav.ent.end - 学习路径: 20.appendix/learning-path.md - # nav.ent.begin - - 关于 License: 20.appendix/8.about-license.md - # nav.ent.end - 常见问题 FAQ: 20.appendix/0.FAQ.md - 生态工具概览: 20.appendix/6.eco-tool-version.md - 导入工具选择: 20.appendix/write-tools.md From 67ba1c538b080732d911e7e775a3f0b54b5dda6c Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Fri, 5 May 2023 15:09:47 +0800 Subject: [PATCH 02/19] Update 11.license-manager.md --- docs-2.0/nebula-dashboard-ent/11.license-manager.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-2.0/nebula-dashboard-ent/11.license-manager.md b/docs-2.0/nebula-dashboard-ent/11.license-manager.md index 0858340031f..5e91b1ac8d4 100644 --- a/docs-2.0/nebula-dashboard-ent/11.license-manager.md +++ b/docs-2.0/nebula-dashboard-ent/11.license-manager.md @@ -1,6 +1,6 @@ # 许可证管理 -在悦数图数据库及附属软件中配置许可证管理工具（License Manager，LM）后，可通过 LM 校验许可证的有效性，从而保证悦数图数据库及附属软件的正常使用。 +在{{nebula.name}}及附属软件中配置许可证管理工具（License Manager，LM）后，可通过 LM 校验许可证的有效性，从而保证图数据库及附属软件的正常使用。 {{dashboard_ent.name}目前仅提供页面展示许可证信息、许可证使用情况和产品列表。 From 1589f337ba5de5414b2b6e8a76f81cc31bc0ad37 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Fri, 5 May 2023 15:52:59 +0800 Subject: [PATCH 03/19] Update 8.faq.md --- docs-2.0/nebula-dashboard-ent/8.faq.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs-2.0/nebula-dashboard-ent/8.faq.md b/docs-2.0/nebula-dashboard-ent/8.faq.md index 40bdc0b0f87..53c6644a309 100644 --- a/docs-2.0/nebula-dashboard-ent/8.faq.md +++ b/docs-2.0/nebula-dashboard-ent/8.faq.md @@ -36,7 +36,11 @@ Meta 服务主要存储{{nebula.name}}数据库中的元数据。一旦 Meta 服 ## 为什么无法启动{{dashboard_ent.name}？ -确保已安装[许可证管理工具](../9.about-license/2.license-management-suite/3.license-manager.md)并且[加载授权码](../9.about-license/4.generate-and-load-license-key.md)。 +- 确保已安装[许可证管理工具](../9.about-license/2.license-management-suite/3.license-manager.md)并且[加载授权码](../9.about-license/4.generate-and-load-license-key.md)。 + +- 确保 License 未过期。 + +用户也可以在{{dashboard_ent.name}目录中执行`cat logs/webserver.log`查看各个模块的启动信息。如果满足以上条件，仍无法启动{{dashboard_ent.name}，请前往 [{{nebula.name}}官方论坛](https://discuss.nebula-graph.com.cn/ "点击前往{{nebula.name}}官方论坛")咨询。 ## 是否可以手动添加{{nebula.name}}安装包？ From c16db5467b5cc723ada9429414a4cb954520b15b Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Fri, 5 May 2023 16:04:05 +0800 Subject: [PATCH 04/19] Update replication-between-clusters.md --- .../replication-between-clusters.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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 fda7e9f6c3e..c739f6bbad1 100644 --- a/docs-2.0/synchronization-and-migration/replication-between-clusters.md +++ b/docs-2.0/synchronization-and-migration/replication-between-clusters.md @@ -89,7 +89,7 @@ drainer：机器 IP 地址为`192.168.10.104`，只启动 drainer 服务。 更多配置说明，请参见[配置管理](../5.configurations-and-logs/1.configurations/1.configurations.md)。 -1. 在所有机器的{{nebula.name}}安装目录内启动对应的服务： +2. 在所有机器的{{nebula.name}}安装目录内启动对应的服务： - 主、从集群启动命令：`sudo scripts/nebula.service start all`。 @@ -544,4 +544,4 @@ nebula> SHOW DRAINER SYNC STATUS; ### WAL 日志文件过期了对集群数据同步有影响吗？ -如果 WAL 日志文件过期了（超过了`--wal-ttl`设置的时间），数据会不同步。用户可以通过手动在 Meta 和 Storage 服务的配置文件中添加`--snapshot_send_files=false`配置以同步数据。更新文件中的配置后，需要重启服务。关于配置文件的详细信息，参见[配置文件简介](../5.configurations-and-logs/1.configurations/1.configurations.md)。 \ No newline at end of file +如果 WAL 日志文件过期了（超过了`--wal-ttl`设置的时间），数据会不同步。用户可以通过手动在 Meta 和 Storage 服务的配置文件中添加`--snapshot_send_files=false`配置以同步数据。更新文件中的配置后，需要重启服务。关于配置文件的详细信息，参见[配置文件简介](../5.configurations-and-logs/1.configurations/1.configurations.md)。 From cca956f466e5588217528a0ee60ed32ecbcd7ea3 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Sat, 6 May 2023 09:47:05 +0800 Subject: [PATCH 05/19] update --- .../graph-computing/analytics-ent-license.md | 86 ------------------- docs-2.0/graph-computing/nebula-analytics.md | 6 +- 2 files changed, 4 insertions(+), 88 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 4a509ef88d4..00000000000 --- a/docs-2.0/graph-computing/analytics-ent-license.md +++ /dev/null @@ -1,86 +0,0 @@ -# {{plato.name}} License - -License 是为用户提供的软件授权证书。用户在部署{{plato.name}}时，需要设置 License 才能正常启动{{plato.name}}。本文介绍{{plato.name}}的 License 相关信息。 - -## 注意事项 - -- 没有设置 License 时，{{plato.name}}无法启动。 - -- 请勿修改 License，否则会导致 License 失效。 - -- License 快过期时，请[联系我们](https://www.nebula-graph.com.cn/contact)申请续期。 - -- License 的过期缓冲为 14 天： - - - 过期前 30 天和过期当天，服务启动时会打印日志进行提醒。 - - - 过期后仍可继续使用 14 天。 - - - 过期 14 天后，服务无法启动，并会打印日志进行提醒。 - -## 获取方式 - -[联系我们](https://www.nebula-graph.com.cn/contact)申请{{plato.name}}License。 - -!!! note - - 填写 [{{plato.name}}试用申请](https://wj.qq.com/s2/10158890/69a8)可获取 30 天免费试用的 License。 - -## {{plato.name}} License 说明 - -{{plato.name}} License 是一个名为`nebula.license`的文件，内容示例如下： - -```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---------- -``` - -License 文件包含生效时间、过期时间等信息。说明如下。 - -|参数|说明| -|:---|:---| -|`vendor`| 发放渠道。| -|`organization`| 用户名称。| -|`issuedDate`| License 生效时间。| -|`expirationDate`| License 过期时间。| -|`product`| 产品类型。{{plato.name}}的产品类型为`nebula_graph_analytics`。| -|`version`| 版本支持的信息。| -|`licenseType`| License 类型（预留参数）。包括`enterprise`、`samll_bussiness`、`pro`、`individual`。| -|`gracePeriod`| 证书过期后可继续使用服务的缓冲时间（单位天），超过缓冲期后停止服务。试用版的 License 过期后无缓冲期，默认值为 0。 | -|`nodes`|集群中{{plato.name}}服务的数量限制。| -|`vcpu`|集群中{{plato.name}}服务的总线程数量限制。| -|`clusterCode`| 用户的硬件信息，也是集群的唯一标识码。试用版的 License 中无此参数。 | - -## 使用方式 - -关于如何使用{{plato.name}}License，参见[{{plato.name}}](nebula-analytics.md)。 - -## 续期操作 - -按照以下操作续期{{plato.name}}License。 - -1. [联系我们](https://www.nebula-graph.com.cn/contact)申请新的{{plato.name}}License 文件`nebula.license`。 -2. 在{{plato.name}}的安装目录下（例如，`/usr/local/nebula-analytics/scripts/`），使用新的 License 文件替换旧的 License 文件。 - -!!! note - - {{plato.name}} License 过期后，用户无法正常使用{{plato.name}}。为了保证业务正常运行，请及时更新 License。 diff --git a/docs-2.0/graph-computing/nebula-analytics.md b/docs-2.0/graph-computing/nebula-analytics.md index 696ed743a3e..7bdbff4fe64 100644 --- a/docs-2.0/graph-computing/nebula-analytics.md +++ b/docs-2.0/graph-computing/nebula-analytics.md @@ -6,7 +6,9 @@ - [联系我们](https://www.nebula-graph.com.cn/contact)获取{{plato.name}}安装包。 -- [准备{{plato.name}} License](analytics-ent-license.md)。 +{{ ent.ent_begin }} +- 已安装[许可证管理工具](../9.about-license/2.license-management-suite/3.license-manager.md)并且[加载授权码](../9.about-license/4.generate-and-load-license-key.md)。 +{{ ent.ent_end }} - 已部署 2.2.x 或以上版本的 [HDFS](https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-common/ClusterSetup.html)。 @@ -88,7 +90,7 @@ export JAVA_HOME= ``` -3. 拷贝 License 至所有机器的{{plato.name}}安装路径的`scripts`目录内。 +3. 配置`analytics.conf`文件，路径为`nebula-analytics/scripts/analytics.conf`。设置`license_manager_url`的值为许可证管理工具所在的主机 IP 和端口号`9119`，例如`192.168.8.100:9119`。