Skip to content
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

Jump to bottom

Clean up Endpoint kind of ResourceExport #3652

Merged
merged 1 commit into from Apr 26, 2022
Merged

Clean up Endpoint kind of ResourceExport #3652

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
32 changes: 17 additions & 15 deletions multicluster/controllers/multicluster/serviceexport_controller.go
View file
Open in desktop
Expand Up @@ -185,41 +185,43 @@ func (r *ServiceExportReconciler) Reconcile(ctx context.Context, req ctrl.Reques
r.leaderNamespace = remoteCluster.GetNamespace()
r.leaderClusterID = string(remoteCluster.GetClusterID())

svc := &corev1.Service{}
if err := r.Client.Get(ctx, req.NamespacedName, &svcExport); err != nil {
klog.V(2).ErrorS(err, "Unable to fetch ServiceExport", "serviceexport", req.String())
if !apierrors.IsNotFound(err) {
return ctrl.Result{}, err
}
cleanup := func() error {
if svcInstalled {
err = r.handleServiceDeleteEvent(ctx, req, remoteCluster)
if err != nil {
return ctrl.Result{}, err
return err
}
r.installedSvcs.Delete(svcObj)
}

if epInstalled {
err = r.handleEndpointDeleteEvent(ctx, req, remoteCluster)
if err != nil {
return ctrl.Result{}, err
return err
}
r.installedEps.Delete(epObj)
}
return nil
}

if err := r.Client.Get(ctx, req.NamespacedName, &svcExport); err != nil {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need a Get call? If we watch ServiceExport, then we should have a Lister to get the ServiceExport from cache?

The same question for other Gets in this file.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's limited by the the whole framework which is generated by kube-builder. It doesn't provide a Lister. If we write our own controller to watch events, we may use a Lister.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you saying all kube-builder controllers act like this? But a Get call is expensive.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, the main logic is in Reconcile(ctx context.Context, req ctrl.Request). https://book.kubebuilder.io/cronjob-tutorial/controller-overview.html
I think the manager optimize the scenario and use cache by default.

Reconcile actually performs the reconciling for a single named object. Our [Request](https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/reconcile?tab=doc#Request) just has a name, but we can use the client to fetch that object from the cache.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok. Seems the client indeed reads from cache.

if !apierrors.IsNotFound(err) {
klog.ErrorS(err, "Unable to fetch ServiceExport", "serviceexport", req.String())
return ctrl.Result{}, err
}
if err := cleanup(); err != nil {
jianjuns marked this conversation as resolved.
Show resolved Hide resolved
return ctrl.Result{}, err
}
return ctrl.Result{}, nil
}

// if corresponding Service doesn't exist, update ServiceExport's status reason to not_found_service,
// and clean up remote ResourceExport if it's an installed Service.
svc := &corev1.Service{}
err = r.Client.Get(ctx, req.NamespacedName, svc)
if err != nil {
if apierrors.IsNotFound(err) {
if svcInstalled {
err = r.handleServiceDeleteEvent(ctx, req, remoteCluster)
if err != nil {
return ctrl.Result{}, err
}
r.installedSvcs.Delete(svcObj)
if err := cleanup(); err != nil {
return ctrl.Result{}, err
}
err = r.updateSvcExportStatus(ctx, req, notFound)
if err != nil {
Expand Down
65 changes: 65 additions & 0 deletions multicluster/test/integration/serviceexport_controller_test.go
View file
Open in desktop
Expand Up @@ -230,4 +230,69 @@ var _ = Describe("ServiceExport controller", func() {
return apierrors.IsNotFound(err)
}, timeout, interval).Should(BeTrue())
})

It("Should update existing ServiceExport status when corresponding Service is removed", func() {
By("By deleting a Service")
svc := &corev1.Service{
ObjectMeta: metav1.ObjectMeta{
Name: "nginx-svc-deleted",
Namespace: testNamespace,
},
Spec: svcSpec,
}
ep := &corev1.Endpoints{
ObjectMeta: metav1.ObjectMeta{
Name: "nginx-svc-deleted",
Namespace: testNamespace,
},
Subsets: []corev1.EndpointSubset{
{
Addresses: []corev1.EndpointAddress{
{
IP: "192.168.170.11",
Hostname: "pod1",
},
},
Ports: epPorts,
},
},
}
svcResExportName := LocalClusterID + "-" + svc.Namespace + "-" + svc.Name + "-service"
epResExportName := LocalClusterID + "-" + ep.Namespace + "-" + ep.Name + "-endpoints"

svcExportDeletedService := &k8smcsv1alpha1.ServiceExport{
ObjectMeta: metav1.ObjectMeta{
Name: "nginx-svc-deleted",
Namespace: testNamespace,
},
}
Expect(k8sClient.Create(ctx, svc)).Should(Succeed())
Expect(k8sClient.Create(ctx, ep)).Should(Succeed())
Expect(k8sClient.Create(ctx, svcExportDeletedService)).Should(Succeed())
time.Sleep(2 * time.Second)

err := k8sClient.Delete(ctx, svc)
Expect(err).ToNot(HaveOccurred())
time.Sleep(2 * time.Second)

latestsvcExportDeletedService := &k8smcsv1alpha1.ServiceExport{}
err = k8sClient.Get(ctx, types.NamespacedName{
Namespace: svcExportDeletedService.Namespace,
Name: svcExportDeletedService.Name,
}, latestsvcExportDeletedService)
Expect(err).ToNot(HaveOccurred())
conditions := latestsvcExportDeletedService.Status.Conditions
Expect(len(conditions)).Should(Equal(1))
Expect(*conditions[0].Message).Should(Equal("the Service does not exist"))

resExp := &mcsv1alpha1.ResourceExport{}
Eventually(func() bool {
err = k8sClient.Get(ctx, types.NamespacedName{Namespace: LeaderNamespace, Name: svcResExportName}, resExp)
return apierrors.IsNotFound(err)
}, timeout, interval).Should(BeTrue())
Eventually(func() bool {
err = k8sClient.Get(ctx, types.NamespacedName{Namespace: LeaderNamespace, Name: epResExportName}, resExp)
return apierrors.IsNotFound(err)
}, timeout, interval).Should(BeTrue())
})
})