Merge pull request #258 from omersch381/add_httpd_timeout

Add configurable httpd timeout

api/bases/designate.openstack.org_designateapis.yaml

@@ -52,6 +52,10 @@ spec:
           spec:
             description: DesignateAPISpec defines the desired state of DesignateAPI
             properties:
+              apiTimeout:
+                description: APITimeout for HAProxy and Apache defaults to DesignateSpecCore
+                  APITimeout (seconds)
+                type: integer
               backendMdnsServerProtocol:
                 description: |-
                   BackendTypeProtocol - Defines the backend protocol to be used between the designate-worker &

api/bases/designate.openstack.org_designates.yaml

@@ -48,6 +48,10 @@ spec:
           spec:
             description: DesignateAPISpec defines the desired state of DesignateAPI
             properties:
+              apiTimeout:
+                default: 120
+                description: Designate API timeout
+                type: integer
               backendMdnsServerProtocol:
                 description: |-
                   BackendTypeProtocol - Defines the backend protocol to be used between the designate-worker &
@@ -95,6 +99,10 @@ spec:
                 description: DesignateAPI - Spec definition for the API service of
                   this Designate deployment
                 properties:
+                  apiTimeout:
+                    description: APITimeout for HAProxy and Apache defaults to DesignateSpecCore
+                      APITimeout (seconds)
+                    type: integer
                   backendMdnsServerProtocol:
                     description: |-
                       BackendTypeProtocol - Defines the backend protocol to be used between the designate-worker &

api/v1beta1/common_types.go

@@ -17,7 +17,6 @@ limitations under the License.
 package v1beta1
 
 import (
-	"github.com/openstack-k8s-operators/lib-common/modules/common/util"
 	corev1 "k8s.io/api/core/v1"
 )
 
@@ -133,19 +132,3 @@ type PasswordSelector struct {
 	// Service - Selector to get the designate service password from the Secret
 	Service string `json:"service"`
 }
-
-// SetupDefaults - initializes any CRD field defaults based on environment variables (the defaulting mechanism itself is implemented via webhooks)
-func SetupDefaults() {
-	// Acquire environmental defaults and initialize Designate defaults with them
-	designateDefaults := DesignateDefaults{
-		APIContainerImageURL:          util.GetEnvVar("RELATED_IMAGE_DESIGNATE_API_IMAGE_URL_DEFAULT", DesignateAPIContainerImage),
-		CentralContainerImageURL:      util.GetEnvVar("RELATED_IMAGE_DESIGNATE_CENTRAL_IMAGE_URL_DEFAULT", DesignateCentralContainerImage),
-		MdnsContainerImageURL:         util.GetEnvVar("RELATED_IMAGE_DESIGNATE_MDNS_IMAGE_URL_DEFAULT", DesignateMdnsContainerImage),
-		ProducerContainerImageURL:     util.GetEnvVar("RELATED_IMAGE_DESIGNATE_PRODUCER_IMAGE_URL_DEFAULT", DesignateProducerContainerImage),
-		WorkerContainerImageURL:       util.GetEnvVar("RELATED_IMAGE_DESIGNATE_WORKER_IMAGE_URL_DEFAULT", DesignateWorkerContainerImage),
-		UnboundContainerImageURL:      util.GetEnvVar("RELATED_IMAGE_DESIGNATE_UNBOUND_IMAGE_URL_DEFAULT", DesignateUnboundContainerImage),
-		Backendbind9ContainerImageURL: util.GetEnvVar("RELATED_IMAGE_DESIGNATE_BACKENDBIND9_IMAGE_URL_DEFAULT", DesignateBackendbind9ContainerImage),
-	}
-
-	SetupDesignateDefaults(designateDefaults)
-}

api/v1beta1/designate_types.go

