Skip to content

MLE-21691: fix bug for service not updated when added new port #92

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
merged 2 commits into from
Jun 17, 2025
Merged

MLE-21691: fix bug for service not updated when added new port #92

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7c66692
MLE-21691: fix bug for service not updated when added new port
Jun 17, 2025
1b316a9
Fix Labels
Jun 17, 2025
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
89 changes: 38 additions & 51 deletions pkg/k8sutil/service.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package k8sutil
import (
"strings"

"github.com/cisco-open/k8s-objectmatcher/patch"
Copy link
Preview

Copilot AI Jun 17, 2025

Choose a reason for hiding this comment

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

[nitpick] Consider reorganizing imports to follow the project's style guide (e.g., grouping standard library, third-party, and local imports separately) for consistency.

Copilot uses AI. Check for mistakes.

corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
Expand All @@ -14,13 +15,15 @@ import (
)

type serviceParameters struct {
StsName string
Ports []corev1.ServicePort
Type corev1.ServiceType
Annotations map[string]string
}

func generateServiceParams(cr *marklogicv1.MarklogicGroup) serviceParameters {
return serviceParameters{
StsName: cr.Spec.Name,
Type: cr.Spec.Service.Type,
Ports: cr.Spec.Service.AdditionalPorts,
Annotations: cr.Spec.Service.Annotations,
Expand Down Expand Up @@ -71,7 +74,7 @@ func generateServicePorts() []corev1.ServicePort {
func generateServiceDef(serviceMeta metav1.ObjectMeta, ownerRef metav1.OwnerReference, params serviceParameters) *corev1.Service {
var svcSpec corev1.ServiceSpec
svcSpec = corev1.ServiceSpec{
Selector: serviceMeta.GetLabels(),
Selector: getSelectorLabels(params.StsName),
Ports: append(params.Ports, generateServicePorts()...),
}
if strings.HasSuffix(serviceMeta.Name, "-cluster") {
Expand All @@ -92,44 +95,11 @@ func generateServiceDef(serviceMeta metav1.ObjectMeta, ownerRef metav1.OwnerRefe
return service
}

func (oc *OperatorContext) getService(namespace string, serviceName string) (*corev1.Service, error) {
logger := oc.ReqLogger

var serviceInfo *corev1.Service
err := oc.Client.Get(oc.Ctx, types.NamespacedName{Name: serviceName, Namespace: namespace}, serviceInfo)
if err != nil {
logger.Info("MarkLogic service get action is failed")
return nil, err
}
logger.Info("MarkLogic service get action is successful")
return serviceInfo, nil
}

func (oc *OperatorContext) CreateOrUpdateService(namespace string, serviceMeta metav1.ObjectMeta, ownerDef metav1.OwnerReference) error {
logger := oc.ReqLogger
serviceDef := generateServiceDef(serviceMeta, ownerDef, serviceParameters{})
_, err := oc.getService(namespace, serviceMeta.Name)
if err != nil {
if errors.IsNotFound(err) {
logger.Info("MarkLogic service is not found, creating a new one")
err = oc.createService(namespace, serviceDef)
if err != nil {
logger.Info("MarkLogic service creation is failed")
return err
}
logger.Info("MarkLogic service creation is successful")
return nil
}
return err
}
return nil
}

func generateService(svcName string, cr *marklogicv1.MarklogicGroup) *corev1.Service {
labels := getCommonLabels(cr.Spec.Name)
var svcParams serviceParameters = serviceParameters{}
svcObjectMeta := generateObjectMeta(svcName, cr.Namespace, labels, svcParams.Annotations)
svcParams = generateServiceParams(cr)
svcObjectMeta := generateObjectMeta(svcName, cr.Namespace, labels, svcParams.Annotations)
service := generateServiceDef(svcObjectMeta, marklogicServerAsOwner(cr), svcParams)
return service
}
Expand All @@ -139,18 +109,21 @@ func (oc *OperatorContext) ReconcileServices() result.ReconcileResult {
logger.Info("service::Reconciling MarkLogic Service")
client := oc.Client
cr := oc.MarklogicGroup
svc := &corev1.Service{}
currentSvc := &corev1.Service{}
headlessSvcName := cr.Spec.Name
svcName := cr.Spec.Name + "-cluster"
services := []string{headlessSvcName, svcName}
for _, service := range services {
svcNsName := types.NamespacedName{Name: service, Namespace: cr.Namespace}
err := client.Get(oc.Ctx, svcNsName, svc)
err := client.Get(oc.Ctx, svcNsName, currentSvc)
svcDef := generateService(service, cr)
if err != nil {
if errors.IsNotFound(err) {
logger.Info("MarkLogic service not found, creating a new one")
svc = generateService(service, cr)
err = client.Create(oc.Ctx, svc)
if err := patch.DefaultAnnotator.SetLastAppliedAnnotation(svcDef); err != nil {
logger.Error(err, "Failed to set last applied annotation for MarkLogic service")
}
err = client.Create(oc.Ctx, svcDef)
if err != nil {
logger.Info("MarkLogic service creation has failed")
return result.Error(err)
Expand All @@ -160,19 +133,33 @@ func (oc *OperatorContext) ReconcileServices() result.ReconcileResult {
logger.Error(err, "MarkLogic service creation has failed")
return result.Error(err)
}
} else {
patchDiff, err := patch.DefaultPatchMaker.Calculate(currentSvc, svcDef,
patch.IgnoreStatusFields(),
patch.IgnoreVolumeClaimTemplateTypeMetaAndStatus(),
patch.IgnoreField("kind"))

if err != nil {
logger.Error(err, "Error calculating patch")
return result.Error(err)
}
if !patchDiff.IsEmpty() {
logger.Info("MarkLogic service spec is different from the MarkLogicGroup spec, updating the service")
currentSvc.Spec = svcDef.Spec
currentSvc.ObjectMeta.Annotations = svcDef.ObjectMeta.Annotations
currentSvc.ObjectMeta.Labels = svcDef.ObjectMeta.Labels
if err := patch.DefaultAnnotator.SetLastAppliedAnnotation(currentSvc); err != nil {
logger.Error(err, "Failed to set last applied annotation for MarkLogic service")
}
err := oc.Client.Update(oc.Ctx, currentSvc)
if err != nil {
logger.Error(err, "Error updating MarkLogic service")
return result.Error(err)
}
} else {
logger.Info("MarkLogic service spec is the same")
}
}
}
return result.Continue()
}

func (oc *OperatorContext) createService(namespace string, service *corev1.Service) error {
logger := oc.ReqLogger
client := oc.Client
err := client.Create(oc.Ctx, service)
if err != nil {
logger.Error(err, "MarkLogic service creation has failed")
return err
}
logger.Info("MarkLogic service creation is successful")
return nil
}