Extend the Probe interface to support optional path, port and scheme properties

api/v1/runtimecomponent_types.go

@@ -177,15 +177,15 @@ type RuntimeComponentServiceAccount struct {
 type RuntimeComponentProbes struct {
 	// Periodic probe of container liveness. Container will be restarted if the probe fails.
 	// +operator-sdk:csv:customresourcedefinitions:order=3,type=spec,displayName="Liveness Probe"
-	Liveness *corev1.Probe `json:"liveness,omitempty"`
+	Liveness *common.BaseComponentProbe `json:"liveness,omitempty"`
 
 	// Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails.
 	// +operator-sdk:csv:customresourcedefinitions:order=2,type=spec,displayName="Readiness Probe"
-	Readiness *corev1.Probe `json:"readiness,omitempty"`
+	Readiness *common.BaseComponentProbe `json:"readiness,omitempty"`
 
 	// Probe to determine successful initialization. If specified, other probes are not executed until this completes successfully.
 	// +operator-sdk:csv:customresourcedefinitions:order=1,type=spec,displayName="Startup Probe"
-	Startup *corev1.Probe `json:"startup,omitempty"`
+	Startup *common.BaseComponentProbe `json:"startup,omitempty"`
 }
 
 // Configure pods to run on particular Nodes.
@@ -544,32 +544,32 @@ func (cr *RuntimeComponent) GetProbes() common.BaseComponentProbes {
 }
 
 // GetLivenessProbe returns liveness probe
-func (p *RuntimeComponentProbes) GetLivenessProbe() *corev1.Probe {
+func (p *RuntimeComponentProbes) GetLivenessProbe() *common.BaseComponentProbe {
 	return p.Liveness
 }
 
 // GetReadinessProbe returns readiness probe
-func (p *RuntimeComponentProbes) GetReadinessProbe() *corev1.Probe {
+func (p *RuntimeComponentProbes) GetReadinessProbe() *common.BaseComponentProbe {
 	return p.Readiness
 }
 
 // GetStartupProbe returns startup probe
-func (p *RuntimeComponentProbes) GetStartupProbe() *corev1.Probe {
+func (p *RuntimeComponentProbes) GetStartupProbe() *common.BaseComponentProbe {
 	return p.Startup
 }
 
 // GetDefaultLivenessProbe returns default values for liveness probe
-func (p *RuntimeComponentProbes) GetDefaultLivenessProbe(ba common.BaseComponent) *corev1.Probe {
+func (p *RuntimeComponentProbes) GetDefaultLivenessProbe(ba common.BaseComponent) *common.BaseComponentProbe {
 	return common.GetDefaultMicroProfileLivenessProbe(ba)
 }
 
 // GetDefaultReadinessProbe returns default values for readiness probe
-func (p *RuntimeComponentProbes) GetDefaultReadinessProbe(ba common.BaseComponent) *corev1.Probe {
+func (p *RuntimeComponentProbes) GetDefaultReadinessProbe(ba common.BaseComponent) *common.BaseComponentProbe {
 	return common.GetDefaultMicroProfileReadinessProbe(ba)
 }
 
 // GetDefaultStartupProbe returns default values for startup probe
-func (p *RuntimeComponentProbes) GetDefaultStartupProbe(ba common.BaseComponent) *corev1.Probe {
+func (p *RuntimeComponentProbes) GetDefaultStartupProbe(ba common.BaseComponent) *common.BaseComponentProbe {
 	return common.GetDefaultMicroProfileStartupProbe(ba)
 }
 

api/v1beta2/runtimecomponent_types.go

@@ -19,7 +19,7 @@ package v1beta2
 import (
 	"time"
 
-	"github.com/application-stacks/runtime-component-operator/common"
+	common "github.com/application-stacks/runtime-component-operator/common_v1beta2"
 	routev1 "github.com/openshift/api/route/v1"
 	prometheusv1 "github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1"
 	appsv1 "k8s.io/api/apps/v1"

bundle/manifests/rc.app.stacks_runtimecomponents.yaml

@@ -3144,8 +3144,6 @@ spec:
                             description: Scheme to use for connecting to the host.
                               Defaults to HTTP.
                             type: string
-                        required:
-                        - port
                         type: object
                       initialDelaySeconds:
                         description: 'Number of seconds after the container has started
@@ -3295,8 +3293,6 @@ spec:
                             description: Scheme to use for connecting to the host.
                               Defaults to HTTP.
                             type: string
-                        required:
-                        - port
                         type: object
                       initialDelaySeconds:
                         description: 'Number of seconds after the container has started
@@ -3447,8 +3443,6 @@ spec:
                             description: Scheme to use for connecting to the host.
                               Defaults to HTTP.
                             type: string
-                        required:
-                        - port
                         type: object
                       initialDelaySeconds:
                         description: 'Number of seconds after the container has started

bundle/manifests/runtime-component.clusterserviceversion.yaml

@@ -71,7 +71,7 @@ metadata:
     categories: Application Runtime
     certified: "true"
     containerImage: icr.io/appcafe/runtime-component-operator:daily
-    createdAt: "2024-05-07T20:25:49Z"
+    createdAt: "2024-05-16T14:08:31Z"
     description: Deploys any runtime component with dynamic and auto-tuning configuration
     olm.skipRange: '>=0.8.0 <1.3.2'
     operators.openshift.io/infrastructure-features: '["disconnected"]'

common/common.go

@@ -1,17 +1,17 @@
 package common
 
 import (
-	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/util/intstr"
 )
 
 // GetDefaultMicroProfileStartupProbe returns the default values for MicroProfile Health-based startup probe.
-func GetDefaultMicroProfileStartupProbe(ba BaseComponent) *corev1.Probe {
-	return &corev1.Probe{
-		ProbeHandler: corev1.ProbeHandler{
-			HTTPGet: &corev1.HTTPGetAction{
+func GetDefaultMicroProfileStartupProbe(ba BaseComponent) *BaseComponentProbe {
+	port := intstr.FromInt(int(ba.GetService().GetPort()))
+	return &BaseComponentProbe{
+		BaseComponentProbeHandler: BaseComponentProbeHandler{
+			HTTPGet: &OptionalHTTPGetAction{
 				Path:   "/health/started",
-				Port:   intstr.FromInt(int(ba.GetService().GetPort())),
+				Port:   &port,
 				Scheme: "HTTPS",
 			},
 		},
@@ -22,12 +22,13 @@ func GetDefaultMicroProfileStartupProbe(ba BaseComponent) *corev1.Probe {
 }
 
 // GetDefaultMicroProfileReadinessProbe returns the default values for MicroProfile Health-based readiness probe.
-func GetDefaultMicroProfileReadinessProbe(ba BaseComponent) *corev1.Probe {
-	return &corev1.Probe{
-		ProbeHandler: corev1.ProbeHandler{
-			HTTPGet: &corev1.HTTPGetAction{
+func GetDefaultMicroProfileReadinessProbe(ba BaseComponent) *BaseComponentProbe {
+	port := intstr.FromInt(int(ba.GetService().GetPort()))
+	return &BaseComponentProbe{
+		BaseComponentProbeHandler: BaseComponentProbeHandler{
+			HTTPGet: &OptionalHTTPGetAction{
 				Path:   "/health/ready",
-				Port:   intstr.FromInt(int(ba.GetService().GetPort())),
+				Port:   &port,
 				Scheme: "HTTPS",
 			},
 		},
@@ -39,12 +40,13 @@ func GetDefaultMicroProfileReadinessProbe(ba BaseComponent) *corev1.Probe {
 }
 
 // GetDefaultMicroProfileLivenessProbe returns the default values for MicroProfile Health-based liveness probe.
-func GetDefaultMicroProfileLivenessProbe(ba BaseComponent) *corev1.Probe {
-	return &corev1.Probe{
-		ProbeHandler: corev1.ProbeHandler{
-			HTTPGet: &corev1.HTTPGetAction{
+func GetDefaultMicroProfileLivenessProbe(ba BaseComponent) *BaseComponentProbe {
+	port := intstr.FromInt(int(ba.GetService().GetPort()))
+	return &BaseComponentProbe{
+		BaseComponentProbeHandler: BaseComponentProbeHandler{
+			HTTPGet: &OptionalHTTPGetAction{
 				Path:   "/health/live",
-				Port:   intstr.FromInt(int(ba.GetService().GetPort())),
+				Port:   &port,
 				Scheme: "HTTPS",
 			},
 		},

common/types.go

@@ -7,6 +7,7 @@ import (
 	corev1 "k8s.io/api/core/v1"
 	networkingv1 "k8s.io/api/networking/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/util/intstr"
 )
 
 // StatusConditionType ...
@@ -177,15 +178,99 @@ type BaseComponentStatefulSet interface {
 	GetAnnotations() map[string]string
 }
 
+// This struct is taken from the Probe specification in https://github.com/kubernetes/api/blob/v0.24.2/core/v1/types.go
+// +kubebuilder:object:generate=true
+type BaseComponentProbe struct {
+	// The action taken to determine the health of a container
+	BaseComponentProbeHandler `json:",inline"`
+	// Number of seconds after the container has started before liveness probes are initiated.
+	// More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+	// +optional
+	InitialDelaySeconds int32 `json:"initialDelaySeconds,omitempty"`
+	// Number of seconds after which the probe times out.
+	// Defaults to 1 second. Minimum value is 1.
+	// More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+	// +optional
+	TimeoutSeconds int32 `json:"timeoutSeconds,omitempty"`
+	// How often (in seconds) to perform the probe.
+	// Default to 10 seconds. Minimum value is 1.
+	// +optional
+	PeriodSeconds int32 `json:"periodSeconds,omitempty"`
+	// Minimum consecutive successes for the probe to be considered successful after having failed.
+	// Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+	// +optional
+	SuccessThreshold int32 `json:"successThreshold,omitempty"`
+	// Minimum consecutive failures for the probe to be considered failed after having succeeded.
+	// Defaults to 3. Minimum value is 1.
+	// +optional
+	FailureThreshold int32 `json:"failureThreshold,omitempty"`
+	// Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
+	// The grace period is the duration in seconds after the processes running in the pod are sent
+	// a termination signal and the time when the processes are forcibly halted with a kill signal.
+	// Set this value longer than the expected cleanup time for your process.
+	// If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
+	// value overrides the value provided by the pod spec.
+	// Value must be non-negative integer. The value zero indicates stop immediately via
+	// the kill signal (no opportunity to shut down).
+	// This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
+	// Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.
+	// +optional
+	TerminationGracePeriodSeconds *int64 `json:"terminationGracePeriodSeconds,omitempty"`
+}
+
+// This struct is taken from the ProbeHandler specification in https://github.com/kubernetes/api/blob/v0.24.2/core/v1/types.go
+// +kubebuilder:object:generate=true
+type BaseComponentProbeHandler struct {
+	// Exec specifies the action to take.
+	// +optional
+	Exec *corev1.ExecAction `json:"exec,omitempty"`
+	// HTTPGet specifies the http request to perform.
+	// +optional
+	HTTPGet *OptionalHTTPGetAction `json:"httpGet,omitempty"`
+	// TCPSocket specifies an action involving a TCP port.
+	// +optional
+	TCPSocket *corev1.TCPSocketAction `json:"tcpSocket,omitempty"`
+
+	// GRPC specifies an action involving a GRPC port.
+	// This is a beta field and requires enabling GRPCContainerProbe feature gate.
+	// +featureGate=GRPCContainerProbe
+	// +optional
+	GRPC *corev1.GRPCAction `json:"grpc,omitempty"`
+}
+
+// This struct is based upon the HTTPGetAction specification in https://github.com/kubernetes/api/blob/v0.24.2/core/v1/types.go
+// +kubebuilder:object:generate=true
+type OptionalHTTPGetAction struct {
+	// Path to access on the HTTP server.
+	// +optional
+	Path string `json:"path,omitempty"`
+	// Name or number of the port to access on the container.
+	// Number must be in the range 1 to 65535.
+	// Name must be an IANA_SVC_NAME.
+	// +optional
+	Port *intstr.IntOrString `json:"port,omitempty"`
+	// Host name to connect to, defaults to the pod IP. You probably want to set
+	// "Host" in httpHeaders instead.
+	// +optional
+	Host string `json:"host,omitempty"`
+	// Scheme to use for connecting to the host.
+	// Defaults to HTTP.
+	// +optional
+	Scheme corev1.URIScheme `json:"scheme,omitempty"`
+	// Custom headers to set in the request. HTTP allows repeated headers.
+	// +optional
+	HTTPHeaders []corev1.HTTPHeader `json:"httpHeaders,omitempty"`
+}
+
 // BaseComponentProbes describes the probes for application container
 type BaseComponentProbes interface {
-	GetLivenessProbe() *corev1.Probe
-	GetReadinessProbe() *corev1.Probe
-	GetStartupProbe() *corev1.Probe
+	GetLivenessProbe() *BaseComponentProbe
+	GetReadinessProbe() *BaseComponentProbe
+	GetStartupProbe() *BaseComponentProbe
 
-	GetDefaultLivenessProbe(ba BaseComponent) *corev1.Probe
-	GetDefaultReadinessProbe(ba BaseComponent) *corev1.Probe
-	GetDefaultStartupProbe(ba BaseComponent) *corev1.Probe
+	GetDefaultLivenessProbe(ba BaseComponent) *BaseComponentProbe
+	GetDefaultReadinessProbe(ba BaseComponent) *BaseComponentProbe
+	GetDefaultStartupProbe(ba BaseComponent) *BaseComponentProbe
 }
 
 type BaseComponentServiceAccount interface {