Skip to content

Commit 6d21351

Browse files
committed
[docs] compress doris operator diagrams
1 parent 46b24f4 commit 6d21351

48 files changed

Lines changed: 60 additions & 60 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/install/deploy-on-kubernetes/doris-operator/architecture.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This document focuses on the overall architecture. For field definitions and dep
1616

1717
Doris Operator can be viewed as two layers: the control plane and the data plane.
1818

19-
![Doris Operator architecture layers](/images/doris-operator/mermaid/02-architecture-layers.png)
19+
![Doris Operator architecture layers](/images/doris-operator/mermaid/02-architecture-layers.jpg)
2020

2121
The control plane reads Doris custom resources and executes the Reconcile flow. The data plane is made of native Kubernetes resources that actually run Doris components.
2222

@@ -33,21 +33,21 @@ A typical flow is:
3333
5. Aggregate component state and write it into CR `status`.
3434
6. If the cluster is not ready, wait for the next Reconcile loop.
3535

36-
![Doris Operator reconcile model](/images/doris-operator/mermaid/03-architecture-reconcile-model.png)
36+
![Doris Operator reconcile model](/images/doris-operator/mermaid/03-architecture-reconcile-model.jpg)
3737

3838
## Control path for compute-storage integrated clusters
3939

4040
`DorisCluster` is used for compute-storage integrated deployments. A single resource can include FE, BE, CN, and Broker configuration.
4141

42-
![Control path for compute-storage integrated clusters](/images/doris-operator/mermaid/04-architecture-integrated-control-path.png)
42+
![Control path for compute-storage integrated clusters](/images/doris-operator/mermaid/04-architecture-integrated-control-path.jpg)
4343

4444
In this path, the main Reconciler is responsible for reading the CR, ordering component actions, cleaning up invalid resources, and aggregating status. Component controllers create and inspect resources for their own components.
4545

4646
## Control path for compute-storage decoupled clusters
4747

4848
`DorisDisaggregatedCluster` is used for compute-storage decoupled deployments. A single resource contains MetaService, FE, and one or more ComputeGroups.
4949

50-
![Control path for compute-storage decoupled clusters](/images/doris-operator/mermaid/05-architecture-decoupled-control-path.png)
50+
![Control path for compute-storage decoupled clusters](/images/doris-operator/mermaid/05-architecture-decoupled-control-path.jpg)
5151

5252
Compared with compute-storage integrated mode, this path involves more Doris metadata-level actions. For example, when scaling down a ComputeGroup, the Operator may need to perform decommission or drop actions first, and then update Kubernetes resources.
5353

docs/install/deploy-on-kubernetes/doris-operator/doris-operator-overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,15 @@ With Doris Operator, you describe the desired cluster state declaratively throug
3131

3232
Doris Operator extends the Kubernetes API through CRDs. After you submit a Doris cluster resource through `kubectl`, Helm, or another release tool, the Operator watches that resource and translates it into native Kubernetes resources such as `StatefulSet`, `Service`, and `PersistentVolumeClaim`.
3333

34-
![How Doris Operator works](/images/doris-operator/mermaid/01-overview-how-doris-operator-works.png)
34+
![How Doris Operator works](/images/doris-operator/mermaid/01-overview-how-doris-operator-works.jpg)
3535

3636
In this model, the user maintains the desired state, and the Operator continuously reconciles actual state toward that target.
3737

3838
## Architecture
3939

4040
Doris Operator can be viewed as two layers: the control plane and the data plane. The control plane includes Doris Operator, the Reconciler, optional Webhook logic, and status aggregation. It watches Doris custom resources and reconciles the actual state toward the desired state. The data plane includes Kubernetes-native resources such as `StatefulSet`, `Service`, PVC, HPA, and Doris Pods, which run the actual Doris components.
4141

42-
![Doris Operator architecture layers](/images/doris-operator/mermaid/02-architecture-layers.png)
42+
![Doris Operator architecture layers](/images/doris-operator/mermaid/02-architecture-layers.jpg)
4343

4444
After a user submits a Doris custom resource through `kubectl`, Helm, or another release tool, the Kubernetes API Server stores the desired state. Doris Operator watches resource changes and runs Reconcile logic, then creates or updates the underlying Kubernetes resources. This layered model reduces the complexity of managing many low-level resources directly and keeps Doris deployments aligned with standard Kubernetes platforms.
4545

docs/install/deploy-on-kubernetes/doris-operator/lifecycle.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ When you create a `DorisCluster` or `DorisDisaggregatedCluster`, the Operator cr
1818

1919
For compute-storage integrated clusters, FE is usually created first:
2020

