Add redis jobboard support

gthiemonge · gthiemonge · commit a3c909ffc67f · 2025-07-30T17:12:12.000+02:00
Added octavia.spec.redisServiceName (default: octavia-redis) to change
the name of the Octavia Redis DB:
If the Redis object is not found, jobboard is disabled

octavia:
  spec:
    redisServiceName: octavia-redis

It requires an existing redis database, it can be set up in the
OpenStackControlPlane with:

spec:
  redis:
    enabled: true
    templates:
      octavia-redis:
        replicas: 1
        tls: {}

JIRA: OSPRH-10144
diff --git a/api/bases/octavia.openstack.org_octaviaamphoracontrollers.yaml b/api/bases/octavia.openstack.org_octaviaamphoracontrollers.yaml
@@ -168,6 +168,13 @@ spec:
                   PersistenceDatabaseAccount - name of MariaDBAccount which will be used
                   to connect for the persistence database
                 type: string
+              redisHosts:
+                default: []
+                description: List of Redis Hosts
+                items:
+                  type: string
+                type: array
+                x-kubernetes-list-type: atomic
               resources:
                 description: |-
                   Resources - Compute Resources required by this service (Limits/Requests).
diff --git a/api/bases/octavia.openstack.org_octavias.yaml b/api/bases/octavia.openstack.org_octavias.yaml
@@ -668,6 +668,13 @@ spec:
                       PersistenceDatabaseAccount - name of MariaDBAccount which will be used
                       to connect for the persistence database
                     type: string
+                  redisHosts:
+                    default: []
+                    description: List of Redis Hosts
+                    items:
+                      type: string
+                    type: array
+                    x-kubernetes-list-type: atomic
                   resources:
                     description: |-
                       Resources - Compute Resources required by this service (Limits/Requests).
@@ -907,6 +914,13 @@ spec:
                       PersistenceDatabaseAccount - name of MariaDBAccount which will be used
                       to connect for the persistence database
                     type: string
+                  redisHosts:
+                    default: []
+                    description: List of Redis Hosts
+                    items:
+                      type: string
+                    type: array
+                    x-kubernetes-list-type: atomic
                   resources:
                     description: |-
                       Resources - Compute Resources required by this service (Limits/Requests).
@@ -1319,6 +1333,13 @@ spec:
                       PersistenceDatabaseAccount - name of MariaDBAccount which will be used
                       to connect for the persistence database
                     type: string
+                  redisHosts:
+                    default: []
+                    description: List of Redis Hosts
+                    items:
+                      type: string
+                    type: array
+                    x-kubernetes-list-type: atomic
                   resources:
                     description: |-
                       Resources - Compute Resources required by this service (Limits/Requests).
@@ -1473,6 +1494,10 @@ spec:
                   RabbitMQ instance name
                   Needed to request a transportURL that is created and used in Octavia
                 type: string
+              redisServiceName:
+                default: octavia-redis
+                description: Name of the Redis database for Jobboard
+                type: string
               resources:
                 description: |-
                   Resources - Compute Resources required by this service (Limits/Requests).
@@ -1659,6 +1684,12 @@ spec:
                   the opentack-operator in the top-level CR (e.g. the ContainerImage)
                 format: int64
                 type: integer
+              redisHosts:
+                description: List of Redis Hosts
+                items:
+                  type: string
+                type: array
+                x-kubernetes-list-type: atomic
               rsyslogreadyCount:
                 description: ReadyCount of octavia Rsyslog instances
                 format: int32
