騰訊開源的 Kubernetes 多集群管理和跨集群編排工具 Clusternet
Clusternet(Cluster Internet) 是一個騰訊開源的 Kubernetes 多集群管理云原生項目，可幫助你像訪問 Internet 一樣輕松管理數以百萬計的 Kubernetes 集群。無論集群運行在公共云、私有云、混合云還是邊緣，Clusternet 都可以讓你管理/訪問它們，就像它們在本地運行一樣。這也有助于消除為每個集群處理不同管理工具的需要。Clusternet 還可以幫助你從托管集群中的一組 API 將應用程序部署和協調到多個集群。當你的集群在 VPC 網絡、邊緣或防火墻后面運行時，Clusternet 可以通過可配置的方式設置網絡隧道。
Clusternet 還提供了一個 Kubernetes 風格的 API，你可以繼續使用 Kubernetes 的方式，比如 KubeConfig，來訪問某個管理的 Kubernetes 集群，或者一個 Kubernetes 服務。
以 Clusternet 項目為基礎實現多云多集群管理平臺，為用戶提供跨云、跨集群、跨 region/zone 的分布式容器服務，將更好的滿足多種場景需求。
1 架構
下圖是 Clusternet 的一個簡單的架構圖：
Clusternet 主要由 clusternet-agent 和 clusternet-hub 兩個組件組成，非常輕量級。
其中 clusternet-agent 組件需要部署在各個子集群中，主要負責：
- 將當前集群作為子集群自動注冊到父集群，也稱為子集群 ManagedCluster
- 上報當前集群元信息，包括 Kubernetes 版本、運行平臺、healthz/readyz/livez 健康狀態、節點狀態等
- 與父集群建立一個 TCP 全雙工的 websocket 安全隧道連接
clusternet-hub 組件部署和運行在父集群中，通過 AA(Aggregated APIServer) 的方式進行工作，主要負責：
- 批準各個子集群注冊請求，并為子集群創建專用資源，例如 namespace、ServiceAccount 和 RBAC 規則等
- 作為聚合的 apiserver (AA)，用作 websocket 服務器，維護來自子集群的多個 websocket 連接
- 提供 Kubernstes 風格的 REST API 來重定向/代理/升級請求到每個子集群 ( 從一組 API 協調應用程序并將其部署到多個集群;
注意：由于 clusternet-hub 作為 AA 運行，所以需要確保父級 apiserver 可以訪問該 clusternet-hub 服務。
2 概念
對于每個想要被管理的 Kubernetes 集群，我們稱之為子集群，子集群注冊到的集群，我們稱之為父集群。組件 clusternet-agent 在子集群中運行，clusternet-hub 在父集群中運行。Clusternet 支持向不同集群分發和管理各種應用資源，包括原生 Kubernetes 各類資源(Deployment/StatefulSet/ConfigMap/Secret 等)、各類 CRD 資源，以及 HelmChart 應用等等。
下圖是 Clusternet 的多集群應用分發模型，其中綠色的模塊是需要用戶去創建的，紫色的模塊是 Clusternet 內部做流轉的資源對象，此外 Clusternet 還提供了 kubectl 插件，可以通過 kubectl clusternet apply 命令來創建資源。
- ClusterRegistrationRequest 是 clusternet-agent 在父集群中為子集群注冊創建的對象
- ManagedCluster 是 clusternet-hub 在批準 ClusterRegistrationRequest 后在父集群中創建的一個對象
- HelmChart 是一個 helm chart 配置的對象
- Subscription 定義了訂閱者想要安裝到集群中的資源，對于每個匹配的集群，將在其專用命名空間中創建一個相應的 Base 對象
- Localization 和 Globalization 將以優先級來定義 Override，數字越小則優先級越低，Localization是命名空間范圍的資源，而 Globalization 是集群范圍的。
- Base 對象將被渲染為應用了 Globalization 和 Localization 設置 Description 對象，Descritpion 是最終要部署到目標子群中的資源
3 部署
從上面的架構可以看出我們需要在子集群和父集群中分別部署 clusternet-agent 和 clusternet-hub 組件。
首先在集群中 Clone 項目代碼：
- $ git clone https://github.com/clusternet/clusternet.git
在父集群中部署 clusternet-hub 組件：
- $ kubectl apply -f deploy/hub
然后為 clusternet-agent 創建一個 bootstrap token:
- $ # 下面命令將創建一個 bootstrap token：07401b.f395accd246ae52d
- $ kubectl apply -f manifests/samples/cluster_bootstrap_token.yaml
然后在子集群中部署 clusternet-agent，幫助子集群注冊到父集群，clusternet-agent 可以配置以下三種同步模式(通過標志 --cluster-sync-mode 配置)：
- Push(推) 模式是指父集群的所有資源變化將由 clusternet-hub 自動同步、推送并應用到子集群
- Pull(拉) 模式表示 clusternet-agent 將自動 watch、同步和應用所有從父集群到子集群的資源變化
- Dual 推拉結合模式，這種模式強烈推薦，通常與特性 AppPusher 一起使用
特性 AppPusher 在 agent 端工作，這主要是出于以下兩個原因：
- 不建議在注冊后改變同步模式，這可能會帶來不一致的配置和行為，這就是為什么強烈推薦雙模式。當雙模式被設置后，AppPusher 提供了一種方法來幫助將 Push 模式切換到 Pull 模式，而無需真正更改標志 --cluster-sync-mode，反之亦然。
- 出于安全考慮，如子集群的安全風險等。
- 當一個子集群禁用 AppPusher 時，父集群不會向其部署任何應用程序，即使設置為 Push 或 Dual 模式，這個時候，這個子集群的工作方式就像 Pull 模式。
- 要部署的資源被表示為 Description 對象，你也可以運行你自己的控制器來 watch 該對象的變化，然后來分發和部署資源。
部署 clusternet-agent 后，首先要創建一個包含集群注冊用的 Token 的 Secret：
- $ # create namespace clusternet-system if not created
- $ kubectl create ns clusternet-system
- $ # here we use the token created above
- $ PARENTURL=https://192.168.10.10 REGTOKEN=07401b.f395accd246ae52d envsubst < ./deploy/templates/clusternet_agent_secret.yaml | kubectl apply -f -
上面的 PARENTURL 是你想注冊的父集群的 apiserver 地址，必須指定 https 方案，它是目前唯一支持的方案。如果 apiserver 不是在標準的 https 端口(:443)上監聽，請在 URL 中指定端口號，以確保代理連接到正確的端點，例如 https://192.168.10.10:6443。
- $ # 部署之前，根據自己的需求更新同步模式
- $ kubectl apply -f deploy/agent
部署完成后檢查集群注冊情況：
- $ # clsrr 是 ClusterRegistrationRequest 對象的別名
- $ kubectl get clsrr
- NAME CLUSTER ID STATUS AGE
- clusternet-dc91021d-2361-4f6d-a404-7c33b9e01118 dc91021d-2361-4f6d-a404-7c33b9e01118 Approved 3d6h
- $ kubectl get clsrr clusternet-dc91021d-2361-4f6d-a404-7c33b9e01118 -o yaml
- apiVersion: clusters.clusternet.io/v1beta1
- kind: ClusterRegistrationRequest
- metadata:
- labels:
- clusters.clusternet.io/cluster-id: dc91021d-2361-4f6d-a404-7c33b9e01118
- clusters.clusternet.io/cluster-name: clusternet-cluster-dzqkw
- clusters.clusternet.io/registered-by: clusternet-agent
- name: clusternet-dc91021d-2361-4f6d-a404-7c33b9e01118
- spec:
- clusterId: dc91021d-2361-4f6d-a404-7c33b9e01118
- clusterName: clusternet-cluster-dzqkw
- clusterType: EdgeClusterSelfProvisioned
- status:
- caCertificate: REDACTED
- dedicatedNamespace: clusternet-dhxfs
- managedClusterName: clusternet-cluster-dzqkw
- result: Approved
- token: REDACTED
在 ClusterRegistrationRequest 被批準后，狀態將被更新，如果需要的話，可以用相應的憑證來訪問父集群。這些憑證已經用指定范圍內的 RBAC 規則設置了，可以查看下面的兩個規則。
- apiVersion: rbac.authorization.k8s.io/v1
- kind: ClusterRole
- metadata:
- annotations:
- clusternet.io/autoupdate: "true"
- labels:
- clusters.clusternet.io/bootstrapping: rbac-defaults
- clusters.clusternet.io/cluster-id: dc91021d-2361-4f6d-a404-7c33b9e01118
- clusternet.io/created-by: clusternet-hub
- name: clusternet-dc91021d-2361-4f6d-a404-7c33b9e01118
- rules:
- - apiGroups:
- - clusters.clusternet.io
- resources:
- - clusterregistrationrequests
- verbs:
- - create
- - get
- - apiGroups:
- - proxies.clusternet.io
- resourceNames:
- - dc91021d-2361-4f6d-a404-7c33b9e01118
- resources:
- - sockets
- verbs:
- - '*'
- ---
- apiVersion: rbac.authorization.k8s.io/v1
- kind: Role
- metadata:
- annotations:
- clusternet.io/autoupdate: "true"
- labels:
- clusters.clusternet.io/bootstrapping: rbac-defaults
- clusternet.io/created-by: clusternet-hub
- name: clusternet-managedcluster-role
- namespace: clusternet-dhxfs
- rules:
- - apiGroups:
- - '*'
- resources:
- - '*'
- verbs:
- - '*'
然后檢查被管理集群的狀態：
- $ # mcls 是 ManagedCluster 對象的別名
- $ # kubectl get mcls -A
- $ # or append "-o wide" to display extra columns
- $ kubectl get mcls -A -o wide
- NAMESPACE NAME CLUSTER ID CLUSTER TYPE SYNC MODE KUBERNETES READYZ AGE
- clusternet-dhxfs clusternet-cluster-dzqkw dc91021d-2361-4f6d-a404-7c33b9e01118 EdgeClusterSelfProvisioned Dual v1.19.10 true 7d23h
- $ kubectl get mcls -n clusternet-dhxfs clusternet-cluster-dzqkw -o yaml
- apiVersion: clusters.clusternet.io/v1beta1
- kind: ManagedCluster
- metadata:
- labels:
- clusters.clusternet.io/cluster-id: dc91021d-2361-4f6d-a404-7c33b9e01118
- clusters.clusternet.io/cluster-name: clusternet-cluster-dzqkw
- clusternet.io/created-by: clusternet-agent
- name: clusternet-cluster-dzqkw
- namespace: clusternet-dhxfs
- spec:
- clusterId: dc91021d-2361-4f6d-a404-7c33b9e01118
- clusterType: EdgeClusterSelfProvisioned
- syncMode: Dual
- status:
- apiserverURL: http://10.0.0.10:8080
- appPusher: true
- healthz: true
- k8sVersion: v1.19.10
- lastObservedTime: "2021-06-30T08:55:14Z"
- livez: true
- platform: linux/amd64
- readyz: true
默認情況下，clusternet-agent 每3分鐘更新一次 ManagedCluster 的狀態，這可以通過標志 --cluster-status-update-frequency 來進行配置。
然后我們可以通過 krew 來安裝 Clusternet 的 kubectl 插件：
- $ kubectl krew install clusternet
安裝完成后就可以使用 kubectl clusternet 命令了：
- $ kubectl clusternet -h
- Usage:
- clusternet [flags]
- clusternet [command]
- Available Commands:
- apply Apply a configuration to a resource by filename or stdin
- create Create a resource from a file or from stdin.
- delete Delete resources by filenames, stdin, resources and names, or by resources and label selector
- edit Edit a resource on the server
- get Display one or many resources
- help Help about any command
- scale Set a new size for a Deployment, ReplicaSet or Replication Controller
- version Print the plugin version information
4 示例
當 Clusternet 部署完成后，接下來我們就可以來嘗試將應用部署到多個集群了。Clusternet 支持從一個托管集群的一組 API 中向多個集群部署應用程序。
注意：Deployer 特性需要由 clusternet-hub 開啟。
首先，讓我們看一個示例應用。下面名為 "app-demo" 的 Subscription 定義了要分發的目標子集群，以及要部署的資源。
- # examples/applications/subscription.yaml
- apiVersion: apps.clusternet.io/v1alpha1
- kind: Subscription
- metadata:
- name: app-demo
- namespace: default
- spec:
- subscribers: # defines the clusters to be distributed to
- - clusterAffinity:
- matchLabels:
- clusters.clusternet.io/cluster-id: dc91021d-2361-4f6d-a404-7c33b9e01118 # PLEASE UPDATE THIS CLUSTER-ID TO YOURS!!!
- feeds: # defines all the resources to be deployed with
- - apiVersion: apps.clusternet.io/v1alpha1
- kind: HelmChart
- name: mysql
- namespace: default
- - apiVersion: v1
- kind: Namespace
- name: foo
- - apiVersion: apps/v1
- kind: Service
- name: my-nginx-svc
- namespace: foo
- - apiVersion: apps/v1
- kind: Deployment
- name: my-nginx
- namespace: foo
在應用這個 Subscription 對象之前，請用你的集群 ID 更新 examples/applications/subscription.yaml。
在安裝了 kubectl 插件 kubectl-clusternet 之后，你可以運行下面的命令將這個應用程序分發到子集群：
- $ kubectl clusternet apply -f examples/applications/
- helmchart.apps.clusternet.io/mysql created
- namespace/foo created
- deployment.apps/my-nginx created
- service/my-nginx-svc created
- subscription.apps.clusternet.io/app-demo created
然后可以使用下面的命令查看剛剛創建的資源：
- $ # list Subscription
- $ kubectl clusternet get subs -A
- NAMESPACE NAME AGE
- default app-demo 6m4s
- $ kubectl clusternet get chart
- NAME CHART VERSION REPO STATUS AGE
- mysql mysql 8.6.2 https://charts.bitnami.com/bitnami Found 71s
- $ kubectl clusternet get ns
- NAME CREATED AT
- foo 2021-08-07T08:50:55Z
- $ kubectl clusternet get svc -n foo
- NAME CREATED AT
- my-nginx-svc 2021-08-07T08:50:57Z
- $ kubectl clusternet get deploy -n foo
- NAME CREATED AT
- my-nginx 2021-08-07T08:50:56Z
Clusternet 將幫助部署和協調應用程序到多個集群，可以通過以下命令檢查狀態。
- $ kubectl clusternet get mcls -A
- NAMESPACE NAME CLUSTER ID SYNC MODE KUBERNETES READYZ AGE
- clusternet-5l82l clusternet-cluster-hx455 dc91021d-2361-4f6d-a404-7c33b9e01118 Dual v1.21.0 true 5d22h
- $ # list Descriptions
- $ kubectl clusternet get desc -A
- NAMESPACE NAME DEPLOYER STATUS AGE
- clusternet-5l82l app-demo-generic Generic Success 2m55s
- clusternet-5l82l app-demo-helm Helm Success 2m55s
- $ kubectl describe desc -n clusternet-5l82l app-demo-generic
- ...
- Status:
- Phase: Success
- Events:
- Type Reason Age From Message
- ---- ------ ---- ---- -------
- Normal SuccessfullyDeployed 2m55s clusternet-hub Description clusternet-5l82l/app-demo-generic is deployed successfully
- $ # list Helm Release
- $ # hr is an alias for HelmRelease
- $ kubectl clusternet get hr -n clusternet-5l82l
- NAME CHART VERSION REPO STATUS AGE
- helm-demo-mysql mysql 8.6.2 https://charts.bitnami.com/bitnami deployed 2m55s
當然也可以在子集群中用 Helm 命令行工具來驗證安裝情況，比如：
- $ helm ls -n abc
- NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
- helm-demo-mysql abc 1 2021-07-06 14:34:44.188938 +0800 CST deployed mysql-8.6.2 8.0.25
這樣我們就成功將一個應用輕松分發到多個集群了。關于 Clusternet 的更多細節和使用方法請查看官方倉庫：https://github.com/clusternet/clusternet 了解更多。
