Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

hide cloud docs in 3.2.0 #2029

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs-2.0/2.quick-start/3.1add-storage-hosts.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,16 @@

首次连接到 Nebula Graph 后,需要先添加 Storage 主机,并确认主机都处于在线状态。

!!! compatibility
<!--
!!! compatibility "历史版本兼容性"

- 从 Nebula Graph 3.0.0 版本开始,必须先使用`ADD HOSTS`添加主机,才能正常通过 Storage 服务读写数据。
- 在 Nebula Graph 3.0.0 之前的版本和 Nebula Graph Cloud 中,无需执行该操作。
-->

!!! compatibility "历史版本兼容性"

从 Nebula Graph 3.0.0 版本开始,必须先使用`ADD HOSTS`添加主机,才能正常通过 Storage 服务读写数据。

## 前提条件

Expand Down
6 changes: 3 additions & 3 deletions docs-2.0/20.appendix/learning-path.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,16 +159,16 @@
| [系统建模](https://docs.nebula-graph.com.cn/{{nebula.release}}/8.service-tuning/3.system-design/) |-|
| [Compaction 策略](https://docs.nebula-graph.com.cn/{{nebula.release}}/8.service-tuning/compaction/) |-|



### 3.7 周边工具

<!--
- 云

|Cloud 版本|文档|视频|
|---------|---------|--------|
|Azure 版|[Nebula Graph Cloud Azure云版](https://docs.nebula-graph.com.cn/2.6.2/nebula-cloud/1.what-is-cloud/)|-|
|Azure 版|[Nebula Graph Cloud Azure云版](https://docs.nebula-graph.com.cn/3.1.0/nebula-cloud/1.what-is-cloud/)|-|
|阿里云版|[Nebula Graph Cloud 阿里云版](https://docs.nebula-graph.com.cn/{{aliyunLatestRelease}}/nebula-cloud/nebula-cloud-on-alibabacloud/1.create-service-instance/)|[Nebula Graph Cloud 阿里云版介绍](https://www.bilibili.com/video/BV1BY411K7QJ)|
-->

- 可视化

Expand Down
4 changes: 2 additions & 2 deletions docs-2.0/4.deployment-and-installation/5.zone.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ Nebula Graph 提供 Zone 功能,可以管理集群中的 Storage 节点,实

## 背景信息

!!! compatibility
!!! compatibility "历史版本兼容性"

从 3.0.0 版本开始,在配置文件中添加的 Storage 节点无法直接读写,配置文件的作用仅仅是将 Storage 节点注册至 Meta 服务中。必须使用`ADD HOSTS`命令后,才能正常读写 Storage 节点。Nebula Graph Cloud 上的集群会自动完成该操作,不需要用户手动执行命令。
从 3.0.0 版本开始,在配置文件中添加的 Storage 节点无法直接读写,配置文件的作用仅仅是将 Storage 节点注册至 Meta 服务中。必须使用`ADD HOSTS`命令后,才能正常读写 Storage 节点。<!-- Nebula Graph Cloud 上的集群会自动完成该操作,不需要用户手动执行命令。 -->

用户可以将 Storage 节点加入某个 Zone 中,创建图空间时指定 Zone,就会在 Zone 内的 Storage 节点上创建及存储图空间。分片及其副本会均匀存储在各个 Zone 中。如下图所示。

Expand Down
2 changes: 2 additions & 0 deletions docs-2.0/4.deployment-and-installation/manage-storage-host.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@

从 3.0.0 版本开始,在配置文件中添加的 Storage 主机无法直接读写,配置文件的作用仅仅是将 Storage 主机注册至 Meta 服务中。必须使用`ADD HOSTS`命令后,才能正常读写 Storage 主机。

<!--
!!! note

Nebula Graph Cloud 上建立的集群会自动添加 Storage 主机,用户无需手动执行`ADD HOSTS`。
-->

## 增加 Storage 主机

Expand Down
12 changes: 10 additions & 2 deletions docs-2.0/nebula-cloud/1.what-is-cloud.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,28 @@
# 什么是 Nebula Graph Cloud

Nebula Graph Cloud(简称 Cloud )是一套集成了 Nebula Graph 数据库和数据服务的云上服务,支持一键部署 Nebula Graph 和相关可视化产品。用户可以在几分钟内创建一个图数据库,并快速扩展计算、存储等资源。
Nebula Graph Cloud(简称 Cloud)是一套集成了 Nebula Graph 数据库和数据服务的云上服务,支持一键部署 Nebula Graph 和相关可视化产品。用户可以在几分钟内创建一个图数据库,并快速扩展计算、存储等资源。

<!--
Nebula Graph Cloud 支持:

- 基于 Azure 的全托管云服务,即 [Nebula Graph Cloud Azure 版](https://docs.nebula-graph.com.cn/{{cloud.azureRelease}}/nebula-cloud/1.what-is-cloud/) 。
- 基于阿里云的半托管云服务,即 [Nebula Graph Cloud 阿里云版](nebula-cloud-on-alibabacloud/1.create-service-instance.md)。
- 基于阿里云的自管云服务,即 [Nebula Graph Cloud 阿里云版](nebula-cloud-on-alibabacloud/1.create-service-instance.md)。
-->

Nebula Graph Cloud 支持基于阿里云的自管云服务,因此又名 [Nebula Graph Cloud 阿里云版](nebula-cloud-on-alibabacloud/1.create-service-instance.md)。

## 内核版本

Cloud 支持的最新 Nebula Graph 内核版本为 {{cloud.aliyunRelease}}。

<!--
Cloud 支持的最新 Nebula Graph 内核版本如下:

| Cloud 版本 | 内核版本 |
|-|-|
| Azure 版 | {{cloud.azureRelease}} |
| 阿里云版 | {{cloud.aliyunRelease}} |
-->

## 产品功能

Expand Down
2 changes: 1 addition & 1 deletion docs-2.0/nebula-console.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Nebula Console 的获取方式如下:
| 参数 | 说明 |
| - | - |
| `-h/-help` | 显示帮助菜单。 |
| `-addr/-address` | 设置要连接的 Graph 服务的 IP 地址。默认地址为 127.0.0.1。如果 Nebula Graph 部署在 [Nebula Cloud](https://docs.nebula-graph.com.cn/2.6.2/nebula-cloud/1.what-is-cloud/) 上,需要创建 [Private Link](https://docs.nebula-graph.com.cn/2.6.2/nebula-cloud/5.solution/5.2.connection-configuration-and-use),并设置该参数的值为专用终结点的 IP 地址。 |
| `-addr/-address` | 设置要连接的 Graph 服务的 IP 地址。默认地址为 127.0.0.1。<!--如果 Nebula Graph 部署在 [Nebula Cloud](https://docs.nebula-graph.com.cn/{{cloud.azureLatestRelease}}/nebula-cloud/1.what-is-cloud/) 上,需要创建 [Private Link](https://docs.nebula-graph.com.cn/{{cloud.azureLatestRelease}}/nebula-cloud/nebula-cloud-on-azure/5.solution/5.2.connection-configuration-and-use),并设置该参数的值为专用终结点的 IP 地址。--> |
| `-P/-port` | 设置要连接的 Graph 服务的端口。默认端口为 9669。|
| `-u/-user` | 设置 Nebula Graph 账号的用户名。未启用身份认证时,可以使用任意已存在的用户名(默认为`root`)。 |
| `-p/-password` | 设置用户名对应的密码。未启用身份认证时,密码可以填写任意字符。 |
Expand Down
3 changes: 3 additions & 0 deletions docs-2.0/nebula-studio/about-studio/st-ug-limitations.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ Studio 上传数据仅支持上传无表头的 CSV 文件,但是,单个文
- `USE <space_name>`:只能在 **Space** 下拉列表中选择图空间,不能运行这个语句选择图空间。
- **控制台** 上使用 nGQL 语句时,用户可以直接回车换行,不能使用换行符。

<!--
使用云服务版 Studio 时,除以上限制外,用户也不能在 **控制台** 上执行用户管理和角色管理相关的语句,包括:

- `CREATE USER`
Expand All @@ -46,6 +47,8 @@ Studio 上传数据仅支持上传无表头的 CSV 文件,但是,单个文
- `GRANT ROLE`
- `REVOKE ROLE`

-->

关于语句的详细信息,参考[用户管理](../../7.data-security/1.authentication/2.management-user.md "点击前往用户管理")。

## 浏览器支持
Expand Down
2 changes: 1 addition & 1 deletion docs-2.0/reuse/source_connect-to-nebula-graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Nebula Graph 支持多种类型的客户端,包括命令行客户端、可视
| 参数 | 说明 |
| - | - |
| `-h/-help` | 显示帮助菜单。 |
| `-addr/-address` | 设置要连接的 Graph 服务的 IP 地址。默认地址为 127.0.0.1。如果 Nebula Graph 部署在 [Nebula Cloud](https://docs.nebula-graph.com.cn/2.6.2/nebula-cloud/1.what-is-cloud/) 上,需要创建 [Private Link](https://docs.nebula-graph.com.cn/2.6.2/nebula-cloud/5.solution/5.2.connection-configuration-and-use),并设置该参数的值为专用终结点的 IP 地址。 |
| `-addr/-address` | 设置要连接的 Graph 服务的 IP 地址。默认地址为 127.0.0.1。<!-- 如果 Nebula Graph 部署在 [Nebula Cloud](https://docs.nebula-graph.com.cn/2.6.2/nebula-cloud/1.what-is-cloud/) 上,需要创建 [Private Link](https://docs.nebula-graph.com.cn/2.6.2/nebula-cloud/5.solution/5.2.connection-configuration-and-use),并设置该参数的值为专用终结点的 IP 地址。 -->|
| `-P/-port` | 设置要连接的 Graph 服务的端口。默认端口为 9669。|
| `-u/-user` | 设置 Nebula Graph 账号的用户名。未启用身份认证时,可以使用任意已存在的用户名(默认为`root`)。 |
| `-p/-password` | 设置用户名对应的密码。未启用身份认证时,密码可以填写任意字符。 |
Expand Down
13 changes: 7 additions & 6 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ plugins:
- nebula-flink/*
- CHANGELOG.md
- nebula-cloud/*
- nebula-cloud.md
- spark-connector/*
- 4.deployment-and-installation/5.zone.md
- 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-200-to-latest.md
Expand All @@ -94,7 +95,7 @@ plugins:
# regex:
# - '.*\.(tmp|bin|tar)$'

# modify when release:
# modify when release:
- with-pdf:
copyright: 2022 vesoft Inc.
cover_subtitle: v3.2.0
Expand All @@ -105,14 +106,14 @@ plugins:
output_path: pdf/NebulaGraph-CN.pdf

extra_javascript:
- js/version-select.js
- js/version-select.js
- js/config.js
- js/jquery.js
- js/init.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

# modify when release:
# modify when release:
extra:
# Language selector.
alternate:
Expand Down Expand Up @@ -492,21 +493,21 @@ nav:
- Nebula Python: 14.client/5.nebula-python-client.md
- Nebula Go: 14.client/6.nebula-go-client.md

- Nebula Graph Cloud: nebula-cloud.md
# - Nebula Graph Cloud: nebula-cloud.md


# - 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
# - 配置 Solution: nebula-cloud/nebula-cloud-on-azure/3.how-to-set-solution.md
# - Cloud Solution 角色身份说明: nebula-cloud/nebula-cloud-on-azure/4.user-role-description.md
# - Solution 操作:
# - Solution: nebula-cloud/nebula-cloud-on-azure/5.solution/5.0.introduce-solution.md
# - 配套的应用(Dashboard/Studio/Explorer): nebula-cloud/nebula-cloud-on-azure/5.solution/5.1.supporting-application.md
# - Private Link: nebula-cloud/nebula-cloud-on-azure/5.solution/5.2.connection-configuration-and-use.md
# - 管理角色权限: nebula-cloud/nebula-cloud-on-azure/5.solution/5.3.role-and-authority-management.md
# - 价格: nebula-cloud/nebula-cloud-on-azure/6.pricing.md
## - 价格: 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 阿里云版:
Expand Down