Added configurable request timeout for OpenStack

Co-Authored-By: Axel Christ <[email protected]>
richardyuwen · Mar 26, 2019 · f5b7d80 · f5b7d80
1 parent 02f7b93
commit f5b7d80
Show file tree

Hide file tree

Showing 11 changed files with 63 additions and 3 deletions.
diff --git a/example/30-cloudprofile-openstack.yaml b/example/30-cloudprofile-openstack.yaml
@@ -49,3 +49,4 @@ spec:
         - europe-1c
     keystoneURL: https://url-to-keystone/v3/
   # dhcpDomain: nova.local # DHCP domain of OpenStack system (only meaningful for Kubernetes 1.10.1, see https://github.com/kubernetes/kubernetes/pull/61890 for details)
+  # requestTimeout: 180s # Kubernetes OpenStack Cloudprovider Request Timeout
diff --git a/hack/templates/resources/30-cloudprofile.yaml.tpl b/hack/templates/resources/30-cloudprofile.yaml.tpl
@@ -500,7 +500,7 @@ spec:<% caBundle=value("spec.caBundle", "") %>
         - europe-1b
         - europe-1c
       % endif
-    keystoneURL: ${value("spec.openstack.keyStoneURL", "https://url-to-keystone/v3/")}<% dnsServers=value("spec.openstack.dnsServers", []) %><% dhcpDomain=value("spec.openstack.dhcpDomain", "") %>
+    keystoneURL: ${value("spec.openstack.keyStoneURL", "https://url-to-keystone/v3/")}<% dnsServers=value("spec.openstack.dnsServers", []) %><% dhcpDomain=value("spec.openstack.dhcpDomain", "") %><% requestTimeout=value("spec.openstack.requestTimeout", "") %>
     % if dnsServers != []:
     dnsServers: ${dnsServers}
     % endif
@@ -509,6 +509,11 @@ spec:<% caBundle=value("spec.caBundle", "") %>
     % else:
   # dhcpDomain: nova.local # DHCP domain of OpenStack system (only meaningful for Kubernetes 1.10.1, see https://github.com/kubernetes/kubernetes/pull/61890 for details)
     % endif
+    % if requestTimeout != "":
+    requestTimeout: ${requestTimeout}
+    % else:
+  # requestTimeout: 180s # Kubernetes OpenStack Cloudprovider Request Timeout
+    % endif
   % endif
   % if cloud == "local":
   local:

diff --git a/pkg/apis/garden/types.go b/pkg/apis/garden/types.go
@@ -217,6 +217,9 @@ type OpenStackProfile struct {
 	// Kubernetes 1.10.1+. See https://github.com/kubernetes/kubernetes/pull/61890 for details.
 	// +optional
 	DHCPDomain *string
+	// RequestTimeout specifies the HTTP timeout against the OpenStack API.
+	// +optional
+	RequestTimeout *string
 }
 
 // OpenStackConstraints is an object containing constraints for certain values in the Shoot specification.

diff --git a/pkg/apis/garden/v1beta1/types.go b/pkg/apis/garden/v1beta1/types.go
@@ -218,6 +218,9 @@ type OpenStackProfile struct {
 	// Kubernetes 1.10.1+. See https://github.com/kubernetes/kubernetes/pull/61890 for details.
 	// +optional
 	DHCPDomain *string `json:"dhcpDomain,omitempty"`
+	// RequestTimeout specifies the HTTP timeout against the OpenStack API.
+	// +optional
+	RequestTimeout *string `json:"requestTimeout,omitempty"`
 }
 
 // OpenStackConstraints is an object containing constraints for certain values in the Shoot specification.

diff --git a/pkg/apis/garden/v1beta1/zz_generated.conversion.go b/pkg/apis/garden/v1beta1/zz_generated.conversion.go
diff --git a/pkg/apis/garden/v1beta1/zz_generated.deepcopy.go b/pkg/apis/garden/v1beta1/zz_generated.deepcopy.go
diff --git a/pkg/apis/garden/validation/validation.go b/pkg/apis/garden/validation/validation.go
@@ -206,6 +206,13 @@ func ValidateCloudProfileSpec(spec *garden.CloudProfileSpec, fldPath *field.Path
 		if spec.OpenStack.DHCPDomain != nil && len(*spec.OpenStack.DHCPDomain) == 0 {
 			allErrs = append(allErrs, field.Required(fldPath.Child("openstack", "dhcpDomain"), "must provide a dhcp domain when the key is specified"))
 		}
+
+		if spec.OpenStack.RequestTimeout != nil {
+			_, err := time.ParseDuration(*spec.OpenStack.RequestTimeout)
+			if err != nil {
+				allErrs = append(allErrs, field.Invalid(fldPath.Child("openstack", "requestTimeout"), *spec.OpenStack.RequestTimeout, fmt.Sprintf("invalid duration: %v", err)))
+			}
+		}
 	}
 
 	if spec.CABundle != nil {

diff --git a/pkg/apis/garden/validation/validation_test.go b/pkg/apis/garden/validation/validation_test.go
@@ -1368,6 +1368,19 @@ var _ = Describe("validation", func() {
 					}))
 				})
 			})
+
+			Context("requestTimeout validation", func() {
+				It("should reject invalid durations", func() {
+					openStackCloudProfile.Spec.OpenStack.RequestTimeout = makeStringPointer("1GiB")
+
+					errorList := ValidateCloudProfile(openStackCloudProfile)
+
+					Expect(errorList).To(ConsistOf(PointTo(MatchFields(IgnoreExtras, Fields{
+						"Type":  Equal(field.ErrorTypeInvalid),
+						"Field": Equal(fmt.Sprintf("spec.%s.requestTimeout", fldPath)),
+					}))))
+				})
+			})
 		})
 
 		Context("tests for Alicloud cloud profiles", func() {

diff --git a/pkg/apis/garden/zz_generated.deepcopy.go b/pkg/apis/garden/zz_generated.deepcopy.go
diff --git a/pkg/openapi/openapi_generated.go b/pkg/openapi/openapi_generated.go
diff --git a/pkg/operation/cloudbotanist/openstackbotanist/controlplane.go b/pkg/operation/cloudbotanist/openstackbotanist/controlplane.go
@@ -75,12 +75,21 @@ func (b *OpenStackBotanist) GenerateCloudProviderConfig() (string, error) {
 		return "", err
 	}
 
+	if needsDHCPDomain && b.Shoot.CloudProfile.Spec.OpenStack.DHCPDomain != nil || b.Shoot.CloudProfile.Spec.OpenStack.RequestTimeout != nil {
+		cloudProviderConfig += fmt.Sprintf(`
+[Metadata]`)
+	}
+
 	if needsDHCPDomain && b.Shoot.CloudProfile.Spec.OpenStack.DHCPDomain != nil {
 		cloudProviderConfig += fmt.Sprintf(`
-[Metadata]
 dhcp-domain=%q`, *b.Shoot.CloudProfile.Spec.OpenStack.DHCPDomain)
 	}
 
+	if b.Shoot.CloudProfile.Spec.OpenStack.RequestTimeout != nil {
+		cloudProviderConfig += fmt.Sprintf(`
+request-timeout=%s`, *b.Shoot.CloudProfile.Spec.OpenStack.RequestTimeout)
+	}
+
 	return cloudProviderConfig, nil
 }