-
Notifications
You must be signed in to change notification settings - Fork 91
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
20 changed files
with
1,070 additions
and
104 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
# 欢迎阅读Nebula Graph {{ nebula.release }} 文档 | ||
|
||
!!! Note "确认正在阅读最新的版本" | ||
|
||
本文档更新时间{{ now().year }}-{{ now().month }}-{{ now().day }}, [GitHub commit](https://github.com/vesoft-inc/nebula-docs-cn/tree/v{{ nebula.release }}) {{ git.short_commit }}。 | ||
|
||
Nebula Graph是一款开源的、分布式的、易扩展的原生图数据库,能够承载数千亿个点和数万亿条边的超大规模数据集,并且提供毫秒级查询。 | ||
|
||
## 快速开始 | ||
|
||
* [简介](1.introduction/1.what-is-nebula-graph.md) | ||
* [快速开始](2.quick-start/1.quick-start-workflow.md) | ||
* [配置要求](4.deployment-and-installation/1.resource-preparations.md) | ||
* [FAQ](20.appendix/0.FAQ.md) | ||
* [生态工具](20.appendix/6.eco-tool-version.md) | ||
|
||
## 其他资料 | ||
|
||
- [《开源分布式图数据库 Nebula | ||
Graph 完全指南》](https://docs.nebula-graph.com.cn/site/pdf/NebulaGraph-book.pdf) | ||
- [Release note](20.appendix/releasenote.md) | ||
- [论坛](https://discuss.nebula-graph.com.cn/) | ||
- [项目主页](https://nebula-graph.com.cn/) | ||
- [系列视频](https://space.bilibili.com/472621355) | ||
- [思维导图](20.appendix/mind-map.md) | ||
- [English](https://docs.nebula-graph.io/) | ||
|
||
## 图例说明 | ||
|
||
|
||
<!-- | ||
本文有 40+ 个 caution。 | ||
本文有 30+ 个 danger。 | ||
本文有 80+ 个 compatibility 和兼容性提示。 | ||
--> | ||
|
||
!!! note | ||
|
||
额外的信息或者操作相关的提醒等。 | ||
|
||
!!! caution | ||
|
||
需要严格遵守的注意事项。不遵守 caution 可能导致系统故障、数据丢失、安全问题等。 | ||
|
||
!!! danger | ||
|
||
会引发危险的事项。不遵守danger必定会导致系统故障、数据丢失、安全问题等。 | ||
|
||
!!! performance | ||
|
||
性能调优时需要注意的事项。 | ||
|
||
!!! faq | ||
|
||
常见问题。 | ||
|
||
!!! compatibility | ||
|
||
nGQL与openCypher的兼容性或nGQL当前版本与历史版本的兼容性。 | ||
|
||
!!! enterpriseonly | ||
|
||
描述社区版和企业版的差异。 | ||
|
||
## 修改文档中的错误 | ||
|
||
Nebula Graph 文档以 Markdown 语言编写。单击文档标题右上侧的铅笔图标即可提交修改建议。 |
37 changes: 37 additions & 0 deletions
37
docs-2.0/nebula-operator/1.introduction-to-nebula-operator.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# 什么是Nebula Operator | ||
|
||
## 基本概念 | ||
|
||
Nebula Operator是用于在[Kubernetes](https://kubernetes.io)系统上自动化部署和运维[Nebula Graph](https://github.com/vesoft-inc/nebula)集群的工具。依托于Kubernetes扩展机制,Nebula Graph将其运维领域的知识全面注入至Kubernetes系统中,让Nebula Graph成为真正的[云原生图数据库](https://www.nebula-cloud.io/)。 | ||
|
||
## 工作原理 | ||
|
||
对于Kubernetes系统内不存在的资源类型,用户可以通过添加自定义API对象的方式注册,常见的方法是使用[CustomResourceDefinition(CRD)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions) 。 | ||
|
||
Nebula Operator将Nebula Graph集群的部署管理抽象为CRD。通过结合多个内置的API对象,包括StatefulSet、Service和ConfigMap,Nebula Graph集群的日常管理和维护被编码为一个控制循环。在Kubernetes系统内,每一种内置资源对象,都运行着一个特定的控制循环,将它的实际状态通过事先规定好的编排动作,逐步调整为最终的期望状态。当一个CR实例被提交时,Nebula Operator会根据控制流程驱动数据库集群进入最终状态。 | ||
|
||
## 功能介绍 | ||
|
||
Nebula Operator已具备的功能如下: | ||
|
||
- **集群创建和卸载**:Nebula Operator简化了用户部署和卸载集群的过程。用户只需提供对应的CR文件,Nebula Operator即可快速创建或者删除一个对应的Nebula Graph集群。更多信息参考[使用Kubectl部署Nebula Graph集群](3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md)或者[使用Helm部署Nebula Graph集群](3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md)。 | ||
|
||
- **集群扩容和缩容**:通过在控制循环中调用Nebula Graph原生提供的扩缩容接口,Nebula Graph封装Nebula Operator实现了扩缩容的逻辑,用户可以通过YAML配置进行简单的扩缩容,且保证数据的稳定性。更多信息参考[使用Kubeclt扩缩容集群](3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md#_3)或[使用Helm扩缩容集群](3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md#_2)。 | ||
|
||
- **故障自愈**:Nebula Operator调用Nebula Graph集群提供的接口,动态地感知服务状态。一旦发现异常,Nebula Operator自动进行容错处理。更多信息参考[故障自愈](5.operator-failover.md)。 | ||
|
||
- **均衡调度**: 基于调度器扩展接口,Nebula Operator提供的调度器可以将应用Pods均匀地分布在Nebula Graph集群中。 | ||
|
||
## 使用限制 | ||
|
||
### 版本限制 | ||
|
||
Nebula Operator不支持v1.x版本的Nebula Graph,其与Nebula Graph版本的对应关系如下: | ||
|
||
| Nebula Operator版本 | Nebula Graph版本 | | ||
| ------------------- | ---------------- | | ||
| {{operator.release}}| {{nebula.release}} | | ||
|
||
### 功能限制 | ||
|
||
目前Nebula Operator只支持手动扩缩容Nebula Graph集群,不支持自动扩缩容Nebula Graph集群。 |
Oops, something went wrong.