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

add cloud #1282

Merged
merged 37 commits into from
Jan 7, 2022
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
5f66fdd
[WIP]add cloud
foesa-yang Dec 1, 2021
e03f521
update-1209
foesa-yang Dec 9, 2021
1a2ed60
update-1210
foesa-yang Dec 10, 2021
bf874da
update-1215
foesa-yang Dec 15, 2021
ccea450
update-1216
foesa-yang Dec 16, 2021
340e37b
update_1221
foesa-yang Dec 21, 2021
66e5446
update-1222
foesa-yang Dec 22, 2021
3f6763e
update
foesa-yang Dec 22, 2021
f8acd9c
update
foesa-yang Dec 22, 2021
8935e87
update-1223
foesa-yang Dec 23, 2021
8cf1182
update-1228
foesa-yang Dec 28, 2021
da1a31e
Update docs-2.0/nebula-cloud/5.solution/5.3.role-and-authority-manage…
foesa-yang Dec 28, 2021
f8866da
Update docs-2.0/nebula-cloud/8.privacy-policy.md
foesa-yang Dec 28, 2021
d6bc595
Update 7.terms-and-conditions.md
foesa-yang Dec 28, 2021
efe42d1
Update 1.what-is-cloud.md
foesa-yang Dec 28, 2021
9f2083f
Update 3.how-to-set-solution.md
foesa-yang Dec 28, 2021
4509363
update
foesa-yang Dec 28, 2021
1f77d01
Merge branch 'add-cloud' of https://github.com/foesa-yang/nebula-docs…
foesa-yang Dec 28, 2021
9b0afd6
Update 1.what-is-cloud.md
foesa-yang Dec 28, 2021
81a4b21
update-1228
foesa-yang Dec 28, 2021
498bf74
Merge branch 'add-cloud' of https://github.com/foesa-yang/nebula-docs…
foesa-yang Dec 28, 2021
3d17bb2
Update 5.0.introduce-solution.md
foesa-yang Dec 28, 2021
9993eae
Update 5.0.introduce-solution.md
foesa-yang Dec 28, 2021
9f7710f
Update 1.what-is-cloud.md
izhuxiaoqing Dec 29, 2021
cd3b1e6
Update 2.how-to-create-subsciption.md
izhuxiaoqing Dec 29, 2021
c4a6074
Update 3.how-to-set-solution.md
foesa-yang Dec 29, 2021
2b283bc
Update 5.2.connection-configuration-and-use.md
foesa-yang Dec 29, 2021
2e6538d
Update docs-2.0/nebula-cloud/5.solution/5.0.introduce-solution.md
foesa-yang Dec 29, 2021
17e8629
Update 5.3.role-and-authority-management.md
foesa-yang Dec 29, 2021
6b41dff
Update 1.what-is-cloud.md
foesa-yang Dec 30, 2021
b81fc4e
Update 4.user-role-description.md
izhuxiaoqing Dec 30, 2021
c8a77c6
Update mkdocs.yml
foesa-yang Dec 30, 2021
fc7466f
update
foesa-yang Dec 31, 2021
0321fdf
update-0104
foesa-yang Jan 4, 2022
615900c
update
foesa-yang Jan 4, 2022
e7d9109
Update 5.2.connection-configuration-and-use.md
foesa-yang Jan 4, 2022
526fa56
Merge branch 'master' into add-cloud
foesa-yang Jan 7, 2022
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
21 changes: 21 additions & 0 deletions docs-2.0/nebula-cloud/1.what-is-cloud.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# 什么是 Nebula Graph Cloud

