karmada/pkg/resourceinterpreter/default/native/healthy.go

/*
Copyright 2022 The Karmada 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 native

import (
	appsv1 "k8s.io/api/apps/v1"
	corev1 "k8s.io/api/core/v1"
	networkingv1 "k8s.io/api/networking/v1"
	policyv1 "k8s.io/api/policy/v1"
	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
	"k8s.io/apimachinery/pkg/runtime/schema"

	"github.com/karmada-io/karmada/pkg/util"
	"github.com/karmada-io/karmada/pkg/util/helper"
)

type healthInterpreter func(object *unstructured.Unstructured) (bool, error)

func getAllDefaultHealthInterpreter() map[schema.GroupVersionKind]healthInterpreter {
	s := make(map[schema.GroupVersionKind]healthInterpreter)
	s[appsv1.SchemeGroupVersion.WithKind(util.DeploymentKind)] = interpretDeploymentHealth
	s[appsv1.SchemeGroupVersion.WithKind(util.StatefulSetKind)] = interpretStatefulSetHealth
	s[appsv1.SchemeGroupVersion.WithKind(util.ReplicaSetKind)] = interpretReplicaSetHealth
	s[appsv1.SchemeGroupVersion.WithKind(util.DaemonSetKind)] = interpretDaemonSetHealth
	s[corev1.SchemeGroupVersion.WithKind(util.ServiceKind)] = interpretServiceHealth
	s[networkingv1.SchemeGroupVersion.WithKind(util.IngressKind)] = interpretIngressHealth
	s[corev1.SchemeGroupVersion.WithKind(util.PersistentVolumeClaimKind)] = interpretPersistentVolumeClaimHealth
	s[corev1.SchemeGroupVersion.WithKind(util.PodKind)] = interpretPodHealth
	s[policyv1.SchemeGroupVersion.WithKind(util.PodDisruptionBudgetKind)] = interpretPodDisruptionBudgetHealth
	return s
}

func interpretDeploymentHealth(object *unstructured.Unstructured) (bool, error) {
	deploy := &appsv1.Deployment{}
	err := helper.ConvertToTypedObject(object, deploy)
	if err != nil {
		return false, err
	}

	if deploy.Status.ObservedGeneration != deploy.Generation {
		return false, nil
	}
	if (deploy.Spec.Replicas != nil) && deploy.Status.UpdatedReplicas < *deploy.Spec.Replicas {
		return false, nil
	}
	if deploy.Status.AvailableReplicas < deploy.Status.UpdatedReplicas {
		return false, nil
	}
	return true, nil
}

func interpretStatefulSetHealth(object *unstructured.Unstructured) (bool, error) {
	statefulSet := &appsv1.StatefulSet{}
	err := helper.ConvertToTypedObject(object, statefulSet)
	if err != nil {
		return false, err
	}

	if statefulSet.Status.ObservedGeneration != statefulSet.Generation {
		return false, nil
	}
	if (statefulSet.Spec.Replicas != nil) && statefulSet.Status.UpdatedReplicas < *statefulSet.Spec.Replicas {
		return false, nil
	}
	if statefulSet.Status.AvailableReplicas < statefulSet.Status.UpdatedReplicas {
		return false, nil
	}
	return true, nil
}

func interpretReplicaSetHealth(object *unstructured.Unstructured) (bool, error) {
	replicaSet := &appsv1.ReplicaSet{}
	err := helper.ConvertToTypedObject(object, replicaSet)
	if err != nil {
		return false, err
	}

	if replicaSet.Status.ObservedGeneration != replicaSet.Generation {
		return false, nil
	}
	if (replicaSet.Spec.Replicas != nil) && replicaSet.Status.AvailableReplicas < *replicaSet.Spec.Replicas {
		return false, nil
	}
	return true, nil
}

func interpretDaemonSetHealth(object *unstructured.Unstructured) (bool, error) {
	daemonSet := &appsv1.DaemonSet{}
	err := helper.ConvertToTypedObject(object, daemonSet)
	if err != nil {
		return false, err
	}

	if daemonSet.Status.ObservedGeneration != daemonSet.Generation {
		return false, nil
	}
	if daemonSet.Status.UpdatedNumberScheduled < daemonSet.Status.DesiredNumberScheduled {
		return false, nil
	}
	if daemonSet.Status.NumberAvailable < daemonSet.Status.UpdatedNumberScheduled {
		return false, nil
	}

	return true, nil
}

func interpretServiceHealth(object *unstructured.Unstructured) (bool, error) {
	service := &corev1.Service{}
	err := helper.ConvertToTypedObject(object, service)
	if err != nil {
		return false, err
	}

	if service.Spec.Type != corev1.ServiceTypeLoadBalancer {
		return true, nil
	}

	for _, ingress := range service.Status.LoadBalancer.Ingress {
		if ingress.Hostname != "" || ingress.IP != "" {
			return true, nil
		}
	}

	return false, nil
}

func interpretIngressHealth(object *unstructured.Unstructured) (bool, error) {
	ingress := &networkingv1.Ingress{}
	err := helper.ConvertToTypedObject(object, ingress)
	if err != nil {
		return false, err
	}

	for _, ing := range ingress.Status.LoadBalancer.Ingress {
		if ing.Hostname != "" || ing.IP != "" {
			return true, nil
		}
	}

	return false, nil
}

func interpretPersistentVolumeClaimHealth(object *unstructured.Unstructured) (bool, error) {
	pvc := &corev1.PersistentVolumeClaim{}
	err := helper.ConvertToTypedObject(object, pvc)
	if err != nil {
		return false, err
	}

	return pvc.Status.Phase == corev1.ClaimBound, nil
}

func interpretPodHealth(object *unstructured.Unstructured) (bool, error) {
	pod := &corev1.Pod{}
	err := helper.ConvertToTypedObject(object, pod)
	if err != nil {
		return false, err
	}

	if pod.Status.Phase == corev1.PodSucceeded {
		return true, nil
	}

	_, condition := helper.GetPodCondition(&pod.Status, corev1.PodReady)
	if pod.Status.Phase == corev1.PodRunning && condition != nil && condition.Status == corev1.ConditionTrue {
		return true, nil
	}

	return false, nil
}

func interpretPodDisruptionBudgetHealth(object *unstructured.Unstructured) (bool, error) {
	pdb := &policyv1.PodDisruptionBudget{}
	err := helper.ConvertToTypedObject(object, pdb)
	if err != nil {
		return false, err
	}

	return pdb.Status.CurrentHealthy >= pdb.Status.DesiredHealthy, nil
}