diff --git a/api/v1beta1/amphoracontroller_types.go b/api/v1beta1/amphoracontroller_types.go
@@ -146,6 +146,11 @@ type OctaviaAmphoraControllerSpecCore struct {
 	// +kubebuilder:default=""
 	AmphoraImageOwnerID string `json:"amphoraImageOwnerID,omitempty"`
 
+	// +kubebuilder:default={}
+	// +listType:=atomic
+	// List of Redis Hosts
+	RedisHosts []string `json:"redisHosts,omitempty"`
+
 	// +operator-sdk:csv:customresourcedefinitions:type=spec
 	// TLS - Parameters related to the TLS
 	TLS tls.Ca `json:"tls,omitempty"`
diff --git a/api/v1beta1/octavia_types.go b/api/v1beta1/octavia_types.go
@@ -227,6 +227,11 @@ type OctaviaSpecBase struct {
 	// TopologyRef to apply the Topology defined by the associated CR referenced
 	// by name
 	TopologyRef *topologyv1.TopoRef `json:"topologyRef,omitempty"`
+
+	// +kubebuilder:validation:Optional
+	// +kubebuilder:default=octavia-redis
+	// Name of the Redis database for Jobboard
+	RedisServiceName string `json:"redisServiceName"`
 }
 
 // PasswordSelector to identify the DB and AdminUser password from the Secret
@@ -322,6 +327,10 @@ type OctaviaStatus struct {
 	// ReadyCount of octavia Rsyslog instances
 	OctaviaRsyslogReadyCount int32 `json:"rsyslogreadyCount,omitempty"`
 
+	// List of Redis Hosts
+	// +listType:=atomic
+	RedisHosts []string `json:"redisHosts,omitempty"`
+
 	// ObservedGeneration - the most recent generation observed for this
 	// service. If the observed generation is less than the spec generation,
 	// then the controller has not processed the latest changes injected by
diff --git a/api/v1beta1/zz_generated.deepcopy.go b/api/v1beta1/zz_generated.deepcopy.go
diff --git a/config/crd/bases/octavia.openstack.org_octaviaamphoracontrollers.yaml b/config/crd/bases/octavia.openstack.org_octaviaamphoracontrollers.yaml
@@ -168,6 +168,13 @@ spec:
                   PersistenceDatabaseAccount - name of MariaDBAccount which will be used
                   to connect for the persistence database
                 type: string
+              redisHosts:
+                default: []
+                description: List of Redis Hosts
+                items:
+                  type: string
+                type: array
+                x-kubernetes-list-type: atomic
               resources:
                 description: |-
                   Resources - Compute Resources required by this service (Limits/Requests).
diff --git a/config/crd/bases/octavia.openstack.org_octavias.yaml b/config/crd/bases/octavia.openstack.org_octavias.yaml
@@ -668,6 +668,13 @@ spec:
                       PersistenceDatabaseAccount - name of MariaDBAccount which will be used
                       to connect for the persistence database
                     type: string
+                  redisHosts:
+                    default: []
+                    description: List of Redis Hosts
+                    items:
+                      type: string
+                    type: array
+                    x-kubernetes-list-type: atomic
                   resources:
                     description: |-
                       Resources - Compute Resources required by this service (Limits/Requests).
@@ -907,6 +914,13 @@ spec:
                       PersistenceDatabaseAccount - name of MariaDBAccount which will be used
                       to connect for the persistence database
                     type: string
+                  redisHosts:
+                    default: []
+                    description: List of Redis Hosts
+                    items:
+                      type: string
+                    type: array
+                    x-kubernetes-list-type: atomic
                   resources:
                     description: |-
                       Resources - Compute Resources required by this service (Limits/Requests).
@@ -1319,6 +1333,13 @@ spec:
                       PersistenceDatabaseAccount - name of MariaDBAccount which will be used
                       to connect for the persistence database
                     type: string
+                  redisHosts:
+                    default: []
+                    description: List of Redis Hosts
+                    items:
+                      type: string
+                    type: array
+                    x-kubernetes-list-type: atomic
                   resources:
                     description: |-
                       Resources - Compute Resources required by this service (Limits/Requests).
@@ -1473,6 +1494,10 @@ spec:
                   RabbitMQ instance name
                   Needed to request a transportURL that is created and used in Octavia
                 type: string
+              redisServiceName:
+                default: octavia-redis
+                description: Name of the Redis database for Jobboard
+                type: string
               resources:
                 description: |-
                   Resources - Compute Resources required by this service (Limits/Requests).
@@ -1659,6 +1684,12 @@ spec:
                   the opentack-operator in the top-level CR (e.g. the ContainerImage)
                 format: int64
                 type: integer
+              redisHosts:
+                description: List of Redis Hosts
+                items:
+                  type: string
+                type: array
+                x-kubernetes-list-type: atomic
               rsyslogreadyCount:
                 description: ReadyCount of octavia Rsyslog instances
                 format: int32
diff --git a/config/rbac/role.yaml b/config/rbac/role.yaml
@@ -333,6 +333,18 @@ rules:
   - patch
   - update
   - watch
+- apiGroups:
+  - redis.openstack.org
+  resources:
+  - redises
+  verbs:
+  - create
+  - delete
+  - get
+  - list
+  - patch
+  - update
+  - watch
 - apiGroups:
   - route.openshift.io
   resources:
diff --git a/config/samples/octavia_v1beta1_octavia.yaml b/config/samples/octavia_v1beta1_octavia.yaml
@@ -5,6 +5,7 @@ metadata:
 spec:
   databaseInstance: openstack
   databaseAccount: octavia
+  redisServiceName: octavia-redis
   persistenceDatabaseAccount: octavia-persistence
   serviceUser: octavia
   rabbitMqClusterName: rabbitmq
diff --git a/controllers/amphoracontroller_controller.go b/controllers/amphoracontroller_controller.go
@@ -708,6 +708,21 @@ func (r *OctaviaAmphoraControllerReconciler) generateServiceSecrets(
 	}
 	templateParameters["HeartbeatKey"] = string(ospSecret.Data["OctaviaHeartbeatKey"])
 
+	if len(spec.RedisHosts) > 0 {
+		templateParameters["JobboardEnable"] = true
+		templateParameters["JobboardBackendHosts"] = strings.Join(spec.RedisHosts[:], ",")
+		templateParameters["GracefulShutdownTimeout"] = 25
+	} else {
+		templateParameters["JobboardEnable"] = false
+		templateParameters["JobboardBackendHosts"] = ""
+		templateParameters["GracefulShutdownTimeout"] = 600
+	}
+	if tlsCfg != nil {
+		templateParameters["JobboardBackendSSLOptions"] = "ssl:true"
+	} else {
+		templateParameters["JobboardBackendSSLOptions"] = ""
+	}
+
 	// TODO(beagles): populate the template parameters
 	cms := []util.Template{
 		{
diff --git a/controllers/octavia_controller.go b/controllers/octavia_controller.go
@@ -21,12 +21,14 @@ import (
 	"context"
 	"fmt"
 	"net/http"
+	"sort"
 	"strings"
 	"time"
 
 	"github.com/go-logr/logr"
 	networkv1 "github.com/k8snetworkplumbingwg/network-attachment-definition-client/pkg/apis/k8s.cni.cncf.io/v1"
 	rabbitmqv1 "github.com/openstack-k8s-operators/infra-operator/apis/rabbitmq/v1beta1"
+	redisv1 "github.com/openstack-k8s-operators/infra-operator/apis/redis/v1beta1"
 	"github.com/openstack-k8s-operators/lib-common/modules/common"
 	"github.com/openstack-k8s-operators/lib-common/modules/common/condition"
 	"github.com/openstack-k8s-operators/lib-common/modules/common/deployment"
@@ -96,6 +98,7 @@ func (r *OctaviaReconciler) GetLogger(ctx context.Context) logr.Logger {
 // +kubebuilder:rbac:groups=keystone.openstack.org,resources=keystoneendpoints,verbs=get;list;watch;create;update;patch;delete;
 // +kubebuilder:rbac:groups=rabbitmq.openstack.org,resources=transporturls,verbs=get;list;watch;create;update;patch;delete
 // +kubebuilder:rbac:groups=k8s.cni.cncf.io,resources=network-attachment-definitions,verbs=get;list;watch
+// +kubebuilder:rbac:groups=redis.openstack.org,resources=redises,verbs=get;list;watch;create;update;patch;delete
 
 // service account, role, rolebinding
 // +kubebuilder:rbac:groups="",resources=serviceaccounts,verbs=get;list;watch;create;update;patch
@@ -271,6 +274,7 @@ func (r *OctaviaReconciler) SetupWithManager(mgr ctrl.Manager) error {
 		Owns(&rbacv1.RoleBinding{}).
 		Owns(&corev1.Service{}).
 		Owns(&rabbitmqv1.TransportURL{}).
+		Owns(&redisv1.Redis{}).
 		Complete(r)
 }
 
@@ -475,6 +479,22 @@ func (r *OctaviaReconciler) reconcileInit(
 
 	// run octavia db sync - end
 
+	if len(instance.Spec.RedisServiceName) > 0 {
+		hostIPs, err := getRedisHosts(ctx, instance, helper, instance.Spec.RedisServiceName)
+		if err != nil {
+			return ctrl.Result{}, err
+		}
+
+		if len(hostIPs) == 0 {
+			Log.Info(fmt.Sprintf("RedisServiceName configured with '%s' but no Redis hosts available, jobboard will be disabled", instance.Spec.RedisServiceName))
+		}
+
+		sort.Strings(hostIPs)
+		instance.Status.RedisHosts = hostIPs
+	} else {
+		instance.Status.RedisHosts = []string{}
+	}
+
 	Log.Info("Reconciled Service init successfully")
 	return ctrl.Result{}, nil
 }
@@ -1556,6 +1576,28 @@ func (r *OctaviaReconciler) transportURLCreateOrUpdate(
 	return transportURL, op, err
 }
 
+func getRedisHosts(
+	ctx context.Context,
+	instance *octaviav1.Octavia,
+	helper *helper.Helper,
+	redisName string,
+) ([]string, error) {
+	listOptions := metav1.ListOptions{
+		LabelSelector: fmt.Sprintf("redis/name=%s", redisName),
+	}
+	pods, err := helper.GetKClient().CoreV1().Pods(instance.Namespace).List(ctx, listOptions)
+	if err != nil {
+		return []string{}, err
+	}
+	hosts := []string{}
+	for _, pod := range pods.Items {
+		// The name of the headless service is redis.Name + "-redis"
+		hostname := fmt.Sprintf("%s.%s-redis.%s.svc", pod.Name, redisName, pod.Namespace)
+		hosts = append(hosts, hostname)
+	}
+	return hosts, nil
+}
+
 func (r *OctaviaReconciler) amphoraControllerDaemonSetCreateOrUpdate(
 	instance *octaviav1.Octavia,
 	networkInfo octavia.NetworkProvisioningSummary,
@@ -1598,6 +1640,7 @@ func (r *OctaviaReconciler) amphoraControllerDaemonSetCreateOrUpdate(
 		daemonset.Spec.LbMgmtNetworkID = networkInfo.TenantNetworkID
 		daemonset.Spec.LbSecurityGroupID = networkInfo.SecurityGroupID
 		daemonset.Spec.AmphoraCustomFlavors = instance.Spec.AmphoraCustomFlavors
+		daemonset.Spec.RedisHosts = instance.Status.RedisHosts
 		daemonset.Spec.TLS = instance.Spec.OctaviaAPI.TLS.Ca
 		daemonset.Spec.AmphoraImageOwnerID = ampImageOwnerID
 		daemonset.Spec.OctaviaProviderSubnetGateway = networkInfo.ManagementSubnetGateway
diff --git a/main.go b/main.go
@@ -42,6 +42,7 @@ import (
 
 	networkv1 "github.com/k8snetworkplumbingwg/network-attachment-definition-client/pkg/apis/k8s.cni.cncf.io/v1"
 	rabbitmqv1 "github.com/openstack-k8s-operators/infra-operator/apis/rabbitmq/v1beta1"
+	redisv1 "github.com/openstack-k8s-operators/infra-operator/apis/redis/v1beta1"
 	keystonev1 "github.com/openstack-k8s-operators/keystone-operator/api/v1beta1"
 	"github.com/openstack-k8s-operators/lib-common/modules/common/operator"
 	mariadbv1 "github.com/openstack-k8s-operators/mariadb-operator/api/v1beta1"
@@ -67,6 +68,7 @@ func init() {
 	utilruntime.Must(ovn1beta1.AddToScheme(scheme))
 	utilruntime.Must(networkv1.AddToScheme(scheme))
 	utilruntime.Must(topologyv1.AddToScheme(scheme))
+	utilruntime.Must(redisv1.AddToScheme(scheme))
 	//+kubebuilder:scaffold:scheme
 }
 
diff --git a/pkg/amphoracontrollers/daemonset.go b/pkg/amphoracontrollers/daemonset.go
@@ -118,17 +118,20 @@ func DaemonSet(
 		fmt.Sprintf(InitContainerCommand, instance.Name),
 	}
 
-	// Because we don't use jobboard, we need to ensure that the octavia
+	// When we don't use jobboard, we need to ensure that the octavia
 	// controllers are gracefully shutdown, so after they receive the signal,
 	// they need to complete the jobs that are being executed (creating a LB,
 	// updating a listener)
 	// 600 sec is close to the value that was used in tripleo, it's based on the
 	// max duration of a flow in a worst case scenario (updating an amphora that
 	// is not reachable).
 	// The octavia [DEFAULT].graceful_shutdown_timeout is set accordingly
-	// TODO(gthiemonge) This setting must be updated/removed when Jobboard is
-	// re-enabled
-	terminationGracePeriodSeconds := int64(600)
+	var terminationGracePeriodSeconds int64
+	if len(instance.Spec.RedisHosts) > 0 {
+		terminationGracePeriodSeconds = int64(30)
+	} else {
+		terminationGracePeriodSeconds = int64(600)
+	}
 
 	capabilities := []corev1.Capability{"NET_ADMIN", "SYS_ADMIN", "SYS_NICE"}
 	if instance.Spec.Role == octaviav1.HealthManager {
diff --git a/templates/octaviaamphoracontroller/config/octavia.conf b/templates/octaviaamphoracontroller/config/octavia.conf
diff --git a/tests/functional/suite_test.go b/tests/functional/suite_test.go
diff --git a/tests/kuttl/common/assert_sample_deployment.yaml b/tests/kuttl/common/assert_sample_deployment.yaml
diff --git a/tests/kuttl/tests/octavia_scale/00-test-resources.yaml b/tests/kuttl/tests/octavia_scale/00-test-resources.yaml
