Deprecate ObjectTransfer feature (#3418)

Add deprecation comments and warning to the crd. Add warning to ObjectTransfer webhook and comment with reference to relevant github issue: #3417 Signed-off-by: Shelly Kagan <[email protected]>
kubevirt · Sep 4, 2024 · 7eedc09 · 7eedc09
1 parent 8e5b203
commit 7eedc09
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 4 deletions.
diff --git a/pkg/apis/core/v1beta1/openapi_generated.go b/pkg/apis/core/v1beta1/openapi_generated.go
diff --git a/pkg/apiserver/webhooks/transfer-validate.go b/pkg/apiserver/webhooks/transfer-validate.go
@@ -40,6 +40,8 @@ type objectTransferValidatingWebhook struct {
 	cdiClient cdiclient.Interface
 }
 
+// ObjectTransfer is now deprecated and will be removed in v1.
+// github issue: https://github.com/kubevirt/containerized-data-importer/issues/3417
 func (wh *objectTransferValidatingWebhook) Admit(ar admissionv1.AdmissionReview) *admissionv1.AdmissionResponse {
 	klog.V(3).Infof("Got AdmissionReview %+v", ar)
 
@@ -107,5 +109,8 @@ func (wh *objectTransferValidatingWebhook) Admit(ar admissionv1.AdmissionReview)
 		return toAdmissionResponseError(err)
 	}
 
-	return allowedAdmissionResponse()
+	return &admissionv1.AdmissionResponse{
+		Allowed:  true,
+		Warnings: []string{"ObjectTransfer feature is deprecated, and will be deleted soon"},
+	}
 }
diff --git a/pkg/apiserver/webhooks/transfer-validate_test.go b/pkg/apiserver/webhooks/transfer-validate_test.go
@@ -196,7 +196,7 @@ var _ = Describe("ObjectTransfer webhook", func() {
 			}}, nil),
 		)
 
-		It("Should accept good stuff", func() {
+		It("Should accept good stuff with deprecation warning", func() {
 			ot := &cdiv1.ObjectTransfer{
 				ObjectMeta: metav1.ObjectMeta{
 					Name: "ot",
@@ -231,6 +231,8 @@ var _ = Describe("ObjectTransfer webhook", func() {
 
 			resp := validateObjectTransfers(ar, nil, nil)
 			Expect(resp.Allowed).To(BeTrue())
+			Expect(resp.Warnings).ToNot(BeEmpty())
+			Expect(resp.Warnings[0]).To(ContainSubstring("ObjectTransfer feature is deprecated"))
 		})
 	})
 

diff --git a/pkg/operator/resources/cluster/BUILD.bazel b/pkg/operator/resources/cluster/BUILD.bazel
@@ -34,6 +34,7 @@ go_library(
         "//vendor/k8s.io/apimachinery/pkg/runtime:go_default_library",
         "//vendor/k8s.io/apimachinery/pkg/util/yaml:go_default_library",
         "//vendor/k8s.io/kube-aggregator/pkg/apis/apiregistration/v1:go_default_library",
+        "//vendor/k8s.io/utils/ptr:go_default_library",
         "//vendor/kubevirt.io/controller-lifecycle-operator-sdk/pkg/sdk/resources:go_default_library",
         "//vendor/sigs.k8s.io/controller-runtime/pkg/client:go_default_library",
     ],

diff --git a/pkg/operator/resources/cluster/object-transfer.go b/pkg/operator/resources/cluster/object-transfer.go
@@ -1,10 +1,12 @@
 package cluster
 
 import (
+	"fmt"
 	"strings"
 
 	extv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	k8syaml "k8s.io/apimachinery/pkg/util/yaml"
+	"k8s.io/utils/ptr"
 
 	"kubevirt.io/containerized-data-importer/pkg/operator/resources"
 )
@@ -18,5 +20,10 @@ func NewObjectTransferCrd() *extv1.CustomResourceDefinition {
 func createObjectTransferCRD() *extv1.CustomResourceDefinition {
 	crd := extv1.CustomResourceDefinition{}
 	_ = k8syaml.NewYAMLToJSONDecoder(strings.NewReader(resources.CDICRDs["objecttransfer"])).Decode(&crd)
+	for i := range crd.Spec.Versions {
+		deprecationWarning := fmt.Sprintf("cdi.kubevirt.io/%s createObjectTransferCRD is now deprecated and will be removed in v1.", crd.Spec.Versions[i].Name)
+		crd.Spec.Versions[i].Deprecated = true
+		crd.Spec.Versions[i].DeprecationWarning = ptr.To(deprecationWarning)
+	}
 	return &crd
 }
diff --git a/pkg/operator/resources/crds_generated.go b/pkg/operator/resources/crds_generated.go
diff --git a/...g/src/kubevirt.io/containerized-data-importer-api/pkg/apis/core/v1beta1/types_transfer.go b/...g/src/kubevirt.io/containerized-data-importer-api/pkg/apis/core/v1beta1/types_transfer.go
@@ -25,6 +25,8 @@ import (
 // see https://github.com/kubernetes/code-generator/issues/59
 // +genclient:nonNamespaced
 
+// Deprecated for removal in v1.
+//
 // ObjectTransfer is the cluster scoped object transfer resource
 // +genclient
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object