feat: add capkk CRDs

pkg/apis/capkk/v1beta1/kkcluster_types.go

@@ -0,0 +1,254 @@
+/*
+Copyright 2024 The KubeSphere Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1beta1
+
+import (
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
+	"sigs.k8s.io/cluster-api/errors"
+)
+
+// KKClusterPhase of KKCluster
+type KKClusterPhase string
+
+// const defines current Phase of KKCluster.
+const (
+	KKClusterPhasePending KKClusterPhase = "Pending"
+	KKClusterPhaseSucceed KKClusterPhase = "Succeed"
+	KKClusterPhaseRunning KKClusterPhase = "Running"
+	KKClusterPhaseFailed  KKClusterPhase = "Failed"
+)
+
+// NodeSelectorMode defines selector function during select cluster nodes.
+type NodeSelectorMode string
+
+// const defines various NodeSelectorMode of KKCluster.
+const (
+	RandomNodeSelectorMode   NodeSelectorMode = "Random"
+	SequenceNodeSelectorMode NodeSelectorMode = "Sequence"
+	// ResponseTimeNodeSelectorMode NodeSelectorMode = "ResponseTime"
+)
+
+const (
+	// HostsReadyCondition will check if hosts are connected firstly, then select control-plane nodes and worker nodes.
+	HostsReadyCondition          clusterv1.ConditionType = "HostsReadyCondition"
+	WaitingCheckHostReadyReason  string                  = "WaitingForCheckHosts"
+	WaitingCheckHostReadyMessage string                  = "Waiting for check if all of the hosts are connected."
+	HostsNotReadyReason          string                  = "HostsNotReady"
+	HostsSelectFailedMessage     string                  = "Not enough connected hosts to complete host selection."
+	WaitingHostsSelectReason     string                  = "WaitingForHostsSelect"
+	WaitingHostsSelectMessage    string                  = "Waiting for select kube-control-plane and worker nodes."
+	HostsReadyReason             string                  = "HostsReady"
+	HostsReadyMessage            string                  = "All hosts are connected."
+
+	// PreparationReadyCondition will check which artifacts need to be installed, also initialize the os system.
+	PreparationReadyCondition clusterv1.ConditionType = "PreCheckReadyCondition"
+	WaitingPreparationReason  string                  = "WaitingForPreparation"
+	WaitingPreparationMessage string                  = "Waiting for pre-check and pre-install artifacts and initialize os system"
+	PreparationNotReadyReason string                  = "PreparationNotReady"
+	PreparationReadyReason    string                  = "PreparationReady"
+	PreparationReadyMessage   string                  = "Both artifacts pre-install and os initialization are ready."
+
+	// EtcdReadyCondition will install etcd into etcd group (binary install only currently).
+	EtcdReadyCondition        clusterv1.ConditionType = "EtcdReadyCondition"
+	WaitingInstallEtcdReason  string                  = "WaitingForInstallEtcd"
+	WaitingInstallEtcdMessage string                  = "Waiting for install ETCD binary service"
+	EtcdNotReadyReason        string                  = "ETCDNotReady"
+	EtcdReadyReason           string                  = "EtcdReady"
+	EtcdReadyMessage          string                  = "Etcd successfully installed."
+
+	// BinaryInstallCondition will install cluster binary tools.
+	BinaryInstallCondition             clusterv1.ConditionType = "BinaryInstallCondition"
+	WaitingInstallClusterBinaryReason  string                  = "WaitingForInstallClusterBinary"
+	WaitingInstallClusterBinaryMessage string                  = "Waiting for install cluster binary tools, e.g. kubeadm and kubelet, etc."
+	BinaryNotReadyReason               string                  = "ClusterBinaryNotReady"
+	BinaryReadyReason                  string                  = "ClusterBinaryReady"
+	BinaryReadyMessage                 string                  = "Cluster binary successfully installed"
+
+	// BootstrapReadyCondition will execute `kubeadm join` & `kubeadm init` command.
+	BootstrapReadyCondition           clusterv1.ConditionType = "BootstrapReadyCondition"
+	WaitingCheckBootstrapReadyReason  string                  = "WaitingForBootstrapReady"
+	WaitingCheckBootstrapReadyMessage string                  = "Waiting for the initial bootstrap to complete. Adding control plane and worker nodes to the cluster."
+	BootstrapNotReadyReason           string                  = "CheckBootstrapNotReady"
+	BootstrapReadyReason              string                  = "CheckBootstrapReady"
+	BootstrapReadyMessage             string                  = "Bootstrap is ready."
+
+	// ClusterReadyCondition will check if cluster is ready.
+	ClusterReadyCondition           clusterv1.ConditionType = "ClusterReadyCondition"
+	WaitingCheckClusterReadyReason  string                  = "WaitingForClusterReady"
+	WaitingCheckClusterReadyMessage string                  = "Waiting for initial bootstrap to ready, add control-plane and worker nodes into cluster."
+	ClusterNotReadyReason           string                  = "ClusterNotReady"
+	ClusterReadyReason              string                  = "ClusterReady"
+	ClusterReadyMessage             string                  = "Cluster is ready."
+)
+
+const (
+	// ClusterFinalizer allows ReconcileKKCluster to clean up KK resources associated with KKCluster before
+	// removing it from the apiserver.
+	ClusterFinalizer = "kkcluster.infrastructure.cluster.x-k8s.io"
+
+	// DefaultNodeSelectorMode is select nodes randomly.
+	DefaultNodeSelectorMode = RandomNodeSelectorMode
+
+	// DefaultControlPlaneGroupName defines default control plane group name of the kubernetes cluster.
+	DefaultControlPlaneGroupName = "kube_control_plane"
+
+	// DefaultWorkerGroupName defines default worker group name of the kubernetes cluster.
+	DefaultWorkerGroupName = "kube_worker"
+
+	// DefaultClusterGroupName defines default cluster group name of the kubernetes cluster.
+	DefaultClusterGroupName = "k8s_cluster"
+)
+
+// KKClusterSpec defines the desired state of KKCluster.
+type KKClusterSpec struct {
+	// Distribution represents the Kubernetes distribution type of the cluster.
+	Distribution string `json:"distribution,omitempty"`
+
+	// NodeSelectorMode is the select mode of the node selector.
+	// +optional
+	NodeSelectorMode NodeSelectorMode `json:"nodeSelectorMode,omitempty"`
+
+	// ControlPlaneGroupName is the group name of kubernetes control plane nodes.
+	// +optional
+	ControlPlaneGroupName string `json:"controlPlaneGroupName,omitempty"`
+
+	// WorkerGroupName is the group name of kubernetes worker nodes.
+	// +optional
+	WorkerGroupName string `json:"workerGroupName,omitempty"`
+
+	// ClusterGroupName is the group name of kubernetes cluster, which contains control plane group and worker group.
+	// +optional
+	ClusterGroupName string `json:"clusterGroupName,omitempty"`
+
+	// InventoryRef is the reference of Inventory.
+	InventoryRef *corev1.ObjectReference `json:"inventoryRef,omitempty"`
+
+	// ConfigRef is the reference of Config.
+	// +optional
+	ConfigRef *corev1.ObjectReference `json:"configRef,omitempty"`
+
+	// ConfigRef is the reference of Pipeline.
+	PipelineRef *corev1.ObjectReference `json:"pipelineRef,omitempty"`
+
+	// ControlPlaneLoadBalancer is optional configuration for customizing control plane behavior.
+	// +optional
+	ControlPlaneLoadBalancer *KKLoadBalancerSpec `json:"controlPlaneLoadBalancer,omitempty"`
+
+	// ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.
+	ControlPlaneEndpoint clusterv1.APIEndpoint `json:"controlPlaneEndpoint"`
+}
+
+// KKClusterStatus defines the observed state of KKCluster.
+type KKClusterStatus struct {
+	// +kubebuilder:default=false
+	Ready bool `json:"ready"`
+
+	// Phase of KKCluster.
+	Phase KKClusterPhase `json:"phase,omitempty"`
+
+	// FailureReason will be set in the event that there is a terminal problem
+	// reconciling the Machine and will contain a succinct value suitable
+	// for machine interpretation.
+	//
+	// This field should not be set for transitive errors that a controller
+	// faces that are expected to be fixed automatically over
+	// time (like service outages), but instead indicate that something is
+	// fundamentally wrong with the Machine's spec or the configuration of
+	// the controller, and that manual intervention is required. Examples
+	// of terminal errors would be invalid combinations of settings in the
+	// spec, values that are unsupported by the controller, or the
+	// responsible controller itself being critically misconfigured.
+	//
+	// Any transient errors that occur during the reconciliation of Machines
+	// can be added as events to the Machine object and/or logged in the
+	// controller's output.
+	// +optional
+	FailureReason *errors.MachineStatusError `json:"failureReason,omitempty"`
+
+	// FailureMessage will be set in the event that there is a terminal problem
+	// reconciling the Machine and will contain a more verbose string suitable
+	// for logging and human consumption.
+	//
+	// This field should not be set for transitive errors that a controller
+	// faces that are expected to be fixed automatically over
+	// time (like service outages), but instead indicate that something is
+	// fundamentally wrong with the Machine's spec or the configuration of
+	// the controller, and that manual intervention is required. Examples
+	// of terminal errors would be invalid combinations of settings in the
+	// spec, values that are unsupported by the controller, or the
+	// responsible controller itself being critically misconfigured.
+	//
+	// Any transient errors that occur during the reconciliation of Machines
+	// can be added as events to the Machine object and/or logged in the
+	// controller's output.
+	// +optional
+	FailureMessage *string `json:"failureMessage,omitempty"`
+
+	// Conditions defines current service state of the KKCluster.
+	// +optional
+	Conditions clusterv1.Conditions `json:"conditions,omitempty"`
+}
+
+// KKLoadBalancerSpec defines the desired state of an KK load balancer.
+type KKLoadBalancerSpec struct {
+	// The hostname on which the API server is serving.
+	Host string `json:"host,omitempty"`
+}
+
+// +genclient
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+// +k8s:openapi-gen=true
+// +kubebuilder:resource:scope=Namespaced,categories=cluster-api,shortName=kkc
+// +kubebuilder:subresource:status
+// +kubebuilder:metadata:labels="cluster.x-k8s.io/v1beta1=v1beta1"
+// +kubebuilder:printcolumn:name="Cluster",type="string",JSONPath=".metadata.labels.cluster\\.x-k8s\\.io/cluster-name",description="Cluster to which this KKClusters belongs"
+// +kubebuilder:printcolumn:name="Ready",type="string",JSONPath=".status.ready",description="Cluster infrastructure is ready for SSH instances"
+// +kubebuilder:printcolumn:name="Endpoint",type="string",JSONPath=".spec.controlPlaneEndpoint",description="API Endpoint",priority=1
+
+// KKCluster resource maps a kubernetes cluster, manage and reconcile cluster status.
+type KKCluster struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   KKClusterSpec   `json:"spec,omitempty"`
+	Status KKClusterStatus `json:"status,omitempty"`
+}
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
+// KKClusterList of KKCluster
+type KKClusterList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []KKCluster `json:"items"`
+}
+
+// GetConditions returns the observations of the operational state of the KKCluster resource.
+func (k *KKCluster) GetConditions() clusterv1.Conditions {
+	return k.Status.Conditions
+}
+
+// SetConditions sets the underlying service state of the KKCluster to the predescribed clusterv1.Conditions.
+func (k *KKCluster) SetConditions(conditions clusterv1.Conditions) {
+	k.Status.Conditions = conditions
+}
+
+func init() {
+	SchemeBuilder.Register(&KKCluster{}, &KKClusterList{})
+}

pkg/apis/capkk/v1beta1/kkcluster_webhook.go

@@ -0,0 +1,41 @@
+package v1beta1
+
+import (
+	"context"
+
+	"k8s.io/apimachinery/pkg/runtime"
+	ctrl "sigs.k8s.io/controller-runtime"
+	"sigs.k8s.io/controller-runtime/pkg/webhook"
+	"sigs.k8s.io/controller-runtime/pkg/webhook/admission"
+)
+
+func (k *KKCluster) SetupWebhookWithManager(mgr ctrl.Manager) error {
+	return ctrl.NewWebhookManagedBy(mgr).
+		For(k).
+		Complete()
+}
+
+// +kubebuilder:webhook:path=/validate-infrastructure-cluster-x-k8s-io-v1beta1-kkcluster,mutating=false,failurePolicy=fail,sideEffects=None,groups=infrastructure.cluster.x-k8s.io,resources=kkclusters,verbs=create;update,versions=v1beta1,name=validation.kkcluster.infrastructure.cluster.x-k8s.io,admissionReviewVersions=v1
+//
+
+var _ webhook.CustomDefaulter = &KKCluster{}
+
+func (k *KKCluster) Default(ctx context.Context, obj runtime.Object) error {
+	return nil
+}
+
+// +kubebuilder:webhook:path=/mutate-infrastructure-cluster-x-k8s-io-v1beta1-kkcluster,mutating=true,failurePolicy=fail,sideEffects=None,groups=infrastructure.cluster.x-k8s.io,resources=kkclusters,verbs=create;update,versions=v1beta1,name=default.kkcluster.infrastructure.cluster.x-k8s.io,admissionReviewVersions=v1
+
+var _ webhook.CustomValidator = &KKCluster{}
+
+func (k *KKCluster) ValidateCreate(ctx context.Context, obj runtime.Object) (warnings admission.Warnings, err error) {
+	return nil, nil
+}
+
+func (k *KKCluster) ValidateUpdate(ctx context.Context, oldObj, newObj runtime.Object) (warnings admission.Warnings, err error) {
+	return nil, nil
+}
+
+func (k *KKCluster) ValidateDelete(ctx context.Context, obj runtime.Object) (warnings admission.Warnings, err error) {
+	return nil, nil
+}