Skip to content

fix: identical endpoint name conflicts #1521

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

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Open

fix: identical endpoint name conflicts #1521

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
04aa51a
fix: identical endpoint name conflicts
akurinnoy Oct 2, 2025
08a1a5e
fixup! fix: identical endpoint name conflicts
akurinnoy Oct 8, 2025
88e0d3c
fixup! fixup! fix: identical endpoint name conflicts
akurinnoy Oct 8, 2025
d9682c9
chore: remove excecive defensive checks
akurinnoy Oct 8, 2025
4879878
chore: remove excessive logs.
akurinnoy Oct 9, 2025
dc0a395
chore: consistent error
akurinnoy Oct 9, 2025
c7ddd74
fixup! chore: consistent error
akurinnoy Oct 9, 2025
91f1014
fixup! fixup! chore: consistent error
akurinnoy Oct 9, 2025
9de6b51
fixup! fixup! fixup! chore: consistent error
akurinnoy Oct 9, 2025
338237f
chore: check terminating workspaces
akurinnoy Oct 9, 2025
654ee01
fixup! chore: check terminating workspaces
akurinnoy Oct 9, 2025
44d04a8
test: fix feedback
akurinnoy Oct 20, 2025
1ea13cf
fixup! test: fix feedback
akurinnoy Oct 20, 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
17 changes: 16 additions & 1 deletion controllers/controller/devworkspacerouting/devworkspacerouting_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ func (r *DevWorkspaceRoutingReconciler) Reconcile(ctx context.Context, req ctrl.
solver, err := r.SolverGetter.GetSolver(r.Client, instance.Spec.RoutingClass)
if err != nil {
if errors.Is(err, solvers.RoutingNotSupported) {
reqLogger.Info("Routing class not supported by this controller, skipping reconciliation", "routingClass", instance.Spec.RoutingClass)
return reconcile.Result{}, nil
}
return reconcile.Result{}, r.markRoutingFailed(instance, fmt.Sprintf("Invalid routingClass for DevWorkspace: %s", err))
Expand Down Expand Up @@ -131,7 +132,7 @@ func (r *DevWorkspaceRoutingReconciler) Reconcile(ctx context.Context, req ctrl.
}

restrictedAccess, setRestrictedAccess := instance.Annotations[constants.DevWorkspaceRestrictedAccessAnnotation]
routingObjects, err := solver.GetSpecObjects(instance, workspaceMeta)
routingObjects, err := solver.GetSpecObjects(instance, workspaceMeta, r.Client, reqLogger)
if err != nil {
var notReady *solvers.RoutingNotReady
if errors.As(err, &notReady) {
Expand All @@ -149,6 +150,12 @@ func (r *DevWorkspaceRoutingReconciler) Reconcile(ctx context.Context, req ctrl.
return reconcile.Result{}, r.markRoutingFailed(instance, fmt.Sprintf("Unable to provision networking for DevWorkspace: %s", invalid))
}

var conflict *solvers.ServiceConflictError
if errors.As(err, &conflict) {
reqLogger.Error(conflict, "Routing controller detected a service conflict", "serviceName", conflict.Reason)
return reconcile.Result{}, r.markRoutingFailed(instance, fmt.Sprintf("Unable to provision networking for DevWorkspace: %s", conflict))
}

// generic error, just fail the reconciliation
return reconcile.Result{}, err
}
Expand Down Expand Up @@ -208,6 +215,10 @@ func (r *DevWorkspaceRoutingReconciler) Reconcile(ctx context.Context, req ctrl.
if errors.As(err, &failError) {
return reconcile.Result{}, r.markRoutingFailed(instance, err.Error())
}
conflictErr := &solvers.HostnameConflictError{}
if errors.As(err, &conflictErr) {
return reconcile.Result{}, r.markRoutingFailed(instance, conflictErr.Error())
}
reqLogger.Error(err, "Error syncing routes")
return reconcile.Result{Requeue: true}, r.reconcileStatus(instance, nil, nil, false, "Preparing routes")
} else if !routesInSync {
Expand All @@ -222,6 +233,10 @@ func (r *DevWorkspaceRoutingReconciler) Reconcile(ctx context.Context, req ctrl.
if errors.As(err, &failError) {
return reconcile.Result{}, r.markRoutingFailed(instance, err.Error())
}
conflictErr := &solvers.HostnameConflictError{}
if errors.As(err, &conflictErr) {
return reconcile.Result{}, r.markRoutingFailed(instance, conflictErr.Error())
}
reqLogger.Error(err, "Error syncing ingresses")
return reconcile.Result{Requeue: true}, r.reconcileStatus(instance, nil, nil, false, "Preparing ingresses")
} else if !ingressesInSync {
Expand Down
10 changes: 8 additions & 2 deletions controllers/controller/devworkspacerouting/solvers/basic_solver.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ import (
"github.com/devfile/devworkspace-operator/pkg/config"
"github.com/devfile/devworkspace-operator/pkg/constants"
"github.com/devfile/devworkspace-operator/pkg/infrastructure"
"github.com/go-logr/logr"
"sigs.k8s.io/controller-runtime/pkg/client"
)

var routeAnnotations = func(endpointName string, endpointAnnotations map[string]string) map[string]string {
Expand Down Expand Up @@ -59,7 +61,7 @@ func (s *BasicSolver) Finalize(*controllerv1alpha1.DevWorkspaceRouting) error {
return nil
}

func (s *BasicSolver) GetSpecObjects(routing *controllerv1alpha1.DevWorkspaceRouting, workspaceMeta DevWorkspaceMetadata) (RoutingObjects, error) {
func (s *BasicSolver) GetSpecObjects(routing *controllerv1alpha1.DevWorkspaceRouting, workspaceMeta DevWorkspaceMetadata, cl client.Client, log logr.Logger) (RoutingObjects, error) {
routingObjects := RoutingObjects{}

// TODO: Use workspace-scoped ClusterHostSuffix to allow overriding
Expand All @@ -70,7 +72,11 @@ func (s *BasicSolver) GetSpecObjects(routing *controllerv1alpha1.DevWorkspaceRou

spec := routing.Spec
services := getServicesForEndpoints(spec.Endpoints, workspaceMeta)
services = append(services, GetDiscoverableServicesForEndpoints(spec.Endpoints, workspaceMeta)...)
discoverableServices, err := GetDiscoverableServicesForEndpoints(spec.Endpoints, workspaceMeta, cl, log)
if err != nil {
return RoutingObjects{}, err
}
services = append(services, discoverableServices...)
routingObjects.Services = services
if infrastructure.IsOpenShift() {
routingObjects.Routes = getRoutesForSpec(routingSuffix, spec.Endpoints, workspaceMeta)
Expand Down
9 changes: 8 additions & 1 deletion controllers/controller/devworkspacerouting/solvers/cluster_solver.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ import (
corev1 "k8s.io/api/core/v1"

controllerv1alpha1 "github.com/devfile/devworkspace-operator/apis/controller/v1alpha1"
"github.com/go-logr/logr"
"sigs.k8s.io/controller-runtime/pkg/client"
)

const (
Expand All @@ -44,9 +46,14 @@ func (s *ClusterSolver) Finalize(*controllerv1alpha1.DevWorkspaceRouting) error
return nil
}

func (s *ClusterSolver) GetSpecObjects(routing *controllerv1alpha1.DevWorkspaceRouting, workspaceMeta DevWorkspaceMetadata) (RoutingObjects, error) {
func (s *ClusterSolver) GetSpecObjects(routing *controllerv1alpha1.DevWorkspaceRouting, workspaceMeta DevWorkspaceMetadata, cl client.Client, log logr.Logger) (RoutingObjects, error) {
spec := routing.Spec
services := getServicesForEndpoints(spec.Endpoints, workspaceMeta)
discoverableServices, err := GetDiscoverableServicesForEndpoints(spec.Endpoints, workspaceMeta, cl, log)
if err != nil {
return RoutingObjects{}, err
}
services = append(services, discoverableServices...)
podAdditions := &controllerv1alpha1.PodAdditions{}
if s.TLS {
readOnlyMode := int32(420)
Expand Down
38 changes: 31 additions & 7 deletions controllers/controller/devworkspacerouting/solvers/common.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,15 @@
package solvers

import (
"context"
"fmt"

controllerv1alpha1 "github.com/devfile/devworkspace-operator/apis/controller/v1alpha1"
"github.com/devfile/devworkspace-operator/pkg/common"
"github.com/devfile/devworkspace-operator/pkg/constants"
"github.com/go-logr/logr"
"k8s.io/apimachinery/pkg/api/errors"
"sigs.k8s.io/controller-runtime/pkg/client"

routeV1 "github.com/openshift/api/route/v1"
corev1 "k8s.io/api/core/v1"
Expand All @@ -36,7 +42,7 @@ type DevWorkspaceMetadata struct {

// GetDiscoverableServicesForEndpoints converts the endpoint list into a set of services, each corresponding to a single discoverable
// endpoint from the list. Endpoints with the NoneEndpointExposure are ignored.
func GetDiscoverableServicesForEndpoints(endpoints map[string]controllerv1alpha1.EndpointList, meta DevWorkspaceMetadata) []corev1.Service {
func GetDiscoverableServicesForEndpoints(endpoints map[string]controllerv1alpha1.EndpointList, meta DevWorkspaceMetadata, cl client.Client, log logr.Logger) ([]corev1.Service, error) {
Copy link
Collaborator

@dkwon17 dkwon17 Nov 3, 2025

Choose a reason for hiding this comment

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

@akurinnoy is there a reason for implementing duplicate endpiont detection in both the webhook and the GetDiscoverableServicesForEndpoints function?

Copy link
Collaborator Author

@akurinnoy akurinnoy Nov 17, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

While the webhook prevents the DevWorkspaces (which will cause endpoint conflicts) from being created, the controller checks other cases:

  • two workspaces created simultaneously - both of them may pass the webhook validation
  • services can be created from other sources
  • old workspaces, created before this validation

Is this the answer to your question?

var services []corev1.Service
for _, machineEndpoints := range endpoints {
for _, endpoint := range machineEndpoints {
Expand All @@ -45,18 +51,36 @@ func GetDiscoverableServicesForEndpoints(endpoints map[string]controllerv1alpha1
}

if endpoint.Attributes.GetBoolean(string(controllerv1alpha1.DiscoverableAttribute), nil) {
// Create service with name matching endpoint
// TODO: This could cause a reconcile conflict if multiple workspaces define the same discoverable endpoint
// Also endpoint names may not be valid as service names
serviceName := common.EndpointName(endpoint.Name)
log.Info("Checking for existing service for discoverable endpoint", "serviceName", serviceName)
existingService := &corev1.Service{}
err := cl.Get(context.TODO(), client.ObjectKey{Name: serviceName, Namespace: meta.Namespace}, existingService)
if err != nil {
if !errors.IsNotFound(err) {
log.Error(err, "Failed to get service from cluster", "serviceName", serviceName)
return nil, err
}
log.Info("No existing service found", "serviceName", serviceName)
} else {
log.Info("Found existing service", "serviceName", serviceName)
if existingService.Labels[constants.DevWorkspaceIDLabel] != meta.DevWorkspaceId {
log.Info("Service conflict detected", "serviceName", serviceName, "existingWorkspaceId", existingService.Labels[constants.DevWorkspaceIDLabel], "currentWorkspaceId", meta.DevWorkspaceId)
return nil, &ServiceConflictError{
Reason: fmt.Sprintf("discoverable endpoint %s conflicts with existing service", endpoint.Name),
}
}
log.Info("Existing service is owned by the same workspace", "serviceName", serviceName)
}

servicePort := corev1.ServicePort{
Name: common.EndpointName(endpoint.Name),
Name: serviceName,
Protocol: corev1.ProtocolTCP,
Port: int32(endpoint.TargetPort),
TargetPort: intstr.FromInt(endpoint.TargetPort),
}
services = append(services, corev1.Service{
ObjectMeta: metav1.ObjectMeta{
Name: common.EndpointName(endpoint.Name),
Name: serviceName,
Namespace: meta.Namespace,
Labels: map[string]string{
constants.DevWorkspaceIDLabel: meta.DevWorkspaceId,
Expand All @@ -74,7 +98,7 @@ func GetDiscoverableServicesForEndpoints(endpoints map[string]controllerv1alpha1
}
}
}
return services
return services, nil
}

// GetServiceForEndpoints returns a single service that exposes all endpoints of given exposure types, possibly also including the discoverable types.
Expand Down
Loading
Loading