@@ -18,6 +18,7 @@ package v1beta1
 
 import (
 	condition "github.com/openstack-k8s-operators/lib-common/modules/common/condition"
+	"github.com/openstack-k8s-operators/lib-common/modules/common/util"
 	"github.com/openstack-k8s-operators/lib-common/modules/storage"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -29,6 +30,9 @@ const (
 
 	// DeploymentHash hash used to detect changes
 	DeploymentHash = "deployment"
+
+	// Designate API timeout
+	APITimeout = 120
 )
 
 // DesignateAPISpecCore - this version has no containerImage for use with the OpenStackControlplane
@@ -186,6 +190,11 @@ type DesignateSpecBase struct {
 	// +kubebuilder:default="designate-redis"
 	// RedisServiceName is the name of the Redis instance to be used (must be in the same namespace as designate)
 	RedisServiceName string `json:"redisServiceName"`
+
+	// +kubebuilder:validation:Optional
+	// +kubebuilder:default=120
+	// Designate API timeout
+	APITimeout int `json:"apiTimeout"`
 }
 
 // DesignateStatus defines the observed state of Designate
@@ -277,6 +286,24 @@ func (instance Designate) IsReady() bool {
 		unboundReady
 }
 
+// SetupDefaults - initializes any CRD field defaults based on environment variables (the defaulting mechanism itself is implemented via webhooks)
+func SetupDefaults() {
+	// Acquire environmental defaults and initialize Designate defaults with them
+	designateDefaults := DesignateDefaults{
+		APIContainerImageURL:          util.GetEnvVar("RELATED_IMAGE_DESIGNATE_API_IMAGE_URL_DEFAULT", DesignateAPIContainerImage),
+		CentralContainerImageURL:      util.GetEnvVar("RELATED_IMAGE_DESIGNATE_CENTRAL_IMAGE_URL_DEFAULT", DesignateCentralContainerImage),
+		MdnsContainerImageURL:         util.GetEnvVar("RELATED_IMAGE_DESIGNATE_MDNS_IMAGE_URL_DEFAULT", DesignateMdnsContainerImage),
+		ProducerContainerImageURL:     util.GetEnvVar("RELATED_IMAGE_DESIGNATE_PRODUCER_IMAGE_URL_DEFAULT", DesignateProducerContainerImage),
+		WorkerContainerImageURL:       util.GetEnvVar("RELATED_IMAGE_DESIGNATE_WORKER_IMAGE_URL_DEFAULT", DesignateWorkerContainerImage),
+		UnboundContainerImageURL:      util.GetEnvVar("RELATED_IMAGE_DESIGNATE_UNBOUND_IMAGE_URL_DEFAULT", DesignateUnboundContainerImage),
+		Backendbind9ContainerImageURL: util.GetEnvVar("RELATED_IMAGE_DESIGNATE_BACKENDBIND9_IMAGE_URL_DEFAULT", DesignateBackendbind9ContainerImage),
+		DesignateAPIRouteTimeout:      APITimeout,
+	}
+
+	SetupDesignateDefaults(designateDefaults)
+}
+
+
 // DesignateExtraVolMounts exposes additional parameters processed by the designate-operator
 // and defines the common VolMounts structure provided by the main storage module
 type DesignateExtraVolMounts struct {

api/v1beta1/designate_webhook.go

@@ -44,6 +44,7 @@ type DesignateDefaults struct {
 	WorkerContainerImageURL       string
 	Backendbind9ContainerImageURL string
 	UnboundContainerImageURL      string
+	DesignateAPIRouteTimeout         int
 }
 
 var designateDefaults DesignateDefaults
@@ -207,3 +208,35 @@ func (r *Designate) ValidateDelete() (admission.Warnings, error) {
 	// TODO(user): fill in your validation logic upon object deletion.
 	return nil, nil
 }
+
+func (spec *DesignateSpecCore) GetDefaultRouteAnnotations() (annotations map[string]string) {
+	return map[string]string{
+		"haproxy.router.openshift.io/timeout": fmt.Sprintf("%ds", designateDefaults.DesignateAPIRouteTimeout),
+	}
+}
+
+// SetDefaultRouteAnnotations sets HAProxy timeout values of the route
+func (spec *DesignateSpecCore) 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 designateAnno = "api.designate.openstack.org/timeout"
+
+	valDesignate, okDesignate := annotations[designateAnno]
+	valHAProxy, okHAProxy := annotations[haProxyAnno]
+
+	// Human operator set the HAProxy timeout manually
+	if !okDesignate && okHAProxy {
+		return
+	}
+
+	// Human operator modified the HAProxy timeout manually without removing the Designate flag
+	if okDesignate && okHAProxy && valDesignate != valHAProxy {
+		delete(annotations, designateAnno)
+		return
+	}
+
+	timeout := fmt.Sprintf("%ds", spec.APITimeout)
+	annotations[designateAnno] = timeout
+	annotations[haProxyAnno] = timeout
+}

api/v1beta1/designateapi_types.go

@@ -78,6 +78,10 @@ type DesignateAPISpecBase struct {
 	// +operator-sdk:csv:customresourcedefinitions:type=spec
 	// TLS - Parameters related to the TLS
 	TLS tls.API `json:"tls,omitempty"`
+
+	// +kubebuilder:validation:Optional
+	// APITimeout for HAProxy and Apache defaults to DesignateSpecCore APITimeout (seconds)
+	APITimeout int `json:"apiTimeout"`
 }
 
 // APIOverrideSpec to override the generated manifest of several child resources.

config/crd/bases/designate.openstack.org_designateapis.yaml

@@ -52,6 +52,10 @@ spec:
           spec:
             description: DesignateAPISpec defines the desired state of DesignateAPI
             properties:
+              apiTimeout:
+                description: APITimeout for HAProxy and Apache defaults to DesignateSpecCore
+                  APITimeout (seconds)
+                type: integer
               backendMdnsServerProtocol:
                 description: |-
                   BackendTypeProtocol - Defines the backend protocol to be used between the designate-worker &

config/crd/bases/designate.openstack.org_designates.yaml

@@ -48,6 +48,10 @@ spec:
           spec:
             description: DesignateAPISpec defines the desired state of DesignateAPI
             properties:
+              apiTimeout:
+                default: 120
+                description: Designate API timeout
+                type: integer
               backendMdnsServerProtocol:
                 description: |-
                   BackendTypeProtocol - Defines the backend protocol to be used between the designate-worker &
@@ -95,6 +99,10 @@ spec:
                 description: DesignateAPI - Spec definition for the API service of
                   this Designate deployment
                 properties:
+                  apiTimeout:
+                    description: APITimeout for HAProxy and Apache defaults to DesignateSpecCore
+                      APITimeout (seconds)
+                    type: integer
                   backendMdnsServerProtocol:
                     description: |-
                       BackendTypeProtocol - Defines the backend protocol to be used between the designate-worker &

controllers/designate_controller.go

@@ -1488,6 +1488,7 @@ func (r *DesignateReconciler) apiDeploymentCreateOrUpdate(ctx context.Context, i
 		deployment.Spec.TLS = instance.Spec.DesignateAPI.TLS
 		deployment.Spec.TransportURLSecret = instance.Status.TransportURLSecret
 		deployment.Spec.NodeSelector = instance.Spec.DesignateAPI.NodeSelector
+		deployment.Spec.APITimeout = instance.Spec.APITimeout
 
 		err := controllerutil.SetControllerReference(instance, deployment, r.Scheme)
 		if err != nil {

controllers/designateapi_controller.go

@@ -1103,6 +1103,7 @@ func (r *DesignateAPIReconciler) generateServiceConfigMaps(
 	templateParameters["ServiceUser"] = instance.Spec.ServiceUser
 	templateParameters["KeystoneInternalURL"] = keystoneInternalURL
 	templateParameters["KeystonePublicURL"] = keystonePublicURL
+	templateParameters["TimeOut"] = instance.Spec.APITimeout
 
 	// create httpd  vhost template parameters
 	httpdVhostConfig := map[string]interface{}{}

templates/designateapi/config/httpd.conf

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