rollouts/pkg/controller/batchrelease/workloads/statefulset_like_controller.go

/*
Copyright 2019 The Kruise 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 workloads

import (
	"context"

	appsv1alpha1 "github.com/openkruise/rollouts/api/v1alpha1"
	"github.com/openkruise/rollouts/pkg/util"
	apps "k8s.io/api/apps/v1"
	v1 "k8s.io/api/core/v1"
	"k8s.io/apimachinery/pkg/api/errors"
	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
	"k8s.io/apimachinery/pkg/runtime/schema"
	"k8s.io/apimachinery/pkg/types"
	"k8s.io/apimachinery/pkg/util/intstr"
	"k8s.io/client-go/tools/record"
	"k8s.io/klog/v2"
	"k8s.io/utils/pointer"
	"sigs.k8s.io/controller-runtime/pkg/client"
)

type StatefulSetLikeController struct {
	client.Client
	recorder       record.EventRecorder
	planController *appsv1alpha1.BatchRelease
	namespacedName types.NamespacedName
	workloadObj    *unstructured.Unstructured
	gvk            schema.GroupVersionKind
	pods           []*v1.Pod
}

func NewStatefulSetLikeController(c client.Client, r record.EventRecorder, p *appsv1alpha1.BatchRelease, n types.NamespacedName, gvk schema.GroupVersionKind) UnifiedWorkloadController {
	return &StatefulSetLikeController{
		Client:         c,
		recorder:       r,
		planController: p,
		namespacedName: n,
		gvk:            gvk,
	}
}

func (c *StatefulSetLikeController) GetWorkloadObject() (*unstructured.Unstructured, error) {
	if c.workloadObj == nil {
		c.workloadObj = &unstructured.Unstructured{}
		c.workloadObj.SetGroupVersionKind(c.gvk)
		if err := c.Get(context.TODO(), c.namespacedName, c.workloadObj); err != nil {
			return nil, err
		}
	}
	return c.workloadObj, nil
}

func (c *StatefulSetLikeController) GetWorkloadInfo() (*util.WorkloadInfo, error) {
	set, err := c.GetWorkloadObject()
	if err != nil {
		return nil, err
	}

	workloadInfo := util.ParseStatefulSetInfo(set, c.namespacedName)
	workloadInfo.Paused = true
	if workloadInfo.Status.UpdatedReadyReplicas <= 0 {
		updatedReadyReplicas, err := c.countUpdatedReadyPods(workloadInfo.Status.UpdateRevision)
		if err != nil {
			return nil, err
		}
		workloadInfo.Status.UpdatedReadyReplicas = updatedReadyReplicas
	}

	return workloadInfo, nil
}

func (c *StatefulSetLikeController) ClaimWorkload() (bool, error) {
	set, err := c.GetWorkloadObject()
	if err != nil {
		return false, err
	}

	err = util.ClaimWorkload(c.Client, c.planController, set, map[string]interface{}{
		"type": apps.RollingUpdateStatefulSetStrategyType,
		"rollingUpdate": map[string]interface{}{
			"partition": pointer.Int32(util.ParseReplicasFrom(set)),
		},
	})
	if err != nil {
		return false, err
	}

	klog.V(3).Infof("Claim StatefulSet(%v) Successfully", c.namespacedName)
	return true, nil
}

func (c *StatefulSetLikeController) ReleaseWorkload(cleanup bool) (bool, error) {
	set, err := c.GetWorkloadObject()
	if err != nil {
		if errors.IsNotFound(err) {
			return true, nil
		}
		return false, err
	}

	err = util.ReleaseWorkload(c.Client, set)
	if err != nil {
		c.recorder.Eventf(c.planController, v1.EventTypeWarning, "ReleaseFailed", err.Error())
		return false, err
	}

	klog.V(3).Infof("Release StatefulSet(%v) Successfully", c.namespacedName)
	return true, nil
}

func (c *StatefulSetLikeController) UpgradeBatch(canaryReplicasGoal, stableReplicasGoal int32) (bool, error) {
	set, err := c.GetWorkloadObject()
	if err != nil {
		return false, err
	}

	// if no needs to patch partition
	if isStatefulSetUpgradedDone(set, canaryReplicasGoal, stableReplicasGoal) {
		return true, nil
	}

	err = util.PatchSpec(c.Client, set, map[string]interface{}{
		"updateStrategy": map[string]interface{}{
			"rollingUpdate": map[string]interface{}{
				"partition": pointer.Int32(stableReplicasGoal),
			},
		},
	})
	if err != nil {
		return false, err
	}

	klog.V(3).Infof("Upgrade StatefulSet(%v) Partition to %v Successfully", c.namespacedName, stableReplicasGoal)
	return true, nil
}

func (c *StatefulSetLikeController) IsBatchReady(canaryReplicasGoal, stableReplicasGoal int32) (bool, error) {
	workloadInfo, err := c.GetWorkloadInfo()
	if err != nil {
		return false, err
	}

	// ignore this corner case
	if canaryReplicasGoal <= 0 {
		return true, nil
	}

	// first: make sure that the canary goal is met
	firstCheckPointReady := workloadInfo.Status.UpdatedReplicas >= canaryReplicasGoal
	if !firstCheckPointReady {
		return false, nil
	}

	updatedReadyReplicas := int32(0)
	// TODO: add updatedReadyReplicas for advanced statefulset
	if workloadInfo.Status.UpdatedReadyReplicas > 0 {
		updatedReadyReplicas = workloadInfo.Status.UpdatedReadyReplicas
	} else {
		updatedReadyReplicas, err = c.countUpdatedReadyPods(workloadInfo.Status.UpdateRevision)
		if err != nil {
			return false, err
		}
	}

	maxUnavailable := 0
	if workloadInfo.MaxUnavailable != nil {
		maxUnavailable, _ = intstr.GetScaledValueFromIntOrPercent(workloadInfo.MaxUnavailable, int(canaryReplicasGoal), true)
	}

	secondCheckPointReady := func() bool {
		// 1. make sure updatedReadyReplicas has achieved the goal
		return updatedReadyReplicas+int32(maxUnavailable) >= canaryReplicasGoal &&
			// 2. make sure at latest one updated pod is available if canaryReplicasGoal != 0
			(canaryReplicasGoal == 0 || updatedReadyReplicas >= 1)
	}
	return secondCheckPointReady(), nil
}

func (c *StatefulSetLikeController) ListOwnedPods() ([]*v1.Pod, error) {
	if c.pods != nil {
		return c.pods, nil
	}
	set, err := c.GetWorkloadObject()
	if err != nil {
		return nil, err
	}
	c.pods, err = util.ListOwnedPods(c.Client, set)
	return c.pods, err
}

func (c *StatefulSetLikeController) countUpdatedReadyPods(updateRevision string) (int32, error) {
	pods, err := c.ListOwnedPods()
	if err != nil {
		return 0, err
	}
	activePods := util.FilterActivePods(pods)
	updatedReadyReplicas := int32(0)
	for _, pod := range activePods {
		if util.IsConsistentWithRevision(pod, updateRevision) && util.IsPodReady(pod) {
			updatedReadyReplicas++
		}
	}
	klog.V(3).Infof("BatchRelease(%v) observed %d updatedReadyReplicas")
	return updatedReadyReplicas, nil
}

func isStatefulSetUpgradedDone(set *unstructured.Unstructured, canaryReplicasGoal, stableReplicasGoal int32) bool {
	partition := util.GetStatefulSetPartition(set)
	if partition <= stableReplicasGoal {
		return true
	}
	updatedReplicas := util.ParseStatusIntFrom(set, "updatedReplicas")
	observedGeneration := util.ParseStatusIntFrom(set, "observedGeneration")
	return set.GetGeneration() == observedGeneration && int(updatedReplicas) >= int(canaryReplicasGoal)
}