Add configurable API Timeouts

mumesan · mumesan · commit 484955dc3ef2 · 2025-01-17T17:02:39.000Z
diff --git a/api/bases/ironic.openstack.org_ironicapis.yaml b/api/bases/ironic.openstack.org_ironicapis.yaml
@@ -52,6 +52,11 @@ spec:
           spec:
             description: IronicAPISpec defines the desired state of IronicAPI
             properties:
+              apiTimeout:
+                default: 60
+                description: APITimeout for HAProxy, Apache
+                minimum: 10
+                type: integer
               containerImage:
                 description: ContainerImage - Ironic API Container Image
                 type: string
diff --git a/api/bases/ironic.openstack.org_ironicinspectors.yaml b/api/bases/ironic.openstack.org_ironicinspectors.yaml
@@ -52,6 +52,11 @@ spec:
           spec:
             description: IronicInspectorSpec defines the desired state of IronicInspector
             properties:
+              apiTimeout:
+                default: 60
+                description: APITimeout for HAProxy, Apache
+                minimum: 10
+                type: integer
               containerImage:
                 description: ContainerImage - Ironic Inspector Container Image
                 type: string
diff --git a/api/bases/ironic.openstack.org_ironics.yaml b/api/bases/ironic.openstack.org_ironics.yaml
@@ -48,6 +48,11 @@ spec:
           spec:
             description: IronicSpec defines the desired state of Ironic
             properties:
+              apiTimeout:
+                default: 60
+                description: APITimeout for HAProxy, Apache
+                minimum: 10
+                type: integer
               customServiceConfig:
                 default: '# add your customization here'
                 description: |-
@@ -545,6 +550,11 @@ spec:
                 description: IronicInspector - Spec definition for the inspector service
                   of this Ironic deployment
                 properties:
+                  apiTimeout:
+                    default: 60
+                    description: APITimeout for HAProxy, Apache
+                    minimum: 10
+                    type: integer
                   customServiceConfig:
                     default: '# add your customization here'
                     description: |-
diff --git a/api/v1beta1/ironic_types.go b/api/v1beta1/ironic_types.go
@@ -149,6 +149,12 @@ type IronicSpecCore struct {
 	// +kubebuilder:validation:Required
 	// +kubebuilder:default=""
 	StorageClass string `json:"storageClass"`
+
+	// +kubebuilder:validation:Optional
+	// +kubebuilder:default=60
+	// +kubebuilder:validation:Minimum=10
+	// APITimeout for HAProxy, Apache
+	APITimeout int `json:"apiTimeout"`
 }
 
 // IronicImages to specify container images required by all ironic services
diff --git a/api/v1beta1/ironic_webhook.go b/api/v1beta1/ironic_webhook.go
@@ -600,3 +600,29 @@ func (spec *IronicSpecCore) Default() {
 		spec.RPCTransport = "json-rpc"
 	}
 }
+
+// SetDefaultRouteAnnotations sets HAProxy timeout values of the route
+func (spec *IronicAPISpec) 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
+	// The annotation func determines when to overwrite existing HAProxy timeout with the APITimeout
+	const ironicAnno = "api.ironic.openstack.org/timeout"
+
+	valIronic, okIronic := annotations[ironicAnno]
+	valHAProxy, okHAProxy := annotations[haProxyAnno]
+
+	// Human operator sets the HAProxy timeout manually
+	if !okIronic && okHAProxy {
+		return
+	}
+
+	// Human operator modified the HAProxy timeout manually without removing the Ironic flag
+	if okIronic && okHAProxy && valIronic != valHAProxy {
+		delete(annotations, ironicAnno)
+		return
+	}
+
+	timeout := fmt.Sprintf("%ds", spec.APITimeout)
+	annotations[ironicAnno] = timeout
+	annotations[haProxyAnno] = timeout
+}
diff --git a/api/v1beta1/ironicapi_types.go b/api/v1beta1/ironicapi_types.go
@@ -105,6 +105,12 @@ type IronicAPISpec struct {
 	// +kubebuilder:validation:Optional
 	// KeystoneEndpoints - Internally used Keystone API endpoints
 	KeystoneEndpoints KeystoneEndpoints `json:"keystoneEndpoints"`
+
+	// +kubebuilder:validation:Optional
+	// +kubebuilder:default=60
+	// +kubebuilder:validation:Minimum=10
+	// APITimeout for HAProxy, Apache
+	APITimeout int `json:"apiTimeout"`
 }
 
 // IronicAPIStatus defines the observed state of IronicAPI
diff --git a/api/v1beta1/ironicinspector_types.go b/api/v1beta1/ironicinspector_types.go
@@ -111,6 +111,12 @@ type IronicInspectorTemplate struct {
 	// +operator-sdk:csv:customresourcedefinitions:type=spec
 	// TLS - Parameters related to the TLS
 	TLS tls.API `json:"tls,omitempty"`
+
+	// +kubebuilder:validation:Optional
+	// +kubebuilder:default=60
+	// +kubebuilder:validation:Minimum=10
+	// APITimeout for HAProxy, Apache
+	APITimeout int `json:"apiTimeout"`
 }
 
 // InspectorOverrideSpec to override the generated manifest of several child resources.
diff --git a/config/crd/bases/ironic.openstack.org_ironicapis.yaml b/config/crd/bases/ironic.openstack.org_ironicapis.yaml
@@ -52,6 +52,11 @@ spec:
           spec:
             description: IronicAPISpec defines the desired state of IronicAPI
             properties:
+              apiTimeout:
+                default: 60
+                description: APITimeout for HAProxy, Apache
+                minimum: 10
+                type: integer
               containerImage:
                 description: ContainerImage - Ironic API Container Image
                 type: string
diff --git a/config/crd/bases/ironic.openstack.org_ironicinspectors.yaml b/config/crd/bases/ironic.openstack.org_ironicinspectors.yaml
@@ -52,6 +52,11 @@ spec:
           spec:
             description: IronicInspectorSpec defines the desired state of IronicInspector
             properties:
+              apiTimeout:
+                default: 60
+                description: APITimeout for HAProxy, Apache
+                minimum: 10
+                type: integer
               containerImage:
                 description: ContainerImage - Ironic Inspector Container Image
                 type: string
diff --git a/config/crd/bases/ironic.openstack.org_ironics.yaml b/config/crd/bases/ironic.openstack.org_ironics.yaml
@@ -48,6 +48,11 @@ spec:
           spec:
             description: IronicSpec defines the desired state of Ironic
             properties:
+              apiTimeout:
+                default: 60
+                description: APITimeout for HAProxy, Apache
+                minimum: 10
+                type: integer
               customServiceConfig:
                 default: '# add your customization here'
                 description: |-
@@ -545,6 +550,11 @@ spec:
                 description: IronicInspector - Spec definition for the inspector service
                   of this Ironic deployment
                 properties:
+                  apiTimeout:
+                    default: 60
+                    description: APITimeout for HAProxy, Apache
+                    minimum: 10
+                    type: integer
                   customServiceConfig:
                     default: '# add your customization here'
                     description: |-
diff --git a/controllers/ironic_controller.go b/controllers/ironic_controller.go
@@ -828,6 +828,10 @@ func (r *IronicReconciler) apiDeploymentCreateOrUpdate(
 		IronicAPISpec.NodeSelector = instance.Spec.NodeSelector
 	}
 
+	if IronicAPISpec.APITimeout == 0 {
+		IronicAPISpec.APITimeout = instance.Spec.APITimeout
+	}
+
 	deployment := &ironicv1.IronicAPI{
 		ObjectMeta: metav1.ObjectMeta{
 			Name:      fmt.Sprintf("%s-api", instance.Name),
@@ -898,6 +902,7 @@ func (r *IronicReconciler) generateServiceConfigMaps(
 	}
 	templateParameters["Standalone"] = instance.Spec.Standalone
 	templateParameters["LogPath"] = ironic.LogPath
+	templateParameters["APITimeout"] = instance.Spec.APITimeout
 
 	databaseAccount := db.GetAccount()
 	dbSecret := db.GetSecret()
@@ -985,6 +990,10 @@ func (r *IronicReconciler) inspectorDeploymentCreateOrUpdate(
 		IronicInspectorSpec.NodeSelector = instance.Spec.NodeSelector
 	}
 
+	if IronicInspectorSpec.APITimeout == 0 {
+		IronicInspectorSpec.APITimeout = instance.Spec.APITimeout
+	}
+
 	deployment := &ironicv1.IronicInspector{
 		ObjectMeta: metav1.ObjectMeta{
 			Name:      fmt.Sprintf("%s-inspector", instance.Name),
diff --git a/controllers/ironicapi_controller.go b/controllers/ironicapi_controller.go
@@ -1011,6 +1011,7 @@ func (r *IronicAPIReconciler) generateServiceConfigMaps(
 			endptConfig["SSLCertificateFile"] = fmt.Sprintf("/etc/pki/tls/certs/%s.crt", endpt.String())
 			endptConfig["SSLCertificateKeyFile"] = fmt.Sprintf("/etc/pki/tls/private/%s.key", endpt.String())
 		}
+		endptConfig["TimeOut"] = instance.Spec.APITimeout
 		httpdVhostConfig[endpt.String()] = endptConfig
 	}
 	templateParameters["VHosts"] = httpdVhostConfig
diff --git a/controllers/ironicinspector_controller.go b/controllers/ironicinspector_controller.go
@@ -1450,6 +1450,7 @@ func (r *IronicInspectorReconciler) generateServiceConfigMaps(
 		httpdVhostConfig[endpt.String()] = endptConfig
 	}
 	templateParameters["VHosts"] = httpdVhostConfig
+	templateParameters["TimeOut"] = instance.Spec.APITimeout
 
 	cms := []util.Template{
 		// Scripts ConfigMap
diff --git a/templates/ironicapi/config/ironic-api-httpd.conf b/templates/ironicapi/config/ironic-api-httpd.conf
@@ -56,5 +56,7 @@ CustomLog /dev/stdout proxy env=forwarded
   WSGIProcessGroup {{ $endpt }}
   WSGIScriptAlias / "/var/www/cgi-bin/ironic/app"
   WSGIPassAuthorization On
+
+  TimeOut {{ $vhost.TimeOut }}
 </VirtualHost>
 {{ end }}
diff --git a/templates/ironicinspector/config/httpd.conf b/templates/ironicinspector/config/httpd.conf
@@ -53,5 +53,7 @@ CustomLog /dev/stdout proxy env=forwarded
   {{- else }}
   SetEnvIf X-Forwarded-Proto http HTTPS=0
   {{- end }}
+
+  Timeout {{ $.TimeOut }}
 </VirtualHost>
 {{ end }}
