Improved uptime-operator annotations

Author: Jelle Dijkstra

api/v3/shared_types.go

@@ -1,10 +1,6 @@
 package v3
 
 import (
-	//nolint:gosec
-	"crypto/sha1"
-	"encoding/hex"
-	"io"
 	"net/url"
 	"strings"
 
@@ -45,14 +41,20 @@ type WMSWFS interface {
 	PodSpecPatch() *corev1.PodSpec
 	HorizontalPodAutoscalerPatch() *HorizontalPodAutoscalerPatch
 	Type() ServiceType
+	TypedName() string
 	Options() Options
 	HasPostgisData() bool
-	// Sha1 hash of the objects name
-	ID() string
+
 	// URLPath returns the configured service URL
 	URLPath() string
 
 	GeoPackages() []*Gpkg
+
+	ReadinessQueryString() (string, error)
+
+	// TODO implement healthcheck in CR
+	// StartUpQueryString() string
+	// LivenessQueryString() string
 }
 
 // Mapfile references a ConfigMap key where an external mapfile is stored.
@@ -260,12 +262,6 @@ func GetBaseURLPath[T WMSWFS](o T) string {
 	return strings.TrimPrefix(parsed.Path, "/")
 }
 
-func GetBaseURLPathWithoutTypeAndVersion[T WMSWFS](o T) string {
-	serviceURL := o.URLPath()
-	parsed, _ := url.Parse(serviceURL)
-	return strings.TrimPrefix(parsed.Path, "/")
-}
-
 func (d *Data) GetColumns() *[]Column {
 	switch {
 	case d.Gpkg != nil:
@@ -299,14 +295,6 @@ func (d *Data) GetGeometryType() *string {
 	}
 }
 
-func Sha1HashOfName[O WMSWFS](obj O) string {
-	//nolint:gosec
-	s := sha1.New()
-	_, _ = io.WriteString(s, obj.GetName())
-
-	return hex.EncodeToString(s.Sum(nil))
-}
-
 func (o Options) UseWebserviceProxy() bool {
 	// options.DisableWebserviceProxy not set or false
 	return !o.DisableWebserviceProxy

api/v3/wfs_types.go

@@ -25,7 +25,9 @@ SOFTWARE.
 package v3
 
 import (
+	"errors"
 	"slices"
+	"strings"
 
 	shared_model "github.com/pdok/smooth-operator/model"
 	corev1 "k8s.io/api/core/v1"
@@ -233,6 +235,17 @@ func (wfs *WFS) Type() ServiceType {
 	return ServiceTypeWFS
 }
 
+func (wfs *WFS) TypedName() string {
+	name := wfs.GetName()
+	typeSuffix := strings.ToLower(string(ServiceTypeWFS))
+
+	if strings.HasSuffix(name, typeSuffix) {
+		return name
+	}
+
+	return name + "-" + typeSuffix
+}
+
 func (wfs *WFS) PodSpecPatch() *corev1.PodSpec {
 	return wfs.Spec.PodSpecPatch
 }
@@ -249,10 +262,6 @@ func (wfs *WFS) Options() Options {
 	return *wfs.Spec.Options
 }
 
-func (wfs *WFS) ID() string {
-	return Sha1HashOfName(wfs)
-}
-
 func (wfs *WFS) URLPath() string {
 	return wfs.Spec.Service.URL
 }
@@ -268,3 +277,10 @@ func (wfs *WFS) GeoPackages() []*Gpkg {
 
 	return gpkgs
 }
+
+func (wfs *WFS) ReadinessQueryString() (string, error) {
+	if len(wfs.Spec.Service.FeatureTypes) == 0 {
+		return "nil", errors.New("cannot get readiness probe for WFS, featuretypes could not be found")
+	}
+	return "SERVICE=WFS&VERSION=2.0.0&REQUEST=GetFeature&TYPENAMES=" + wfs.Spec.Service.FeatureTypes[0].Name + "&STARTINDEX=0&COUNT=1", nil
+}

api/v3/wms_types.go

@@ -25,9 +25,12 @@ SOFTWARE.
 package v3
 
 import (
+	"errors"
+	"fmt"
 	"maps"
 	"slices"
 	"sort"
+	"strings"
 
 	"k8s.io/apimachinery/pkg/runtime/schema"
 
@@ -571,6 +574,17 @@ func (wms *WMS) Type() ServiceType {
 	return ServiceTypeWMS
 }
 
+func (wms *WMS) TypedName() string {
+	name := wms.GetName()
+	typeSuffix := strings.ToLower(string(ServiceTypeWMS))
+
+	if strings.HasSuffix(name, typeSuffix) {
+		return name
+	}
+
+	return name + "-" + typeSuffix
+}
+
 func (wms *WMS) PodSpecPatch() *corev1.PodSpec {
 	return wms.Spec.PodSpecPatch
 }
@@ -587,10 +601,6 @@ func (wms *WMS) Options() Options {
 	return *wms.Spec.Options
 }
 
-func (wms *WMS) ID() string {
-	return Sha1HashOfName(wms)
-}
-
 func (wms *WMS) URLPath() string {
 	return wms.Spec.Service.URL
 }
@@ -614,3 +624,24 @@ func (wms *WMS) GeoPackages() []*Gpkg {
 
 	return gpkgs
 }
+
+func (wms *WMS) HealthCheckBBox() string {
+	// TODO make dynamic
+	return "190061.4619730016857,462435.5987861062749,202917.7508707302331,473761.6884966178914"
+}
+
+func (wms *WMS) ReadinessQueryString() (string, error) {
+	// TODO implement healthcheck from CR
+	firstDataLayerName := ""
+	for _, layer := range wms.Spec.Service.GetAllLayers() {
+		if layer.IsDataLayer() {
+			firstDataLayerName = *layer.Name
+			break
+		}
+	}
+	if firstDataLayerName == "" {
+		return "", errors.New("cannot get readiness probe for WMS, the first datalayer could not be found")
+	}
+
+	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), nil
+}

cmd/main.go

@@ -92,6 +92,7 @@ func main() {
 	var multitoolImage, mapfileGeneratorImage, mapserverImage, capabilitiesGeneratorImage, featureinfoGeneratorImage, ogcWebserviceProxyImage, apacheExporterImage string
 	var slackWebhookURL string
 	var logLevel int
+	var setUptimeOperatorAnnotations bool
 	flag.StringVar(&metricsAddr, "metrics-bind-address", ":8080", "The address the metrics endpoint binds to. "+
 		"Use :8443 for HTTPS or :8080 for HTTP, or leave as 0 to disable the metrics service.")
 	flag.StringVar(&probeAddr, "health-probe-bind-address", ":8081", "The address the probe endpoint binds to.")
@@ -114,6 +115,7 @@ func main() {
 	flag.IntVar(&mapserverDebugLevel, "mapserver-debug-level", 0, "Debug level for the mapserver container, between 0 (error only) and 5 (very very verbose).")
 	flag.StringVar(&slackWebhookURL, "slack-webhook-url", "", "The webhook url for sending slack messages. Disabled if left empty")
 	flag.IntVar(&logLevel, "log-level", 0, "The zapcore loglevel. 0 = info, 1 = warn, 2 = error")
+	flag.BoolVar(&setUptimeOperatorAnnotations, "set-uptime-operator-annotations", true, "When enabled IngressRoutes get annotations that are used by the pdok/uptime-operator.")
 
 	opts := zap.Options{
 		Development: true,
@@ -137,6 +139,7 @@ func main() {
 	}
 	pdoknlv3.SetHost(host)
 	mapfilegenerator.SetDebugLevel(mapserverDebugLevel)
+	controller.SetUptimeOperatorAnnotations(setUptimeOperatorAnnotations)
 
 	// if the enable-http2 flag is false (the default), http/2 should be disabled
 	// due to its vulnerabilities. More specifically, disabling http/2 will

internal/controller/mapserver/deployment.go

@@ -23,8 +23,6 @@ const (
 	ConfigMapLegendGeneratorVolumeName       = "legend-generator-config"
 	ConfigMapFeatureinfoGeneratorVolumeName  = "featureinfo-generator-config"
 	ConfigMapStylingFilesVolumeName          = "styling-files"
-	// TODO How should we determine this boundingbox?
-	healthCheckBbox = "190061.4619730016857,462435.5987861062749,202917.7508707302331,473761.6884966178914"
 
 	mimeTextXML = "text/xml"
 )
@@ -361,26 +359,18 @@ func getLivenessProbe[O pdoknlv3.WMSWFS](obj O) *v1.Probe {
 }
 
 func getReadinessProbeForWFS(wfs *pdoknlv3.WFS) (*v1.Probe, error) {
-	if len(wfs.Spec.Service.FeatureTypes) == 0 {
-		return nil, errors.New("cannot get readiness probe for WFS, featuretypes could not be found")
+	queryString, err := wfs.ReadinessQueryString()
+	if err != nil {
+		return nil, err
 	}
-	queryString := "SERVICE=WFS&VERSION=2.0.0&REQUEST=GetFeature&TYPENAMES=" + wfs.Spec.Service.FeatureTypes[0].Name + "&STARTINDEX=0&COUNT=1"
 	return getProbe(queryString, mimeTextXML), nil
 }
 
 func getReadinessProbeForWMS(wms *pdoknlv3.WMS) (*v1.Probe, error) {
-	firstDataLayerName := ""
-	for _, layer := range wms.Spec.Service.GetAllLayers() {
-		if layer.IsDataLayer() {
-			firstDataLayerName = *layer.Name
-			break
-		}
+	queryString, err := wms.ReadinessQueryString()
+	if err != nil {
+		return nil, err
 	}
-	if firstDataLayerName == "" {
-		return nil, errors.New("cannot get readiness probe for WMS, the first datalayer could not be found")
-	}
-
-	queryString := "SERVICE=WMS&VERSION=1.3.0&REQUEST=GetMap&BBOX=" + healthCheckBbox + "&CRS=EPSG:28992&WIDTH=100&HEIGHT=100&LAYERS=" + firstDataLayerName + "&STYLES=&FORMAT=image/png"
 	mimeType := "image/png"
 
 	return getProbe(queryString, mimeType), nil
@@ -411,7 +401,7 @@ func getStartupProbeForWMS(wms *pdoknlv3.WMS) (*v1.Probe, error) {
 		return nil, errors.New("cannot get startup probe for WMS, layers could not be found")
 	}
 
-	queryString := "SERVICE=WMS&VERSION=1.3.0&REQUEST=GetMap&BBOX=" + healthCheckBbox + "&CRS=EPSG:28992&WIDTH=100&HEIGHT=100&LAYERS=" + strings.Join(layerNames, ",") + "&STYLES=&FORMAT=image/png"
+	queryString := "SERVICE=WMS&VERSION=1.3.0&REQUEST=GetMap&BBOX=" + wms.HealthCheckBBox() + "&CRS=EPSG:28992&WIDTH=100&HEIGHT=100&LAYERS=" + strings.Join(layerNames, ",") + "&STYLES=&FORMAT=image/png"
 	mimeType := "image/png"
 	return getProbe(queryString, mimeType), nil
 }