Skip to content

Commit

Permalink
Merge 3.1.0 into master (#1924)
Browse files Browse the repository at this point in the history
* publish 3.1.0 (#1707)

* Update deploy.yaml

* customize color

* nebula macro changes for 310 (#1708)

* add one more note (#1709)

* add limits for using Operator (#1710)

* Update mkdocs.yml (#1711)

* Update mkdocs.yml (#1714)

* merge algorithm table (#1716)

* Update nebula-algorithm.md

* Fix in-topic links (#1719)

* Update 4.manage.md (#1715)

* Update mkdocs.yml (#1718)

* Update 0.FAQ.md (#1720)

* Update 1.create-native-index.md (#1721)

* Update 1.create-native-index.md (#1722)

* change theme color to red (#1723)

* Update 1.get-subgraph.md (#1725)

* Update extra.css (#1724)

* Update 2.find-path.md

* Update 1.explain-and-profile.md

* Update mkdocs.yml

* Update mkdocs.yml

* Update 2.data-model.md

* Update 2.match.md

* Update deploy.yaml

* Update pkglist.txt

* Update pkglist.txt

* Update requirements.txt

* Update mkdocs.yml

* Update use-importer.md

* fix release version

* Update source_manage-service.md

* Update 1.configurations.md

* Update 1.configurations.md

* Update 3.graph-config.md

* Update 4.storage-config.md

* update release

* Update mkdocs.yml (#1729)

* Update 2.compile-br.md

* rename url and modify format (#1728)

* rename url and modify format

* fix conflict and modify format

* Update replication-between-clusters.md

* Update 2.deploy-connect-dashboard-ent.md (#1731)

* Update 2.deploy-connect-dashboard-ent.md

* Update 2.deploy-connect-dashboard-ent.md

* switch sync data (#1732)

* modify error description (#1733)

* fix version

* mike set-default 3.1.0 (#1726)

* Update practice.md

* fix gateway

* macro error fix for operator 1.1.0 (#1734)

* macro error fix for operator 1.1.0

* macro changed to tag

* macro release changed to tag

* release-notes.md

* macro fix (#1735)

* nebula.tag

* tags

* Update 6.eco-tool-version.md

* Update 6.eco-tool-version.md

* Update 4.delete-edge.md

* merge

* Update 4.delete-edge.md

* Update st-ug-deploy.md

* Update 6.clear-space.md (#1736)

* Rename releasenote.md to release-notes.md

* Update ex-ug-deploy.md (#1737)

* Update 3.deploy-nebula-graph-with-docker-compose.md

* Update audit-log.md

* modify release-notes link (#1738)

* Revert "modify release-notes link (#1738)" (#1739)

This reverts commit 89bd994.

* add note for dashboard Exposure (#1742)

* add note for dashboard Exposure

* Update 1.resource-preparations.md

* fix pdf admonition

* fix pdf admonition
with version select

* Create 6.deploy-nebula-graph-with-peripherals.md (#1747)

* Create 6.deploy-nebula-graph-with-peripherals.md

* Update 1.resource-preparations.md

* Update mkdocs.yml

* rollback version select

* unify release-note

* Update 0-2.relates.md (#1748)

* Update 0-2.relates.md

* Update 0-2.relates.md

* Update 10.geography.md (#1746)

* Update use-importer.md (#1745)

* Update 4.storage-service.md (#1744)

* OPT (#1741)

* Update 1.insert-edge.md (#1740)

* Update 1.resource-preparations.md

* Update 1.overview.md (#1713)

* Update 1.resource-preparations.md (#1717)

* Update 1.resource-preparations.md

* Update 1.resource-preparations.md

Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com>

* Update use-importer.md (#1751)

modify release note linked url

* comment out sed

* Update 1.resource-preparations.md

* result-changes-for-status-all-before-adding-hosts (#1756)

* systemd note available for nebula-ent created by dashboard (#1755)

* Update 18.show-queries.md (#1761)

* Update 17.show-sessions.md (#1760)

* Update 4.install-nebula-graph-from-tar.md (#1759)

* Update 14.geo.md (#1754)

* Update 4.show-create-space.md (#1758)

* Config changes for quick start (#1757)

* config-changes-for-quick-start

* Update 3.1add-storage-hosts.md

* Update 4.ldap.md (#1762)

* Update 6.list.md (#1767)

* Update 6.cheatsheet-for-ngql-command.md (#1763)

* Update 1.overview.md (#1764)

* Update 1.comparison.md (#1765)

* Update with.md (#1773)

* Update where.md (#1772)

* Update limit.md (#1771)

* Update ttl-options.md (#1770)

* Update return.md (#1769)

* Update order-by.md (#1768)

* Update 4.describe-space.md (#1774)

* update docker (#1766)

* Sub and superscripts display error fix (#1775)

* update explorer (#1777)

* Chinese search support test (#1778)

* rollback-Chinese search support test (#1779)

* Chinese search support test

* Revert " Chinese search support test"

This reverts commit a061ccd.

* Update st-ug-release-note.md (#1780)

* Update st-ug-release-note.md

* Update mkdocs.yml

* Update st-ug-release-note.md

* Update st-ug-deploy.md

* Update st-ug-deploy.md (#1781)

* Update 1.what-is-nebula-graph.md (#1786)

The writing here  is Inconsistent with that on the official website page.

* rename studio (#1787)

* fixed broken openkruise URLs (#1784)

* Update 2.deploy-dashboard.md (#1790)

* optimize explorer (#1789)

* optimize explorer

* Update ex-ug-query-exploration.md

* deploy nebula ent with operator (#1793)

* Update ex-ug-parameter.md (#1795)

Syntax parsing fails when containing ; and database name

* Update ex-ug-import-from-mysql.md (#1796)

Modify the SQL

* Update mkdocs.yml (#1782)

* Add http gateway (#1788)

* update-studio

* Update mkdocs.yml

* Update st-ug-deploy.md

* Update 3.nebula-cpp-client.md (#1792)

* Update 3.nebula-cpp-client.md

* Update 3.nebula-cpp-client.md

* Update 3.nebula-cpp-client.md

* Update 3.nebula-cpp-client.md

* Update docs-2.0/14.client/3.nebula-cpp-client.md

Co-authored-by: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com>

Co-authored-by: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com>

* Update 3.1create-cluster-with-kubectl.md (#1794)

* Update 3.2create-cluster-with-helm.md (#1791)

* Update 3.2create-cluster-with-helm.md

* Update 3.2create-cluster-with-helm.md

* Update st-ug-release-note.md (#1783)

* Update st-ug-release-note.md

* Update mkdocs.yml

* Update st-ug-release-note.md

* Update st-ug-deploy.md

* Update st-ug-release-note.md

* Update the way to keep THP disabled (#1798)

* optimize explorer (#1797)

* optimize explorer

* Update mkdocs.yml

* Update 12.query-visually.md

* Optimization for create space (#1785)

* Update 1.create-space.md

* Update 1.create-space.md

* Update 0512 (#1799)

* update-studio

* Merge branch 'v3.1.0' of https://github.com/vesoft-inc/nebula-docs-cn into v3.1.0

* Update 12.query-visually.md (#1800)

* Error code (#1801)

* update-studio

* update error code

* Add CLEAR SPACE in cheetsheet (#1815)

* Update nebula-analytics.md (#1812)

* Update nebula-analytics.md

* Update nebula-analytics.md

* Studio 3.3.2 (#1816)

* update-studio

* update studio v3.3.2

* Update st-ug-release-note.md

* Update 1.what-is-dashboard-ent.md (#1817)

* Update 0-2.relates.md (#1821)

Corrected typo "按快" to "按块"

* fix-google-analytics (#1824)

* Revert "fix-google-analytics (#1824)" (#1825)

This reverts commit a59c4c3.

* Fix ga (#1828)

* Revert "fix-google-analytics (#1824)"

This reverts commit a59c4c3.

* fix ga

* Update mkdocs.yml (#1832)

* Update 2.match.md (#1835)

* Update 4.storage-service.md (#1834)

Syntax problem, should be added”被“,then ”超过多个心跳仍无响应的副本会被认为发生故障“

* Add toString in type convertion function table (#1829)

* Add toString in type convertion function table

* Update 9.type-conversion.md

* Update 9.type-conversion.md

* fix google analytics (#1837)

* Update 2.match.md (#1839)

* Update 2.match.md

* updates

* Update docs-2.0/3.ngql-guide/7.general-query-statements/2.match.md

Co-authored-by: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com>

* Update 2.match.md

Co-authored-by: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com>

* Update 12.query-visually.md (#1841)

* Update 12.query-visually.md (#1842)

* field clause required for go and fetch statements (#1823)

* field clause required for go and fetch statements

* Update ngql-style-guide.md

* add dashboard community 1.1.1 (#1844)

* Create docs for Cloud on Alibaba (#1848)

* Create docs for Cloud on Alibaba

* update cloud intro

* Update 1.what-is-cloud.md

* add version support info

* Update 1.what-is-cloud.md

* metric updates (#1833)

* Added Java ORM in intro (#1852)

* Added Java ORM in intro

* Update 1.nebula-client.md

Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com>

* Fixed a wrong URL (#1851)

* Update creation link (#1862)

* Update metric description (#1870)

* Create docs for Cloud on Alibaba

* Update metric description

* Update 4.nebula-java-client.md (#1864)

* Update 2.deploy-connect-dashboard-ent.md (#1867)

* fix coalesce() (#1860)

* Update 3.deploy-nebula-graph-with-docker-compose.md (#1876)

* Update 3.deploy-nebula-graph-with-docker-compose.md

* Update 3.deploy-nebula-graph-with-docker-compose.md

* Update 3.deploy-nebula-graph-with-docker-compose.md

* Update docs-2.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md

Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com>

Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com>

* correct 1.create-tag.md TTL_DURATION (#1873)

* correct 1.create-tag.md TTL_DURATION

https://docs.nebula-graph.com.cn/3.1.0/3.ngql-guide/10.tag-statements/1.create-tag/
中关于TTL_DURATION的描述是:“指定属性存活时间。超时的属性将会过期。属性值和时间戳差值之和如果小于当前时间戳,属性就会过期。默认值为0,表示属性永不过期。”
1、官方文档中“属性值和时间戳差值之和如果小于当前时间戳,属性就会过期”这句话转为公式就是:prop+(current-prop)<current 等价于 0 < 0时,属性就会过期。
2、然而,过期代表的含义应当是:prop+TTL_DURATION<current就会过期。
1和2的公式是不等价的,所以正确的表述应当是:属性值和属性存活时间之和如果小于当前时间戳,属性就会过期。

* Update 1.create-tag.md

Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com>

* Update ttl-options.md (#1879)

update TTL desc

* Update provider name (#1884)

* update version description (#1881)

* Update learning-path.md (#1892)

* Add instructions for renewing license on alibaba cloud (#1894)

* Create docs for Cloud on Alibaba

* Add instruction for renewing license on alibaba cloud

* Update 2.use-cloud-services.md

* only-provide-nebula-ent-package-in-Dashboard (#1899)

* only-provide-nebula-ent-package-in-Dashboard

version update

Update 1.create-cluster.md

* Update 1.create-cluster.md

* Update learning path (#1901)

* update-studio

* Update learning-path.md

* Update playground (#1897)

* update-studio

* add playground

* Add hostname example with hyphen (#1910)

* Add hostname example with hyphen

* Update manage-storage-host.md

Co-authored-by: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com>

* Update README.md (#1906)

* Update 6.cheatsheet-for-ngql-command.md (#1915)

* Update 2.deploy-dashboard.md (#1908)

* Update deploy.yaml

Co-authored-by: abby.huang <78209557+abby-cyber@users.noreply.github.com>
Co-authored-by: min.wu <50101159+whitewum@users.noreply.github.com>
Co-authored-by: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com>
Co-authored-by: whitewum <min.wu@vesoft.com>
Co-authored-by: Steam <evaz1879@gmail.com>
Co-authored-by: foesa <35463247+foesa-yang@users.noreply.github.com>
Co-authored-by: root <root@DESKTOP-F6DDR9M.localdomain>
Co-authored-by: lisahui <90186547+lisahui@users.noreply.github.com>
Co-authored-by: Wey Gu <weyl.gu@gmail.com>
Co-authored-by: Sandy.lu <104358440+shanlai@users.noreply.github.com>
Co-authored-by: study-day <38400198+study-day@users.noreply.github.com>
Co-authored-by: bugmaker <65704625+red-vel@users.noreply.github.com>
  • Loading branch information
13 people committed Jun 30, 2022
1 parent 8f9d85c commit 921ecf1
Show file tree
Hide file tree
Showing 32 changed files with 250 additions and 42 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ jobs:
mkdir -p /usr/web/nebula-docs/
tar -xzf /usr/web/nebula-docs.tar.gz -C /usr/web/nebula-docs/
mkdir -p /usr/web/nebula-docs/site/pdf/
cp -f /usr/web/nebula-docs/3.1.0/pdf/NebulaGraph-CN.pdf /usr/web/nebula-docs/site/pdf/NebulaGraph-book.pdf
cp -f /usr/web/nebula-docs/master/pdf/NebulaGraph-CN.pdf /usr/web/nebula-docs/site/pdf/NebulaGraph-book.pdf
# pip3 install --upgrade pip
# pip3 install -r /usr/web/nebula-docs/requirement.txt
Expand Down
2 changes: 1 addition & 1 deletion docs-2.0/1.introduction/0-2.relates.md
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ SNB 数据集模拟一个社交网络的人、发帖之间的关系,考虑了

硬件决定了软件的架构——从发现摩尔定律的 50 年代到进入多核的 00 年代,硬件发展趋势和速度一直深刻的决定了软件的架构。数据库类系统大多围绕“硬盘+内存”设计,高性能计算型系统大多围绕“内存 + CPU”设计,分布式系统面对千兆、万兆和 RDMA 网卡的设计也完全不同。

图基于拓扑的遍历有着极其明显的随机访问特点,因此大多数早期图数据库系统都采用了“大内存 + HDD” 的架构————通过设计**常驻**在内存中的一些数据结构(例如B+树、Hash表等),在内存中实现随机访问目的,以优化图的拓扑遍历,再将这些随机访问转换成 HDD 所适合的顺序读写。整套软件的架构(包括存储和计算层)都必须基于和围绕这样的 IO 流程来展开。随着 SSD 价格的快速下降[^ssdhdd],SSD 正在替代 HDD 成为持久化设备的主流。SSD 随机访问友好、IO 队列深、按快存取的特点与 HDD 高度顺序、随机时延极高、磁道易损坏的访问特点有着明显的不同。全部的软件架构也需要重新设计,这成为沉重的历史技术负担。
图基于拓扑的遍历有着极其明显的随机访问特点,因此大多数早期图数据库系统都采用了“大内存 + HDD” 的架构————通过设计**常驻**在内存中的一些数据结构(例如B+树、Hash表等),在内存中实现随机访问目的,以优化图的拓扑遍历,再将这些随机访问转换成 HDD 所适合的顺序读写。整套软件的架构(包括存储和计算层)都必须基于和围绕这样的 IO 流程来展开。随着 SSD 价格的快速下降[^ssdhdd],SSD 正在替代 HDD 成为持久化设备的主流。SSD 随机访问友好、IO 队列深、按块存取的特点与 HDD 高度顺序、随机时延极高、磁道易损坏的访问特点有着明显的不同。全部的软件架构也需要重新设计,这成为沉重的历史技术负担。

![](https://docs-cdn.nebula-graph.com.cn/books/images/ssdhdd.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ pId = vid % numParts + 1;

分布式系统中,同一份数据通常会有多个副本,这样即使少数副本发生故障,系统仍可正常运行。这就需要一定的技术手段来保证多个副本之间的一致性。

基本原理:Raft 就是一种用于保证多副本一致性的协议。Raft 采用多个副本之间竞选的方式,赢得”超过半数”副本投票的(候选)副本成为 Leader,由 Leader 代表所有副本对外提供服务;其他 Follower 作为备份。当该 Leader 出现异常后(通信故障、运维命令等),其余 Follower 进行新一轮选举,投票出一个新的 Leader。Leader 和 Follower 之间通过心跳的方式相互探测是否存活,并以 Raft-wal 的方式写入硬盘,超过多个心跳仍无响应的副本会认为发生故障
基本原理:Raft 就是一种用于保证多副本一致性的协议。Raft 采用多个副本之间竞选的方式,赢得”超过半数”副本投票的(候选)副本成为 Leader,由 Leader 代表所有副本对外提供服务;其他 Follower 作为备份。当该 Leader 出现异常后(通信故障、运维命令等),其余 Follower 进行新一轮选举,投票出一个新的 Leader。Leader 和 Follower 之间通过心跳的方式相互探测是否存活,并以 Raft-wal 的方式写入硬盘,超过多个心跳仍无响应的副本会被认为发生故障

!!! Note

Expand Down
3 changes: 1 addition & 2 deletions docs-2.0/14.client/1.nebula-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ Nebula Graph 提供多种类型客户端,便于用户连接、管理 Nebula Gr

目前仅 Nebula Java 客户端支持线程安全(thread-safe)。


!!! caution

以下客户端工具也可用于连接和管理 Nebula Graph。他们由非常酷的社区用户提供和维护,欢迎大家参与测试和贡献。
Expand All @@ -26,4 +25,4 @@ Nebula Graph 提供多种类型客户端,便于用户连接、管理 Nebula Gr
- [Nebula .net](https://github.com/nebula-contrib/nebula-net)
- [Nebula JDBC](https://github.com/nebula-contrib/nebula-jdbc)
- [NORM(Nebula Graph 的 Golang ORM)](https://github.com/zhihu/norm)
- [Graph-Ocean(Nebula Graph 的 Java ORM)](https://github.com/nebula-contrib/graph-ocean)
- [Graph-Ocean(Nebula Graph 的 Java ORM)](https://github.com/nebula-contrib/graph-ocean)
17 changes: 15 additions & 2 deletions docs-2.0/20.appendix/learning-path.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,13 @@

### 3.7 周边工具

-

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

- 可视化

| 可视化工具 | 文档 | 视频 |
Expand All @@ -181,7 +188,13 @@
| 数据导入 | [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?) |
| 数据导出 | [Nebula Exchange 企业版](https://docs.nebula-graph.com.cn/{{nebula.release}}/nebula-exchange/about-exchange/ex-ug-what-is-exchange/) | - |


- 备份与恢复

| 文档 | 视频 |
| ------------------------|------------------------------------ |
|[Nebula BR](../backup-and-restore/nebula-br/1.what-is-br.md)|[Nebula Graph 容灾备份工具 nebula-br](https://www.bilibili.com/video/BV11L4y1g7rD)|

- 性能测试

| 文档 |
Expand Down Expand Up @@ -260,4 +273,4 @@

考试用书[《开源分布式图数据库 Nebula Graph 完全指南》](https://docs.nebula-graph.com.cn/site/pdf/NebulaGraph-book.pdf)

单击[Nebula Graph (第N期) 个人技能认证](https://discuss.nebula-graph.com.cn/t/topic/5253)查看考试入口及考试开放和截止时间
单击[Nebula Graph 个人技能认证](https://discuss.nebula-graph.com.cn/t/topic/8728)查看考试说明及入口
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,6 @@ nebula> MATCH (v:player{name:"Tim Duncan"})-[e:follow{degree:95}]->(v2) \

使用`|`可以匹配多个 Edge type,例如`[e:follow|:serve]`。第一个 Edge type 前的英文冒号(:)不可省略,后续 Edge type 前的英文冒号可以省略,例如`[e:follow|serve]`


!!! note

同时匹配多个 Tag 和多个 Edge type 时,不支持进行属性过滤。
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 @@ -16,6 +16,8 @@ ADD HOSTS "<hostname>":<port> [,"<hostname>":<port> ...];
- 增加 Storage 主机在**下一个**心跳周期之后才能生效,为确保数据同步,请等待 2 个心跳周期(20 秒),然后执行`SHOW HOSTS`查看是否在线。

- IP地址和端口请和配置文件中的设置保持一致,例如单机部署的默认为`127.0.0.1:9779`。

- 使用域名时,需要用引号包裹,例如 `ADD HOSTS "foo-bar":9779`。

- 使用域名时,需要用引号包裹,例如 `ADD HOSTS "foo-bar":9779`。

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,4 +108,4 @@ curl -G "http://<ip>:<port>/stats?stats=<metric_name_list> [&format=json]"

{% include "/source-monitoring-metrics.md" %}

<!-- The line above is for content reusing. The source file is in the docs-2.0/reuse directory. -->
<!-- The line above is for content reusing. The source file is in the docs-2.0/reuse directory. -->
2 changes: 1 addition & 1 deletion docs-2.0/graph-computing/nebula-algorithm.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Nebula Algorithm 版本和 Nebula Graph 内核的版本对应关系如下。

|Algorithm client 版本|Nebula Graph 版本|
|Nebula Algorithm 版本|Nebula Graph 版本|
|:---|:---|
|3.0-SNAPSHOT | nightly |
|{{algorithm.release}}| {{nebula.release}} |
Expand Down
2 changes: 1 addition & 1 deletion docs-2.0/graph-computing/nebula-analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Nebula Analytics 是一款高性能图计算框架工具,支持对 Nebula Grap

Nebula Analytics 版本和 Nebula Graph 内核的版本对应关系如下。

|Analytics client 版本|Nebula Graph 版本|
|Nebula Analytics 版本|Nebula Graph 版本|
|:---|:---|
|{{plato.release}}|{{nebula.release}}|
|1.0.x|3.0.x|
Expand Down
18 changes: 16 additions & 2 deletions docs-2.0/nebula-cloud/1.what-is-cloud.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,25 @@
# 什么是 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 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)
- 权限控制。用户可以为指定图空间增加不同角色权限的数据库用户,保证业务数据安全。
- 官方支持。用户可以快速创建工单,咨询使用过程中遇到的问题。
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),之后[续期许可证](../../4.deployment-and-installation/deploy-license.md#nebula_graph_license_3)。

## 前提条件

- 准备[阿里云账号](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)页面。

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,64 @@
# 使用服务实例

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

## 试用期与续期

Nebula Graph Cloud 阿里云版中的 Nebula Graph、Nebula Dashboard 和 Nebula Explorer 服务都是企业版,需要有效的许可证才能正常运行。创建实例时默认赠送有效期为 3 天的试用版许可证。

试用版许可证到期时,服务无法使用。如需继续使用,发送邮件[申请正式许可证](mailto:inquiry@vesoft.com)

获取有效的许可证后,使用新的许可证[替换旧许可证](../../4.deployment-and-installation/deploy-license.md#nebula_graph_license_3),即可继续使用服务。

!!! note

替换许可证时需要连接 Meta 服务所在的阿里云 ECS 实例,方法参见[连接方式概述](https://help.aliyun.com/document_detail/71529.html)。

正式版许可证的续期方法与试用版相同。

## 查看服务实例

在计算巢控制台可以查看服务实例的详细信息,详情参见[查看服务实例](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)
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit 921ecf1

Please sign in to comment.