Merge pull request #7528 from 24sama/main

✨add kubekey k3s boostrap and control plane provider
kubernetes-sigs · Nov 16, 2022 · fa3ebdc · fa3ebdc
2 parents 566c3c4 + 1b32672
commit fa3ebdc
Show file tree

Hide file tree

Showing 5 changed files with 67 additions and 38 deletions.
diff --git a/cmd/clusterctl/client/config/providers_client.go b/cmd/clusterctl/client/config/providers_client.go
@@ -65,17 +65,19 @@ const (
 
 // Bootstrap providers.
 const (
-	KubeadmBootstrapProviderName  = "kubeadm"
-	TalosBootstrapProviderName    = "talos"
-	MicroK8sBootstrapProviderName = "microk8s"
+	KubeadmBootstrapProviderName    = "kubeadm"
+	TalosBootstrapProviderName      = "talos"
+	MicroK8sBootstrapProviderName   = "microk8s"
+	KubeKeyK3sBootstrapProviderName = "kubekey-k3s"
 )
 
 // ControlPlane providers.
 const (
-	KubeadmControlPlaneProviderName  = "kubeadm"
-	TalosControlPlaneProviderName    = "talos"
-	MicroK8sControlPlaneProviderName = "microk8s"
-	NestedControlPlaneProviderName   = "nested"
+	KubeadmControlPlaneProviderName    = "kubeadm"
+	TalosControlPlaneProviderName      = "talos"
+	MicroK8sControlPlaneProviderName   = "microk8s"
+	NestedControlPlaneProviderName     = "nested"
+	KubeKeyK3sControlPlaneProviderName = "kubekey-k3s"
 )
 
 // Other.
@@ -253,6 +255,11 @@ func (p *providersClient) defaults() []Provider {
 			url:          "https://github.com/kubernetes-sigs/cluster-api/releases/latest/bootstrap-components.yaml",
 			providerType: clusterctlv1.BootstrapProviderType,
 		},
+		&provider{
+			name:         KubeKeyK3sBootstrapProviderName,
+			url:          "https://github.com/kubesphere/kubekey/releases/latest/bootstrap-components.yaml",
+			providerType: clusterctlv1.BootstrapProviderType,
+		},
 		&provider{
 			name:         TalosBootstrapProviderName,
 			url:          "https://github.com/siderolabs/cluster-api-bootstrap-provider-talos/releases/latest/bootstrap-components.yaml",
@@ -269,6 +276,11 @@ func (p *providersClient) defaults() []Provider {
 			url:          "https://github.com/kubernetes-sigs/cluster-api/releases/latest/control-plane-components.yaml",
 			providerType: clusterctlv1.ControlPlaneProviderType,
 		},
+		&provider{
+			name:         KubeKeyK3sControlPlaneProviderName,
+			url:          "https://github.com/kubesphere/kubekey/releases/latest/control-plane-components.yaml",
+			providerType: clusterctlv1.ControlPlaneProviderType,
+		},
 		&provider{
 			name:         TalosControlPlaneProviderName,
 			url:          "https://github.com/siderolabs/cluster-api-control-plane-provider-talos/releases/latest/control-plane-components.yaml",

diff --git a/cmd/clusterctl/client/config_test.go b/cmd/clusterctl/client/config_test.go
@@ -57,9 +57,11 @@ func Test_clusterctlClient_GetProvidersConfig(t *testing.T) {
 			wantProviders: []string{
 				config.ClusterAPIProviderName,
 				config.KubeadmBootstrapProviderName,
+				config.KubeKeyK3sBootstrapProviderName,
 				config.MicroK8sBootstrapProviderName,
 				config.TalosBootstrapProviderName,
 				config.KubeadmControlPlaneProviderName,
+				config.KubeKeyK3sControlPlaneProviderName,
 				config.MicroK8sControlPlaneProviderName,
 				config.NestedControlPlaneProviderName,
 				config.TalosControlPlaneProviderName,
@@ -100,9 +102,11 @@ func Test_clusterctlClient_GetProvidersConfig(t *testing.T) {
 				config.ClusterAPIProviderName,
 				customProviderConfig.Name(),
 				config.KubeadmBootstrapProviderName,
+				config.KubeKeyK3sBootstrapProviderName,
 				config.MicroK8sBootstrapProviderName,
 				config.TalosBootstrapProviderName,
 				config.KubeadmControlPlaneProviderName,
+				config.KubeKeyK3sControlPlaneProviderName,
 				config.MicroK8sControlPlaneProviderName,
 				config.NestedControlPlaneProviderName,
 				config.TalosControlPlaneProviderName,

diff --git a/cmd/clusterctl/cmd/config_repositories_test.go b/cmd/clusterctl/cmd/config_repositories_test.go
@@ -103,9 +103,11 @@ var expectedOutputText = `NAME                TYPE                     URL
 cluster-api         CoreProvider             https://github.com/myorg/myforkofclusterapi/releases/latest/                                core_components.yaml
 another-provider    BootstrapProvider        ./                                                                                          bootstrap-components.yaml
 kubeadm             BootstrapProvider        https://github.com/kubernetes-sigs/cluster-api/releases/latest/                             bootstrap-components.yaml
+kubekey-k3s         BootstrapProvider        https://github.com/kubesphere/kubekey/releases/latest/                                      bootstrap-components.yaml
 microk8s            BootstrapProvider        https://github.com/canonical/cluster-api-bootstrap-provider-microk8s/releases/latest/       bootstrap-components.yaml
 talos               BootstrapProvider        https://github.com/siderolabs/cluster-api-bootstrap-provider-talos/releases/latest/         bootstrap-components.yaml
 kubeadm             ControlPlaneProvider     https://github.com/kubernetes-sigs/cluster-api/releases/latest/                             control-plane-components.yaml
+kubekey-k3s         ControlPlaneProvider     https://github.com/kubesphere/kubekey/releases/latest/                                      control-plane-components.yaml
 microk8s            ControlPlaneProvider     https://github.com/canonical/cluster-api-control-plane-provider-microk8s/releases/latest/   control-plane-components.yaml
 nested              ControlPlaneProvider     https://github.com/kubernetes-sigs/cluster-api-provider-nested/releases/latest/             control-plane-components.yaml
 talos               ControlPlaneProvider     https://github.com/siderolabs/cluster-api-control-plane-provider-talos/releases/latest/     control-plane-components.yaml
@@ -148,6 +150,10 @@ var expectedOutputYaml = `- File: core_components.yaml
   Name: kubeadm
   ProviderType: BootstrapProvider
   URL: https://github.com/kubernetes-sigs/cluster-api/releases/latest/
+- File: bootstrap-components.yaml
+  Name: kubekey-k3s
+  ProviderType: BootstrapProvider
+  URL: https://github.com/kubesphere/kubekey/releases/latest/
 - File: bootstrap-components.yaml
   Name: microk8s
   ProviderType: BootstrapProvider
@@ -160,6 +166,10 @@ var expectedOutputYaml = `- File: core_components.yaml
   Name: kubeadm
   ProviderType: ControlPlaneProvider
   URL: https://github.com/kubernetes-sigs/cluster-api/releases/latest/
+- File: control-plane-components.yaml
+  Name: kubekey-k3s
+  ProviderType: ControlPlaneProvider
+  URL: https://github.com/kubesphere/kubekey/releases/latest/
 - File: control-plane-components.yaml
   Name: microk8s
   ProviderType: ControlPlaneProvider

diff --git a/docs/book/src/clusterctl/provider-contract.md b/docs/book/src/clusterctl/provider-contract.md
@@ -242,35 +242,37 @@ easier transition from `kubectl apply` to `clusterctl`.
 As a reference you can consider the labels applied to the following
 providers.
 
-| Provider Name| Label                                                 |
-|--------------|-------------------------------------------------------|
-|CAPI          | cluster.x-k8s.io/provider=cluster-api                 |
-|CABPK         | cluster.x-k8s.io/provider=bootstrap-kubeadm           |
-|CABPM         | cluster.x-k8s.io/provider=bootstrap-microk8s          |
-|CACPK         | cluster.x-k8s.io/provider=control-plane-kubeadm       |
-|CACPM         | cluster.x-k8s.io/provider=control-plane-microk8s      |
-|CACPN         | cluster.x-k8s.io/provider=control-plane-nested        |
-|CAPA          | cluster.x-k8s.io/provider=infrastructure-aws          |
-|CAPB          | cluster.x-k8s.io/provider=infrastructure-byoh         |
-|CAPC          | cluster.x-k8s.io/provider=infrastructure-cloudstack   |
-|CAPD          | cluster.x-k8s.io/provider=infrastructure-docker       |
-|CAPDO         | cluster.x-k8s.io/provider=infrastructure-digitalocean |
-|CAPG          | cluster.x-k8s.io/provider=infrastructure-gcp          |
-|CAPH          | cluster.x-k8s.io/provider=infrastructure-hetzner      |
-|CAPIBM        | cluster.x-k8s.io/provider=infrastructure-ibmcloud     |
-|CAPKK         | cluster.x-k8s.io/provider=infrastructure-kubekey      |
-|CAPK          | cluster.x-k8s.io/provider=infrastructure-kubevirt     |
-|CAPM3         | cluster.x-k8s.io/provider=infrastructure-metal3       |
-|CAPN          | cluster.x-k8s.io/provider=infrastructure-nested       |
-|CAPO          | cluster.x-k8s.io/provider=infrastructure-openstack    |
-|CAPOCI        | cluster.x-k8s.io/provider=infrastructure-oci          |
-|CAPP          | cluster.x-k8s.io/provider=infrastructure-packet       |
-|CAPV          | cluster.x-k8s.io/provider=infrastructure-vsphere      |
-|CAPVC         | cluster.x-k8s.io/provider=infrastructure-vcluster     |
-|CAPVCD        | cluster.x-k8s.io/provider=infrastructure-vcd          |
-|CAPX          | cluster.x-k8s.io/provider=infrastructure-nutanix      |
-|CAPZ          | cluster.x-k8s.io/provider=infrastructure-azure        |
-|CAPOSC        | cluster.x-k8s.io/provider=infrastructure-outscale     |
+| Provider Name | Label                                                 |
+|---------------|-------------------------------------------------------|
+| CAPI          | cluster.x-k8s.io/provider=cluster-api                 |
+| CABPK         | cluster.x-k8s.io/provider=bootstrap-kubeadm           |
+| CABPM         | cluster.x-k8s.io/provider=bootstrap-microk8s          |
+| CABPKK3S      | cluster.x-k8s.io/provider=bootstrap-kubekey-k3s       |
+| CACPK         | cluster.x-k8s.io/provider=control-plane-kubeadm       |
+| CACPM         | cluster.x-k8s.io/provider=control-plane-microk8s      |
+| CACPN         | cluster.x-k8s.io/provider=control-plane-nested        |
+| CACPKK3S      | cluster.x-k8s.io/provider=control-plane-kubekey-k3s   |
+| CAPA          | cluster.x-k8s.io/provider=infrastructure-aws          |
+| CAPB          | cluster.x-k8s.io/provider=infrastructure-byoh         |
+| CAPC          | cluster.x-k8s.io/provider=infrastructure-cloudstack   |
+| CAPD          | cluster.x-k8s.io/provider=infrastructure-docker       |
+| CAPDO         | cluster.x-k8s.io/provider=infrastructure-digitalocean |
+| CAPG          | cluster.x-k8s.io/provider=infrastructure-gcp          |
+| CAPH          | cluster.x-k8s.io/provider=infrastructure-hetzner      |
+| CAPIBM        | cluster.x-k8s.io/provider=infrastructure-ibmcloud     |
+| CAPKK         | cluster.x-k8s.io/provider=infrastructure-kubekey      |
+| CAPK          | cluster.x-k8s.io/provider=infrastructure-kubevirt     |
+| CAPM3         | cluster.x-k8s.io/provider=infrastructure-metal3       |
+| CAPN          | cluster.x-k8s.io/provider=infrastructure-nested       |
+| CAPO          | cluster.x-k8s.io/provider=infrastructure-openstack    |
+| CAPOCI        | cluster.x-k8s.io/provider=infrastructure-oci          |
+| CAPP          | cluster.x-k8s.io/provider=infrastructure-packet       |
+| CAPV          | cluster.x-k8s.io/provider=infrastructure-vsphere      |
+| CAPVC         | cluster.x-k8s.io/provider=infrastructure-vcluster     |
+| CAPVCD        | cluster.x-k8s.io/provider=infrastructure-vcd          |
+| CAPX          | cluster.x-k8s.io/provider=infrastructure-nutanix      |
+| CAPZ          | cluster.x-k8s.io/provider=infrastructure-azure        |
+| CAPOSC        | cluster.x-k8s.io/provider=infrastructure-outscale     |
 ### Workload cluster templates
 
 An infrastructure provider could publish a **cluster templates** file to be used by `clusterctl generate cluster`.

diff --git a/docs/book/src/user/quick-start.md b/docs/book/src/user/quick-start.md
@@ -441,8 +441,6 @@ clusterctl init --infrastructure ibmcloud
 clusterctl init --infrastructure kubekey
 ```
 
-{{#/tab }}
-
 {{#/tab }}
 {{#tab Kubevirt}}
 
@@ -819,6 +817,8 @@ export INSTANCES=<your-linux-ip-address>
 export CONTROL_PLANE_ENDPOINT_IP=<your-control-plane-virtual-ip>
 ```
 
+Please visit the [KubeKey provider] for more information.
+
 {{#/tab }}
 {{#tab Kubevirt}}
 
@@ -1243,6 +1243,7 @@ See the [clusterctl] documentation for more detail about clusterctl supported ac
 [management cluster]: ../reference/glossary.md#management-cluster
 [Metal3 getting started guide]: https://github.com/metal3-io/cluster-api-provider-metal3/blob/master/docs/getting-started.md
 [Metal3 provider]: https://github.com/metal3-io/cluster-api-provider-metal3/
+[KubeKey provider]: https://github.com/kubesphere/kubekey
 [Kubevirt provider]: https://github.com/kubernetes-sigs/cluster-api-provider-kubevirt/
 [oci-provider]: https://oracle.github.io/cluster-api-provider-oci/#getting-started
 [Equinix Metal getting started guide]: https://github.com/kubernetes-sigs/cluster-api-provider-packet#using