Add configurable API Timeouts

This patch adds an `apiTimeout` field to the `SwiftProxySpecCore` to
allow human operators to simultaneously configure the timeouts for
HAProxy and Apache. The `apiTimeout` defaults to 60 seconds to mimic the
behavior present in OSP17.

Jira: https://issues.redhat.com/browse/OSPRH-10957

Signed-off-by: Christian Schwede <cschwede@redhat.com>

Author: cschwede

api/bases/swift.openstack.org_swiftproxies.yaml

@@ -52,6 +52,12 @@ spec:
           spec:
             description: SwiftProxySpec defines the desired state of SwiftProxy
             properties:
+              apiTimeout:
+                default: 60
+                description: Default APITimeout for HAProxy and Apache, defaults to
+                  60 seconds
+                minimum: 1
+                type: integer
               ceilometerEnabled:
                 default: false
                 description: Enables ceilometer in the swift proxy and creates required

api/bases/swift.openstack.org_swifts.yaml

@@ -86,6 +86,12 @@ spec:
                 description: SwiftProxy - Spec definition for the Proxy service of
                   this Swift deployment
                 properties:
+                  apiTimeout:
+                    default: 60
+                    description: Default APITimeout for HAProxy and Apache, defaults
+                      to 60 seconds
+                    minimum: 1
+                    type: integer
                   ceilometerEnabled:
                     default: false
                     description: Enables ceilometer in the swift proxy and creates

api/v1beta1/swift_types.go

@@ -29,6 +29,9 @@ const (
 	ContainerImageContainer = "quay.io/podified-antelope-centos9/openstack-swift-container:current-podified"
 	ContainerImageObject    = "quay.io/podified-antelope-centos9/openstack-swift-object:current-podified"
 	ContainerImageProxy     = "quay.io/podified-antelope-centos9/openstack-swift-proxy-server:current-podified"
+
+	// ProxyAPITimeoutDefault  - Default timeout in seconds for HAProxy and Apache
+	ProxyAPITimeout = 60
 )
 
 // SwiftSpec defines the desired state of Swift

api/v1beta1/swift_webhook.go

@@ -37,6 +37,7 @@ type SwiftDefaults struct {
 	ContainerContainerImageURL string
 	ObjectContainerImageURL    string
 	ProxyContainerImageURL     string
+	ProxyAPITimeout int
 }
 
 var swiftDefaults SwiftDefaults
@@ -100,6 +101,10 @@ func (spec *SwiftSpec) Default() {
 	if spec.SwiftProxy.ContainerImageProxy == "" {
 		spec.SwiftProxy.ContainerImageProxy = swiftDefaults.ProxyContainerImageURL
 	}
+
+    if spec.SwiftProxy.APITimeout == 0 {
+        spec.SwiftProxy.APITimeout = swiftDefaults.ProxyAPITimeout
+    }
 }
 
 // Default - set defaults for this Swift core spec (this version is used by OpenStackControlplane webhooks)
@@ -312,3 +317,29 @@ func (spec *SwiftSpec) ValidateSwiftTopology(basePath *field.Path, namespace str
 
 	return allErrs
 }
+
+// SetDefaultRouteAnnotations sets HAProxy timeout values of the route
+func (spec *SwiftSpecCore) SetDefaultRouteAnnotations(annotations map[string]string) {
+	const haProxyAnno = "haproxy.router.openshift.io/timeout"
+	// Use a custom annotation to flag when the operator has set the default HAProxy timeout
+	// With the annotation func determines when to overwrite existing HAProxy timeout with the APITimeout
+	const swiftAnno = "api.swift.openstack.org/timeout"
+
+	valSwift, okSwift := annotations[swiftAnno]
+	valHAProxy, okHAProxy := annotations[haProxyAnno]
+
+	// Human operator set the HAProxy timeout manually
+	if !okSwift && okHAProxy {
+		return
+	}
+
+	// Human operator modified the HAProxy timeout manually without removing the Swift flag
+	if okSwift && okHAProxy && valSwift != valHAProxy {
+		delete(annotations, swiftAnno)
+		return
+	}
+
+	timeout := fmt.Sprintf("%ds", spec.SwiftProxy.APITimeout)
+	annotations[swiftAnno] = timeout
+	annotations[haProxyAnno] = timeout
+}

api/v1beta1/swiftproxy_types.go

@@ -113,6 +113,11 @@ type SwiftProxySpecCore struct {
 	// by name
 	TopologyRef *topologyv1.TopoRef `json:"topologyRef,omitempty"`
 
+	// +kubebuilder:default=60
+	// +kubebuilder:validation:Minimum=1
+	// Default APITimeout for HAProxy and Apache, defaults to 60 seconds
+	APITimeout int `json:"apiTimeout,omitempty"`
+
 	// +kubebuilder:validation:Optional
 	// +kubebuilder:default={swift-ring-files}
 	// +listType=atomic

config/crd/bases/swift.openstack.org_swiftproxies.yaml

@@ -52,6 +52,12 @@ spec:
           spec:
             description: SwiftProxySpec defines the desired state of SwiftProxy
             properties:
+              apiTimeout:
+                default: 60
+                description: Default APITimeout for HAProxy and Apache, defaults to
+                  60 seconds
+                minimum: 1
+                type: integer
               ceilometerEnabled:
                 default: false
                 description: Enables ceilometer in the swift proxy and creates required

config/crd/bases/swift.openstack.org_swifts.yaml

@@ -86,6 +86,12 @@ spec:
                 description: SwiftProxy - Spec definition for the Proxy service of
                   this Swift deployment
                 properties:
+                  apiTimeout:
+                    default: 60
+                    description: Default APITimeout for HAProxy and Apache, defaults
+                      to 60 seconds
+                    minimum: 1
+                    type: integer
                   ceilometerEnabled:
                     default: false
                     description: Enables ceilometer in the swift proxy and creates

controllers/swiftproxy_controller.go

@@ -582,6 +582,7 @@ func (r *SwiftProxyReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 		secretRef,
 		os.GetRegion(),
 		transportURLString,
+		instance.Spec.APITimeout,
 	)
 	err = secret.EnsureSecrets(ctx, helper, instance, tpl, &envVars)
 	if err != nil {

pkg/swiftproxy/templates.go

@@ -38,6 +38,7 @@ func SecretTemplates(
 	secretRef string,
 	keystoneRegion string,
 	transportURL string,
+	apiTimeout int,
 ) []util.Template {
 	templateParameters := make(map[string]interface{})
 	templateParameters["ServiceUser"] = instance.Spec.ServiceUser
@@ -50,6 +51,7 @@ func SecretTemplates(
 	templateParameters["SecretRef"] = secretRef
 	templateParameters["KeystoneRegion"] = keystoneRegion
 	templateParameters["TransportURL"] = transportURL
+	templateParameters["APITimeout"] = apiTimeout
 
 	// MTLS params
 	if mc.Status.MTLSCert != "" {

templates/swiftproxy/config/httpd.conf

@@ -22,6 +22,8 @@ SetEnvIf X-Forwarded-For "^.*\..*\..*\..*" forwarded
 CustomLog /dev/stdout combined env=!forwarded
 CustomLog /dev/stdout proxy env=forwarded
 
+TimeOut {{ .APITimeout }}
+
 {{ range $endpt, $vhost := .VHosts }}
 # {{ $endpt }} vhost {{ $vhost.ServerName }} configuration
 <VirtualHost *:8080>