Skip to content

Find CSVs by label for an operator, to ensure deleting all the CSVs for a specific subscription #1055

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ibm-ci-bot merged 2 commits into from
Jun 6, 2024
Merged

Find CSVs by label for an operator, to ensure deleting all the CSVs for a specific subscription #1055

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2574b94
Find CSVs by label for an operator, to ensure deleting all the CSVs f…
Daniel-Fan Jun 6, 2024
cc56931
Update test case
Daniel-Fan Jun 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions controllers/operandconfig/operandconfig_controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,15 +121,15 @@ var _ = Describe("OperandConfig controller", func() {
}, timeout, interval).Should(Succeed())

By("Creating and Setting status of the ClusterServiceVersions")
jaegerCSV := testutil.ClusterServiceVersion("jaeger-csv.v0.0.1", operatorNamespaceName, testutil.JaegerExample)
jaegerCSV := testutil.ClusterServiceVersion("jaeger-csv.v0.0.1", "jaeger", operatorNamespaceName, testutil.JaegerExample)
Expect(k8sClient.Create(ctx, jaegerCSV)).Should(Succeed())
Eventually(func() error {
k8sClient.Get(ctx, types.NamespacedName{Name: "jaeger-csv.v0.0.1", Namespace: operatorNamespaceName}, jaegerCSV)
jaegerCSV.Status = testutil.ClusterServiceVersionStatus()
return k8sClient.Status().Update(ctx, jaegerCSV)
}, timeout, interval).Should(Succeed())

