alibabacloud-provider-for-Cluster-API

This project is a Cluster API provider developed by Alibaba Cloud following the Cluster API specification. It implements the creation and deletion of ACK (Alibaba Cloud Kubernetes Service) managed clusters on the Alibaba Cloud platform.

The project allows customization of ACK cluster configurations, including node counts, machine types, and other parameters. Users can flexibly configure the scale and performance of ACK clusters according to their needs.

---

Development Environment

• go: 1.22.3
• kubernetes: v1.25.1
• kubebuilder: 3.14.0
• terraform: 1.7.3
• terraform-aliyun-provider: 1.223.2
• clusterctl: v1.6.3
• clusterawsadm: v2.3.1

For development environment setup instructions, refer to the Dockerfile in the project root directory.

---

Code Compilation

CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -a -o bin/manager cmd/main.go

This command generates a binary executable file, which can be deployed manually.

Deployment

Deploy the CRD (Custom Resource Definition) in the cluster:

kubectl apply -f config/crd/bases/

Prepare Alibaba Cloud credentials (access_key and secret_key):

Fill in the required credentials in the config/manager/provider_config.yaml file. This is mandatory; otherwise, the program will fail to start.

  credentials: |
    {
      "access_key": "",
      "secret_key": "",
    }

Build and Deploy

Build the Docker image (includes compilation):

make docker-build

Verify the deployed Pod:

[root@k8s-master-01 cluster-api-provider-aliyun]# kubectl get pod
NAME                                                              READY   STATUS    RESTARTS   AGE
cluster-api-provider-aliyun-controller-manager-549c649467-h9sfq   2/2     Running   0          125m

Usage

Create a Test Cluster

kubectl apply -f config/samples/ack-test.yaml

Check Cluster Status

[root@k8s-master-01 ~]# kwd cluster
NAME              CLUSTERCLASS   PHASE         AGE   VERSION
ack-test                         Provisioned   16m

The ACK clusters deployed via this project are compatible with clusterctl commands. The output of clusterctl describe cluster and kubectl get cluster will be consistent.

Example output from clusterctl describe cluster:

[root@k8s-master-01 ~]# clusterctl describe cluster ack-test
NAME                                                               READY  SEVERITY  REASON  SINCE  MESSAGE
Cluster/ack-test                                                   True                     2m56s
├─ClusterInfrastructure - AliyunManagedCluster/ack-test
├─ControlPlane - AliyunManagedControlPlane/ack-test-control-plane
└─Workers
  └─MachinePool/ack-test-pool-0                                    True                     2m11s
    └─MachinePoolInfrastructure - AliyunManagedMachinePool/ack-test-pool-0

Retrieve the cluster's kubeconfig:

[root@k8s-master-01 ~]# clusterctl get kubeconfig ack-test
apiVersion: v1
clusters:
- cluster: {}
## Omitted for brevity

License

alibabacloud-provider-for-Cluster-API is a Cluster API provider developed by Alibaba Cloud and licensed under the Apache License (Version 2.0) This product contains various third-party components under other open source licenses. See the NOTICE file for more information.

---

本项目是由阿里云开发的Cluster API Provider实现，遵循Cluster API 规范，在阿里云平台上实现了创建和删除 ACK 托管集群的功能。

该项目支持自定义 ACK 集群配置，包括节点数量、机型等参数的设置。用户可以根据实际需求，灵活配置 ACK 集群的规模和性能。

开发环境

• go: 1.22.3
• kubernetes: v1.25.1
• kubebuilder: 3.14.0
• terraform: 1.7.3
• terraform-aliyun-provider: 1.223.2
• clusterctl: v1.6.3
• clusterawsadm: v2.3.1

开发环境配置请参考项目根目录Dockerfile

代码编译

CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -a -o bin/manager cmd/main.go

可得到二进制可执行文件, 可自行部署.

部署方式

在集群中创建CRD

kubectl apply -f config/crd/bases/

准备阿里云平台认证信息(access_key, secret_key), 填入config/manager/provider_config.yaml文件.

必填, 否则程序会启动失败.

  credentials: |
    {
      "access_key": "",
      "secret_key": "",
    }

镜像构建(含代码编译)

make docker-build

以 Deployment 形式部署 manager.

make deploy

会自动完成 Namespace, RBAC, Webhook, Deployment 等资源的构建.

[root@k8s-master-01 cluster-api-provider-aliyun]# kubectl get pod
NAME                                                              READY   STATUS    RESTARTS   AGE
cluster-api-provider-aliyun-controller-manager-549c649467-h9sfq   2/2     Running   0          125m

运行成果

创建测试集群.

kubectl apply -f config/samples/ack-test.yaml

查询集群状态.

[root@k8s-master-01 ~]# kwd cluster
NAME              CLUSTERCLASS   PHASE         AGE   VERSION
ack-test                         Provisioned   16m

由于实现了部分 cluster-api 接口, 通过该项目部署的 ACK 集群, 可以通过clusterctl获取集群状态, 与kubectl get cluster的结果一致.

[root@k8s-master-01 ~]# clusterctl describe cluster ack-test
NAME                                                               READY  SEVERITY  REASON  SINCE  MESSAGE
Cluster/ack-test                                                   True                     2m56s
├─ClusterInfrastructure - AliyunManagedCluster/ack-test
├─ControlPlane - AliyunManagedControlPlane/ack-test-control-plane
└─Workers
  └─MachinePool/ack-test-pool-0                                    True                     2m11s
    └─MachinePoolInfrastructure - AliyunManagedMachinePool/ack-test-pool-0

$ clusterctl get kubeconfig ack-test
apiVersion: v1
clusters:
- cluster: {}
## 省略