From 02148bef13b83934f703b71052cb39b96e5d3d36 Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Mon, 4 Jul 2022 18:25:33 +0800 Subject: [PATCH 1/9] Update enterprise in docs --- docs-2.0/20.appendix/6.eco-tool-version.md | 5 + docs-2.0/20.appendix/learning-path.md | 27 ++ docs-2.0/20.appendix/release-note.md | 3 + docs-2.0/3.ngql-guide/4.job-statements.md | 3 + .../9.space-statements/6.clear-space.md | 10 +- .../1.resource-preparations.md | 1 + ...bula-graph-by-compiling-the-source-code.md | 2 + .../4.install-nebula-graph-from-tar.md | 3 + .../6.deploy-nebula-graph-with-peripherals.md | 14 +- .../deploy-nebula-graph-cluster.md | 16 +- .../1.configurations/1.configurations.md | 4 + .../1.configurations/2.meta-config.md | 14 + .../1.configurations/3.graph-config.md | 3 + .../1.configurations/4.storage-config.md | 4 + .../1.authentication/1.authentication.md | 4 + .../1.authentication/2.management-user.md | 63 ++- docs-2.0/8.service-tuning/load-balance.md | 3 + .../parameter-reference/ex-ug-parameter.md | 3 + .../3.1create-cluster-with-kubectl.md | 434 ++++++++++-------- .../3.2create-cluster-with-helm.md | 3 + docs-2.0/reuse/source_manage-service.md | 7 +- mkdocs.yml | 145 +++--- 22 files changed, 508 insertions(+), 263 deletions(-) diff --git a/docs-2.0/20.appendix/6.eco-tool-version.md b/docs-2.0/20.appendix/6.eco-tool-version.md index 280ac92973a..43b8f187b8d 100644 --- a/docs-2.0/20.appendix/6.eco-tool-version.md +++ b/docs-2.0/20.appendix/6.eco-tool-version.md @@ -50,6 +50,7 @@ Nebula Dashboard(简称 Dashboard)是一款用于监控 Nebula Graph 集群 |:---|:---| | {{ nebula.tag }} | {{dashboard.tag}}| +{{ ent.ent-begin }} ## Nebula Dashboard(企业版) Nebula Dashboard(简称 Dashboard)是一款用于监控和管理 Nebula Graph 多集群中机器和服务状态的可视化工具,支持在可视化界面进行集群创建、集群导入、数据平衡、扩容缩容等操作。详情参见[什么是 Nebula Dashboard](../nebula-dashboard-ent/1.what-is-dashboard-ent.md)。 @@ -58,6 +59,9 @@ Nebula Dashboard(简称 Dashboard)是一款用于监控和管理 Nebula Grap |:---|:---| | {{ nebula.tag }} | {{dashboard_ent.tag}}| +{{ ent.ent-end }} + +{{ ent.ent-begin }} ## Nebula Explorer Nebula Explorer(简称 Explorer)是一款可以通过 Web 访问的图探索可视化工具,搭配 Nebula Graph 内核使用,用于与图数据进行可视化交互。即使没有图数据操作经验,用户也可以快速成为图专家。详情参见[什么是 Nebula Explorer](../nebula-explorer/about-explorer/ex-ug-what-is-explorer.md)。 @@ -66,6 +70,7 @@ Nebula Explorer(简称 Explorer)是一款可以通过 Web 访问的图探索 |:---|:---| | {{ nebula.tag }} | {{explorer.tag}}| +{{ ent.ent-end }} ## Nebula Stats Exporter [nebula-stats-exporter](https://github.com/vesoft-inc/nebula-stats-exporter)将监控数据导入Prometheus。 diff --git a/docs-2.0/20.appendix/learning-path.md b/docs-2.0/20.appendix/learning-path.md index eae7b640444..79685414470 100644 --- a/docs-2.0/20.appendix/learning-path.md +++ b/docs-2.0/20.appendix/learning-path.md @@ -172,15 +172,40 @@ - 可视化 +{{ commu.commu_begin }} + + | 可视化工具 | 文档 | 视频 | + | -------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | + | 数据可视化 | [Nebula Studio](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-studio/about-studio/st-ug-what-is-graph-studio/) | [Nebula Studio 图探索功能](https://www.bilibili.com/video/BV1QN411Z7Vh)和[Nebula Studio 可视化建模](https://www.bilibili.com/video/BV19A411L77h?spm_id_from=333.999.0.0) | + | 数据监控和运维 | [Nebula Dashboard 社区版](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-dashboard/1.what-is-dashboard/) | [可视化监控 Nebula Dashboard](https://www.bilibili.com/video/BV1qQ4y1k7gb?) | + +{{ commu.commu_end }} + +{{ ent.ent_begin }} | 可视化工具 | 文档 | 视频 | | -------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | | 数据可视化 | [Nebula Studio](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-studio/about-studio/st-ug-what-is-graph-studio/) | [Nebula Studio 图探索功能](https://www.bilibili.com/video/BV1QN411Z7Vh)和[Nebula Studio 可视化建模](https://www.bilibili.com/video/BV19A411L77h?spm_id_from=333.999.0.0) | | 数据监控和运维 | [Nebula Dashboard 企业版](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-dashboard-ent/1.what-is-dashboard-ent/)和 [Nebula Dashboard 社区版](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-dashboard/1.what-is-dashboard/) | [可视化监控 Nebula Dashboard](https://www.bilibili.com/video/BV1qQ4y1k7gb?) | | 数据分析 | [Nebula Explorer 企业版](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-explorer/about-explorer/ex-ug-what-is-explorer/) | [可视化图探索 Nebula Explorer](https://www.bilibili.com/video/BV1fP4y1h7Fx?) | +{{ ent.ent_begin }} + - 数据导入与导出 +{{ commu.commu_begin }} + + | 导入与导出 | 文档 | 视频 | + | -------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | + | 数据导入 | [Nebula Importer](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-importer/use-importer/) | [Nebula Importer](https://www.bilibili.com/video/BV1ny4y1u7i4) | + | 数据导入 | [Nebula Spark Connector](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-spark-connector/) | - | + | 数据导入 | [Nebula Flink Connector](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-flink-connector/) | - | + | 数据导入 | [Nebula Exchange 社区版](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-exchange/about-exchange/ex-ug-what-is-exchange/) | [Nebula Graph 数据导入工具——Exchange](https://www.bilibili.com/video/BV1Pq4y177D9)、[Exchange 导入 SST 数据](https://www.bilibili.com/video/BV1y34y1o7Di?) | + +{{ commu.commu_end }} + +{{ ent.ent_begin }} + | 导入与导出 | 文档 | 视频 | | -------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | | 数据导入 | [Nebula Importer](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-importer/use-importer/) | [Nebula Importer](https://www.bilibili.com/video/BV1ny4y1u7i4) | @@ -189,6 +214,8 @@ | 数据导入 | [Nebula Exchange 社区版](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-exchange/about-exchange/ex-ug-what-is-exchange/) | [Nebula Graph 数据导入工具——Exchange](https://www.bilibili.com/video/BV1Pq4y177D9)、[Exchange 导入 SST 数据](https://www.bilibili.com/video/BV1y34y1o7Di?) | | 数据导出 | [Nebula Exchange 企业版](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-exchange/about-exchange/ex-ug-what-is-exchange/) | - | +{{ ent.ent_begin }} + - 备份与恢复 | 文档 | 视频 | diff --git a/docs-2.0/20.appendix/release-note.md b/docs-2.0/20.appendix/release-note.md index e1fb62514f2..c700d25baff 100644 --- a/docs-2.0/20.appendix/release-note.md +++ b/docs-2.0/20.appendix/release-note.md @@ -1,5 +1,6 @@ # Nebula Graph {{ nebula.release }} release notes +{{ ent.ent_begin }} ## 企业版 ### 功能 @@ -65,3 +66,5 @@ ## 历史版本 [历史版本](https://nebula-graph.com.cn/tags/release-note/) + +{{ ent.ent_end }} \ No newline at end of file diff --git a/docs-2.0/3.ngql-guide/4.job-statements.md b/docs-2.0/3.ngql-guide/4.job-statements.md index 058f88bc9b8..2dc83b5aaf1 100644 --- a/docs-2.0/3.ngql-guide/4.job-statements.md +++ b/docs-2.0/3.ngql-guide/4.job-statements.md @@ -6,6 +6,7 @@ 所有作业管理命令都需要先选择图空间后才能执行。 +{{ ent.ent_begin }} ## SUBMIT JOB BALANCE DATA !!! enterpriseonly @@ -31,6 +32,8 @@ nebula> SUBMIT JOB BALANCE DATA; +------------+ ``` +{{ ent.ent_end }} + <!-- balance-3.1 ## SUBMIT JOB BALANCE IN ZONE diff --git a/docs-2.0/3.ngql-guide/9.space-statements/6.clear-space.md b/docs-2.0/3.ngql-guide/9.space-statements/6.clear-space.md index 52ad9ee689b..023582d71eb 100644 --- a/docs-2.0/3.ngql-guide/9.space-statements/6.clear-space.md +++ b/docs-2.0/3.ngql-guide/9.space-statements/6.clear-space.md @@ -13,10 +13,18 @@ - 图空间中的数据量越大,`CLEAR SPACE`消耗的时间越长。如果`CLEAR SPACE`的执行因客户端连接超时而失败,可以增大 [Graph 服务配置](../../5.configurations-and-logs/1.configurations/3.graph-config.md)中`storage_client_timeout_ms`参数的值。 - 在`CLEAR SPACE`的执行过程中,向该图空间写入数据的行为不会被自动禁止。这样的写入行为可能导致`CLEAR SPACE`清除数据不完全,残留的数据也可能受到损坏。 - !!! enterpriseonly + !!! note + - 社区版 Nebula Graph 不支持在运行`CLEAR SPACE`的同时禁止写入。 + +{{ ent.ent_begin }} + + !!! enterpriseonly + - 企业版 Nebula Graph 支持先运行`SET VARIABLE read_only=true`阻止向 Nebula Graph 写入数据,再运行`CLEAR SPACE`。数据清除成功后运行`SET VARIABLE read_only=false`即可重新允许写入。 +{{ ent.ent_end }} + ## 语法 ```ngql diff --git a/docs-2.0/4.deployment-and-installation/1.resource-preparations.md b/docs-2.0/4.deployment-and-installation/1.resource-preparations.md index cc46a66addf..57f7ecfdaa9 100644 --- a/docs-2.0/4.deployment-and-installation/1.resource-preparations.md +++ b/docs-2.0/4.deployment-and-installation/1.resource-preparations.md @@ -20,6 +20,7 @@ Nebula Graph 是针对 NVMe SSD 进行设计和实现的,所有默认参数都 企业版支持在 ARM 架构(包括 Apple Mac M1 和华为鲲鹏)上运行。访问官网获取[商业支持](https://nebula-graph.com.cn/pricing/)。 + !!! note 社区用户可以在 ARM MacOS 的 Docker Desktop 上或者 ARM Linux Server 上运行容器化的 Nebula Graph。 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 783b84c761d..9aaa91ed069 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 @@ -82,7 +82,9 @@ master 分支的代码更新速度快,如果安装了 master 分支对应的 ## 下一步 +{{ ent.ent_begin }} - (企业版)[设置 License](../deploy-license.md) +{{ ent.ent_end }} - [管理 Nebula Graph 服务](../../2.quick-start/5.start-stop-service.md) 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 e267a547069..ccc2ccbd4fe 100644 --- a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md +++ b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md @@ -68,6 +68,9 @@ ## 下一步 +{{ ent.ent_begin }} - (企业版)[设置 License](../deploy-license.md) +{{ ent.ent_end }} + - [管理 Nebula Graph 服务](../manage-service.md) diff --git a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/6.deploy-nebula-graph-with-peripherals.md b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/6.deploy-nebula-graph-with-peripherals.md index 74fc0da9cc2..b5dd6bccb31 100644 --- a/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/6.deploy-nebula-graph-with-peripherals.md +++ b/docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/6.deploy-nebula-graph-with-peripherals.md @@ -1,16 +1,26 @@ # 使用生态工具安装 Nebula Graph -用户可以使用以下生态工具安装企业版和社区版的 Nebula Graph: +用户可以使用以下生态工具安装 Nebula Graph: +{{ ent.ent_begin }} - 企业版 Nebula Dashboard + +{{ ent.ent_end }} + - Nebula Operator ## 安装详情 +{{ ent.ent_begin }} - 使用**企业版 Nebula Dashboard** 安装 Nebula Graph 的详情,参见[创建集群](../../nebula-dashboard-ent/3.create-import-dashboard/1.create-cluster.md)。 + +{{ ent.ent_end }} + - 使用 **Nebula Operator** 安装 Nebula Graph 的详情,参见[使用 Kubectl 部署 Nebula Graph 集群](../../nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md) 或 [使用 Helm 部署 Nebula Graph 集群](../../nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md)。 +{{ ent.ent_begin }} + !!! note 联系销售([inqury@vesoft.com](mailto:inqury@vesoft.com))获取企业版 Nebula Graph 的安装包。 - +{{ ent.ent_end }} \ No newline at end of file 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 a770e2ee64c..8cd311318e2 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 @@ -19,7 +19,7 @@ Nebula Graph 不提供官方的集群部署工具,用户可以使用 RPM 或 D ## 手动部署流程 -### 1. 安装 Nebula Graph +### 安装 Nebula Graph 在集群的每一台服务器上都安装 Nebula Graph,安装后暂不需要启动服务。安装方式请参见: @@ -27,13 +27,13 @@ Nebula Graph 不提供官方的集群部署工具,用户可以使用 RPM 或 D - [使用源码安装 Nebula Graph](1.install-nebula-graph-by-compiling-the-source-code.md) -### 2.(企业版)设置 License。 +{{ ent.ent_begin }} +### (企业版)设置 License。 -- 如果部署企业版 Nebula Graph,需要设置 License。详情请参见[设置 Nebula Graph 企业版 License](../../4.deployment-and-installation/deploy-license.md)。 +如果部署企业版 Nebula Graph,需要设置 License。详情请参见[设置 Nebula Graph 企业版 License](../../4.deployment-and-installation/deploy-license.md)。 -- 如果部署社区版 Nebula Graph,略过此步骤。 - -### 3. 修改配置文件 +{{ ent.ent_end }} +### 修改配置文件 修改每个服务器上的 Nebula Graph 配置文件。 @@ -261,7 +261,7 @@ Nebula Graph 的所有配置文件均位于安装目录的`etc`目录内,包 --port=9779 ``` -### 4. 启动集群 +### 启动集群 依次启动**各个服务器**上的对应进程。 @@ -287,7 +287,7 @@ sudo /usr/local/nebula/scripts/nebula.service start <metad|graphd|storaged|all> - `/usr/local/nebula`是 Nebula Graph 的默认安装路径,如果修改过安装路径,请使用实际路径。更多启停服务的内容,请参见[管理 Nebula Graph 服务](../../2.quick-start/5.start-stop-service.md)。 -### 5. 检查集群 +### 检查集群 安装原生 CLI 客户端 [Nebula Console](../../2.quick-start/3.connect-to-nebula-graph.md#_1),然后连接任何一个已启动 graphd 进程的机器,添加 Storage 主机,然后执行命令`SHOW HOSTS`检查集群状态。例如: diff --git a/docs-2.0/5.configurations-and-logs/1.configurations/1.configurations.md b/docs-2.0/5.configurations-and-logs/1.configurations/1.configurations.md index 76054e12762..dec5a1e7410 100644 --- a/docs-2.0/5.configurations-and-logs/1.configurations/1.configurations.md +++ b/docs-2.0/5.configurations-and-logs/1.configurations/1.configurations.md @@ -2,10 +2,14 @@ Nebula Graph 基于 [gflags](https://gflags.github.io/gflags/) 库打造了系统配置,多数配置项都是其中的 flags。Nebula Graph 服务启动时,默认会从[配置文件](#_4)中获取配置信息。对于文件中没有的配置项,系统使用默认值。 +{{ ent.ent_begin }} + !!! enterpriseonly 性能、参数、查询语句的调优方式及服务仅在企业版提供。 +{{ ent.ent_end }} + !!! note * 由于配置项多且可能随着 Nebula Graph 的开发发生变化,文档不会介绍所有配置项。按下文说明可在命令行获取配置项的详细说明。 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 a70d33ef768..e0da7f1f9eb 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 @@ -19,6 +19,18 @@ Meta 服务提供了两份初始配置文件`nebula-metad.conf.default`和`nebul ## basics 配置 +{{ commu.commu_begin }} + +| 名称 | 预设值 | 说明 | +| :----------- | :----------------------- | :------------------| +| `daemonize` | `true` | 是否启动守护进程。 | +| `pid_file` | `pids/nebula-metad.pid` | 记录进程 ID 的文件。 | +| `timezone_name` | - | 指定 Nebula Graph 的时区。初始配置文件中未设置该参数,如需使用请手动添加。系统默认值为`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`。 | + +{{ commu.commu_end }} + +{{ ent.ent_begin }} + | 名称 | 预设值 | 说明 | | :----------- | :----------------------- | :------------------| | `daemonize` | `true` | 是否启动守护进程。 | @@ -26,6 +38,8 @@ Meta 服务提供了两份初始配置文件`nebula-metad.conf.default`和`nebul | `timezone_name` | - | 指定 Nebula Graph 的时区。初始配置文件中未设置该参数,如需使用请手动添加。系统默认值为`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`。 | |`license_path`|`share/resources/nebula.license`|企业版 License 路径。企业版需要用户[设置 License](../../4.deployment-and-installation/deploy-license.md) 才可以正常启动并使用企业版功能。仅企业版 Nebula Graph 需要设置本参数,其他周边工具如何设置 License,请参见相应周边工具的部署文档。| +{{ ent.ent_end }} + !!! Note * 在插入[时间类型](../../3.ngql-guide/3.data-types/4.date-and-time.md)的属性值时,Nebula Graph 会根据`timezone_name`设置的时区将该时间值(TIMESTAMP 类型例外)转换成相应的 UTC 时间,因此在查询中返回的时间类型属性值为 UTC 时间。 diff --git a/docs-2.0/5.configurations-and-logs/1.configurations/3.graph-config.md b/docs-2.0/5.configurations-and-logs/1.configurations/3.graph-config.md index f6de1ede41f..a60bcf3b86e 100644 --- a/docs-2.0/5.configurations-and-logs/1.configurations/3.graph-config.md +++ b/docs-2.0/5.configurations-and-logs/1.configurations/3.graph-config.md @@ -100,6 +100,7 @@ Graph 服务提供了两份初始配置文件`nebula-graphd.conf.default`和`neb | ------------------- | ------------------------ | ------------------------------------------ | | `system_memory_high_watermark_ratio` | `0.8` |内存高水位报警机制的触发阈值。系统内存占用率高于该值会触发报警机制,Nebula Graph 会停止接受查询。| +{{ ent.ent_begin }} ## audit 配置 !!! enterpriseonly @@ -108,6 +109,8 @@ Graph 服务提供了两份初始配置文件`nebula-graphd.conf.default`和`neb 详细参数说明参见[审计日志](../2.log-management/audit-log.md)。 +{{ ent.ent_end }} + ## metrics 配置 | 名称 | 预设值 | 说明 | diff --git a/docs-2.0/5.configurations-and-logs/1.configurations/4.storage-config.md b/docs-2.0/5.configurations-and-logs/1.configurations/4.storage-config.md index 5dea5daf2ab..7781606e6ed 100644 --- a/docs-2.0/5.configurations-and-logs/1.configurations/4.storage-config.md +++ b/docs-2.0/5.configurations-and-logs/1.configurations/4.storage-config.md @@ -170,6 +170,8 @@ rocksdb options 配置的格式为`{"<option_name>":"<option_value>"}`,多个 参数的详细说明请参见 [RocksDB 官方文档](https://rocksdb.org/)。 +{{ ent.ent_begin }} + ## storage cache 配置 !!! enterpriseonly @@ -189,6 +191,8 @@ rocksdb options 配置的格式为`{"<option_name>":"<option_value>"}`,多个 | `empty_key_pool_capacity` | `50` | empty_key 缓存池的大小。 单位:兆字节。 | | `empty_key_item_ttl` | `300` | empty_key 缓存条目的有效时间。单位:秒。 | +{{ ent.ent_end }} + ## 超级节点处理(出入边数量极多的点) 在每个点出发的查询获取到边时,直接截断。目的是避免超级节点的邻边过多,单个查询占用过多的硬盘和内存。截取前 `max_edge_returned_per_vertex` 个边,多余的边不返回。该参数作用于全局,不用于单个 space。 diff --git a/docs-2.0/7.data-security/1.authentication/1.authentication.md b/docs-2.0/7.data-security/1.authentication/1.authentication.md index 1a7f9eccbba..133cd29edd4 100644 --- a/docs-2.0/7.data-security/1.authentication/1.authentication.md +++ b/docs-2.0/7.data-security/1.authentication/1.authentication.md @@ -30,6 +30,8 @@ Nebula Graph 支持两种身份验证方式:本地身份验证和 LDAP 验证 开启身份验证后,默认的 God 角色账号为`root`,密码为`nebula`。角色详情请参见[内置角色权限](3.role-list.md)。 +{{ ent.ent_begin }} + ## OpenLDAP 验证 OpenLDAP 是轻型目录访问协议(LDAP)的开源实现,可以实现账号集中管理。 @@ -39,3 +41,5 @@ OpenLDAP 是轻型目录访问协议(LDAP)的开源实现,可以实现账 !!! Enterpriseonly 当前仅企业版支持集成 OpenLDAP 进行身份验证,详情请参见[使用 OpenLDAP 进行身份验证](4.ldap.md)。 + +{{ ent.ent_end }} \ No newline at end of file diff --git a/docs-2.0/7.data-security/1.authentication/2.management-user.md b/docs-2.0/7.data-security/1.authentication/2.management-user.md index 5a4e9b53f1f..5a4b1e7beba 100644 --- a/docs-2.0/7.data-security/1.authentication/2.management-user.md +++ b/docs-2.0/7.data-security/1.authentication/2.management-user.md @@ -13,10 +13,39 @@ 执行`CREATE USER`语句可以创建新的 Nebula Graph 用户。当前仅** God **角色用户(即`root`用户)能够执行`CREATE USER`语句。 +{{ commu.commu_begin }} + +- 语法 + + ```ngql + CREATE USER [IF NOT EXISTS] <user_name> [WITH PASSWORD '<password>']; + ``` + + - `IF NOT EXISTS`:检测待创建的用户名是否存在,只有不存在时,才会创建新用户。 + - `user_name`:待创建的用户名。 + - `password`:用户名对应的密码。 + +- 示例 + + ```ngql + nebula> CREATE USER user1 WITH PASSWORD 'nebula'; + nebula> SHOW USERS; + +---------+-------------------------------+ + | Account | IP Whitelist | + +---------+-------------------------------+ + | "root" | "" | + | "user1" | "" | + +---------+-------------------------------+ + ``` + +{{ commu.commu_end }} + +{{ ent.ent_begin }} + - 语法 ```ngql - CREATE USER [IF NOT EXISTS] <user_name> [WITH PASSWORD '<password>'] [WITH IP WHITELIST <ip_list>]; + CREATE USER [IF NOT EXISTS] <user_name> [WITH PASSWORD '<password>'][WITH IP WHITELIST <ip_list>]; ``` - `IF NOT EXISTS`:检测待创建的用户名是否存在,只有不存在时,才会创建新用户。 @@ -38,6 +67,7 @@ | "user2" | "192.168.10.10,192.168.10.12" | +---------+-------------------------------+ ``` +{{ ent.ent_end }} ## 授权用户(`GRANT ROLE`) @@ -130,6 +160,36 @@ nebula> CHANGE PASSWORD user1 FROM 'nebula' TO 'nebula123'; ``` +{{ commu.commu_begin }} +## 修改用户密码(`ALTER USER`) + +执行`ALTER USER`语句可以修改用户密码,修改时不需要提供旧密码。当前仅** God **角色用户(即`root`用户)能够执行`ALTER USER`语句。 + +- 语法 + + ```ngql + ALTER USER <user_name> WITH PASSWORD '<password>'; + ``` + +- 示例 + + ```ngql + nebula> ALTER USER user2 WITH PASSWORD 'nebula'; + nebula> SHOW USERS; + +---------+--------------+ + | Account | IP Whitelist | + +---------+--------------+ + | "root" | "" | + | "user1" | "" | + | "user2" | "" | + +---------+--------------+ + + ``` + +{{ commu.commu_end }} + +{{ ent.ent_begin }} + ## 修改用户密码和 IP 白名单(`ALTER USER`) 执行`ALTER USER`语句可以修改用户密码和 IP 白名单,修改时不需要提供旧密码。当前仅** God **角色用户(即`root`用户)能够执行`ALTER USER`语句。 @@ -159,6 +219,7 @@ nebula> ALTER USER user2 WITH PASSWORD 'nebula' WITH IP WHITELIST 192.168.10.10; ``` +{{ ent.ent_end }} ## 删除用户(`DROP USER`) diff --git a/docs-2.0/8.service-tuning/load-balance.md b/docs-2.0/8.service-tuning/load-balance.md index 71f79020f80..8c749eea35d 100644 --- a/docs-2.0/8.service-tuning/load-balance.md +++ b/docs-2.0/8.service-tuning/load-balance.md @@ -6,6 +6,7 @@ `BALANCE`命令通过创建和执行一组子任务来迁移数据和均衡分片分布,**禁止**停止集群中的任何机器或改变机器的 IP 地址,直到所有子任务完成,否则后续子任务会失败。 +{{ ent.ent_begin }} ## 均衡分片分布 !!! enterpriseonly @@ -83,6 +84,8 @@ 如果有子任务失败,请执行`RECOVER JOB <job_id>`。如果重做负载均衡仍然不能解决问题,请到[Nebula Graph社区](https://discuss.nebula-graph.com.cn/)寻求帮助。 +{{ ent.ent_end }} + ### 停止负载均衡作业 停止负载均衡作业,请执行命令`STOP JOB <job_id>`。 diff --git a/docs-2.0/nebula-exchange/parameter-reference/ex-ug-parameter.md b/docs-2.0/nebula-exchange/parameter-reference/ex-ug-parameter.md index 9a1a40c7677..265638c0405 100644 --- a/docs-2.0/nebula-exchange/parameter-reference/ex-ug-parameter.md +++ b/docs-2.0/nebula-exchange/parameter-reference/ex-ug-parameter.md @@ -186,6 +186,7 @@ |`tags.path`|string|-|是|指定需要生成 SST 文件的源文件的路径。| |`tags.repartitionWithNebula`|bool|`false`|否|生成 SST 文件时是否要基于 Nebula Graph 中图空间的 partition 进行数据重分区。开启该功能可减少 DOWNLOAD 和 INGEST SST 文件需要的时间。当图空间的分片数量(partition_num)大于`1`时,请设置为`true`,否则可能会导致生成的数据文件中只包含无 Tag 的点。| +{{ ent.ent_begin }} ### Nebula Graph 源特有参数 !!! enterpriseonly @@ -198,6 +199,8 @@ |`tags.noField`|bool|`false`|是|当值为`true`时,仅导出 VID 而不导出属性数据;当值为`false`时导出 VID 和属性数据。| |`tags.return.fields`|list|`[]`|是|指定要导出的属性。例如,要导出`name`和`age`属性,需将参数值设置为`["name","age"]`。该参数仅在`tags.noField`的值为`false`时生效。| +{{ ent.ent_end }} + ## 边配置 对于不同的数据源,边的配置也有所不同,有很多通用参数,也有部分特有参数,配置时需要配置通用参数和不同数据源的特有参数。 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 cd4ed2d348b..6710f6105de 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 @@ -7,208 +7,262 @@ ## 前提条件 - [安装 Nebula Operator](../2.deploy-nebula-operator.md) + +{{ ent.ent_begin }} - 准备相应的 License 文件 !!! enterpriseonly 只有当创建的 Nebula Graph 集群是企业版本时,才需要提供 License 文件。 +{{ ent.ent_end }} ## 创建集群 本文以创建名为`nebula`的集群为例,说明如何部署 Nebula Graph 集群。 +{{ commu.commu_begin }} + 1. 创建名为`apps_v1alpha1_nebulacluster.yaml`的文件。 + + ```yaml + apiVersion: apps.nebula-graph.io/v1alpha1 + kind: NebulaCluster + metadata: + name: nebula + spec: + graphd: + resources: + requests: + cpu: "500m" + memory: "500Mi" + limits: + cpu: "1" + memory: "1Gi" + replicas: 1 + image: vesoft/nebula-graphd + version: {{nebula.tag}} + service: + type: NodePort + externalTrafficPolicy: Local + logVolumeClaim: + resources: + requests: + storage: 2Gi + storageClassName: gp2 + metad: + resources: + requests: + cpu: "500m" + memory: "500Mi" + limits: + cpu: "1" + memory: "1Gi" + replicas: 1 + image: vesoft/nebula-metad + version: {{nebula.tag}} + dataVolumeClaim: + resources: + requests: + storage: 2Gi + storageClassName: gp2 + logVolumeClaim: + resources: + requests: + storage: 2Gi + storageClassName: gp2 + storaged: + resources: + requests: + cpu: "500m" + memory: "500Mi" + limits: + cpu: "1" + memory: "1Gi" + replicas: 3 + image: vesoft/nebula-storaged + version: {{nebula.tag}} + dataVolumeClaim: + resources: + requests: + storage: 2Gi + storageClassName: gp2 + logVolumeClaim: + resources: + requests: + storage: 2Gi + storageClassName: gp2 + reference: + name: statefulsets.apps + version: v1 + schedulerName: default-scheduler + imagePullPolicy: Always + ``` + + 参数描述如下: + + | 参数 | 默认值 | 描述 | + | :---- | :--- | :--- | + | `metadata.name` | - | 创建的 Nebula Graph 集群名称。 | + | `spec.graphd.replicas` | `1` | Graphd 服务的副本数。 | + | `spec.graphd.images` | `vesoft/nebula-graphd` | Graphd 服务的容器镜像。 | + | `spec.graphd.version` | `{{nebula.tag}}` | Graphd 服务的版本号。 | + | `spec.graphd.service` | - | Graphd 服务 Service 配置。 | + | `spec.graphd.logVolumeClaim.storageClassName` | - | Graphd 服务的日志盘存储配置。 | + | `spec.metad.replicas` | `1` | Metad 服务的副本数。 | + | `spec.metad.images` | `vesoft/nebula-metad` | Metad 服务的容器镜像。 | + | `spec.metad.version` | `{{nebula.tag}}` | Metad 服务的版本号。 | + | `spec.metad.dataVolumeClaim.storageClassName` | - | Metad 服务的数据盘存储配置。 | + | `spec.metad.logVolumeClaim.storageClassName`|-|Metad 服务的日志盘存储配置。| + | `spec.storaged.replicas` | `3` | Storaged 服务的副本数。 | + | `spec.storaged.images` | `vesoft/nebula-storaged` | Storaged 服务的容器镜像。 | + | `spec.storaged.version` | `{{nebula.tag}}` | Storaged 服务的版本号。 | + | `spec.storaged.dataVolumeClaim.storageClassName` | - | Storaged 服务的数据盘存储配置。 | + | `spec.storaged.logVolumeClaim.storageClassName`|-|Storaged 服务的日志盘存储配置。| + | `spec.reference.name` | - | 依赖的控制器名称。 | + | `spec.schedulerName` | - | 调度器名称。 | + | `spec.imagePullPolicy` | Nebula Graph 镜像的拉取策略。关于拉取策略详情,请参考 [Image pull policy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy)。 | 镜像拉取策略。 | + +2. 创建 Nebula Graph 集群。 + + ```bash + kubectl create -f apps_v1alpha1_nebulacluster.yaml + ``` + + 返回: + + ```bash + nebulacluster.apps.nebula-graph.io/nebula created + ``` + +3. 查看 Nebula Graph 集群状态。 - === "社区版集群示例" - - ```yaml - apiVersion: apps.nebula-graph.io/v1alpha1 - kind: NebulaCluster - metadata: - name: nebula - spec: - graphd: - resources: - requests: - cpu: "500m" - memory: "500Mi" - limits: - cpu: "1" - memory: "1Gi" - replicas: 1 - image: vesoft/nebula-graphd - version: {{nebula.tag}} - service: - type: NodePort - externalTrafficPolicy: Local - logVolumeClaim: - resources: - requests: - storage: 2Gi - storageClassName: gp2 - metad: - resources: - requests: - cpu: "500m" - memory: "500Mi" - limits: - cpu: "1" - memory: "1Gi" - replicas: 1 - image: vesoft/nebula-metad - version: {{nebula.tag}} - dataVolumeClaim: - resources: - requests: - storage: 2Gi - storageClassName: gp2 - logVolumeClaim: - resources: - requests: - storage: 2Gi - storageClassName: gp2 - storaged: - resources: - requests: - cpu: "500m" - memory: "500Mi" - limits: - cpu: "1" - memory: "1Gi" - replicas: 3 - image: vesoft/nebula-storaged - version: {{nebula.tag}} - dataVolumeClaim: - resources: - requests: - storage: 2Gi - storageClassName: gp2 - logVolumeClaim: - resources: - requests: - storage: 2Gi - storageClassName: gp2 - reference: - name: statefulsets.apps - version: v1 - schedulerName: default-scheduler - imagePullPolicy: Always - ``` - - === "企业版集群示例" - - ```yaml - # 联系销售人员获取完整配置。 - apiVersion: apps.nebula-graph.io/v1alpha1 - kind: NebulaCluster - metadata: - annotations: - nebula-graph.io/owner: test - name: nebula - spec: - enablePVReclaim: true - graphd: - readinessProbe: - failureThreshold: 3 - httpGet: - path: /status - port: 19669 - scheme: HTTP - initialDelaySeconds: 40 - periodSeconds: 10 - successThreshold: 1 - timeoutSeconds: 10 - image: reg.vesoft-inc.com/vesoft-ent/nebula-graphd - logVolumeClaim: - resources: - requests: - storage: 2Gi - storageClassName: fast-disks - replicas: 1 - resources: - limits: - cpu: "1" - memory: 1Gi - requests: - cpu: 500m - memory: 500Mi - version: {{nebula.tag}} - imagePullPolicy: Always - imagePullSecrets: - - name: vesoft - metad: - license: - secretName: nebula-license - licenseKey: nebula.license - readinessProbe: - failureThreshold: 3 - httpGet: - path: /status - port: 19559 - scheme: HTTP - initialDelaySeconds: 5 - periodSeconds: 5 - successThreshold: 1 - timeoutSeconds: 5 - image: reg.vesoft-inc.com/vesoft-ent/nebula-metad - logVolumeClaim: - resources: - requests: - storage: 2Gi - storageClassName: fast-disks - dataVolumeClaim: - resources: - requests: - storage: 2Gi - storageClassName: fast-disks - replicas: 1 - resources: - limits: - cpu: "1" - memory: 1Gi - requests: - cpu: 500m - memory: 500Mi - version: {{nebula.tag}} - reference: - name: statefulsets.apps - version: v1 - schedulerName: default-scheduler - storaged: - readinessProbe: - failureThreshold: 3 - httpGet: - path: /status - port: 19779 - scheme: HTTP - initialDelaySeconds: 40 - periodSeconds: 10 - successThreshold: 1 - timeoutSeconds: 5 - image: reg.vesoft-inc.com/vesoft-ent/nebula-storaged - logVolumeClaim: - resources: - requests: - storage: 2Gi - storageClassName: fast-disks - dataVolumeClaim: - resources: - requests: - storage: 2Gi - storageClassName: fast-disks - replicas: 3 - resources: - limits: - cpu: "1" - memory: 1Gi - requests: - cpu: 500m - memory: 500Mi - version: {{nebula.tag}} - enableAutoBalance: true - ``` + ```bash + kubectl get nebulaclusters.apps.nebula-graph.io nebula + ``` + + 返回: + + ```bash + NAME GRAPHD-DESIRED GRAPHD-READY METAD-DESIRED METAD-READY STORAGED-DESIRED STORAGED-READY AGE + nebula 1 1 1 1 3 3 86s + ``` +{{ commu.commu_end }} + +{{ ent.ent_begin }} +1. 创建名为`apps_v1alpha1_nebulacluster.yaml`的文件。 + ```yaml + # 联系销售人员获取完整配置。 + apiVersion: apps.nebula-graph.io/v1alpha1 + kind: NebulaCluster + metadata: + annotations: + nebula-graph.io/owner: test + name: nebula + spec: + enablePVReclaim: true + graphd: + readinessProbe: + failureThreshold: 3 + httpGet: + path: /status + port: 19669 + scheme: HTTP + initialDelaySeconds: 40 + periodSeconds: 10 + successThreshold: 1 + timeoutSeconds: 10 + image: reg.vesoft-inc.com/vesoft-ent/nebula-graphd + logVolumeClaim: + resources: + requests: + storage: 2Gi + storageClassName: fast-disks + replicas: 1 + resources: + limits: + cpu: "1" + memory: 1Gi + requests: + cpu: 500m + memory: 500Mi + version: {{nebula.tag}} + imagePullPolicy: Always + imagePullSecrets: + - name: vesoft + metad: + license: + secretName: nebula-license + licenseKey: nebula.license + readinessProbe: + failureThreshold: 3 + httpGet: + path: /status + port: 19559 + scheme: HTTP + initialDelaySeconds: 5 + periodSeconds: 5 + successThreshold: 1 + timeoutSeconds: 5 + image: reg.vesoft-inc.com/vesoft-ent/nebula-metad + logVolumeClaim: + resources: + requests: + storage: 2Gi + storageClassName: fast-disks + dataVolumeClaim: + resources: + requests: + storage: 2Gi + storageClassName: fast-disks + replicas: 1 + resources: + limits: + cpu: "1" + memory: 1Gi + requests: + cpu: 500m + memory: 500Mi + version: {{nebula.tag}} + reference: + name: statefulsets.apps + version: v1 + schedulerName: default-scheduler + storaged: + readinessProbe: + failureThreshold: 3 + httpGet: + path: /status + port: 19779 + scheme: HTTP + initialDelaySeconds: 40 + periodSeconds: 10 + successThreshold: 1 + timeoutSeconds: 5 + image: reg.vesoft-inc.com/vesoft-ent/nebula-storaged + logVolumeClaim: + resources: + requests: + storage: 2Gi + storageClassName: fast-disks + dataVolumeClaim: + resources: + requests: + storage: 2Gi + storageClassName: fast-disks + replicas: 3 + resources: + limits: + cpu: "1" + memory: 1Gi + requests: + cpu: 500m + memory: 500Mi + version: {{nebula.tag}} + enableAutoBalance: true + ``` + 参数描述如下: | 参数 | 默认值 | 描述 | @@ -231,7 +285,7 @@ | `spec.storaged.logVolumeClaim.storageClassName`|-|Storaged 服务的日志盘存储配置。| | `spec.reference.name` | - | 依赖的控制器名称。 | | `spec.schedulerName` | - | 调度器名称。 | - | `spec.imagePullPolicy` | Nebula Graph 镜像的拉取策略。关于拉取策略详情,请参考 [Image pull policy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy)。 | 镜像拉取策略。 | + | `spec.imagePullPolicy` | Nebula Graph 镜像的拉取策略。关于拉取策略详情,请参考 [Image pull policy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy)。 | 镜像拉取策略。 | | `spec.metad.license` | - | 创建企业版 Nebula Graph 集群所需的 License 配置。 | !!! enterpriseonly @@ -357,6 +411,8 @@ 目前仅支持对 Nebula Graph 集群中的 Graph 服务和 Storage 服务进行扩缩容,不支持扩缩容 Meta 服务。 +{{ ent.ent_end }} + ## 删除集群 使用 Kubectl 删除 Nebula Graph 集群的命令如下: diff --git a/docs-2.0/nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md b/docs-2.0/nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md index 83e0005d63f..e23a43c8dc3 100644 --- a/docs-2.0/nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md +++ b/docs-2.0/nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md @@ -64,6 +64,7 @@ nebula-storaged-2 1/1 Running 0 5m34s ``` +{{ ent.ent_begin }} ## 扩缩容集群 !!! enterpriseonly @@ -91,6 +92,8 @@ helm upgrade "${NEBULA_CLUSTER_NAME}" nebula-operator/nebula-cluster \ 用户可点击 [nebula-cluster/values.yaml](https://github.com/vesoft-inc/nebula-operator/blob/{{operator.tag}}/charts/nebula-cluster/values.yaml) 查看 Nebula Cluster 集群 Chart 的更多配置。有关文件中配置项的解释,参考下文** Nebula Graph 集群 Chart 配置参数说明**。 +{{ ent.ent_end }} + ## 删除集群 使用 Helm 删除集群的命令如下: diff --git a/docs-2.0/reuse/source_manage-service.md b/docs-2.0/reuse/source_manage-service.md index 595fddcf9b7..f2807e659f1 100644 --- a/docs-2.0/reuse/source_manage-service.md +++ b/docs-2.0/reuse/source_manage-service.md @@ -1,4 +1,4 @@ -Nebula Graph 支持通过脚本或 systemd 管理服务。本文详细介绍这两种方式。 +Nebula Graph 支持通过脚本或 systemd 管理服务。 !!! enterpriseonly @@ -39,6 +39,7 @@ $ sudo /usr/local/nebula/scripts/nebula.service |`storaged`|管理 Storage 服务。| |`all`|管理所有服务。| +{{ ent.ent_begin }} ## 使用 systemd 管理服务 为方便使用,Nebula Graph 企业版支持用 systemd 管理服务,通过`systemctl`启动、停止、重启和查看服务。 @@ -51,8 +52,6 @@ $ sudo /usr/local/nebula/scripts/nebula.service - 对于其他方式安装的企业版 Nebula Graph,需要用户手动将`.service`文件移动到`/usr/lib/systemd/system`目录内,并修改`.service`文件内的`ExecStart`的文件路径,才可以正常使用`systemctl`命令。 - - ### 语法 ```bash @@ -70,6 +69,8 @@ $ systemctl <start | stop | restart | status > <nebula | nebula-metad | nebula-g |`nebula-graphd`|管理 Graph 服务。| |`nebula-storaged`|管理 Storage 服务。| +{{ ent.ent_end }} + ## 启动 Nebula Graph 服务 ### 非容器部署 diff --git a/mkdocs.yml b/mkdocs.yml index 9c90ae37a50..55be1c0a850 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -75,7 +75,24 @@ plugins: - spark-connector/* - 4.deployment-and-installation/5.zone.md - 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-200-to-latest.md + # 文档为企业版需注释以下页面(以下文档均为企业版) - nebula-cloud/* + - 3.ngql-guide/6.functions-and-expressions/17.ES-function.md + - 4.deployment-and-installation/deploy-license.md + - 5.configurations-and-logs/2.log-management/audit-log.md + - 7.data-security/1.authentication/4.ldap.md + - 8.service-tuning/load-balance.md + - graph-computing/0.deploy-controller-analytics.md + - graph-computing/nebula-analytics.md + - graph-computing/use-explorer.md + - nebula-dashboard-ent/* + - nebula-explorer/* + - nebula-exchange/use-exchange/ex-ug-export-from-nebula.md + - nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md + - synchronization-and-migration/replication-between-clusters.md + - 20.appendix/8.about-license/ + + # Exclude the file with the following file name. # - abc.md # Exclude files with regular expressions (regexes) @@ -223,6 +240,13 @@ extra: cloud: azureRelease: 2.6.2 # Azure云兼容的最新内核版本 aliyunRelease: 3.1.0 # 阿里云兼容的最新内核版本 + ent: + ent_begin: <!-- # 文档为企业版时需补全该注释 + ent_end: --> + commu: + commu_begin: <!-- --> # 文档为社区版时需补全该注释 + commu_end: <!-- --> + nav: @@ -297,7 +321,7 @@ nav: - 条件表达式函数: 3.ngql-guide/6.functions-and-expressions/5.conditional-expressions.md - 谓词函数: 3.ngql-guide/6.functions-and-expressions/8.predicate.md - geo 函数: 3.ngql-guide/6.functions-and-expressions/14.geo.md - - Elasticsearch 查询函数: 3.ngql-guide/6.functions-and-expressions/17.ES-function.md +#ent - Elasticsearch 查询函数: 3.ngql-guide/6.functions-and-expressions/17.ES-function.md - 自定义函数: 3.ngql-guide/6.functions-and-expressions/9.user-defined-functions.md - 通用查询语句: @@ -408,7 +432,7 @@ nav: - 使用 RPM/DEB 包部署多机集群: 4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md - 使用生态工具安装: 4.deployment-and-installation/2.compile-and-install-nebula-graph/6.deploy-nebula-graph-with-peripherals.md - 安装存算合并版 Nebula Graph: 4.deployment-and-installation/standalone-deployment.md - - 设置 Nebula Graph 企业版 License: 4.deployment-and-installation/deploy-license.md +#ent - 设置 Nebula Graph 企业版 License: 4.deployment-and-installation/deploy-license.md - 管理服务: 4.deployment-and-installation/manage-service.md - 连接服务: 4.deployment-and-installation/connect-to-nebula-graph.md - 管理 Storage 主机: 4.deployment-and-installation/manage-storage-host.md @@ -428,7 +452,7 @@ nav: - Linux 内核配置: 5.configurations-and-logs/1.configurations/6.kernel-config.md - 日志: - 运行日志: 5.configurations-and-logs/2.log-management/logs.md - - 审计日志(企业版): 5.configurations-and-logs/2.log-management/audit-log.md +#ent - 审计日志(企业版): 5.configurations-and-logs/2.log-management/audit-log.md - 监控: - 查询 Nebula Graph 监控指标: 6.monitor-and-metrics/1.query-performance-metrics.md @@ -439,7 +463,7 @@ nav: - 身份验证: 7.data-security/1.authentication/1.authentication.md - 用户管理: 7.data-security/1.authentication/2.management-user.md - 内置角色权限: 7.data-security/1.authentication/3.role-list.md - - OpenLDAP 验证: 7.data-security/1.authentication/4.ldap.md +#ent - OpenLDAP 验证: 7.data-security/1.authentication/4.ldap.md - SSL 加密: 7.data-security/4.ssl.md - 备份与恢复: @@ -452,7 +476,7 @@ nav: - 同步与迁移: - 负载均衡: synchronization-and-migration/2.balance-syntax.md - - 集群间数据同步: synchronization-and-migration/replication-between-clusters.md +#ent - 集群间数据同步: synchronization-and-migration/replication-between-clusters.md - 最佳实践: - Compaction: 8.service-tuning/compaction.md @@ -474,8 +498,9 @@ nav: # - Nebula Graph Cloud: nebula-cloud.md - - Nebula Graph Cloud: - - 什么是 Nebula Graph Cloud: nebula-cloud/1.what-is-cloud.md +#ent +# - Nebula Graph Cloud: +# - 什么是 Nebula Graph Cloud: nebula-cloud/1.what-is-cloud.md # - Nebula Graph Cloud Azure版: # - 创建订阅: nebula-cloud/nebula-cloud-on-azure/2.how-to-create-subsciption.md # - 配置Solution: nebula-cloud/nebula-cloud-on-azure/3.how-to-set-solution.md @@ -488,10 +513,10 @@ nav: # - 价格: nebula-cloud/nebula-cloud-on-azure/6.pricing.md # - 用户服务条款: nebula-cloud/nebula-cloud-on-azure/7.terms-and-conditions.md # - 隐私政策条款: nebula-cloud/nebula-cloud-on-azure/8.privacy-policy.md - - Nebula Graph Cloud 阿里云版: - - 创建服务实例: nebula-cloud/nebula-cloud-on-alibabacloud/1.create-service-instance.md - - 使用服务实例: nebula-cloud/nebula-cloud-on-alibabacloud/2.use-cloud-services.md - - 删除服务实例: nebula-cloud/nebula-cloud-on-alibabacloud/3.delete-service-instance.md +# - Nebula Graph Cloud 阿里云版: +# - 创建服务实例: nebula-cloud/nebula-cloud-on-alibabacloud/1.create-service-instance.md +# - 使用服务实例: nebula-cloud/nebula-cloud-on-alibabacloud/2.use-cloud-services.md +# - 删除服务实例: nebula-cloud/nebula-cloud-on-alibabacloud/3.delete-service-instance.md - Nebula Studio: - Studio 版本更新说明: nebula-studio/about-studio/st-ug-release-note.md @@ -524,50 +549,52 @@ nav: - Dashboard 页面介绍: nebula-dashboard/4.use-dashboard.md - 监控指标说明: nebula-dashboard/6.monitor-parameter.md - - Nebula Dashboard(企业版): - - 什么是 Nebula Dashboard 企业版: nebula-dashboard-ent/1.what-is-dashboard-ent.md - - 部署 Nebula Dashboard 企业版: nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md - - Nebula Dashboard 企业版 License: nebula-dashboard-ent/11.dashboard-ent-license.md - - 创建及导入集群: - - 创建集群: nebula-dashboard-ent/3.create-import-dashboard/1.create-cluster.md - - 导入集群: nebula-dashboard-ent/3.create-import-dashboard/2.import-cluster.md - - 集群管理: - - 集群总览: nebula-dashboard-ent/4.cluster-operator/1.overview.md - - 集群监控: nebula-dashboard-ent/4.cluster-operator/2.monitor.md - - 监控告警: nebula-dashboard-ent/9.alerts.md - - 集群信息: nebula-dashboard-ent/4.cluster-operator/3.cluster-information.md - - 集群诊断: nebula-dashboard-ent/4.cluster-operator/7.cluster-diagnosis.md - - 集群操作: nebula-dashboard-ent/4.cluster-operator/4.manage.md - - 备份与恢复: nebula-dashboard-ent/4.cluster-operator/8.backup-and-restore.md - - 操作记录: nebula-dashboard-ent/4.cluster-operator/5.operation-record.md - - 其他设置: nebula-dashboard-ent/4.cluster-operator/6.settings.md - - 任务中心: nebula-dashboard-ent/10.tasks.md - - 权限管理: nebula-dashboard-ent/5.account-management.md - - 安装包管理: nebula-dashboard-ent/11.manage-package.md - - 全局配置: nebula-dashboard-ent/6.global-config.md - - 监控指标说明: nebula-dashboard-ent/7.monitor-parameter.md - - 常见问题 FAQ: nebula-dashboard-ent/8.faq.md - - - Nebula Explorer: - - 什么是 Nebula Explorer: nebula-explorer/about-explorer/ex-ug-what-is-explorer.md - - 安装与登录: - - 部署 Explorer: nebula-explorer/deploy-connect/ex-ug-deploy.md - - 连接数据库: nebula-explorer/deploy-connect/ex-ug-connect.md - - Nebula Explorer License(企业版): nebula-explorer/deploy-connect/3.explorer-license.md - - 页面概览: nebula-explorer/ex-ug-page-overview.md - - 创建 Schema: nebula-explorer/10.create-schema.md - - 导入数据: nebula-explorer/11.import-data.md - - 选择图空间: nebula-explorer/13.choose-graphspace.md - - 开始探索: nebula-explorer/ex-ug-query-exploration.md - - 节点筛选: nebula-explorer/node-filtering.md - - 探索拓展: nebula-explorer/ex-ug-graph-exploration.md - - 可视化查询: nebula-explorer/12.query-visually.md - - 画布功能: - - 画布概览: nebula-explorer/canvas-operations/canvas-overview.md - - 可视化模式: nebula-explorer/canvas-operations/visualization-mode.md - - 画布快照: nebula-explorer/canvas-operations/canvas-snapshot.md - - 控制台: nebula-explorer/explorer-console.md - - 基本操作和快捷键: nebula-explorer/ex-ug-shortcuts.md +#ent +# - Nebula Dashboard(企业版): +# - 什么是 Nebula Dashboard 企业版: nebula-dashboard-ent/1.what-is-dashboard-ent.md +# - 部署 Nebula Dashboard 企业版: nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md +# - Nebula Dashboard 企业版 License: nebula-dashboard-ent/11.dashboard-ent-license.md +# - 创建及导入集群: +# - 创建集群: nebula-dashboard-ent/3.create-import-dashboard/1.create-cluster.md +# - 导入集群: nebula-dashboard-ent/3.create-import-dashboard/2.import-cluster.md +# - 集群管理: +# - 集群总览: nebula-dashboard-ent/4.cluster-operator/1.overview.md +# - 集群监控: nebula-dashboard-ent/4.cluster-operator/2.monitor.md +# - 监控告警: nebula-dashboard-ent/9.alerts.md +# - 集群信息: nebula-dashboard-ent/4.cluster-operator/3.cluster-information.md +# - 集群诊断: nebula-dashboard-ent/4.cluster-operator/7.cluster-diagnosis.md +# - 集群操作: nebula-dashboard-ent/4.cluster-operator/4.manage.md +# - 备份与恢复: nebula-dashboard-ent/4.cluster-operator/8.backup-and-restore.md +# - 操作记录: nebula-dashboard-ent/4.cluster-operator/5.operation-record.md +# - 其他设置: nebula-dashboard-ent/4.cluster-operator/6.settings.md +# - 任务中心: nebula-dashboard-ent/10.tasks.md +# - 权限管理: nebula-dashboard-ent/5.account-management.md +# - 安装包管理: nebula-dashboard-ent/11.manage-package.md +# - 全局配置: nebula-dashboard-ent/6.global-config.md +# - 监控指标说明: nebula-dashboard-ent/7.monitor-parameter.md +# - 常见问题 FAQ: nebula-dashboard-ent/8.faq.md + +#ent +# - Nebula Explorer: +# - 什么是 Nebula Explorer: nebula-explorer/about-explorer/ex-ug-what-is-explorer.md +# - 安装与登录: +# - 部署 Explorer: nebula-explorer/deploy-connect/ex-ug-deploy.md +# - 连接数据库: nebula-explorer/deploy-connect/ex-ug-connect.md +# - Nebula Explorer License(企业版): nebula-explorer/deploy-connect/3.explorer-license.md +# - 页面概览: nebula-explorer/ex-ug-page-overview.md +# - 创建 Schema: nebula-explorer/10.create-schema.md +# - 导入数据: nebula-explorer/11.import-data.md +# - 选择图空间: nebula-explorer/13.choose-graphspace.md +# - 开始探索: nebula-explorer/ex-ug-query-exploration.md +# - 节点筛选: nebula-explorer/node-filtering.md +# - 探索拓展: nebula-explorer/ex-ug-graph-exploration.md +# - 可视化查询: nebula-explorer/12.query-visually.md +# - 画布功能: +# - 画布概览: nebula-explorer/canvas-operations/canvas-overview.md +# - 可视化模式: nebula-explorer/canvas-operations/visualization-mode.md +# - 画布快照: nebula-explorer/canvas-operations/canvas-snapshot.md +# - 控制台: nebula-explorer/explorer-console.md +# - 基本操作和快捷键: nebula-explorer/ex-ug-shortcuts.md - Nebula Importer: - 使用 Nebula Importer: nebula-importer/use-importer.md @@ -621,11 +648,11 @@ nav: - Nebula Algorithm: graph-computing/nebula-algorithm.md - - Nebula Analytics: graph-computing/nebula-analytics.md +#ent - Nebula Analytics: graph-computing/nebula-analytics.md - - Nebula Explorer 工作流: graph-computing/use-explorer.md +#ent - Nebula Explorer 工作流: graph-computing/use-explorer.md - - Dag Controller: graph-computing/0.deploy-controller-analytics.md +#ent - Dag Controller: graph-computing/0.deploy-controller-analytics.md - Nebula Spark Connector: nebula-spark-connector.md @@ -636,7 +663,7 @@ nav: - 附录: - Release Note: 20.appendix/release-note.md - 学习路径: 20.appendix/learning-path.md - - 关于 License: 20.appendix/8.about-license.md +#ent - 关于 License: 20.appendix/8.about-license.md - 常见问题 FAQ: 20.appendix/0.FAQ.md - 生态工具概览: 20.appendix/6.eco-tool-version.md - 导入工具选择: 20.appendix/write-tools.md From 3ea03d63defc147a1ace9e90deb99e1611670278 Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Mon, 4 Jul 2022 18:35:28 +0800 Subject: [PATCH 2/9] Update 6.eco-tool-version.md --- docs-2.0/20.appendix/6.eco-tool-version.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs-2.0/20.appendix/6.eco-tool-version.md b/docs-2.0/20.appendix/6.eco-tool-version.md index 43b8f187b8d..85a4194ad66 100644 --- a/docs-2.0/20.appendix/6.eco-tool-version.md +++ b/docs-2.0/20.appendix/6.eco-tool-version.md @@ -51,6 +51,7 @@ Nebula Dashboard(简称 Dashboard)是一款用于监控 Nebula Graph 集群 | {{ nebula.tag }} | {{dashboard.tag}}| {{ ent.ent-begin }} + ## Nebula Dashboard(企业版) Nebula Dashboard(简称 Dashboard)是一款用于监控和管理 Nebula Graph 多集群中机器和服务状态的可视化工具,支持在可视化界面进行集群创建、集群导入、数据平衡、扩容缩容等操作。详情参见[什么是 Nebula Dashboard](../nebula-dashboard-ent/1.what-is-dashboard-ent.md)。 @@ -71,6 +72,7 @@ Nebula Explorer(简称 Explorer)是一款可以通过 Web 访问的图探索 | {{ nebula.tag }} | {{explorer.tag}}| {{ ent.ent-end }} + ## Nebula Stats Exporter [nebula-stats-exporter](https://github.com/vesoft-inc/nebula-stats-exporter)将监控数据导入Prometheus。 From 528301a2009d1868853215814cafa8c3b91de7ee Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Tue, 5 Jul 2022 10:32:12 +0800 Subject: [PATCH 3/9] Update mkdocs.yml --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 55be1c0a850..9c9cc4be15e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -75,7 +75,7 @@ plugins: - spark-connector/* - 4.deployment-and-installation/5.zone.md - 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-200-to-latest.md - # 文档为企业版需注释以下页面(以下文档均为企业版) + # 发布包含企业版功能的文档版本时,注释以下页面 - nebula-cloud/* - 3.ngql-guide/6.functions-and-expressions/17.ES-function.md - 4.deployment-and-installation/deploy-license.md From 2760954038676b9052b6694799687d6b26062e3b Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Tue, 5 Jul 2022 10:32:23 +0800 Subject: [PATCH 4/9] Update mkdocs.yml Co-authored-by: randomJoe211 <69501902+randomJoe211@users.noreply.github.com> --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 9c9cc4be15e..cc9ef9f09b5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -241,7 +241,7 @@ extra: azureRelease: 2.6.2 # Azure云兼容的最新内核版本 aliyunRelease: 3.1.0 # 阿里云兼容的最新内核版本 ent: - ent_begin: <!-- # 文档为企业版时需补全该注释 + ent_begin: <!-- # 文档包含企业版时需补全该注释(<!-- -->),只包含社区版时只保留注释头(<!--) ent_end: --> commu: commu_begin: <!-- --> # 文档为社区版时需补全该注释 From f1daba87f5a54d5f725ff9b8ea9b0f0590f44a79 Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Tue, 5 Jul 2022 10:32:30 +0800 Subject: [PATCH 5/9] Update mkdocs.yml Co-authored-by: randomJoe211 <69501902+randomJoe211@users.noreply.github.com> --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index cc9ef9f09b5..6b19510e513 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -242,7 +242,7 @@ extra: aliyunRelease: 3.1.0 # 阿里云兼容的最新内核版本 ent: ent_begin: <!-- # 文档包含企业版时需补全该注释(<!-- -->),只包含社区版时只保留注释头(<!--) - ent_end: --> + ent_end: --> #文档包含企业版时需补全该注释(<!-- -->),只包含社区版时只保留注释尾(-->) commu: commu_begin: <!-- --> # 文档为社区版时需补全该注释 commu_end: <!-- --> From af823c4b3658ede2bd77089d7a53f45156dfd472 Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Tue, 5 Jul 2022 10:33:50 +0800 Subject: [PATCH 6/9] Update mkdocs.yml --- mkdocs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 6b19510e513..ea736263c08 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -244,8 +244,8 @@ extra: ent_begin: <!-- # 文档包含企业版时需补全该注释(<!-- -->),只包含社区版时只保留注释头(<!--) ent_end: --> #文档包含企业版时需补全该注释(<!-- -->),只包含社区版时只保留注释尾(-->) commu: - commu_begin: <!-- --> # 文档为社区版时需补全该注释 - commu_end: <!-- --> + commu_begin: <!-- --> # 文档包含社区版时需补全该注释(<!-- -->),只包含企业版时只保留注释头(<!--) + commu_end: <!-- --> # 文档包含社区版时需补全该注释(<!-- -->),只包含企业版时只保留注释尾(-->) From 303f5fc091cb45f6be7cd14ea2423d1e2253b8d5 Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Tue, 5 Jul 2022 11:43:05 +0800 Subject: [PATCH 7/9] update --- docs-2.0/20.appendix/6.eco-tool-version.md | 7 ------ docs-2.0/20.appendix/learning-path.md | 27 ---------------------- mkdocs.yml | 2 -- 3 files changed, 36 deletions(-) diff --git a/docs-2.0/20.appendix/6.eco-tool-version.md b/docs-2.0/20.appendix/6.eco-tool-version.md index 85a4194ad66..280ac92973a 100644 --- a/docs-2.0/20.appendix/6.eco-tool-version.md +++ b/docs-2.0/20.appendix/6.eco-tool-version.md @@ -50,8 +50,6 @@ Nebula Dashboard(简称 Dashboard)是一款用于监控 Nebula Graph 集群 |:---|:---| | {{ nebula.tag }} | {{dashboard.tag}}| -{{ ent.ent-begin }} - ## Nebula Dashboard(企业版) Nebula Dashboard(简称 Dashboard)是一款用于监控和管理 Nebula Graph 多集群中机器和服务状态的可视化工具,支持在可视化界面进行集群创建、集群导入、数据平衡、扩容缩容等操作。详情参见[什么是 Nebula Dashboard](../nebula-dashboard-ent/1.what-is-dashboard-ent.md)。 @@ -60,9 +58,6 @@ Nebula Dashboard(简称 Dashboard)是一款用于监控和管理 Nebula Grap |:---|:---| | {{ nebula.tag }} | {{dashboard_ent.tag}}| -{{ ent.ent-end }} - -{{ ent.ent-begin }} ## Nebula Explorer Nebula Explorer(简称 Explorer)是一款可以通过 Web 访问的图探索可视化工具,搭配 Nebula Graph 内核使用,用于与图数据进行可视化交互。即使没有图数据操作经验,用户也可以快速成为图专家。详情参见[什么是 Nebula Explorer](../nebula-explorer/about-explorer/ex-ug-what-is-explorer.md)。 @@ -71,8 +66,6 @@ Nebula Explorer(简称 Explorer)是一款可以通过 Web 访问的图探索 |:---|:---| | {{ nebula.tag }} | {{explorer.tag}}| -{{ ent.ent-end }} - ## Nebula Stats Exporter [nebula-stats-exporter](https://github.com/vesoft-inc/nebula-stats-exporter)将监控数据导入Prometheus。 diff --git a/docs-2.0/20.appendix/learning-path.md b/docs-2.0/20.appendix/learning-path.md index 79685414470..a5ec2ece2be 100644 --- a/docs-2.0/20.appendix/learning-path.md +++ b/docs-2.0/20.appendix/learning-path.md @@ -172,40 +172,14 @@ - 可视化 -{{ commu.commu_begin }} - - | 可视化工具 | 文档 | 视频 | - | -------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | - | 数据可视化 | [Nebula Studio](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-studio/about-studio/st-ug-what-is-graph-studio/) | [Nebula Studio 图探索功能](https://www.bilibili.com/video/BV1QN411Z7Vh)和[Nebula Studio 可视化建模](https://www.bilibili.com/video/BV19A411L77h?spm_id_from=333.999.0.0) | - | 数据监控和运维 | [Nebula Dashboard 社区版](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-dashboard/1.what-is-dashboard/) | [可视化监控 Nebula Dashboard](https://www.bilibili.com/video/BV1qQ4y1k7gb?) | - -{{ commu.commu_end }} - -{{ ent.ent_begin }} | 可视化工具 | 文档 | 视频 | | -------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | | 数据可视化 | [Nebula Studio](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-studio/about-studio/st-ug-what-is-graph-studio/) | [Nebula Studio 图探索功能](https://www.bilibili.com/video/BV1QN411Z7Vh)和[Nebula Studio 可视化建模](https://www.bilibili.com/video/BV19A411L77h?spm_id_from=333.999.0.0) | | 数据监控和运维 | [Nebula Dashboard 企业版](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-dashboard-ent/1.what-is-dashboard-ent/)和 [Nebula Dashboard 社区版](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-dashboard/1.what-is-dashboard/) | [可视化监控 Nebula Dashboard](https://www.bilibili.com/video/BV1qQ4y1k7gb?) | | 数据分析 | [Nebula Explorer 企业版](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-explorer/about-explorer/ex-ug-what-is-explorer/) | [可视化图探索 Nebula Explorer](https://www.bilibili.com/video/BV1fP4y1h7Fx?) | -{{ ent.ent_begin }} - - - 数据导入与导出 -{{ commu.commu_begin }} - - | 导入与导出 | 文档 | 视频 | - | -------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | - | 数据导入 | [Nebula Importer](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-importer/use-importer/) | [Nebula Importer](https://www.bilibili.com/video/BV1ny4y1u7i4) | - | 数据导入 | [Nebula Spark Connector](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-spark-connector/) | - | - | 数据导入 | [Nebula Flink Connector](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-flink-connector/) | - | - | 数据导入 | [Nebula Exchange 社区版](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-exchange/about-exchange/ex-ug-what-is-exchange/) | [Nebula Graph 数据导入工具——Exchange](https://www.bilibili.com/video/BV1Pq4y177D9)、[Exchange 导入 SST 数据](https://www.bilibili.com/video/BV1y34y1o7Di?) | - -{{ commu.commu_end }} - -{{ ent.ent_begin }} - | 导入与导出 | 文档 | 视频 | | -------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | | 数据导入 | [Nebula Importer](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-importer/use-importer/) | [Nebula Importer](https://www.bilibili.com/video/BV1ny4y1u7i4) | @@ -214,7 +188,6 @@ | 数据导入 | [Nebula Exchange 社区版](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-exchange/about-exchange/ex-ug-what-is-exchange/) | [Nebula Graph 数据导入工具——Exchange](https://www.bilibili.com/video/BV1Pq4y177D9)、[Exchange 导入 SST 数据](https://www.bilibili.com/video/BV1y34y1o7Di?) | | 数据导出 | [Nebula Exchange 企业版](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-exchange/about-exchange/ex-ug-what-is-exchange/) | - | -{{ ent.ent_begin }} - 备份与恢复 diff --git a/mkdocs.yml b/mkdocs.yml index 15e919299b8..ee059964449 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -85,8 +85,6 @@ plugins: - graph-computing/0.deploy-controller-analytics.md - graph-computing/nebula-analytics.md - graph-computing/use-explorer.md - - nebula-dashboard-ent/* - - nebula-explorer/* - nebula-exchange/use-exchange/ex-ug-export-from-nebula.md - nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md - synchronization-and-migration/replication-between-clusters.md From cefcd6dc1f28cd581693164c0e91d3f78066bd5e Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Tue, 5 Jul 2022 17:13:12 +0800 Subject: [PATCH 8/9] Update mkdocs.yml --- mkdocs.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index ee059964449..6ca1509657d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -72,11 +72,12 @@ plugins: # Exclude all files in a directory. The path starts with the directory name in docs-2.0, such as `20.appendix/*`. - nebula-flink/* - CHANGELOG.md + - nebula-cloud/* - spark-connector/* - 4.deployment-and-installation/5.zone.md - 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-200-to-latest.md # 发布包含企业版功能的文档版本时,注释以下页面 - - nebula-cloud/* + # begin - 3.ngql-guide/6.functions-and-expressions/17.ES-function.md - 4.deployment-and-installation/deploy-license.md - 5.configurations-and-logs/2.log-management/audit-log.md @@ -89,6 +90,7 @@ plugins: - nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md - synchronization-and-migration/replication-between-clusters.md - 20.appendix/8.about-license/ + # end # Exclude the file with the following file name. From 5aef924a64fa063371a1c49e5690749b5fcc8a91 Mon Sep 17 00:00:00 2001 From: foesa <35463247+foesa-yang@users.noreply.github.com> Date: Wed, 6 Jul 2022 10:17:57 +0800 Subject: [PATCH 9/9] update --- .../1.configurations/2.meta-config.md | 7 -- .../1.authentication/2.management-user.md | 64 ++++++------------- .../3.1create-cluster-with-kubectl.md | 61 +++--------------- mkdocs.yml | 4 -- 4 files changed, 30 insertions(+), 106 deletions(-) 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 e0da7f1f9eb..39e93d194a7 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 @@ -19,23 +19,16 @@ Meta 服务提供了两份初始配置文件`nebula-metad.conf.default`和`nebul ## basics 配置 -{{ commu.commu_begin }} - | 名称 | 预设值 | 说明 | | :----------- | :----------------------- | :------------------| | `daemonize` | `true` | 是否启动守护进程。 | | `pid_file` | `pids/nebula-metad.pid` | 记录进程 ID 的文件。 | | `timezone_name` | - | 指定 Nebula Graph 的时区。初始配置文件中未设置该参数,如需使用请手动添加。系统默认值为`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`。 | -{{ commu.commu_end }} - {{ ent.ent_begin }} | 名称 | 预设值 | 说明 | | :----------- | :----------------------- | :------------------| -| `daemonize` | `true` | 是否启动守护进程。 | -| `pid_file` | `pids/nebula-metad.pid` | 记录进程 ID 的文件。 | -| `timezone_name` | - | 指定 Nebula Graph 的时区。初始配置文件中未设置该参数,如需使用请手动添加。系统默认值为`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`。 | |`license_path`|`share/resources/nebula.license`|企业版 License 路径。企业版需要用户[设置 License](../../4.deployment-and-installation/deploy-license.md) 才可以正常启动并使用企业版功能。仅企业版 Nebula Graph 需要设置本参数,其他周边工具如何设置 License,请参见相应周边工具的部署文档。| {{ ent.ent_end }} diff --git a/docs-2.0/7.data-security/1.authentication/2.management-user.md b/docs-2.0/7.data-security/1.authentication/2.management-user.md index 5a4b1e7beba..36541ab1104 100644 --- a/docs-2.0/7.data-security/1.authentication/2.management-user.md +++ b/docs-2.0/7.data-security/1.authentication/2.management-user.md @@ -13,7 +13,6 @@ 执行`CREATE USER`语句可以创建新的 Nebula Graph 用户。当前仅** God **角色用户(即`root`用户)能够执行`CREATE USER`语句。 -{{ commu.commu_begin }} - 语法 @@ -25,6 +24,17 @@ - `user_name`:待创建的用户名。 - `password`:用户名对应的密码。 +{{ ent.ent_begin }} +- 企业版语法 + + ```ngql + CREATE USER [IF NOT EXISTS] <user_name> [WITH PASSWORD '<password>'][WITH IP WHITELIST <ip_list>]; + ``` + + - `ip_list`(企业版):IP 白名单列表。该用户只有通过列表内的 IP 才能连接 Nebula Graph。多个 IP 之间用英文逗号(,)分隔。 + +{{ ent.ent_end }} + - 示例 ```ngql @@ -38,32 +48,15 @@ +---------+-------------------------------+ ``` -{{ commu.commu_end }} - {{ ent.ent_begin }} - -- 语法 +- 企业版示例 ```ngql - CREATE USER [IF NOT EXISTS] <user_name> [WITH PASSWORD '<password>'][WITH IP WHITELIST <ip_list>]; - ``` - - - `IF NOT EXISTS`:检测待创建的用户名是否存在,只有不存在时,才会创建新用户。 - - `user_name`:待创建的用户名。 - - `password`:用户名对应的密码。 - - `ip_list`(企业版):IP 白名单列表。该用户只有通过列表内的 IP 才能连接 Nebula Graph。多个 IP 之间用英文逗号(,)分隔。 - -- 示例 - - ```ngql - nebula> CREATE USER user1 WITH PASSWORD 'nebula'; nebula> CREATE USER user2 WITH PASSWORD 'nebula' WITH IP WHITELIST 192.168.10.10,192.168.10.12; nebula> SHOW USERS; +---------+-------------------------------+ | Account | IP Whitelist | +---------+-------------------------------+ - | "root" | "" | - | "user1" | "" | | "user2" | "192.168.10.10,192.168.10.12" | +---------+-------------------------------+ ``` @@ -160,7 +153,6 @@ nebula> CHANGE PASSWORD user1 FROM 'nebula' TO 'nebula123'; ``` -{{ commu.commu_begin }} ## 修改用户密码(`ALTER USER`) 执行`ALTER USER`语句可以修改用户密码,修改时不需要提供旧密码。当前仅** God **角色用户(即`root`用户)能够执行`ALTER USER`语句。 @@ -171,6 +163,14 @@ ALTER USER <user_name> WITH PASSWORD '<password>'; ``` +{{ ent.ent_begin }} +- 企业版语法 + + ```ngql + ALTER USER <user_name> WITH PASSWORD '<password>' [WITH IP WHITELIST <ip_list>]; + ``` +{{ ent.ent_end }} + - 示例 ```ngql @@ -186,37 +186,15 @@ ``` -{{ commu.commu_end }} - {{ ent.ent_begin }} -## 修改用户密码和 IP 白名单(`ALTER USER`) - -执行`ALTER USER`语句可以修改用户密码和 IP 白名单,修改时不需要提供旧密码。当前仅** God **角色用户(即`root`用户)能够执行`ALTER USER`语句。 - -- 语法 - - ```ngql - ALTER USER <user_name> WITH PASSWORD '<password>' [WITH IP WHITELIST <ip_list>]; - ``` - -- 示例 +- 企业版示例 !!! enterpriseonly 没有使用`WITH IP WHITELIST`时,表示取消 IP 白名单,用户使用任何 IP 都可以连接 Nebula Graph。 ```ngql - nebula> ALTER USER user2 WITH PASSWORD 'nebula'; - nebula> SHOW USERS; - +---------+--------------+ - | Account | IP Whitelist | - +---------+--------------+ - | "root" | "" | - | "user1" | "" | - | "user2" | "" | - +---------+--------------+ - nebula> ALTER USER user2 WITH PASSWORD 'nebula' WITH IP WHITELIST 192.168.10.10; ``` {{ ent.ent_end }} 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 6710f6105de..d2fb63a50c3 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 @@ -20,10 +20,8 @@ 本文以创建名为`nebula`的集群为例,说明如何部署 Nebula Graph 集群。 -{{ commu.commu_begin }} - -1. 创建名为`apps_v1alpha1_nebulacluster.yaml`的文件。 - +1. 社区版集群示例,创建名为`apps_v1alpha1_nebulacluster.yaml`的文件。 + ```yaml apiVersion: apps.nebula-graph.io/v1alpha1 kind: NebulaCluster @@ -122,36 +120,10 @@ | `spec.schedulerName` | - | 调度器名称。 | | `spec.imagePullPolicy` | Nebula Graph 镜像的拉取策略。关于拉取策略详情,请参考 [Image pull policy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy)。 | 镜像拉取策略。 | -2. 创建 Nebula Graph 集群。 - - ```bash - kubectl create -f apps_v1alpha1_nebulacluster.yaml - ``` - - 返回: - - ```bash - nebulacluster.apps.nebula-graph.io/nebula created - ``` - -3. 查看 Nebula Graph 集群状态。 - - ```bash - kubectl get nebulaclusters.apps.nebula-graph.io nebula - ``` - - 返回: - - ```bash - NAME GRAPHD-DESIRED GRAPHD-READY METAD-DESIRED METAD-READY STORAGED-DESIRED STORAGED-READY AGE - nebula 1 1 1 1 3 3 86s - ``` - - -{{ commu.commu_end }} {{ ent.ent_begin }} -1. 创建名为`apps_v1alpha1_nebulacluster.yaml`的文件。 +1. 企业版集群示例,创建名为`apps_v1alpha1_nebulacluster.yaml`的文件。 + ```yaml # 联系销售人员获取完整配置。 apiVersion: apps.nebula-graph.io/v1alpha1 @@ -263,34 +235,16 @@ enableAutoBalance: true ``` - 参数描述如下: + 企业版特有参数描述如下: | 参数 | 默认值 | 描述 | | :---- | :--- | :--- | - | `metadata.name` | - | 创建的 Nebula Graph 集群名称。 | - | `spec.graphd.replicas` | `1` | Graphd 服务的副本数。 | - | `spec.graphd.images` | `vesoft/nebula-graphd` | Graphd 服务的容器镜像。 | - | `spec.graphd.version` | `{{nebula.tag}}` | Graphd 服务的版本号。 | - | `spec.graphd.service` | - | Graphd 服务 Service 配置。 | - | `spec.graphd.logVolumeClaim.storageClassName` | - | Graphd 服务的日志盘存储配置。 | - | `spec.metad.replicas` | `1` | Metad 服务的副本数。 | - | `spec.metad.images` | `vesoft/nebula-metad` | Metad 服务的容器镜像。 | - | `spec.metad.version` | `{{nebula.tag}}` | Metad 服务的版本号。 | - | `spec.metad.dataVolumeClaim.storageClassName` | - | Metad 服务的数据盘存储配置。 | - | `spec.metad.logVolumeClaim.storageClassName`|-|Metad 服务的日志盘存储配置。| - | `spec.storaged.replicas` | `3` | Storaged 服务的副本数。 | - | `spec.storaged.images` | `vesoft/nebula-storaged` | Storaged 服务的容器镜像。 | - | `spec.storaged.version` | `{{nebula.tag}}` | Storaged 服务的版本号。 | - | `spec.storaged.dataVolumeClaim.storageClassName` | - | Storaged 服务的数据盘存储配置。 | - | `spec.storaged.logVolumeClaim.storageClassName`|-|Storaged 服务的日志盘存储配置。| - | `spec.reference.name` | - | 依赖的控制器名称。 | - | `spec.schedulerName` | - | 调度器名称。 | - | `spec.imagePullPolicy` | Nebula Graph 镜像的拉取策略。关于拉取策略详情,请参考 [Image pull policy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy)。 | 镜像拉取策略。 | | `spec.metad.license` | - | 创建企业版 Nebula Graph 集群所需的 License 配置。 | !!! enterpriseonly 拉取企业版 Nebula Graph 集群镜像前,请确保已联系销售人员([inqury@vesoft.com](mailto:inqury@vesoft.com))获取企业版 Nebula Graph 集群的镜像信息。 +{{ ent.ent_end }} 2. 创建 Nebula Graph 集群。 @@ -304,6 +258,7 @@ nebulacluster.apps.nebula-graph.io/nebula created ``` +{{ ent.ent_begin }} 3. 配置集群 License。 !!! enterpriseonly @@ -321,6 +276,7 @@ ```bash kubectl get secrets nebula-license -o yaml ``` +{{ ent.ent_end }} 4. 查看 Nebula Graph 集群状态。 @@ -335,6 +291,7 @@ nebula 1 1 1 1 3 3 86s ``` +{{ ent.ent_begin }} ## 扩缩容集群 !!! enterpriseonly diff --git a/mkdocs.yml b/mkdocs.yml index 6ca1509657d..75d36c95d4d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -247,10 +247,6 @@ extra: ent: ent_begin: <!-- # 文档包含企业版时需补全该注释(<!-- -->),只包含社区版时只保留注释头(<!--) ent_end: --> #文档包含企业版时需补全该注释(<!-- -->),只包含社区版时只保留注释尾(-->) - commu: - commu_begin: <!-- --> # 文档包含社区版时需补全该注释(<!-- -->),只包含企业版时只保留注释头(<!--) - commu_end: <!-- --> # 文档包含社区版时需补全该注释(<!-- -->),只包含企业版时只保留注释尾(-->) - nav: