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 architecture map & update dependencies for operator #2123

Merged
merged 1 commit into from
Sep 15, 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
2 changes: 2 additions & 0 deletions docs-2.0/nebula-operator/1.introduction-to-nebula-operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

NebulaGraph Operator 是用于在 [Kubernetes](https://kubernetes.io) 系统上自动化部署和运维 [NebulaGraph](https://github.com/vesoft-inc/nebula) 集群的工具。依托于 Kubernetes 扩展机制,NebulaGraph 将其运维领域的知识全面注入至 Kubernetes 系统中,让 NebulaGraph 成为真正的[云原生图数据库](https://www.nebula-cloud.io/)。

![operator_map](https://docs-cdn.nebula-graph.com.cn/figures/operator_map_2022-09-08_18-55-18.png)

## 工作原理

对于 Kubernetes 系统内不存在的资源类型,用户可以通过添加自定义 API 对象的方式注册,常见的方法是使用 [CustomResourceDefinition(CRD)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions) 。
Expand Down
36 changes: 5 additions & 31 deletions docs-2.0/nebula-operator/2.deploy-nebula-operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,45 +8,18 @@

## 前提条件

### 安装软件

安装 NebulaGraph Operator 前,用户需要安装以下软件并确保安装版本的正确性:
安装 NebulaGraph Operator 前,用户需要安装以下软件并确保安装版本的正确性(NebulaGraph Operator 不负责处理安装这些软件过程中出现的问题)。

| 软件 | 版本要求 |
| ------------------------------------------------------------ | --------- |
| [Kubernetes](https://kubernetes.io) | \>= 1.16 |
| [Helm](https://helm.sh) | \>= 3.2.0 |
| [CoreDNS](https://github.com/coredns/coredns) | \>= 1.6.0 |
| [CertManager](https://cert-manager.io) | \>= 1.2.0 |
| [OpenKruise](https://openkruise.io) | \>= 0.8.0 |

如果使用基于角色的访问控制的策略,用户需开启 [RBAC](https://kubernetes.io/docs/admin/authorization/rbac)(可选)。

### 软件说明

!!! note

以下内容为 NebulaGraph Operator 使用的第三方项目,NebulaGraph Operator 不负责处理安装这些软件过程中出现的问题。

- [CoreDNS](https://coredns.io/)

CoreDNS 是一个灵活的、可扩展的 DNS 服务器,被[安装](https://github.com/coredns/deployment/tree/master/kubernetes)在集群内作为集群内 Pods 的 DNS 服务器。

NebulaGraph 集群中的每个组件通过 DNS 解析类似`x.default.svc.cluster.local`这样的域名相互通信。

- [cert-manager](https://cert-manager.io/)

!!! note

如果用户已将 NebulaGraph Operator 配置项`admissionWebhook.create`的值设为`false`,无需安装 cert-manager。有关配置项的详情,请参考下文**安装 NebulaGraph Operator **中的**自定义配置 Chart **部分。

cert-manager 是一个自动化管理证书的工具,利用 Kubernetes API 扩展功能,使用 Webhook 服务器提供对 cert-manager 资源的动态准入控制。用户可参考 [cert-manager installation documentation](https://cert-manager.io/docs/installation/kubernetes/) 安装 cert-manager。

cert-manager 用于验证 NebulaGraph 的每个组件副本。如果用户在生产环境中运行它并关心 NebulaGraph 的高可用性,建议将`admissionWebhook.create`的值设为`true`,然后再安装 cert-manager。

- [OpenKruise](https://openkruise.io/)

OpenKruise 是 Kubernetes 的一整套标准扩展,能与原始的 Kubernetes 一起工作,为应用 Pod、Sidecar 容器,甚至是节点中的镜像的管理供更强大和高效的功能。NebulaGraph Operator 启动时需要用到 OpenKruise 开启针对 StatefulSet 的高级功能。用户可参考 [openkruise installation documentation](https://openkruise.io/docs/installation) 安装 OpenKruise。
- 如果使用基于角色的访问控制的策略,用户需开启 [RBAC](https://kubernetes.io/docs/admin/authorization/rbac)(可选)。
- [CoreDNS](https://coredns.io/) 是一个灵活的、可扩展的 DNS 服务器,被[安装](https://github.com/coredns/deployment/tree/master/kubernetes)在集群内作为集群内 Pods 的 DNS 服务器。NebulaGraph 集群中的每个组件通过 DNS 解析类似`x.default.svc.cluster.local`这样的域名相互通信。

## 操作步骤

Expand Down Expand Up @@ -191,7 +164,8 @@ helm install nebula-operator nebula-operator/nebula-operator --namespace=<nebula

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

1.x 版本的 NebulaGraph Operator 不兼容 3.x 以下版本的 NebulaGraph。
- 不支持升级 0.9.0 及以下版本的 NebulaGraph Operator 至 1.x 版本。
- 1.x 版本的 NebulaGraph Operator 不兼容 3.x 以下版本的 NebulaGraph。

1. 拉取最新的 Helm 仓库。

Expand Down