mongodbCSV := testutil.ClusterServiceVersion("mongodb-atlas-kubernetes-csv.v0.0.1", operatorNamespaceName, testutil.MongodbExample)
mongodbCSV := testutil.ClusterServiceVersion("mongodb-atlas-kubernetes-csv.v0.0.1", "mongodb-atlas-kubernetes", operatorNamespaceName, testutil.MongodbExample)
Expect(k8sClient.Create(ctx, mongodbCSV)).Should(Succeed())
Eventually(func() error {
k8sClient.Get(ctx, types.NamespacedName{Name: "mongodb-atlas-kubernetes-csv.v0.0.1", Namespace: operatorNamespaceName}, mongodbCSV)
Expand Down
4 changes: 2 additions & 2 deletions controllers/operandregistry/operandregistry_controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,15 +120,15 @@ var _ = Describe("OperandRegistry controller", func() {
}, timeout, interval).Should(Succeed())

By("Creating and Setting status of the ClusterServiceVersions")
jaegerCSV := testutil.ClusterServiceVersion("jaeger-csv.v0.0.1", operatorNamespaceName, testutil.JaegerExample)
jaegerCSV := testutil.ClusterServiceVersion("jaeger-csv.v0.0.1", "jaeger", operatorNamespaceName, testutil.JaegerExample)
Expect(k8sClient.Create(ctx, jaegerCSV)).Should(Succeed())
Eventually(func() error {
k8sClient.Get(ctx, types.NamespacedName{Name: "jaeger-csv.v0.0.1", Namespace: operatorNamespaceName}, jaegerCSV)
jaegerCSV.Status = testutil.ClusterServiceVersionStatus()
return k8sClient.Status().Update(ctx, jaegerCSV)
}, timeout, interval).Should(Succeed())

mongodbCSV := testutil.ClusterServiceVersion("mongodb-atlas-kubernetes-csv.v0.0.1", operatorNamespaceName, testutil.MongodbExample)
mongodbCSV := testutil.ClusterServiceVersion("mongodb-atlas-kubernetes-csv.v0.0.1", "mongodb-atlas-kubernetes", operatorNamespaceName, testutil.MongodbExample)
Expect(k8sClient.Create(ctx, mongodbCSV)).Should(Succeed())
Eventually(func() error {
k8sClient.Get(ctx, types.NamespacedName{Name: "mongodb-atlas-kubernetes-csv.v0.0.1", Namespace: operatorNamespaceName}, mongodbCSV)
Expand Down
12 changes: 6 additions & 6 deletions controllers/operandrequest/operandrequest_controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,15 +140,15 @@ var _ = Describe("OperandRequest controller", func() {
}, testutil.Timeout, testutil.Interval).Should(Succeed())

By("Creating and Setting status of the ClusterServiceVersions")
jaegerCSV := testutil.ClusterServiceVersion("jaeger-csv.v0.0.1", operatorNamespaceName, testutil.JaegerExample)
jaegerCSV := testutil.ClusterServiceVersion("jaeger-csv.v0.0.1", "jaeger", operatorNamespaceName, testutil.JaegerExample)
Expect(k8sClient.Create(ctx, jaegerCSV)).Should(Succeed())
Eventually(func() error {
k8sClient.Get(ctx, types.NamespacedName{Name: "jaeger-csv.v0.0.1", Namespace: operatorNamespaceName}, jaegerCSV)
jaegerCSV.Status = testutil.ClusterServiceVersionStatus()
return k8sClient.Status().Update(ctx, jaegerCSV)
}, testutil.Timeout, testutil.Interval).Should(Succeed())

mongodbCSV := testutil.ClusterServiceVersion("mongodb-atlas-kubernetes-csv.v0.0.1", operatorNamespaceName, testutil.MongodbExample)
mongodbCSV := testutil.ClusterServiceVersion("mongodb-atlas-kubernetes-csv.v0.0.1", "mongodb-atlas-kubernetes", operatorNamespaceName, testutil.MongodbExample)
Expect(k8sClient.Create(ctx, mongodbCSV)).Should(Succeed())
Eventually(func() error {
k8sClient.Get(ctx, types.NamespacedName{Name: "mongodb-atlas-kubernetes-csv.v0.0.1", Namespace: operatorNamespaceName}, mongodbCSV)
Expand Down Expand Up @@ -272,15 +272,15 @@ var _ = Describe("OperandRequest controller", func() {
}, testutil.Timeout, testutil.Interval).Should(Succeed())

By("Creating and Setting status of the ClusterServiceVersions")
jaegerCSV := testutil.ClusterServiceVersion("jaeger-csv.v0.0.1", operatorNamespaceName, testutil.JaegerExample)
jaegerCSV := testutil.ClusterServiceVersion("jaeger-csv.v0.0.1", "jaeger", operatorNamespaceName, testutil.JaegerExample)
Expect(k8sClient.Create(ctx, jaegerCSV)).Should(Succeed())
Eventually(func() error {
k8sClient.Get(ctx, types.NamespacedName{Name: "jaeger-csv.v0.0.1", Namespace: operatorNamespaceName}, jaegerCSV)
jaegerCSV.Status = testutil.ClusterServiceVersionStatus()
return k8sClient.Status().Update(ctx, jaegerCSV)
}, testutil.Timeout, testutil.Interval).Should(Succeed())

mongodbCSV := testutil.ClusterServiceVersion("mongodb-atlas-kubernetes-csv.v0.0.1", operatorNamespaceName, testutil.MongodbExample)
mongodbCSV := testutil.ClusterServiceVersion("mongodb-atlas-kubernetes-csv.v0.0.1", "mongodb-atlas-kubernetes", operatorNamespaceName, testutil.MongodbExample)
Expect(k8sClient.Create(ctx, mongodbCSV)).Should(Succeed())
Eventually(func() error {
k8sClient.Get(ctx, types.NamespacedName{Name: "mongodb-atlas-kubernetes-csv.v0.0.1", Namespace: operatorNamespaceName}, mongodbCSV)
Expand Down Expand Up @@ -433,15 +433,15 @@ var _ = Describe("OperandRequest controller", func() {
}, testutil.Timeout, testutil.Interval).Should(Succeed())

By("Creating and Setting status of the ClusterServiceVersions")
jaegerCSV := testutil.ClusterServiceVersion("jaeger-csv.v0.0.1", operatorNamespaceName, testutil.JaegerExample)
jaegerCSV := testutil.ClusterServiceVersion("jaeger-csv.v0.0.1", "jaeger", operatorNamespaceName, testutil.JaegerExample)
Expect(k8sClient.Create(ctx, jaegerCSV)).Should(Succeed())
Eventually(func() error {
k8sClient.Get(ctx, types.NamespacedName{Name: "jaeger-csv.v0.0.1", Namespace: operatorNamespaceName}, jaegerCSV)
jaegerCSV.Status = testutil.ClusterServiceVersionStatus()
return k8sClient.Status().Update(ctx, jaegerCSV)
}, testutil.Timeout, testutil.Interval).Should(Succeed())

mongodbCSV := testutil.ClusterServiceVersion("mongodb-atlas-kubernetes-csv.v0.0.1", operatorNamespaceName, testutil.MongodbExample)
mongodbCSV := testutil.ClusterServiceVersion("mongodb-atlas-kubernetes-csv.v0.0.1", "mongodb-atlas-kubernetes", operatorNamespaceName, testutil.MongodbExample)
Expect(k8sClient.Create(ctx, mongodbCSV)).Should(Succeed())
Eventually(func() error {
k8sClient.Get(ctx, types.NamespacedName{Name: "mongodb-atlas-kubernetes-csv.v0.0.1", Namespace: operatorNamespaceName}, mongodbCSV)
Expand Down
42 changes: 24 additions & 18 deletions controllers/operandrequest/reconcile_operator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -351,20 +351,23 @@ func (r *Reconciler) deleteSubscription(ctx context.Context, cr *operatorv1alpha

klog.V(2).Infof("Deleting Subscription %s/%s ...", sub.Namespace, sub.Name)

csv, err := r.GetClusterServiceVersion(ctx, sub)
csvList, err := r.GetClusterServiceVersionList(ctx, sub)
// If can't get CSV, requeue the request
if err != nil {
return err
}

if csv != nil {
klog.V(3).Info("Set Deleting Condition in the operandRequest")
cr.SetDeletingCondition(csv.Name, operatorv1alpha1.ResourceTypeCsv, corev1.ConditionTrue, &r.Mutex)
if csvList != nil {
klog.Infof("Found %d ClusterServiceVersions for Subscription %s/%s", len(csvList), sub.Namespace, sub.Name)
for _, csv := range csvList {
klog.V(3).Info("Set Deleting Condition in the operandRequest")
cr.SetDeletingCondition(csv.Name, operatorv1alpha1.ResourceTypeCsv, corev1.ConditionTrue, &r.Mutex)

klog.V(1).Infof("Deleting the ClusterServiceVersion, Namespace: %s, Name: %s", csv.Namespace, csv.Name)
if err := r.Delete(ctx, csv); err != nil {
cr.SetDeletingCondition(csv.Name, operatorv1alpha1.ResourceTypeCsv, corev1.ConditionFalse, &r.Mutex)
return err
klog.V(1).Infof("Deleting the ClusterServiceVersion, Namespace: %s, Name: %s", csv.Namespace, csv.Name)
if err := r.Delete(ctx, csv); err != nil {
cr.SetDeletingCondition(csv.Name, operatorv1alpha1.ResourceTypeCsv, corev1.ConditionFalse, &r.Mutex)
return err
}
}
}

Expand Down Expand Up @@ -426,16 +429,17 @@ func (r *Reconciler) uninstallOperatorsAndOperands(ctx context.Context, operandN
return nil
}

if csv, err := r.GetClusterServiceVersion(ctx, sub); err != nil {
if csvList, err := r.GetClusterServiceVersionList(ctx, sub); err != nil {
// If can't get CSV, requeue the request
return err
} else if csv != nil {
} else if csvList != nil {
klog.Infof("Found %d ClusterServiceVersions for Subscription %s/%s", len(csvList), sub.Namespace, sub.Name)
if uninstallOperand {
klog.V(2).Infof("Deleting all the Custom Resources for CSV, Namespace: %s, Name: %s", csv.Namespace, csv.Name)
if err := r.deleteAllCustomResource(ctx, csv, requestInstance, configInstance, operandName, configInstance.Namespace); err != nil {
klog.V(2).Infof("Deleting all the Custom Resources for CSV, Namespace: %s, Name: %s", csvList[0].Namespace, csvList[0].Name)
if err := r.deleteAllCustomResource(ctx, csvList[0], requestInstance, configInstance, operandName, configInstance.Namespace); err != nil {
return err
}
klog.V(2).Infof("Deleting all the k8s Resources for CSV, Namespace: %s, Name: %s", csv.Namespace, csv.Name)
klog.V(2).Infof("Deleting all the k8s Resources for CSV, Namespace: %s, Name: %s", csvList[0].Namespace, csvList[0].Name)
if err := r.deleteAllK8sResource(ctx, configInstance, operandName, configInstance.Namespace); err != nil {
return err
}
Expand All @@ -447,12 +451,14 @@ func (r *Reconciler) uninstallOperatorsAndOperands(ctx context.Context, operandN
}

klog.V(3).Info("Set Deleting Condition in the operandRequest")
requestInstance.SetDeletingCondition(csv.Name, operatorv1alpha1.ResourceTypeCsv, corev1.ConditionTrue, &r.Mutex)
requestInstance.SetDeletingCondition(csvList[0].Name, operatorv1alpha1.ResourceTypeCsv, corev1.ConditionTrue, &r.Mutex)

klog.V(1).Infof("Deleting the ClusterServiceVersion, Namespace: %s, Name: %s", csv.Namespace, csv.Name)
if err := r.Delete(ctx, csv); err != nil {
requestInstance.SetDeletingCondition(csv.Name, operatorv1alpha1.ResourceTypeCsv, corev1.ConditionFalse, &r.Mutex)
return errors.Wrap(err, "failed to delete the ClusterServiceVersion")
for _, csv := range csvList {
klog.V(1).Infof("Deleting the ClusterServiceVersion, Namespace: %s, Name: %s", csv.Namespace, csv.Name)
if err := r.Delete(ctx, csv); err != nil {
requestInstance.SetDeletingCondition(csv.Name, operatorv1alpha1.ResourceTypeCsv, corev1.ConditionFalse, &r.Mutex)
return errors.Wrapf(err, "failed to delete the ClusterServiceVersion %s/%s", csv.Namespace, csv.Name)
}
}
}
}
Expand Down
38 changes: 38 additions & 0 deletions controllers/operator/manager.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -391,6 +391,44 @@ func (m *ODLMOperator) GetClusterServiceVersion(ctx context.Context, sub *olmv1a
return csv, nil
}

// GetClusterServiceVersionList gets a list of ClusterServiceVersions from the subscription
func (m *ODLMOperator) GetClusterServiceVersionList(ctx context.Context, sub *olmv1alpha1.Subscription) ([]*olmv1alpha1.ClusterServiceVersion, error) {
// Check if subscription is nil
if sub == nil {
klog.Error("The subscription is nil")
return nil, fmt.Errorf("the subscription is nil")
}

packageName := sub.Spec.Package
csvNamespace := sub.Namespace

// Get the ClusterServiceVersion list with label operators.coreos.com/packageName.csvNamespace=''
csvList := &olmv1alpha1.ClusterServiceVersionList{}
opts := []client.ListOption{
client.MatchingLabels{fmt.Sprintf("operators.coreos.com/%s.%s", packageName, csvNamespace): ""},
client.InNamespace(csvNamespace),
}

if err := m.Reader.List(ctx, csvList, opts...); err != nil {
if apierrors.IsNotFound(err) || len(csvList.Items) == 0 {
klog.V(3).Infof("No ClusterServiceVersion found with label operators.coreos.com/%s.%s", packageName, csvNamespace)
return nil, nil
}
return nil, errors.Wrapf(err, "failed to list ClusterServiceVersions with label operators.coreos.com/%s.%s", packageName, csvNamespace)
} else if len(csvList.Items) > 1 {
klog.Warningf("Multiple ClusterServiceVersions found with label operators.coreos.com/%s.%s", packageName, csvNamespace)
}

var csvs []*olmv1alpha1.ClusterServiceVersion
for i := range csvList.Items {
klog.V(3).Infof("Get ClusterServiceVersion %s in the namespace %s", csvList.Items[i].Name, csvNamespace)
csvs = append(csvs, &csvList.Items[i])
}

klog.V(3).Infof("Get %v ClusterServiceVersions in the namespace %s", len(csvs), csvNamespace)
return csvs, nil
}

// GetOperatorNamespace returns the operator namespace based on the install mode
func (m *ODLMOperator) GetOperatorNamespace(installMode, namespace string) string {
if installMode == apiv1alpha1.InstallModeCluster {
Expand Down
5 changes: 4 additions & 1 deletion controllers/testutil/test_util.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -495,14 +495,17 @@ func SubscriptionStatus(name, namespace, csvVersion string) olmv1alpha1.Subscrip
}
}

func ClusterServiceVersion(name, namespace, example string) *olmv1alpha1.ClusterServiceVersion {
func ClusterServiceVersion(name, packageName, namespace, example string) *olmv1alpha1.ClusterServiceVersion {
return &olmv1alpha1.ClusterServiceVersion{
ObjectMeta: metav1.ObjectMeta{
Name: name,
Namespace: namespace,
Annotations: map[string]string{
"alm-examples": example,
},
Labels: map[string]string{
"operators.coreos.com/" + packageName + "." + namespace: "",
},
},
Spec: olmv1alpha1.ClusterServiceVersionSpec{
InstallStrategy: olmv1alpha1.NamedInstallStrategy{
Expand Down