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

Create docs for Cloud on Alibaba #1848

Merged
merged 5 commits into from
Jun 2, 2022
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
20 changes: 17 additions & 3 deletions docs-2.0/nebula-cloud/1.what-is-cloud.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,26 @@
# 什么是 Nebula Graph Cloud

Nebula Graph Cloud(简称 Cloud )是一款支持 [Azure](https://azure.microsoft.com/zh-cn/) 平台,在云上搭建 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)。

## 内核版本

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

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

## 产品功能

- 即买即用。用户可以根据自己的业务发展随时创建或停止 Nebula Graph 实例,业务提供充分的灵活性。
- 集成可视化图数据库管理工具 Nebula Studio、Nebula Dashboard、Nebula Explorer。可以使用它们导入图数据集、执行 nGQL 语句查询、探索图数据、监控数据等。即使没有图数据库操作经验,也可以快速成为图专家。详情参见 [配套的应用](../nebula-cloud/5.solution/5.1.supporting-application.md)。
- 创建私有链接。用户可直接使用 Nebula Console 连接到云上数据库,而不需要先访问云平台。详情参见 [Private Link](../nebula-cloud/5.solution/5.2.connection-configuration-and-use.md)
- 集成可视化图数据库管理工具 Nebula Studio、Nebula Dashboard、Nebula Explorer。可以使用它们导入图数据集、执行 nGQL 语句查询、探索图数据、监控数据等。即使没有图数据库操作经验,也可以快速成为图专家。
- 用户可直接使用 Nebula Console 等客户端连接到云上数据库,而不需要先访问云平台。
- 权限控制。用户可以为指定图空间增加不同角色权限的数据库用户,保证业务数据安全。
- 官方支持。用户可以快速创建工单,咨询使用过程中遇到的问题。

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
# 创建服务实例

在使用 Nebula Graph Cloud 阿里云版服务前,要先在阿里云控制台创建服务实例。

!!! caution

通过 Nebula Graph Cloud 阿里云版创建的 Nebula Graph、Nebula Dashboard 和 Nebula Explorer 都是企业版实例,许可证的默认有效期为 3 天,仅供试用。如需长期使用服务,发送邮件[申请正式许可证](mailto:inquiry@vesoft.com)。

## 前提条件

- 准备[阿里云账号](https://help.aliyun.com/document_detail/324606.html)。

- 如果使用 RAM 用户创建实例,需为其添加以下权限:

- AliyunECSFullAccess
- AliyunVPCFullAccess
- AliyunROSFullAccess
- AliyunCloudMonitorFullAccess
- AliyunComputeNestUserFullAccess

## 操作步骤

1. 登录[创建服务实例](https://computenest.console.aliyun.com/user/cn-hangzhou/serviceInstanceCreate?ServiceId=service-9a6808fad8b143ae8eed&ServiceVersion=3)页面。

2. 选中**同意授权并创建关联角色**。

![选中 同意授权并创建关联角色](https://docs-cdn.nebula-graph.com.cn/figures/authorize-compute-nest_cn_2022.05.30.png)

3. 选择要创建实例的**地域**。

4. 进行**基本信息配置**。

1. 选择 **NebulaGraph版本**。默认为 **3.1.0**。
当前仅能选择 **3.1.0**。

2. 设置 **NebulaGraph集群名**。默认为`nebula`。

3. 设置实例密码。

- 密码长度为 8-30 个字符。
- 密码中必须包含大写字母、小写字母、数字、特殊符号中的三种。
- 特殊符号包括:()`~!@#$%^&*_-+=|{}[]:;'<>,.?/

5. 进行**付费模式设置**,指定 ECS 服务器的付费方式。默认为**按量付费**。

- **按量付费**:按照计费周期计费,在每个结算周期生成账单并从账户中扣除相应费用。详情参见[按量付费](https://help.aliyun.com/document_detail/40653.html)。

- **预付费,包年包月**:先付费后使用。详情参见[包年包月](https://help.aliyun.com/document_detail/56220.html)。

选择包年包月模式需要指定**购买时长周期**和**购买时长**。**购买时长周期**当前仅支持 **Month**,即按月购买,**购买时间**选择范围为 1-60 月。

6. 进行**基础设施配置**。

1. 选择**专有网络VPC实例ID**。

如果下拉列表为空,先单击其右侧的**新建专有网络**,完成专有网络创建。

2. 选择**交换机可用区**。

3. 选择**业务网络交换机的实例ID**。

如果下拉列表为空,先单击其右侧的**新建交换机**,完成交换机创建。

7. 进行**集群节点配置**,根据业务需求配置 Nebula Graph 内核服务的节点。

Nebula Graph 内核包含 Graph、Meta、Storage服务,因此需要为这些服务分别选择**节点数量**、**节点实例类型**、**数据盘类型**和**数据盘空间**。

!!! caution
建议按照页面推荐信息配置集群节点以提升服务的可用性,例如配置 3 个 Meta 节点和至少 3 个 Storage 节点。

8. 进行**可视化产品配置**,选择要部署的可视化产品。

可选用的产品包括 [Dashboard](../../nebula-dashboard-ent/1.what-is-dashboard-ent.md) 和 [Explorer](../../nebula-explorer/about-explorer/ex-ug-what-is-explorer.md),默认都处于**开启**状态,此时需要为其选择**实例类型**。选中**关闭**表示不部署相应产品。

9. 根据需要配置**标签和资源组**。详情参见[什么是资源管理](https://help.aliyun.com/document_detail/94475.html)。

10. 完成**权限确认**,并选中**我同意授权服务商(欧若数网)获取上述权限以提供代运维服务**。

11. 在页面底部,选中**我已阅读并同意《计算巢服务协议》**,并单击**创建**。

12. 在**创建**对话框,完成**信息确认**并**支付费用**。

13. 在**提交成功**页面,单击去列表查看。

14. 在实例列表中查看目标实例的**状态**,确保状态为**部署中**。

部署的平均耗时为 10 分钟。完成后实例的状态变为**已部署**。

## 常见问题

Q:服务实例的状态显示为**部署失败**怎么处理?

1. 如果使用 RAM 账号创建的实例,确认为该账号授予了本文前提条件中指定的权限。
2. 如果权限符合要求,[删除](https://help.aliyun.com/document_detail/290837.html)创建失败的实例,尝试重新创建。
3. 如果仍然创建失败,到 [Nebula Graph 论坛](https://discuss.nebula-graph.com.cn/)寻求帮助。
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# 使用服务实例

创建好服务实例后,即可查看服务信息,并开始使用 Nebula Graph 服务。

## 查看服务实例

在计算巢控制台可以查看服务实例的详细信息,详情参见[查看服务实例](https://help.aliyun.com/document_detail/290838.html)。

## 查看连接地址

连接服务前,需要在阿里云计算巢的实例详情中查看各服务的连接地址。查看方式如下:

1. 登录[服务实例管理](https://computenest.console.aliyun.com/user/cn-hangzhou/serviceInstance/private)页面。

2. 在实例列表中,单击目标实例的**服务实例ID**,或其右侧**操作**列的**详情**。

3. 在**概览**页的**基本信息**区域,可以查看 Graph 服务、Meta 服务、Storage 服务,以及 Explorer 和 Dashboard 的连接地址。

常用的连接地址有:

- **graph_private_ip** 与 **graph_public_ip**,即 Graph 服务的私网与公网 IP 地址,可用于连接 Nebula Graph。

- **explorer_portal**,即 Nebula Explorer 的连接地址,单击地址即可在浏览器中打开 Nebula Explorer。

- **dashboard_portal**,即 Nebula Dashboard 的连接地址,单击地址即可在浏览器中打开 Nebula Dashboard。

## 连接 Nebula Graph

Nebula Graph Cloud 阿里云版提供多种连接方式。

### 使用客户端直连 Nebula Graph

获取到连接地址后,即可使用 Nebula Graph 的各类客户端连接服务。

连接方式:

直连 **graph_private_ip** 或 **graph_public_ip** 地址。详细连接方式参见[客户端文档]((https://docs.nebula-graph.com.cn/{{nebula.release}}/14.client/1.nebula-client/))。

### 使用 Explorer 连接 Nebula Graph

使用图探索工具可以快速连接 Nebula Graph,与图数据进行可视化交互。

连接方式:

1. 在浏览器中使用 **explorer_portal** 地址打开 Nebula Explorer。
2. 使用 Explorer 连接 Nebula Graph。详情参见[连接数据库](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-explorer/deploy-connect/ex-ug-connect/)。

## 监控 Nebula Graph

在 Nebula Graph Cloud 阿里云版中部署 Dashboard 后,可以使用 Dashboard 实时监控 Nebula Graph 服务的状态。详情参见 [Dashboard 文档](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-dashboard-ent/1.what-is-dashboard-ent/)。
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# 删除服务实例

如果不再需要某个实例,可手动删除该实例。

删除方式参见[删除服务实例](https://help.aliyun.com/document_detail/290837.html)。
41 changes: 25 additions & 16 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,8 @@ 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/*
- nebula-cloud.md
# - nebula-cloud/*
# Exclude the file with the following file name.
# - abc.md
# Exclude files with regular expressions (regexes)
Expand Down Expand Up @@ -212,6 +213,9 @@ extra:
release: 3.1.2
branch: release-3.1
tag: v3.1.2
cloud:
azureRelease: 2.6.2 # Azure云兼容的最新内核版本
aliyunRelease: 3.1.0 # 阿里云兼容的最新内核版本


nav:
Expand Down Expand Up @@ -463,21 +467,26 @@ 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 Graph Cloud: nebula-cloud/1.what-is-cloud.md
# - 创建订阅: nebula-cloud/2.how-to-create-subsciption.md
# - 配置Solution: nebula-cloud/3.how-to-set-solution.md
# - Cloud Solution 角色身份说明: nebula-cloud/4.user-role-description.md
# - Solution 操作:
# - Solution: nebula-cloud/5.solution/5.0.introduce-solution.md
# - 配套的应用(Dashboard/Studio/Explorer): nebula-cloud/5.solution/5.1.supporting-application.md
# - Private Link: nebula-cloud/5.solution/5.2.connection-configuration-and-use.md
# - 管理角色权限: nebula-cloud/5.solution/5.3.role-and-authority-management.md
# - 价格: nebula-cloud/6.pricing.md
# - 用户服务条款: nebula-cloud/7.terms-and-conditions.md
# - 隐私政策条款: nebula-cloud/8.privacy-policy.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
# - 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/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 Studio:
- Studio 版本更新说明: nebula-studio/about-studio/st-ug-release-note.md
Expand Down