URL aliases

Author: Jelle Dijkstra

api/v3/shared_types.go

@@ -48,6 +48,7 @@ type WMSWFS interface {
 
 	// URLPath returns the configured service URL
 	URL() smoothoperatormodel.URL
+	IngressRouteURLs() smoothoperatormodel.IngressRouteURLs
 
 	GeoPackages() []*Gpkg
 

api/v3/shared_validation.go

@@ -11,6 +11,13 @@ func ValidateUpdate[W WMSWFS](newW, oldW W, validate func(W, *[]string, *field.E
 	warnings := []string{}
 	allErrs := field.ErrorList{}
 
+	// Check that the ingressRouteUrls contain the base url and no urls have been removed
+	err := sharedValidation.ValidateIngressRouteURLsContainsBaseURL(newW.IngressRouteURLs(), newW.URL(), nil)
+	if err != nil {
+		allErrs = append(allErrs, err)
+	}
+	sharedValidation.ValidateIngressRouteURLsNotRemoved(oldW.IngressRouteURLs(), newW.IngressRouteURLs(), &allErrs, nil)
+
 	sharedValidation.ValidateLabelsOnUpdate(oldW.GetLabels(), newW.GetLabels(), &allErrs)
 
 	path := field.NewPath("spec").Child("service").Child("url")

api/v3/wfs_types.go

@@ -70,6 +70,7 @@ func init() {
 }
 
 // WFSSpec vertegenwoordigt de hoofdstruct voor de YAML-configuratie
+// +kubebuilder:validation:XValidation:rule="!has(self.ingressRouteUrls) || self.ingressRouteUrls.exists_one(x, x.url == self.service.url)",messageExpression="'ingressRouteUrls should include service.url '+self.service.url"
 type WFSSpec struct {
 	// Optional lifecycle settings
 	Lifecycle *smoothoperatormodel.Lifecycle `json:"lifecycle,omitempty"`
@@ -86,6 +87,10 @@ type WFSSpec struct {
 	// Custom healthcheck options
 	HealthCheck *HealthCheckWFS `json:"healthCheck,omitempty"`
 
+	// Optional list of URLs where the service can be reached
+	// By default only the spec.service.url is used
+	IngressRouteURLs smoothoperatormodel.IngressRouteURLs `json:"ingressRouteUrls,omitempty"`
+
 	// service configuration
 	Service WFSService `json:"service"`
 }
@@ -299,3 +304,11 @@ func (wfs *WFS) ReadinessQueryString() (string, string, error) {
 
 	return "SERVICE=WFS&VERSION=2.0.0&REQUEST=GetFeature&TYPENAMES=" + wfs.Spec.Service.FeatureTypes[0].Name + "&STARTINDEX=0&COUNT=1", "text/xml", nil
 }
+
+func (wfs *WFS) IngressRouteURLs() smoothoperatormodel.IngressRouteURLs {
+	if len(wfs.Spec.IngressRouteURLs) == 0 {
+		return smoothoperatormodel.IngressRouteURLs{{URL: wfs.Spec.Service.URL}}
+	}
+
+	return wfs.Spec.IngressRouteURLs
+}

api/v3/wfs_validation.go

@@ -21,6 +21,11 @@ func (wfs *WFS) ValidateCreate() ([]string, error) {
 		allErrs = append(allErrs, err)
 	}
 
+	err = sharedValidation.ValidateIngressRouteURLsContainsBaseURL(wfs.Spec.IngressRouteURLs, wfs.URL(), nil)
+	if err != nil {
+		allErrs = append(allErrs, err)
+	}
+
 	ValidateWFS(wfs, &warnings, &allErrs)
 
 	if len(allErrs) == 0 {

api/v3/wms_types.go

@@ -49,6 +49,7 @@ const (
 // NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.
 
 // WMSSpec defines the desired state of WMS.
+// +kubebuilder:validation:XValidation:rule="!has(self.ingressRouteUrls) || self.ingressRouteUrls.exists_one(x, x.url == self.service.url)",messageExpression="'ingressRouteUrls should include service.url '+self.service.url"
 type WMSSpec struct {
 	// Optional lifecycle settings
 	Lifecycle *smoothoperatormodel.Lifecycle `json:"lifecycle,omitempty"`
@@ -69,6 +70,10 @@ type WMSSpec struct {
 	// Custom healthcheck options
 	HealthCheck *HealthCheckWMS `json:"healthCheck,omitempty"`
 
+	// Optional list of URLs where the service can be reached
+	// By default only the spec.service.url is used
+	IngressRouteURLs smoothoperatormodel.IngressRouteURLs `json:"ingressRouteUrls,omitempty"`
+
 	// Service specification
 	Service WMSService `json:"service"`
 }
@@ -669,3 +674,11 @@ func (wms *WMS) ReadinessQueryString() (string, string, error) {
 
 	return fmt.Sprintf("SERVICE=WMS&VERSION=1.3.0&REQUEST=GetMap&BBOX=%s&CRS=EPSG:28992&WIDTH=100&HEIGHT=100&LAYERS=%s&STYLES=&FORMAT=image/png", wms.HealthCheckBBox(), firstDataLayerName), "image/png", nil
 }
+
+func (wms *WMS) IngressRouteURLs() smoothoperatormodel.IngressRouteURLs {
+	if len(wms.Spec.IngressRouteURLs) == 0 {
+		return smoothoperatormodel.IngressRouteURLs{{URL: wms.Spec.Service.URL}}
+	}
+
+	return wms.Spec.IngressRouteURLs
+}

api/v3/wms_validation.go

@@ -21,6 +21,11 @@ func (wms *WMS) ValidateCreate() ([]string, error) {
 		allErrs = append(allErrs, err)
 	}
 
+	err = sharedValidation.ValidateIngressRouteURLsContainsBaseURL(wms.Spec.IngressRouteURLs, wms.URL(), nil)
+	if err != nil {
+		allErrs = append(allErrs, err)
+	}
+
 	ValidateWMS(wms, &warnings, &allErrs)
 
 	if len(allErrs) == 0 {

api/v3/zz_generated.deepcopy.go

@@ -1061,6 +1061,21 @@ spec:
                 required:
                 - maxReplicas
                 type: object
+              ingressRouteUrls:
+                description: |-
+                  Optional list of URLs where the service can be reached
+                  By default only the spec.service.url is used
+                items:
+                  properties:
+                    url:
+                      pattern: ^https?://.+/.+
+                      type: string
+                  required:
+                  - url
+                  type: object
+                maxItems: 30
+                minItems: 1
+                type: array
               lifecycle:
                 description: Optional lifecycle settings
                 properties:
@@ -1555,6 +1570,10 @@ spec:
             - podSpecPatch
             - service
             type: object
+            x-kubernetes-validations:
+            - messageExpression: '''ingressRouteUrls should include service.url ''+self.service.url'
+              rule: '!has(self.ingressRouteUrls) || self.ingressRouteUrls.exists_one(x,
+                x.url == self.service.url)'
           status:
             description: OperatorStatus defines the observed state of an Atom/WFS/WMS/....
             properties:

config/crd/bases/pdok.nl_wfs.yaml

@@ -1087,6 +1087,21 @@ spec:
                   required:
                     - maxReplicas
                   type: object
+                ingressRouteUrls:
+                  description: |-
+                    Optional list of URLs where the service can be reached
+                    By default only the spec.service.url is used
+                  items:
+                    properties:
+                      url:
+                        pattern: ^https?://.+/.+
+                        type: string
+                    required:
+                      - url
+                    type: object
+                  maxItems: 30
+                  minItems: 1
+                  type: array
                 lifecycle:
                   description: Optional lifecycle settings
                   properties:
@@ -2148,6 +2163,9 @@ spec:
                 - podSpecPatch
                 - service
               type: object
+              x-kubernetes-validations:
+                - messageExpression: '''ingressRouteUrls should include service.url ''+self.service.url'
+                  rule: '!has(self.ingressRouteUrls) || self.ingressRouteUrls.exists_one(x, x.url == self.service.url)'
             status:
               description: OperatorStatus defines the observed state of an Atom/WFS/WMS/....
               properties:

config/crd/bases/pdok.nl_wms.yaml

@@ -13,7 +13,7 @@ require (
 	github.com/pdok/featureinfo-generator v1.4.0-beta1
 	github.com/pdok/ogc-capabilities-generator v1.0.0-beta8
 	github.com/pdok/ogc-specifications v1.0.0-beta9
-	github.com/pdok/smooth-operator v0.1.1
+	github.com/pdok/smooth-operator v0.1.2
 	github.com/peterbourgon/ff v1.7.1
 	github.com/stretchr/testify v1.10.0
 	github.com/traefik/traefik/v3 v3.3.4