Feature: Allow to customize probe configuration (#519)

Author: ajanikow

pkg/apis/deployment/v1/server_group_spec.go

@@ -72,37 +72,101 @@ type ServerGroupSpec struct {
 type ServerGroupProbesSpec struct {
 	// LivenessProbeDisabled if true livenessProbes are disabled
 	LivenessProbeDisabled *bool `json:"livenessProbeDisabled,omitempty"`
-	// LivenessProbeDisabled if specified the given probes is used as liveness probe
-	//LivenessProbeOverride *v1.Probe `json:"LivenessProbeOverride,omitempty"`
-	// LivenessProbeDisabled if true readinessProbes are disabled
-	ReadinessProbeDisabled *bool `json:"ReadinessProbeDisabled,omitempty"`
-	// ReadinessProbeOverride if specified the given probes is used as readiness probe
-	//ReadinessProbeOverride *v1.Probe `json:"ReadinessProbeOverride,omitempty"`
+	// LivenessProbeSpec override liveness probe configuration
+	LivenessProbeSpec *ServerGroupProbeSpec `json:"livenessProbeSpec,omitempty"`
+
+	// OldReadinessProbeDisabled if true readinessProbes are disabled
+	//
+	// Deprecated: This field is deprecated, keept only for backward compatibility.
+	OldReadinessProbeDisabled *bool `json:"ReadinessProbeDisabled,omitempty"`
+	// ReadinessProbeDisabled override flag for probe disabled in good manner (lowercase) with backward compatibility
+	ReadinessProbeDisabled *bool `json:"readinessProbeDisabled,omitempty"`
+	// ReadinessProbeSpec override readiness probe configuration
+	ReadinessProbeSpec *ServerGroupProbeSpec `json:"readinessProbeSpec,omitempty"`
 }
 
-// // HasLivenessProbeOverride returns true if a livenessprobe override is set
-// func (s ServerGroupProbesSpec) HasLivenessProbeOverride() bool {
-// 	return s.LivenessProbeOverride != nil
-// }
+// GetReadinessProbeDisabled returns in proper manner readiness probe flag with backward compatibility.
+func (s ServerGroupProbesSpec) GetReadinessProbeDisabled() *bool {
+	if s.OldReadinessProbeDisabled != nil {
+		return s.OldReadinessProbeDisabled
+	}
 
-// // HasReadinessProbeOverride returns true if a readinessprobe override is set
-// func (s ServerGroupProbesSpec) HasReadinessProbeOverride() bool {
-// 	return s.ReadinessProbeOverride != nil
-// }
+	return s.ReadinessProbeDisabled
+}
 
-// GetSidecars returns a list of sidecars the use wish to add
-func (s ServerGroupSpec) GetSidecars() []v1.Container {
-	return s.Sidecars
+// ServerGroupProbeSpec
+type ServerGroupProbeSpec struct {
+	InitialDelaySeconds *int32 `json:"initialDelaySeconds,omitempty"`
+	PeriodSeconds       *int32 `json:"periodSeconds,omitempty"`
+	TimeoutSeconds      *int32 `json:"timeoutSeconds,omitempty"`
+	SuccessThreshold    *int32 `json:"successThreshold,omitempty"`
+	FailureThreshold    *int32 `json:"failureThreshold,omitempty"`
+}
+
+// GetInitialDelaySeconds return InitialDelaySeconds valid value. In case if InitialDelaySeconds is nil default is returned.
+func (s *ServerGroupProbeSpec) GetInitialDelaySeconds(d int32) int32 {
+	if s == nil || s.InitialDelaySeconds == nil {
+		return d // Default Kubernetes value
+	}
+
+	return *s.InitialDelaySeconds
 }
 
-// IsLivenessProbeDisabled returns true if liveness probes are disabled
-func (s ServerGroupProbesSpec) IsLivenessProbeDisabled() bool {
-	return util.BoolOrDefault(s.LivenessProbeDisabled)
+// GetPeriodSeconds return PeriodSeconds valid value. In case if PeriodSeconds is nil default is returned.
+func (s *ServerGroupProbeSpec) GetPeriodSeconds(d int32) int32 {
+	if s == nil || s.PeriodSeconds == nil {
+		return d
+	}
+
+	if *s.PeriodSeconds <= 0 {
+		return 1 // Value 0 is not allowed
+	}
+
+	return *s.PeriodSeconds
 }
 
-// IsReadinessProbeDisabled returns true if readiness probes are disabled
-func (s ServerGroupProbesSpec) IsReadinessProbeDisabled() bool {
-	return util.BoolOrDefault(s.ReadinessProbeDisabled)
+// GetTimeoutSeconds return TimeoutSeconds valid value. In case if TimeoutSeconds is nil default is returned.
+func (s *ServerGroupProbeSpec) GetTimeoutSeconds(d int32) int32 {
+	if s == nil || s.TimeoutSeconds == nil {
+		return d
+	}
+
+	if *s.TimeoutSeconds <= 0 {
+		return 1 // Value 0 is not allowed
+	}
+
+	return *s.TimeoutSeconds
+}
+
+// GetSuccessThreshold return SuccessThreshold valid value. In case if SuccessThreshold is nil default is returned.
+func (s *ServerGroupProbeSpec) GetSuccessThreshold(d int32) int32 {
+	if s == nil || s.SuccessThreshold == nil {
+		return d
+	}
+
+	if *s.SuccessThreshold <= 0 {
+		return 1 // Value 0 is not allowed
+	}
+
+	return *s.SuccessThreshold
+}
+
+// GetFailureThreshold return FailureThreshold valid value. In case if FailureThreshold is nil default is returned.
+func (s *ServerGroupProbeSpec) GetFailureThreshold(d int32) int32 {
+	if s == nil || s.FailureThreshold == nil {
+		return d
+	}
+
+	if *s.FailureThreshold <= 0 {
+		return 1 // Value 0 is not allowed
+	}
+
+	return *s.FailureThreshold
+}
+
+// GetSidecars returns a list of sidecars the use wish to add
+func (s ServerGroupSpec) GetSidecars() []v1.Container {
+	return s.Sidecars
 }
 
 // HasVolumeClaimTemplate returns whether there is a volumeClaimTemplate or not

pkg/apis/deployment/v1/zz_generated.deepcopy.go

@@ -0,0 +1,76 @@
+//
+// DISCLAIMER
+//
+// Copyright 2020 ArangoDB GmbH, Cologne, Germany
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// Copyright holder is ArangoDB GmbH, Cologne, Germany
+//
+// Author Adam Janikowski
+//
+
+package pod
+
+import api "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
+
+func newProbe(canBeEnabled, enabledByDefault bool) Probe {
+	return Probe{
+		EnabledByDefault: enabledByDefault,
+		CanBeEnabled:     canBeEnabled,
+	}
+}
+
+func ReadinessSpec(group api.ServerGroup) Probe {
+	return probeMap[group].readiness
+}
+
+func LivenessSpec(group api.ServerGroup) Probe {
+	return probeMap[group].liveness
+}
+
+type Probe struct {
+	CanBeEnabled, EnabledByDefault bool
+}
+
+type probes struct {
+	liveness, readiness Probe
+}
+
+// probeMap defines default values and if Probe can be enabled
+var probeMap = map[api.ServerGroup]probes{
+	api.ServerGroupSingle: {
+		liveness:  newProbe(true, true),
+		readiness: newProbe(true, true),
+	},
+	api.ServerGroupAgents: {
+		liveness:  newProbe(true, true),
+		readiness: newProbe(false, false),
+	},
+	api.ServerGroupDBServers: {
+		liveness:  newProbe(true, true),
+		readiness: newProbe(false, false),
+	},
+	api.ServerGroupCoordinators: {
+		liveness:  newProbe(false, false),
+		readiness: newProbe(true, true),
+	},
+	api.ServerGroupSyncMasters: {
+		liveness:  newProbe(true, true),
+		readiness: newProbe(false, false),
+	},
+	api.ServerGroupSyncWorkers: {
+		liveness:  newProbe(true, true),
+		readiness: newProbe(false, false),
+	},
+}