Merge pull request #282 from Akrog/apiTimeout

Add configurable API Timeouts
openstack-k8s-operators · Jun 7, 2024 · 84eee55 · 84eee55
2 parents bb1bd22 + 25d0900
commit 84eee55
Show file tree

Hide file tree

Showing 7 changed files with 46 additions and 0 deletions.
diff --git a/api/bases/manila.openstack.org_manilas.yaml b/api/bases/manila.openstack.org_manilas.yaml
@@ -36,6 +36,10 @@ spec:
             type: object
           spec:
             properties:
+              apiTimeout:
+                default: 60
+                minimum: 10
+                type: integer
               customServiceConfig:
                 default: '# add your customization here'
                 type: string

diff --git a/api/v1beta1/manila_types.go b/api/v1beta1/manila_types.go
@@ -115,6 +115,12 @@ type ManilaSpecBase struct {
 	// +kubebuilder:validation:Optional
 	// DBPurge parameters -
 	DBPurge DBPurge `json:"dbPurge,omitempty"`
+
+	// +kubebuilder:validation:Optional
+	// +kubebuilder:default=60
+	// +kubebuilder:validation:Minimum=10
+	// APITimeout for HAProxy, Apache, and rpc_response_timeout
+	APITimeout int `json:"apiTimeout"`
 }
 
 // ManilaStatus defines the observed state of Manila

diff --git a/api/v1beta1/manila_webhook.go b/api/v1beta1/manila_webhook.go
@@ -230,3 +230,29 @@ func (r *Manila) ValidateDelete() (admission.Warnings, error) {
 	// TODO(user): fill in your validation logic upon object deletion.
 	return nil, nil
 }
+
+// SetDefaultRouteAnnotations sets HAProxy timeout values of the route
+func (spec *ManilaSpecCore) 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 manilaAnno = "api.manila.openstack.org/timeout"
+
+	valManila, okManila := annotations[manilaAnno]
+	valHAProxy, okHAProxy := annotations[haProxyAnno]
+
+	// Human operator set the HAProxy timeout manually
+	if (!okManila && okHAProxy) {
+		return
+	}
+
+	// Human operator modified the HAProxy timeout manually without removing the Manila flag
+	if (okManila && okHAProxy && valManila != valHAProxy) {
+		delete(annotations, manilaAnno)
+		return
+	}
+
+	timeout := fmt.Sprintf("%ds", spec.APITimeout)
+	annotations[manilaAnno] = timeout
+	annotations[haProxyAnno] = timeout
+}
diff --git a/config/crd/bases/manila.openstack.org_manilas.yaml b/config/crd/bases/manila.openstack.org_manilas.yaml
@@ -36,6 +36,10 @@ spec:
             type: object
           spec:
             properties:
+              apiTimeout:
+                default: 60
+                minimum: 10
+                type: integer
               customServiceConfig:
                 default: '# add your customization here'
                 type: string

diff --git a/controllers/manila_controller.go b/controllers/manila_controller.go
@@ -893,6 +893,7 @@ func (r *ManilaReconciler) generateServiceConfig(
 			instance.Status.DatabaseHostname,
 			manila.DatabaseCRName),
 		"MemcachedServersWithInet": memcached.GetMemcachedServerListWithInetString(),
+		"TimeOut":                  instance.Spec.APITimeout,
 	}
 
 	// create httpd  vhost template parameters

diff --git a/templates/manila/config/00-config.conf b/templates/manila/config/00-config.conf
@@ -10,6 +10,9 @@ auth_strategy=keystone
 control_exchange=openstack
 api_paste_config=/etc/manila/api-paste.ini
 
+# Keep the RPC call timeout in sync with HAProxy and Apache timeouts
+rpc_response_timeout = {{ .TimeOut }}
+
 [cinder]
 [cors]
 

diff --git a/templates/manila/config/10-manila_wsgi.conf b/templates/manila/config/10-manila_wsgi.conf
@@ -14,6 +14,8 @@
     Require all granted
   </Directory>
 
+  Timeout {{ $.TimeOut }}
+
   ## Logging
   ErrorLog /dev/stdout
   ServerSignature Off