21-
![Cluster creation flow for DorisCluster](/images/doris-operator/mermaid/11-lifecycle-doriscluster-creation.png)
21+
![Cluster creation flow for DorisCluster](/images/doris-operator/mermaid/11-lifecycle-doriscluster-creation.jpg)
2222

2323
For compute-storage decoupled clusters, MetaService is created first:
2424

25-
![Cluster creation flow for DorisDisaggregatedCluster](/images/doris-operator/mermaid/12-lifecycle-decoupled-cluster-creation.png)
25+
![Cluster creation flow for DorisDisaggregatedCluster](/images/doris-operator/mermaid/12-lifecycle-decoupled-cluster-creation.jpg)
2626

2727
If dependencies are not ready, the Operator keeps waiting and retries in later Reconcile loops.
2828

@@ -84,7 +84,7 @@ When scaling in a ComputeGroup, Doris metadata-level actions may be required. Th
8484
| `enableDecommission: true` | Run decommission before scale-in and wait for safe removal |
8585
| `enableDecommission: false` | Directly drop the corresponding node |
8686

87-
![ComputeGroup scale-in flow](/images/doris-operator/mermaid/13-lifecycle-computegroup-scale-in.png)
87+
![ComputeGroup scale-in flow](/images/doris-operator/mermaid/13-lifecycle-computegroup-scale-in.jpg)
8888

8989
Before scaling in, confirm current data distribution and business traffic.
9090

docs/install/deploy-on-kubernetes/doris-operator/resource-model.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,13 @@ spec:
3535
3636
Regardless of deployment mode, the user directly manages a Doris custom resource. The Operator uses that resource to create native Kubernetes resources, and those resources run Doris components.
3737
38-
![Doris Operator resource model overview](/images/doris-operator/mermaid/06-resource-model-overview.png)
38+
![Doris Operator resource model overview](/images/doris-operator/mermaid/06-resource-model-overview.jpg)
3939
4040
## DorisCluster
4141
4242
`DorisCluster` is used for compute-storage integrated deployments. It usually contains FE, BE, CN, and Broker components.
4343

44-
![DorisCluster resource model](/images/doris-operator/mermaid/07-resource-model-doriscluster.png)
44+
![DorisCluster resource model](/images/doris-operator/mermaid/07-resource-model-doriscluster.jpg)
4545

4646
| Component | Description | Main Kubernetes resources |
4747
| --- | --- | --- |
@@ -54,7 +54,7 @@ Regardless of deployment mode, the user directly manages a Doris custom resource
5454

5555
`DorisDisaggregatedCluster` is used for compute-storage decoupled deployments. It usually contains MetaService, FE, and one or more ComputeGroups.
5656

57-
![DorisDisaggregatedCluster resource model](/images/doris-operator/mermaid/08-resource-model-disaggregatedcluster.png)
57+
![DorisDisaggregatedCluster resource model](/images/doris-operator/mermaid/08-resource-model-disaggregatedcluster.jpg)
5858

5959
| Component | Description | Main Kubernetes resources |
6060
| --- | --- | --- |
@@ -139,10 +139,10 @@ The resource model also implies component dependencies.
139139

140140
In a compute-storage integrated cluster, FE is the entry point for other components to register and access Doris metadata:
141141

142-
![Dependencies between components in DorisCluster](/images/doris-operator/mermaid/09-resource-model-integrated-dependencies.png)
142+
![Dependencies between components in DorisCluster](/images/doris-operator/mermaid/09-resource-model-integrated-dependencies.jpg)
143143

144144
In a compute-storage decoupled cluster, MetaService is ready first, FE depends on it, and ComputeGroups depend on FE:
145145

146-
![Dependencies between components in DorisDisaggregatedCluster](/images/doris-operator/mermaid/10-resource-model-decoupled-dependencies.png)
146+
![Dependencies between components in DorisDisaggregatedCluster](/images/doris-operator/mermaid/10-resource-model-decoupled-dependencies.jpg)
147147

148148
When an upstream component is not ready, downstream components may keep waiting or reconciling. That is expected behavior. For the execution order of creation and changes, see [Doris Operator Lifecycle Management](./lifecycle).

