OCPBUGS-17950: Make packaeserver wakeup interval configurable

The packageserver wakeup interval is used to update its package
manifest from CatSrcs. However, this does not need to happen
periodically (especially 5m) as the CatSrc pods will restart
when a change occurs to data it is caching, and this will be
acted upon by packageserver.

This allows configuration of this interval via the
package-server-manager deployment (which then gets passed
onto the packageserver deployment).

Signed-off-by: Todd Short <[email protected]>

Author: tmshort

cmd/package-server-manager/main.go

@@ -29,6 +29,7 @@ const (
 	defaultMetricsPort          = "0"
 	defaultHealthCheckPort      = ":8080"
 	defaultPprofPort            = ":6060"
+	defaultInterval             = "5m"
 	leaderElectionConfigmapName = "packageserver-controller-lock"
 )
 
@@ -62,6 +63,10 @@ func run(cmd *cobra.Command, args []string) error {
 	if err != nil {
 		return err
 	}
+	interval, err := cmd.Flags().GetString("interval")
+	if err != nil {
+		return err
+	}
 
 	ctrl.SetLogger(zap.New(zap.UseDevMode(true)))
 	setupLog := ctrl.Log.WithName("setup")
@@ -99,6 +104,7 @@ func run(cmd *cobra.Command, args []string) error {
 		Name:      name,
 		Namespace: namespace,
 		Image:     os.Getenv("PACKAGESERVER_IMAGE"),
+		Interval:  interval,
 		Client:    mgr.GetClient(),
 		Log:       ctrl.Log.WithName("controllers").WithName(name),
 		Scheme:    mgr.GetScheme(),

cmd/package-server-manager/start.go

@@ -16,6 +16,7 @@ func newStartCmd() *cobra.Command {
 	cmd.Flags().String("namespace", defaultNamespace, "configures the metadata.namespace that contains the packageserver csv resource")
 	cmd.Flags().String("health", defaultHealthCheckPort, "configures the health check port that the kubelet is configured to probe")
 	cmd.Flags().String("pprof", defaultPprofPort, "configures the pprof port that the process exposes")
+	cmd.Flags().String("interval", defaultInterval, "configures the wakeup interval for the packageserver csc resource")
 	cmd.Flags().Bool("disable-leader-election", false, "configures whether leader election will be disabled")
 
 	return cmd

manifests/0000_50_olm_06-psm-operator.deployment.ibm-cloud-managed.yaml

@@ -41,6 +41,8 @@ spec:
             - $(PACKAGESERVER_NAME)
             - --namespace
             - $(PACKAGESERVER_NAMESPACE)
+            - --interval
+            - $(PACKAGESERVER_INTERVAL)
           image: quay.io/operator-framework/olm@sha256:de396b540b82219812061d0d753440d5655250c621c753ed1dc67d6154741607
           imagePullPolicy: IfNotPresent
           env:
@@ -52,6 +54,8 @@ spec:
               valueFrom:
                 fieldRef:
                   fieldPath: metadata.namespace
+            - name: PACKAGESERVER_INTERVAL
+              value: 5m
             - name: RELEASE_VERSION
               value: "0.0.1-snapshot"
           resources:

manifests/0000_50_olm_06-psm-operator.deployment.yaml

@@ -41,6 +41,8 @@ spec:
             - $(PACKAGESERVER_NAME)
             - --namespace
             - $(PACKAGESERVER_NAMESPACE)
+            - --interval
+            - $(PACKAGESERVER_INTERVAL)
           image: quay.io/operator-framework/olm@sha256:de396b540b82219812061d0d753440d5655250c621c753ed1dc67d6154741607
           imagePullPolicy: IfNotPresent
           env:
@@ -52,6 +54,8 @@ spec:
               valueFrom:
                 fieldRef:
                   fieldPath: metadata.namespace
+            - name: PACKAGESERVER_INTERVAL
+              value: 5m
             - name: RELEASE_VERSION
               value: "0.0.1-snapshot"
           resources:

pkg/manifests/manifests.go

@@ -3,6 +3,8 @@ package manifests
 import (
 	_ "embed"
 
+	"fmt"
+
 	olmv1alpha1 "github.com/operator-framework/api/pkg/operators/v1alpha1"
 
 	"k8s.io/apimachinery/pkg/util/yaml"
@@ -31,6 +33,33 @@ func NewPackageServerCSV(opts ...CSVOption) (*olmv1alpha1.ClusterServiceVersion,
 	return &csv, nil
 }
 
+func WithRunFlags(flags []string) CSVOption {
+	for _, f := range flags {
+		fmt.Printf("WithRunFlags passed in flag: '%v'\n", f)
+	}
+	return func(csv *olmv1alpha1.ClusterServiceVersion) {
+		for _, f := range flags {
+			fmt.Printf("WithRunFlags returned func: flag '%v'\n", f)
+		}
+		for i, deployment := range csv.Spec.InstallStrategy.StrategySpec.DeploymentSpecs {
+			for j, container := range deployment.Spec.Template.Spec.Containers {
+				// TODO: Should be fine to hardcode this for now, but likely want
+				// to pass this as a parameter?
+				if container.Name == "packageserver" {
+					for _, flag := range flags {
+						fmt.Printf("WithRunFlags returned func: applying flag '%v'\n", flag)
+						container.Command = append(container.Command, flag)
+					}
+					csv.Spec.InstallStrategy.StrategySpec.DeploymentSpecs[i].Spec.Template.Spec.Containers[j].Command = container.Command
+					fmt.Printf("WithRunFlags returned func: updated command '%v'\n", container.Command)
+					break
+				}
+			}
+		}
+
+	}
+}
+
 func WithName(name string) CSVOption {
 	return func(csv *olmv1alpha1.ClusterServiceVersion) {
 		csv.Name = name

pkg/package-server-manager/config.go

@@ -66,11 +66,12 @@ func getTopologyModeFromInfra(infra *configv1.Infrastructure) bool {
 // resource matches that of the codified defaults and high availability configurations, where
 // codified defaults are defined by the csv returned by the manifests.NewPackageServerCSV
 // function.
-func ensureCSV(log logr.Logger, image string, csv *olmv1alpha1.ClusterServiceVersion, highlyAvailableMode bool) (bool, error) {
+func ensureCSV(log logr.Logger, image string, interval string, csv *olmv1alpha1.ClusterServiceVersion, highlyAvailableMode bool) (bool, error) {
 	expectedCSV, err := manifests.NewPackageServerCSV(
 		manifests.WithName(csv.Name),
 		manifests.WithNamespace(csv.Namespace),
 		manifests.WithImage(image),
+		manifests.WithRunFlags([]string{"--interval", interval}),
 	)
 	if err != nil {
 		return false, err

pkg/package-server-manager/controller.go

@@ -54,6 +54,7 @@ type PackageServerCSVReconciler struct {
 	Name      string
 	Namespace string
 	Image     string
+	Interval  string
 }
 
 // Reconcile is part of the main kubernetes reconciliation loop which is responsible
@@ -77,13 +78,14 @@ func (r *PackageServerCSVReconciler) Reconcile(ctx context.Context, req ctrl.Req
 		manifests.WithName(r.Name),
 		manifests.WithNamespace(r.Namespace),
 		manifests.WithImage(r.Image),
+		manifests.WithRunFlags([]string{"--interval", r.Interval}),
 	)
 	if err != nil {
 		log.Error(err, "failed to serialize a new packageserver csv from the base YAML manifest")
 		return ctrl.Result{}, err
 	}
 	res, err := controllerutil.CreateOrUpdate(ctx, r.Client, required, func() error {
-		return reconcileCSV(r.Log, r.Image, required, highAvailabilityMode)
+		return reconcileCSV(r.Log, r.Image, r.Interval, required, highAvailabilityMode)
 	})
 
 	log.Info("reconciliation result", "res", res)
@@ -95,12 +97,12 @@ func (r *PackageServerCSVReconciler) Reconcile(ctx context.Context, req ctrl.Req
 	return ctrl.Result{}, nil
 }
 
-func reconcileCSV(log logr.Logger, image string, csv *olmv1alpha1.ClusterServiceVersion, highAvailabilityMode bool) error {
+func reconcileCSV(log logr.Logger, image string, interval string, csv *olmv1alpha1.ClusterServiceVersion, highAvailabilityMode bool) error {
 	if csv.ObjectMeta.CreationTimestamp.IsZero() {
 		log.Info("attempting to create the packageserver csv")
 	}
 
-	modified, err := ensureCSV(log, image, csv, highAvailabilityMode)
+	modified, err := ensureCSV(log, image, interval, csv, highAvailabilityMode)
 	if err != nil {
 		return fmt.Errorf("error ensuring CSV: %v", err)
 	}

pkg/package-server-manager/controller_test.go

@@ -22,6 +22,7 @@ var (
 	name      = "packageserver"
 	namespace = "openshift-operator-lifecycle-manager"
 	image     = getImageFromManifest()
+	interval  = "5m"
 )
 
 func TestHighlyAvailableFromInstructure(t *testing.T) {
@@ -111,6 +112,7 @@ func newTestCSV(
 	csv, err := manifests.NewPackageServerCSV(
 		manifests.WithName(name),
 		manifests.WithNamespace(namespace),
+		manifests.WithRunFlags([]string{"--interval", interval}),
 	)
 	if err != nil {
 		return nil
@@ -133,6 +135,7 @@ func getImageFromManifest() string {
 	csv, err := manifests.NewPackageServerCSV(
 		manifests.WithName(name),
 		manifests.WithNamespace(namespace),
+		manifests.WithRunFlags([]string{"--interval", interval}),
 	)
 	if err != nil {
 		return ""
@@ -258,7 +261,7 @@ func TestEnsureCSV(t *testing.T) {
 		tc := tc
 
 		t.Run(tc.name, func(t *testing.T) {
-			gotBool, gotErr := ensureCSV(logger, image, tc.inputCSV, tc.highlyAvailable)
+			gotBool, gotErr := ensureCSV(logger, image, interval, tc.inputCSV, tc.highlyAvailable)
 			require.EqualValues(t, tc.want.expectedBool, gotBool)
 			require.EqualValues(t, tc.want.expectedErr, gotErr)
 			require.EqualValues(t, tc.inputCSV.Spec, tc.expectedCSV.Spec)

scripts/generate_crds_manifests.sh

@@ -151,6 +151,8 @@ spec:
             - \$(PACKAGESERVER_NAME)
             - --namespace
             - \$(PACKAGESERVER_NAMESPACE)
+            - --interval
+            - \$(PACKAGESERVER_INTERVAL)
           image: quay.io/operator-framework/olm@sha256:de396b540b82219812061d0d753440d5655250c621c753ed1dc67d6154741607
           imagePullPolicy: IfNotPresent
           env:
@@ -162,6 +164,8 @@ spec:
               valueFrom:
                 fieldRef:
                   fieldPath: metadata.namespace
+            - name: PACKAGESERVER_INTERVAL
+              value: 5m
             - name: RELEASE_VERSION
               value: "0.0.1-snapshot"
           resources: