Debian Codegraph @

pkg/registry/rest/delete.go

raw
1 /*
2 Copyright 2014 The Kubernetes Authors.
3
4 Licensed under the Apache License, Version 2.0 (the "License");
5 you may not use this file except in compliance with the License.
6 You may obtain a copy of the License at
7
8 http://www.apache.org/licenses/LICENSE-2.0
9
10 Unless required by applicable law or agreed to in writing, software
11 distributed under the License is distributed on an "AS IS" BASIS,
12 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 See the License for the specific language governing permissions and
14 limitations under the License.
15 */
16
17 package rest
18
19 import (
20 "context"
21 "fmt"
22 "time"
23
24 "k8s.io/apimachinery/pkg/api/errors"
25 metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
26 "k8s.io/apimachinery/pkg/apis/meta/v1/validation"
27 "k8s.io/apimachinery/pkg/runtime"
28 "k8s.io/apimachinery/pkg/runtime/schema"
29 "k8s.io/apiserver/pkg/admission"
30 utilpointer "k8s.io/utils/pointer"
31 )
32
33 // RESTDeleteStrategy defines deletion behavior on an object that follows Kubernetes
34 // API conventions.
35 type RESTDeleteStrategy interface {
36 runtime.ObjectTyper
37 }
38
39 type GarbageCollectionPolicy string
40
41 const (
42 DeleteDependents GarbageCollectionPolicy = "DeleteDependents"
43 OrphanDependents GarbageCollectionPolicy = "OrphanDependents"
44 // Unsupported means that the resource knows that it cannot be GC'd, so the finalizers
45 // should never be set in storage.
46 Unsupported GarbageCollectionPolicy = "Unsupported"
47 )
48
49 // GarbageCollectionDeleteStrategy must be implemented by the registry that wants to
50 // orphan dependents by default.
51 type GarbageCollectionDeleteStrategy interface {
52 // DefaultGarbageCollectionPolicy returns the default garbage collection behavior.
53 DefaultGarbageCollectionPolicy(ctx context.Context) GarbageCollectionPolicy
54 }
55
56 // RESTGracefulDeleteStrategy must be implemented by the registry that supports
57 // graceful deletion.
58 type RESTGracefulDeleteStrategy interface {
59 // CheckGracefulDelete should return true if the object can be gracefully deleted and set
60 // any default values on the DeleteOptions.
61 // NOTE: if return true, `options.GracePeriodSeconds` must be non-nil (nil will fail),
62 // that's what tells the deletion how "graceful" to be.
63 CheckGracefulDelete(ctx context.Context, obj runtime.Object, options *metav1.DeleteOptions) bool
64 }
65
66 // BeforeDelete tests whether the object can be gracefully deleted.
67 // If graceful is set, the object should be gracefully deleted. If gracefulPending
68 // is set, the object has already been gracefully deleted (and the provided grace
69 // period is longer than the time to deletion). An error is returned if the
70 // condition cannot be checked or the gracePeriodSeconds is invalid. The options
71 // argument may be updated with default values if graceful is true. Second place
72 // where we set deletionTimestamp is pkg/registry/generic/registry/store.go.
73 // This function is responsible for setting deletionTimestamp during gracefulDeletion,
74 // other one for cascading deletions.
75 func BeforeDelete(strategy RESTDeleteStrategy, ctx context.Context, obj runtime.Object, options *metav1.DeleteOptions) (graceful, gracefulPending bool, err error) {
76 objectMeta, gvk, kerr := objectMetaAndKind(strategy, obj)
77 if kerr != nil {
78 return false, false, kerr
79 }
80 if errs := validation.ValidateDeleteOptions(options); len(errs) > 0 {
81 return false, false, errors.NewInvalid(schema.GroupKind{Group: metav1.GroupName, Kind: "DeleteOptions"}, "", errs)
82 }
83 // Checking the Preconditions here to fail early. They'll be enforced later on when we actually do the deletion, too.
84 if options.Preconditions != nil {
85 if options.Preconditions.UID != nil && *options.Preconditions.UID != objectMeta.GetUID() {
86 return false, false, errors.NewConflict(schema.GroupResource{Group: gvk.Group, Resource: gvk.Kind}, objectMeta.GetName(), fmt.Errorf("the UID in the precondition (%s) does not match the UID in record (%s). The object might have been deleted and then recreated", *options.Preconditions.UID, objectMeta.GetUID()))
87 }
88 if options.Preconditions.ResourceVersion != nil && *options.Preconditions.ResourceVersion != objectMeta.GetResourceVersion() {
89 return false, false, errors.NewConflict(schema.GroupResource{Group: gvk.Group, Resource: gvk.Kind}, objectMeta.GetName(), fmt.Errorf("the ResourceVersion in the precondition (%s) does not match the ResourceVersion in record (%s). The object might have been modified", *options.Preconditions.ResourceVersion, objectMeta.GetResourceVersion()))
90 }
91 }
92
93 // Negative values will be treated as the value `1s` on the delete path.
94 if gracePeriodSeconds := options.GracePeriodSeconds; gracePeriodSeconds != nil && *gracePeriodSeconds < 0 {
95 options.GracePeriodSeconds = utilpointer.Int64(1)
96 }
97 if deletionGracePeriodSeconds := objectMeta.GetDeletionGracePeriodSeconds(); deletionGracePeriodSeconds != nil && *deletionGracePeriodSeconds < 0 {
98 objectMeta.SetDeletionGracePeriodSeconds(utilpointer.Int64(1))
99 }
100
101 gracefulStrategy, ok := strategy.(RESTGracefulDeleteStrategy)
102 if !ok {
103 // If we're not deleting gracefully there's no point in updating Generation, as we won't update
104 // the obcject before deleting it.
105 return false, false, nil
106 }
107 // if the object is already being deleted, no need to update generation.
108 if objectMeta.GetDeletionTimestamp() != nil {
109 // if we are already being deleted, we may only shorten the deletion grace period
110 // this means the object was gracefully deleted previously but deletionGracePeriodSeconds was not set,
111 // so we force deletion immediately
112 // IMPORTANT:
113 // The deletion operation happens in two phases.
114 // 1. Update to set DeletionGracePeriodSeconds and DeletionTimestamp
115 // 2. Delete the object from storage.
116 // If the update succeeds, but the delete fails (network error, internal storage error, etc.),
117 // a resource was previously left in a state that was non-recoverable. We
118 // check if the existing stored resource has a grace period as 0 and if so
119 // attempt to delete immediately in order to recover from this scenario.
120 if objectMeta.GetDeletionGracePeriodSeconds() == nil || *objectMeta.GetDeletionGracePeriodSeconds() == 0 {
121 return false, false, nil
122 }
123 // only a shorter grace period may be provided by a user
124 if options.GracePeriodSeconds != nil {
125 period := int64(*options.GracePeriodSeconds)
126 if period >= *objectMeta.GetDeletionGracePeriodSeconds() {
127 return false, true, nil
128 }
129 // Move the existing deletionTimestamp back by existing object.DeletionGracePeriod, then forward by options.DeletionGracePeriod.
130 // This moves the deletionTimestamp back, since the grace period can only be shortened in this code path.
131 newDeletionTimestamp := metav1.NewTime(
132 objectMeta.GetDeletionTimestamp().Add(-time.Second * time.Duration(*objectMeta.GetDeletionGracePeriodSeconds())).
133 Add(time.Second * time.Duration(*options.GracePeriodSeconds)))
134 // Prevent shortening the grace period moving deletionTimestamp into the past
135 if now := metav1Now(); newDeletionTimestamp.Before(&now) {
136 newDeletionTimestamp = now
137 if period != 0 {
138 // Since a graceful deletion was requested (options.GracePeriodSeconds != 0), but the entire grace period has already expired,
139 // shorten to the minimum period possible while still treating this as a graceful delete.
140 // This means the API server updates the object, another actor observes the update
141 // and is still responsible for the final delete with options.GracePeriodSeconds == 0.
142 period = int64(1)
143 }
144 }
145 objectMeta.SetDeletionTimestamp(&newDeletionTimestamp)
146 objectMeta.SetDeletionGracePeriodSeconds(&period)
147 return true, false, nil
148 }
149 // graceful deletion is pending, do nothing
150 options.GracePeriodSeconds = objectMeta.GetDeletionGracePeriodSeconds()
151 return false, true, nil
152 }
153
154 // `CheckGracefulDelete` will be implemented by specific strategy
155 if !gracefulStrategy.CheckGracefulDelete(ctx, obj, options) {
156 return false, false, nil
157 }
158
159 if options.GracePeriodSeconds == nil {
160 return false, false, errors.NewInternalError(fmt.Errorf("options.GracePeriodSeconds should not be nil"))
161 }
162
163 requestedDeletionTimestamp := metav1.NewTime(metav1Now().Add(time.Second * time.Duration(*options.GracePeriodSeconds)))
164 objectMeta.SetDeletionTimestamp(&requestedDeletionTimestamp)
165 objectMeta.SetDeletionGracePeriodSeconds(options.GracePeriodSeconds)
166 // If it's the first graceful deletion we are going to set the DeletionTimestamp to non-nil.
167 // Controllers of the object that's being deleted shouldn't take any nontrivial actions, hence its behavior changes.
168 // Thus we need to bump object's Generation (if set). This handles generation bump during graceful deletion.
169 // The bump for objects that don't support graceful deletion is handled in pkg/registry/generic/registry/store.go.
170 if objectMeta.GetGeneration() > 0 {
171 objectMeta.SetGeneration(objectMeta.GetGeneration() + 1)
172 }
173
174 return true, false, nil
175 }
176
177 // AdmissionToValidateObjectDeleteFunc returns a admission validate func for object deletion
178 func AdmissionToValidateObjectDeleteFunc(admit admission.Interface, staticAttributes admission.Attributes, objInterfaces admission.ObjectInterfaces) ValidateObjectFunc {
179 mutatingAdmission, isMutatingAdmission := admit.(admission.MutationInterface)
180 validatingAdmission, isValidatingAdmission := admit.(admission.ValidationInterface)
181
182 mutating := isMutatingAdmission && mutatingAdmission.Handles(staticAttributes.GetOperation())
183 validating := isValidatingAdmission && validatingAdmission.Handles(staticAttributes.GetOperation())
184
185 return func(ctx context.Context, old runtime.Object) error {
186 if !mutating && !validating {
187 return nil
188 }
189 finalAttributes := admission.NewAttributesRecord(
190 nil,
191 // Deep copy the object to avoid accidentally changing the object.
192 old.DeepCopyObject(),
193 staticAttributes.GetKind(),
194 staticAttributes.GetNamespace(),
195 staticAttributes.GetName(),
196 staticAttributes.GetResource(),
197 staticAttributes.GetSubresource(),
198 staticAttributes.GetOperation(),
199 staticAttributes.GetOperationOptions(),
200 staticAttributes.IsDryRun(),
201 staticAttributes.GetUserInfo(),
202 )
203 if mutating {
204 if err := mutatingAdmission.Admit(ctx, finalAttributes, objInterfaces); err != nil {
205 return err
206 }
207 }
208 if validating {
209 if err := validatingAdmission.Validate(ctx, finalAttributes, objInterfaces); err != nil {
210 return err
211 }
212 }
213 return nil
214 }
215 }