/* Copyright 2020 The Kubernetes 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 storageversion import ( "context" "fmt" "time" "k8s.io/api/apiserverinternal/v1alpha1" apierrors "k8s.io/apimachinery/pkg/api/errors" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" "k8s.io/apimachinery/pkg/runtime/schema" "k8s.io/klog/v2" ) // Client has the methods required to update the storage version. type Client interface { Create(context.Context, *v1alpha1.StorageVersion, metav1.CreateOptions) (*v1alpha1.StorageVersion, error) UpdateStatus(context.Context, *v1alpha1.StorageVersion, metav1.UpdateOptions) (*v1alpha1.StorageVersion, error) Get(context.Context, string, metav1.GetOptions) (*v1alpha1.StorageVersion, error) } // SetCommonEncodingVersion updates the CommonEncodingVersion and the AllEncodingVersionsEqual // condition based on the StorageVersions. func SetCommonEncodingVersion(sv *v1alpha1.StorageVersion) { var oldCommonEncodingVersion *string if sv.Status.CommonEncodingVersion != nil { version := *sv.Status.CommonEncodingVersion oldCommonEncodingVersion = &version } sv.Status.CommonEncodingVersion = nil if len(sv.Status.StorageVersions) != 0 { firstVersion := sv.Status.StorageVersions[0].EncodingVersion agreed := true for _, ssv := range sv.Status.StorageVersions { if ssv.EncodingVersion != firstVersion { agreed = false break } } if agreed { sv.Status.CommonEncodingVersion = &firstVersion } } condition := v1alpha1.StorageVersionCondition{ Type: v1alpha1.AllEncodingVersionsEqual, Status: v1alpha1.ConditionFalse, ObservedGeneration: sv.Generation, LastTransitionTime: metav1.NewTime(time.Now()), Reason: "CommonEncodingVersionUnset", Message: "Common encoding version unset", } if sv.Status.CommonEncodingVersion != nil { condition.Status = v1alpha1.ConditionTrue condition.Reason = "CommonEncodingVersionSet" condition.Message = "Common encoding version set" } forceTransition := false if oldCommonEncodingVersion != nil && sv.Status.CommonEncodingVersion != nil && *oldCommonEncodingVersion != *sv.Status.CommonEncodingVersion { forceTransition = true } setStatusCondition(&sv.Status.Conditions, condition, forceTransition) } func findStatusCondition(conditions []v1alpha1.StorageVersionCondition, conditionType v1alpha1.StorageVersionConditionType) *v1alpha1.StorageVersionCondition { for i := range conditions { if conditions[i].Type == conditionType { return &conditions[i] } } return nil } // setStatusCondition sets the corresponding condition in conditions to newCondition. // conditions must be non-nil. // 1. if the condition of the specified type already exists: all fields of the existing condition are updated to // newCondition, LastTransitionTime is set to now if the new status differs from the old status // 2. if a condition of the specified type does not exist: LastTransitionTime is set to now() if unset, // and newCondition is appended // // NOTE: forceTransition allows overwriting LastTransitionTime even when the status doesn't change. func setStatusCondition(conditions *[]v1alpha1.StorageVersionCondition, newCondition v1alpha1.StorageVersionCondition, forceTransition bool) { if conditions == nil { return } if newCondition.LastTransitionTime.IsZero() { newCondition.LastTransitionTime = metav1.NewTime(time.Now()) } existingCondition := findStatusCondition(*conditions, newCondition.Type) if existingCondition == nil { *conditions = append(*conditions, newCondition) return } statusChanged := existingCondition.Status != newCondition.Status if statusChanged || forceTransition { existingCondition.LastTransitionTime = newCondition.LastTransitionTime } existingCondition.Status = newCondition.Status existingCondition.Reason = newCondition.Reason existingCondition.Message = newCondition.Message existingCondition.ObservedGeneration = newCondition.ObservedGeneration } // updateStorageVersionFor updates the storage version object for the resource. func updateStorageVersionFor(c Client, apiserverID string, gr schema.GroupResource, encodingVersion string, decodableVersions []string) error { retries := 3 var retry int var err error for retry < retries { err = singleUpdate(c, apiserverID, gr, encodingVersion, decodableVersions) if err == nil { return nil } if apierrors.IsAlreadyExists(err) || apierrors.IsConflict(err) { time.Sleep(1 * time.Second) continue } if err != nil { klog.Errorf("retry %d, failed to update storage version for %v: %v", retry, gr, err) retry++ time.Sleep(1 * time.Second) } } return err } func singleUpdate(c Client, apiserverID string, gr schema.GroupResource, encodingVersion string, decodableVersions []string) error { shouldCreate := false name := fmt.Sprintf("%s.%s", gr.Group, gr.Resource) sv, err := c.Get(context.TODO(), name, metav1.GetOptions{}) if err != nil && !apierrors.IsNotFound(err) { return err } if apierrors.IsNotFound(err) { shouldCreate = true sv = &v1alpha1.StorageVersion{} sv.ObjectMeta.Name = name } updatedSV := localUpdateStorageVersion(sv, apiserverID, encodingVersion, decodableVersions) if shouldCreate { createdSV, err := c.Create(context.TODO(), updatedSV, metav1.CreateOptions{}) if err != nil { return err } // assign the calculated status to the object just created, then update status createdSV.Status = updatedSV.Status _, err = c.UpdateStatus(context.TODO(), createdSV, metav1.UpdateOptions{}) return err } _, err = c.UpdateStatus(context.TODO(), updatedSV, metav1.UpdateOptions{}) return err } // localUpdateStorageVersion updates the input storageversion with given server storageversion info. // The function updates the input storageversion in place. func localUpdateStorageVersion(sv *v1alpha1.StorageVersion, apiserverID, encodingVersion string, decodableVersions []string) *v1alpha1.StorageVersion { newSSV := v1alpha1.ServerStorageVersion{ APIServerID: apiserverID, EncodingVersion: encodingVersion, DecodableVersions: decodableVersions, } foundSSV := false for i, ssv := range sv.Status.StorageVersions { if ssv.APIServerID == apiserverID { sv.Status.StorageVersions[i] = newSSV foundSSV = true break } } if !foundSSV { sv.Status.StorageVersions = append(sv.Status.StorageVersions, newSSV) } SetCommonEncodingVersion(sv) return sv }