Nebula Graph Cloud(简称Cloud)是一款支持 [Azure](https://azure.microsoft.com/zh-cn/) 平台,在云上搭建 Nebula Graph 数据库的产品,支持一键部署 Nebula Graph。用户可以在几分钟内创建一个图数据库,并快速扩展计算、存储等资源。
foesa-yang marked this conversation as resolved.
Show resolved Hide resolved

## 使用场景

使用 Azure 云上资源,快速订阅 Nebula Graph 服务,并部署 Nebula Graph 数据库至云上,支持使用可视化周边工具、管理用户权限等功能。
foesa-yang marked this conversation as resolved.
Show resolved Hide resolved

## 产品功能

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

## 产品优点

- 灵活与弹性:Cloud 最大的优势在于弹性与灵活性,无需自购软硬件即可快速(5-10分钟)搭建 Nebula Graph 数据库。
foesa-yang marked this conversation as resolved.
Show resolved Hide resolved
- 高可用性:Cloud 上创建的 Nebula Graph 集群采用 Raft 协议,结合云厂商提供的同城多机房实现数据冗余备份,保证云计算基础框架的高可用性、数据的可靠性以及云服务器的高可用性。
- 操作易用:Cloud 提供 Web 页面对 Nebula Graph 集群进行在线管理,同时提供配套的可视化软件,降低用户使用门槛,快速上手。
12 changes: 12 additions & 0 deletions docs-2.0/nebula-cloud/2.how-to-create-subsciption.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# 创建订阅

在使用 Cloud 之前,用户需要在 Azure 上创建订阅,本文介绍如何在 Azure Marketplace 上创建订阅。

## 购买流程

1. 登录[Azure官网](https://portal.azure.com/#home),然后进入[Nebula Cloud购买页面]()。
foesa-yang marked this conversation as resolved.
Show resolved Hide resolved


## 后续操作

购买完成后,用户需要创建并配置Solution。详细信息,参考[如何配置Solution](../nebula-nebula-cloud/3.how-to-set-solution.md)。
38 changes: 38 additions & 0 deletions docs-2.0/nebula-cloud/3.how-to-set-solution.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# 配置实例

Solution 指运行在 Nebula Graph Cloud 上的 Nebula Graph 数据库。本文介绍如何在 Cloud 上创建配置 Solution。

## 配置流程

1.
foesa-yang marked this conversation as resolved.
Show resolved Hide resolved
## Solution 状态

用户可能会在 Solution 页面上看到如下表描述的状态。

|状态| 状态说明 |
|:---|:---|
| pending | 提交创建 Solution 申请后,进入任务调度阶段,此时 Solution 短暂处于 pending 状态。 |
| creating | Solution 所需资源已经准备完毕,Solution 自动开始创建,此时 Solution 短暂处于 creating 状态,可能持续几分钟到十几分钟。|
| starting | 重新启动 Solution,此时 Solution 短暂处于 starting 状态。 |
| stopping | 用户点击停止 Solution 后,此时 Solution 短暂处于 stopping 状态。 |
| deleting | 用户点击删除 Solution 后,此时 Solution 短暂处于 deleting 状态。 |
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

删除solution这里是在azure上面停止订阅还是在cloud上面删除? @hetao92

| running | Solution 创建成功后,会长时间稳定地处于 running 状态。 |
| stopped | 停止 Solution 后,会长时间稳定地处于 stopped 状态。 |
| deleted | 删除 Solution 后,会长时间稳定地处于 deleted 状态。 |
| create_failed | Solution 创建失败后,会长时间稳定地处于 create_failed 状态。 |
| stop_failed | Solution 停止失败后,会长时间稳定地处于 stop_failed 状态。 |
| start_failed | Solution 开始失败后,会长时间稳定地处于 start_failed 状态。 |
foesa-yang marked this conversation as resolved.
Show resolved Hide resolved


!!! caution

如果 Solution 长时间处于某个中间状态,刷新页面后仍未改变,说明出现异常,用户需要提交工单处理。

!!! caution

如果 Solution 处于 create_failed、stop_failed、start_failed 态,用户可以重新执行 `创建、停止、开始` 的操作。

## Solution Info页面介绍

在 Cloud 的首页点击 Solution 名字进入指定的 Solution Info 页面。Solution Info 页面由以下几个部分组成:Basic Info、Instance Info、Price Info、Getting Started。

44 changes: 44 additions & 0 deletions docs-2.0/nebula-cloud/4.user-role-description.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Cloud Solution 角色身份说明

在创建 Solution 之后,用户需要明确 Cloud 中角色身份的权限,本文介绍Cloud Solution 角色身份说明。

## 内置角色

Nebula Cloud 中内置了多种角色,说明如下:

- OWNER
- 资源管理员,对应服务订阅的创建者,具有订阅及资源管理权限。
- 配置 `Solution`,确定及创建服务、激活订阅。
- 管理服务,可以启动或停止 `Solution` 的服务。
- 管理数据库中 `ROOT` 权限的用户,手动授权 `ROOT` 用户。
- 管理数据库私有链接,可以通过私有链接访问云上数据库。
- 查看资源记录。
- 连接可视化工具 Dashboard,可以查看指定 Solution 的结点监控和服务监控。
foesa-yang marked this conversation as resolved.
Show resolved Hide resolved

- ROOT
- 对应 Nebula Graph 数据库的 God 权限角色,由资源管理员设置。God 角色的执行权限,详情可见[内置角色权限](../7.data-security/1.authentication/3.role-list.md)。
- 管理 Cloud 中的不同 space 下的 `USER` 级别的用户,授权 `USER` 级别用户时,需要指定 Nebula Graph 数据库的操作权限,包括`ADMIN、DBA、GUEST、USER`,详情可见[内置角色权限](../7.data-security/1.authentication/3.role-list.md)。
- 业务直连访问管理,通过私有链接访问云上数据库。
- 连接可视化工具 Dashboard、Studio、Explorer。

- USER
- 使用数据的用户,由 Cloud 中 `ROOT` 用户通过权限管理添加邀请的 Azure 平台用户。
foesa-yang marked this conversation as resolved.
Show resolved Hide resolved
- 对应 Nebula Graph 数据库的 `ADMIN`、`DBA`、`GUES` 或 `USER` 权限角色。
foesa-yang marked this conversation as resolved.
Show resolved Hide resolved
- 业务直连访问管理,通过私有链接访问云上数据库。
- 连接可视化工具 Studio、Explorer。

## Solutions 页面的权限

在 Solution 页面中,不同的角色将会看到不同的侧边栏,下表描述了不同角色及相应的权限。其中,第一列角色所能访问的页面,Y 表示拥有权限,N 表示没有权限。
foesa-yang marked this conversation as resolved.
Show resolved Hide resolved

|页面|OWNER|ROOT|USER|
|:---|:---|:---|:---|
|Solution Info|Y|Y|Y|
|Applications|Y|Y|Y|
|Connectivity|Y|N|N|
|Root Management|Y|N|N|
|User Management|N|Y|N|
|Audit Log|Y|N|N|
|Settings|Y|N|N|
|Subscribe Settings|Y|N|N|
|Billing|Y|N|N|
23 changes: 23 additions & 0 deletions docs-2.0/nebula-cloud/5.solution/5.1.supporting-application.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# 配套的应用(Dashboard/Studio/Explorer)

Nebula Graph Cloud 集成了可视化图数据库管理工具 Nebula Graph Studio、可视化数据库监控工具 Nebula Dashboard、可视化图探索工具 Nebula Explorer。

不同的用户角色将会使在 **Applications** 页面看到不同的周边工具,下表描述了不同角色及相应的权限。其中,第一列表示角色所能使用的周边工具,Y 表示拥有权限,N 表示没有权限。

|周边工具|OWNER|ROOT|USER|
|:---|:---|:---|:---|
|Dashboard|Y|Y|N|
|Studio|N|Y|Y|
|Explorer|N|Y|Y|

## Dashboard

Dashboard 是一款用于监控和管理 Nebula Graph 多集群中机器和服务状态的可视化工具。目前 Dashboard 仅支持查看 [集群监控](../../nebula-dashboard-ent/4.cluster-operator/2.monitor.md) 页面。

## Studio

Studio 是一款可以通过 Web 访问的图数据库开源可视化工具,搭配 Nebula Graph 内核使用,提供构图、数据导入、编写 nGQL 查询、图探索等一站式服务。使用说明及详情信息,可查看 [什么是 Nebula Graph Studio](../../nebula-studio/about-studio/st-ug-what-is-graph-studio.md)。

## Explorer

Explore 是一款可以通过 Web 访问的图探索可视化工具,搭配 Nebula Graph 内核使用,用于与图数据进行可视化交互。即使没有图数据操作经验,用户也可以快速成为图专家。使用说明及详情信息,可查看 [什么是 Nebula Graph Explorer](../../nebula-explorer/about-explorer/ex-ug-what-is-explorer.md)。
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# Private Link

Solution 可在 Connectivity 中设置 Private Link 让用户能够通过虚拟网络中的专用节点访问 Nebula Graph 数据库,并且网络流量不会进入公共互联网。

## 如何配置Private Link
foesa-yang marked this conversation as resolved.
Show resolved Hide resolved

1. 输入订阅 ID 后点击 **创建** 服务,创建时间大约需要2分钟。

!!! note

订阅 ID 在 Azure Portal 的 **订阅** 页面中查看。用户可以点击 [Subscriptions](https://portal.azure.com/?l=en.en-us#blade/Microsoft_Azure_Billing/SubscriptionsBlade) 页面快速访问。

2. 创建成功后用户可使用 **别名** 连接到 Azure 资源,在 Azure 中创建专用终结点。

1. 在 Azure 首页的搜索框内输入 `专用链接中心` 后,选择左侧目录栏中的 `专用终结点`。
foesa-yang marked this conversation as resolved.
Show resolved Hide resolved
2. 选择`+ 创建`。
3. 在 **创建专用链接服务** 的 `基本` 选项卡中,输入或选择以下信息:
foesa-yang marked this conversation as resolved.
Show resolved Hide resolved

|设置项|预设值|
|:---|:---|
|**项目详细信息**||
|订阅|选择用户的订阅。|
|资源组|选择用户已有的资源组或新建一个资源组。|
|**实例详情信息**||
|名称|输入用户专用终结点的名字。|
|区域|选择区域。|
foesa-yang marked this conversation as resolved.
Show resolved Hide resolved

!!! caution

为避免性能和速度问题,选择的区域尽量与业务区域在同一区域。

4. 在页面的下方,选择 `下一步:资源` 的按钮。
5. 在 `资源` 选项卡中,输入或选择以下信息:

|设置项|预设值|
|:---|:---|
|连接方法|选择`按资源 ID 或别名连接到 Azure 资源`。|
|资源ID或别名|输入别名。|
|请求消息|输入此消息将发送给资源所有者。|

!!! note

别名在 Nebula Graph Cloud 的 Connectivity 页面中,点击 ![copy](../figs/copy.png) 可一键复制。

6. 在页面的下方,选择 `下一步:配置` 的按钮。
7. 在 `配置` 选项卡中,选择以下信息:

|设置项|预设值|
|:---|:---|
|虚拟网络|选择已创建好的虚拟网络。|
|子网|选择前选定的虚拟网络中的子网。|

!!! note

目前不支持与专用 DNS 集成。

8. 在页面的下方,选择 `下一步:标记` 的按钮。
9. (可选)在 `标记` 选项卡中,输入`名称/值对`。
10. 在页面的下方,选择 `下一步:查看 + 创建` 的按钮。
11. 选择`创建`按钮。

3. 创建好`专用终结点`后,复制`专用 IP` 并写入 Cloud 的 Connectivity 页面,点击`创建`。

!!! note

在 Cloud 中仅存储 Private Link Endpoint IP 信息,用户可以随时点击 ![edit](../figs/edit.png) 进行修改。

## 如何使用Private Link连接Nebula Graph

Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# 角色与权限管理
foesa-yang marked this conversation as resolved.
Show resolved Hide resolved

Empty file.
Empty file.
Empty file.
Binary file added docs-2.0/nebula-cloud/figs/copy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-2.0/nebula-cloud/figs/edit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.