docs/install/deploy-on-kubernetes/doris-operator/status-and-troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ ComputeGroup phases can include `Ready`, `Reconciling`, `Scaling`, `Decommission
103103

104104
Use the following order:
105105

106-
![Recommended troubleshooting path](/images/doris-operator/mermaid/14-troubleshooting-path.png)
106+
![Recommended troubleshooting path](/images/doris-operator/mermaid/14-troubleshooting-path.jpg)
107107

108108
## Common entry points
109109

i18n/zh-CN/docusaurus-plugin-content-docs/current/install/deploy-on-kubernetes/doris-operator/architecture.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Doris Operator 遵循标准的 Kubernetes Operator 设计模式。用户通过 C
1616

1717
Doris Operator 可以分为控制面和数据面两层。
1818

19-
![Doris Operator architecture layers](/images/doris-operator/mermaid/02-architecture-layers.png)
19+
![Doris Operator architecture layers](/images/doris-operator/mermaid/02-architecture-layers.jpg)
2020

2121
控制面负责读取 Doris 自定义资源并执行 Reconcile 流程;数据面由实际运行 Doris 组件的 Kubernetes 原生资源组成。
2222

@@ -33,21 +33,21 @@ Reconcile 循环是 Doris Operator 的核心。每当用户创建或修改 Doris
3333
5. 汇总组件状态并写回 CR `status`
3434
6. 如果集群尚未就绪,则等待下一轮 Reconcile。
3535

36-
![Doris Operator reconcile model](/images/doris-operator/mermaid/03-architecture-reconcile-model.png)
36+
![Doris Operator reconcile model](/images/doris-operator/mermaid/03-architecture-reconcile-model.jpg)
3737

3838
## 存算一体控制链路
3939

4040
`DorisCluster` 用于存算一体部署。一个资源通常包含 FE、BE、CN、Broker 等组件配置。
4141

42-
![Control path for compute-storage integrated clusters](/images/doris-operator/mermaid/04-architecture-integrated-control-path.png)
42+
![Control path for compute-storage integrated clusters](/images/doris-operator/mermaid/04-architecture-integrated-control-path.jpg)
4343

4444
在这条链路里,主 Reconciler 负责读取 CR、组织组件执行顺序、清理无效资源并汇总状态;组件控制器负责各自组件的资源创建和状态检查。
4545

4646
## 存算分离控制链路
4747

4848
`DorisDisaggregatedCluster` 用于存算分离部署。一个资源中包含 MetaService、FE 和一个或多个 ComputeGroup。
4949

50-
![Control path for compute-storage decoupled clusters](/images/doris-operator/mermaid/05-architecture-decoupled-control-path.png)
50+
![Control path for compute-storage decoupled clusters](/images/doris-operator/mermaid/05-architecture-decoupled-control-path.jpg)
5151

5252
与存算一体相比,这条链路会涉及更多 Doris 元数据层动作。例如缩容 ComputeGroup 时,Operator 可能需要先执行 decommission 或 drop,再更新 Kubernetes 资源。
5353

i18n/zh-CN/docusaurus-plugin-content-docs/current/install/deploy-on-kubernetes/doris-operator/doris-operator-overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,15 @@ Doris Operator 将这些操作收敛到统一的 Doris 自定义资源中,让
3131

3232
Doris Operator 通过 CRD 扩展 Kubernetes API。用户通过 `kubectl`、Helm 或其他发布工具提交 Doris 集群资源后,Operator 会监听资源变化,并把它转换为 `StatefulSet``Service``PersistentVolumeClaim` 等 Kubernetes 原生资源。
3333

34-
![How Doris Operator works](/images/doris-operator/mermaid/01-overview-how-doris-operator-works.png)
34+
![How Doris Operator works](/images/doris-operator/mermaid/01-overview-how-doris-operator-works.jpg)
3535

3636
在这个模型中,用户维护的是期望状态,Operator 持续把实际状态收敛到目标状态。
3737

3838
## 架构形态
3939

4040
Doris Operator 的架构可以分为控制面和数据面。控制面包含 Doris Operator、Reconciler、Webhook 和状态聚合逻辑,负责监听 Doris 自定义资源并推进实际状态向期望状态收敛;数据面包含 `StatefulSet``Service`、PVC、HPA 和 Doris Pods 等 Kubernetes 原生资源,负责承载实际运行的 Doris 组件。
4141

42-
![Doris Operator 架构分层](/images/doris-operator/mermaid/02-architecture-layers.png)
42+
![Doris Operator 架构分层](/images/doris-operator/mermaid/02-architecture-layers.jpg)
4343

4444
用户通过 `kubectl`、Helm 或其他发布工具提交 Doris 自定义资源后,Kubernetes API Server 保存期望状态,Doris Operator 负责监听资源变化并执行 Reconcile,最终创建或更新底层 Kubernetes 资源。这种分层方式降低了用户直接操作大量底层资源的复杂度,也让 Doris 部署更容易与标准 Kubernetes 平台兼容。
4545

i18n/zh-CN/docusaurus-plugin-content-docs/current/install/deploy-on-kubernetes/doris-operator/lifecycle.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ Doris Operator 通过 Reconcile 循环管理 Doris 集群生命周期。用户
1818

1919
对存算一体集群,通常先创建 FE:
2020

21-
![Cluster creation flow for DorisCluster](/images/doris-operator/mermaid/11-lifecycle-doriscluster-creation.png)
21+
![Cluster creation flow for DorisCluster](/images/doris-operator/mermaid/11-lifecycle-doriscluster-creation.jpg)
2222

2323
对存算分离集群,通常先创建 MetaService:
2424

25-
![Cluster creation flow for DorisDisaggregatedCluster](/images/doris-operator/mermaid/12-lifecycle-decoupled-cluster-creation.png)
25+
![Cluster creation flow for DorisDisaggregatedCluster](/images/doris-operator/mermaid/12-lifecycle-decoupled-cluster-creation.jpg)
2626

2727
如果依赖组件未就绪,Operator 会持续等待,并在后续 Reconcile 中重试。
2828

@@ -84,7 +84,7 @@ spec:
8484
| `enableDecommission: true` | 缩容前先执行 decommission,并等待安全下线 |
8585
| `enableDecommission: false` | 直接 drop 对应节点 |
8686

87-
![ComputeGroup scale-in flow](/images/doris-operator/mermaid/13-lifecycle-computegroup-scale-in.png)
87+
![ComputeGroup scale-in flow](/images/doris-operator/mermaid/13-lifecycle-computegroup-scale-in.jpg)
8888

8989
执行缩容前,建议先确认当前数据分布和业务流量。
9090

i18n/zh-CN/docusaurus-plugin-content-docs/current/install/deploy-on-kubernetes/doris-operator/resource-model.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,13 @@ spec:
3535
3636
无论使用哪种部署形态,用户直接维护的都是 Doris 自定义资源。Operator 根据自定义资源创建 Kubernetes 原生资源,再由这些资源运行 Doris 组件。
3737
38-
![Doris Operator resource model overview](/images/doris-operator/mermaid/06-resource-model-overview.png)
38+
![Doris Operator resource model overview](/images/doris-operator/mermaid/06-resource-model-overview.jpg)
3939
4040
## DorisCluster
4141
4242
`DorisCluster` 用于存算一体部署,通常包含 FE、BE、CN、Broker 四类组件。
4343

44-
![DorisCluster resource model](/images/doris-operator/mermaid/07-resource-model-doriscluster.png)
44+
![DorisCluster resource model](/images/doris-operator/mermaid/07-resource-model-doriscluster.jpg)
4545

4646
| 组件 | 说明 | 主要 Kubernetes 资源 |
4747
| --- | --- | --- |
@@ -54,7 +54,7 @@ spec:
5454

5555
`DorisDisaggregatedCluster` 用于存算分离部署,通常包含 MetaService、FE 和一个或多个 ComputeGroup。
5656

57-
![DorisDisaggregatedCluster resource model](/images/doris-operator/mermaid/08-resource-model-disaggregatedcluster.png)
57+
![DorisDisaggregatedCluster resource model](/images/doris-operator/mermaid/08-resource-model-disaggregatedcluster.jpg)
5858

5959
| 组件 | 说明 | 主要 Kubernetes 资源 |
6060
| --- | --- | --- |
@@ -139,10 +139,10 @@ demo-adhoc-query-external
139139

140140
在存算一体集群中,FE 是其他组件注册和访问 Doris 元数据的入口:
141141

142-
![Dependencies between components in DorisCluster](/images/doris-operator/mermaid/09-resource-model-integrated-dependencies.png)
142+
![Dependencies between components in DorisCluster](/images/doris-operator/mermaid/09-resource-model-integrated-dependencies.jpg)
143143

144144
在存算分离集群中,MetaService 先就绪,FE 依赖 MetaService,ComputeGroup 再依赖 FE:
145145

146-
![Dependencies between components in DorisDisaggregatedCluster](/images/doris-operator/mermaid/10-resource-model-decoupled-dependencies.png)
146+
![Dependencies between components in DorisDisaggregatedCluster](/images/doris-operator/mermaid/10-resource-model-decoupled-dependencies.jpg)
147147

148148
当上游组件未就绪时,下游组件可能持续等待或反复 Reconcile,这属于正常行为。更详细的创建和变更顺序见 [Doris Operator 生命周期管理](./lifecycle)。

i18n/zh-CN/docusaurus-plugin-content-docs/current/install/deploy-on-kubernetes/doris-operator/status-and-troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ ComputeGroup 的 phase 可能包括 `Ready`、`Reconciling`、`Scaling`、`Decom
103103

104104
建议按下面的顺序推进:
105105

106-
![Recommended troubleshooting path](/images/doris-operator/mermaid/14-troubleshooting-path.png)
106+
![Recommended troubleshooting path](/images/doris-operator/mermaid/14-troubleshooting-path.jpg)
107107

108108
## 常见入口
109109

0 commit comments

Comments
 (0)