Skip to content

Commit

Permalink
update docs on controller-manager (#75)
Browse files Browse the repository at this point in the history
Signed-off-by: Di Xu <stephenhsu90@gmail.com>
  • Loading branch information
dixudx committed Apr 7, 2023
1 parent 8c2dab9 commit 60a2f40
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 12 deletions.
13 changes: 7 additions & 6 deletions content/en/docs/introduction.md
Expand Up @@ -80,8 +80,8 @@ Clusternet is multiple platforms supported now, including `linux/amd64`, `linux/

![](/images/clusternet-arch.png)

Clusternet is a lightweight addon that consists of three components, `clusternet-agent`, `clusternet-scheduler`
and `clusternet-hub`.
Clusternet is a lightweight addon that consists of four components, `clusternet-agent`, `clusternet-scheduler`,
`clusternet-controller-manager` (added since v0.15.0) and `clusternet-hub`.

`clusternet-agent` is responsible for

Expand All @@ -95,14 +95,15 @@ and `clusternet-hub`.

- scheduling resources/feeds to matched child clusters based on `SchedulingStrategy`;

`clusternet-hub` is responsible for

`clusternet-controller` (added since v0.15.0) is responsible for
- approving cluster registration requests and creating dedicated resources, such as namespaces, serviceaccounts and RBAC
rules, for each child cluster;
- coordinating and deploying applications to multiple clusters from a single set of APIs;

`clusternet-hub` is responsible for
- serving as an **aggregated apiserver (AA)**, which is used to provide shadow APIs and serve as a websocket server that
maintain multiple active websocket connections from child clusters;
- providing Kubernstes-styled API to redirect/proxy/upgrade requests to each child cluster;
- coordinating and deploying applications to multiple clusters from a single set of APIs;
- providing Kubernetes-styled API to redirect/proxy/upgrade requests to each child cluster;

{{% alert title="Note" color="warning" %}}
Since `clusternet-hub` is running as an AA, please make sure that parent apiserver could visit the `clusternet-hub` service.
Expand Down
16 changes: 10 additions & 6 deletions content/zh-cn/docs/introduction.md
Expand Up @@ -75,24 +75,28 @@ Clusternet现在支持多个平台,包括`linux/amd64`、`linux/arm64`、`linu

![](/images/clusternet-arch.png)

Clusternet 是一个轻量级插件,由“clusternet-agent”、“clusternet-scheduler”和“clusternet-hub”三个组件组成.
Clusternet 是一个轻量级插件,由 "clusternet-agent"、"clusternet-scheduler"、"clusternet-controller-manager"(自 v0.15.0 起)和
"clusternet-hub" 四个组件组成.

`clusternet-agent` 负责

- 自动将当前集群注册到父集群作为子集群,也称为ManagedCluster;
- 自动将当前集群注册到父集群作为子集群,也称为"ManagedCluster";
- 报告当前集群的心跳,包括Kubernetes版本、运行平台、`healthz`/`readyz`/`livez`、状态等;
- 建立一个 websocket 连接,它通过单个 TCP 连接来提供全双工通信通道到父集群;

`clusternet-scheduler` 负责

- 基于`SchedulingStrategy`来调度资源/feeds到匹配的子集群;
- 基于 `SchedulingStrategy` 来调度资源/feeds到匹配的子集群;

`clusternet-hub` 负责
`clusternet-controller-manager`(自 v0.15.0 起)负责

- 批准集群注册请求并为每个子集群创建专用资源,例如命名空间、服务帐户和 RBAC 规则;
- 利用 API,协调和部署应用程序到多个集群;

`clusternet-hub` 负责

- 作为**aggregated apiserver (AA)** 服务。提供 shadow APIs,并用作 websocket 服务器,来维护子集群的多个活动 websocket 连接;
- 提供 Kubernstes 风格的 API, 将请求重定向/代理/升级到每个子集群;
- 利用 API, 协调和部署应用程序到多个集群;
- 提供 Kubernetes 风格的 API, 将请求重定向/代理/升级到每个子集群;

{{% alert title="Note" color="warning" %}}
由于 `clusternet-hub` 是作为 AA 服务运行,请确保父 apiserver 可以访问 `clusternet-hub` 服务。
Expand Down

0 comments on commit 60a2f40

Please sign in to comment.