knative.dev/pkg@v0.0.0-20260602142205-ac97e43f6622/reconciler/deletion.go (about)

     1  /*
     2  Copyright 2021 The Knative 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 reconciler
    18  
    19  import (
    20  	"context"
    21  
    22  	"k8s.io/apimachinery/pkg/types"
    23  )
    24  
    25  // OnDeletionInterface defines the strongly typed interface to be implemented by a
    26  // controller observing a deletion of an object. Every controller that was active
    27  // during the deletion of the respective resource is guaranteed to observe this event,
    28  // leader or not. It's usually used to clear up in-memory state regarding the respective
    29  // resource. Finalizers should be used to ensure external resources are properly cleaned
    30  // up.
    31  type OnDeletionInterface interface {
    32  	// ObserveDeletion implements custom logic to observe deletion of the respective resource
    33  	// with the given key.
    34  	ObserveDeletion(ctx context.Context, key types.NamespacedName) error
    35  }