Skip to content

Commit

Permalink
keep operator comm content consistency between en & ch (#2318)
Browse files Browse the repository at this point in the history
* keep operator comm content consistency between en & ch

* broken link fix
  • Loading branch information
abby-cyber authored Oct 30, 2023
1 parent 095118b commit f488eba
Show file tree
Hide file tree
Showing 8 changed files with 44 additions and 67 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ NebulaGraph Operator does not support the v1.x version of NebulaGraph. NebulaGra

| NebulaGraph | NebulaGraph Operator |
| ------------- | -------------------- |
| 3.5.x ~ 3.6.0 | 1.5.0 ~ 1.7.x |
| 3.5.x ~ 3.6.0 | 1.5.0 ~ 1.7.x |
| 3.0.0 ~ 3.4.1 | 1.3.0, 1.4.0 ~ 1.4.2 |
| 3.0.0 ~ 3.3.x | 1.0.0, 1.1.0, 1.2.0 |
| 2.5.x ~ 2.6.x | 0.9.0 |
Expand All @@ -43,10 +43,6 @@ NebulaGraph Operator does not support the v1.x version of NebulaGraph. NebulaGra
- The 1.x version NebulaGraph Operator is not compatible with NebulaGraph of version below v3.x.
- Starting from NebulaGraph Operator 0.9.0, logs and data are stored separately. Using NebulaGraph Operator 0.9.0 or later versions to manage a NebulaGraph 2.5.x cluster created with Operator 0.8.0 can cause compatibility issues. You can backup the data of the NebulaGraph 2.5.x cluster and then create a 2.6.x cluster with Operator 0.9.0.

### Feature limitations

The NebulaGraph Operator scaling feature is only available for the Enterprise Edition of NebulaGraph clusters and does not support scaling the Community Edition version of NebulaGraph clusters.

## Release note

[Release](https://github.com/vesoft-inc/nebula-operator/releases/tag/{{operator.tag}})
2 changes: 1 addition & 1 deletion docs-2.0-en/nebula-operator/2.deploy-nebula-operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Before installing NebulaGraph Operator, you need to install the following softwa

!!! note

- If using a role-based access control policy, you need to enable [RBAC](https://kubernetes.io/docs/admin/authorization/rbac) (optional).
- If using a role-based access control policy, you need to enable [RBAC](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) (optional).

- [CoreDNS](https://coredns.io/) is a flexible and scalable DNS server that is [installed](https://github.com/coredns/helm) for Pods in NebulaGraph clusters.

Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -65,23 +65,9 @@
kubectl -n "${NEBULA_CLUSTER_NAMESPACE}" get pod -l "app.kubernetes.io/cluster=${NEBULA_CLUSTER_NAME}"
```

Output:

```bash
NAME READY STATUS RESTARTS AGE
nebula-graphd-0 1/1 Running 0 5m34s
nebula-graphd-1 1/1 Running 0 5m34s
nebula-metad-0 1/1 Running 0 5m34s
nebula-metad-1 1/1 Running 0 5m34s
nebula-metad-2 1/1 Running 0 5m34s
nebula-storaged-0 1/1 Running 0 5m34s
nebula-storaged-1 1/1 Running 0 5m34s
nebula-storaged-2 1/1 Running 0 5m34s
```

## Scaling clusters

- The cluster scaling feature is for NebulaGraph Enterprise Edition only.
The cluster scaling feature is for NebulaGraph Enterprise Edition only.

## Delete clusters

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# 什么是 NebulaGraph Operator



## 基本概念

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

## 工作原理

对于 Kubernetes 系统内不存在的资源类型,用户可以通过添加自定义 API 对象的方式注册,常见的方法是使用 [CustomResourceDefinition(CRD)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions)
对于 Kubernetes 系统内不存在的资源类型,用户可以通过添加自定义 API 对象的方式注册,常见的方法是使用 [CustomResourceDefinition(CRD)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions)

NebulaGraph Operator 将{{nebula.name}}集群的部署管理抽象为 CRD。通过结合多个内置的 API 对象,包括 StatefulSet、Service 和 ConfigMap,{{nebula.name}}集群的日常管理和维护被编码为一个控制循环。在 Kubernetes 系统内,每一种内置资源对象,都运行着一个特定的控制循环,将它的实际状态通过事先规定好的编排动作,逐步调整为最终的期望状态。当一个 CR 实例被提交时,NebulaGraph Operator 会根据控制流程驱动数据库集群进入最终状态。

Expand All @@ -21,7 +19,6 @@ NebulaGraph Operator 已具备的功能如下:
- **集群创建和卸载**:NebulaGraph Operator 简化了用户部署和卸载集群的过程。用户只需提供对应的 CR 文件,NebulaGraph Operator 即可快速创建或者删除一个对应的{{nebula.name}}集群。更多信息参考[使用 Kubectl 部署{{nebula.name}}集群](3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md)或者[使用 Helm 部署{{nebula.name}}集群](3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md)



- **集群升级**:支持升级 {{operator.upgrade_from}} 版的{{nebula.name}}集群至 {{operator.upgrade_to}} 版。

- **故障自愈**:NebulaGraph Operator 调用{{nebula.name}}集群提供的接口,动态地感知服务状态。一旦发现异常,NebulaGraph Operator 自动进行容错处理。更多信息参考[故障自愈](5.operator-failover.md)
Expand Down
4 changes: 2 additions & 2 deletions docs-2.0-zh/nebula-operator/2.deploy-nebula-operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

!!! note

- 如果使用基于角色的访问控制的策略,用户需开启 [RBAC](https://kubernetes.io/docs/admin/authorization/rbac)(可选)。
- 如果使用基于角色的访问控制的策略,用户需开启 [RBAC](https://kubernetes.io/docs/reference/access-authn-authz/rbac/)(可选)。
- [CoreDNS](https://coredns.io/) 是一个灵活的、可扩展的 DNS 服务器,被[安装](https://github.com/coredns/helm)在集群内作为集群内 Pods 的 DNS 服务器。{{nebula.name}}集群中的每个组件通过 DNS 解析类似`x.default.svc.cluster.local`这样的域名相互通信。

## 操作步骤
Expand Down Expand Up @@ -163,7 +163,7 @@ helm install nebula-operator nebula-operator/nebula-operator --namespace=<nebula
helm upgrade nebula-operator nebula-operator/nebula-operator --namespace=nebula-operator-system --version={{operator.release}} --set admissionWebhook.create=true
```

更多信息,参考 [Helm 升级](https://helm.sh/docs/helm/helm_update/)
更多信息,参考 [Helm 升级](https://helm.sh/docs/helm/helm_upgrade/)


### 升级 NebulaGraph Operator
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,9 @@
2. 创建集群配置文件。


创建名为`apps_v1alpha1_nebulacluster.yaml`的文件。文件内容参见[示例配置](https://github.com/vesoft-inc/nebula-operator/blob/v{{operator.release}}/config/samples/apps_v1alpha1_nebulacluster.yaml)
创建名为`apps_v1alpha1_nebulacluster.yaml`的文件。文件内容参见[示例配置](https://github.com/vesoft-inc/nebula-operator/blob/v{{operator.release}}/config/samples/nebulacluster.yaml)




示例配置的参数描述如下:

Expand Down Expand Up @@ -89,15 +88,12 @@
```



## 扩缩容集群


不支持扩缩容社区版的{{nebula.name}}集群。




## 删除集群

使用 Kubectl 删除{{nebula.name}}集群的命令如下:
Expand Down
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,8 @@ markdown_extensions:
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
# collapse content
- pymdownx.details

# Plugins
plugins:
Expand Down

0 comments on commit f488eba

Please sign in to comment.