Add config for packageserver wakeup interval (openshift#298)

Signed-off-by: Todd Short <[email protected]>
Upstream-repository: api
Upstream-commit: 7961b0208d99b3e059a0607663dba547a7e685d7

Author: tmshort

manifests/0000_50_olm_00-olmconfigs.crd.yaml

@@ -45,6 +45,10 @@ spec:
                     disableCopiedCSVs:
                       description: DisableCopiedCSVs is used to disable OLM's "Copied CSV" feature for operators installed at the cluster scope, where a cluster scoped operator is one that has been installed in an OperatorGroup that targets all namespaces. When reenabled, OLM will recreate the "Copied CSVs" for each cluster scoped operator.
                       type: boolean
+                    packageServerSyncInterval:
+                      description: PackageServerSyncInterval is used to define the sync interval for packagerserver pods. Packageserver pods periodically check the status of CatalogSources; this specifies the period using duration format (e.g. "60m"). For this parameter, only hours ("h"), minutes ("m"), and seconds ("s") may be specified. When not specified, the period defaults to the value specified within the packageserver.
+                      type: string
+                      pattern: ^([0-9]+(\.[0-9]+)?(s|m|h))+$
             status:
               description: OLMConfigStatus is the status for an OLMConfig resource.
               type: object

staging/api/crds/operators.coreos.com_olmconfigs.yaml

@@ -43,6 +43,10 @@ spec:
                     disableCopiedCSVs:
                       description: DisableCopiedCSVs is used to disable OLM's "Copied CSV" feature for operators installed at the cluster scope, where a cluster scoped operator is one that has been installed in an OperatorGroup that targets all namespaces. When reenabled, OLM will recreate the "Copied CSVs" for each cluster scoped operator.
                       type: boolean
+                    packageServerSyncInterval:
+                      description: PackageServerSyncInterval is used to define the sync interval for packagerserver pods. Packageserver pods periodically check the status of CatalogSources; this specifies the period using duration format (e.g. "60m"). For this parameter, only hours ("h"), minutes ("m"), and seconds ("s") may be specified. When not specified, the period defaults to the value specified within the packageserver.
+                      type: string
+                      pattern: ^([0-9]+(\.[0-9]+)?(s|m|h))+$
             status:
               description: OLMConfigStatus is the status for an OLMConfig resource.
               type: object

staging/api/crds/zz_defs.go

@@ -2,14 +2,84 @@ package v1
 
 import (
 	"testing"
+	"time"
 
 	"github.com/stretchr/testify/require"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
 func boolPointer(in bool) *bool {
 	return &in
 }
+func TestPackageServerSyncInterval(t *testing.T) {
+	five := time.Minute * 5
+	one := time.Second * 60
 
+	fiveParsed, err := time.ParseDuration("5m")
+	require.NoError(t, err)
+
+	oneParsed, err := time.ParseDuration("60s")
+	require.NoError(t, err)
+
+	tests := []struct {
+		description string
+		olmConfig   *OLMConfig
+		expected    *time.Duration
+	}{
+		{
+			description: "NilConfig",
+			olmConfig:   nil,
+			expected:    nil,
+		},
+		{
+			description: "MissingSpec",
+			olmConfig:   &OLMConfig{},
+			expected:    nil,
+		},
+		{
+			description: "MissingFeatures",
+			olmConfig: &OLMConfig{
+				Spec: OLMConfigSpec{},
+			},
+			expected: nil,
+		},
+		{
+			description: "MissingPackageServerInterval",
+			olmConfig: &OLMConfig{
+				Spec: OLMConfigSpec{},
+			},
+			expected: nil,
+		},
+		{
+			description: "PackageServerInterval5m",
+			olmConfig: &OLMConfig{
+				Spec: OLMConfigSpec{
+					Features: &Features{
+						PackageServerSyncInterval: &metav1.Duration{Duration: fiveParsed},
+					},
+				},
+			},
+			expected: &five,
+		},
+		{
+			description: "PackageServerInterval60s",
+			olmConfig: &OLMConfig{
+				Spec: OLMConfigSpec{
+					Features: &Features{
+						PackageServerSyncInterval: &metav1.Duration{Duration: oneParsed},
+					},
+				},
+			},
+			expected: &one,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.description, func(t *testing.T) {
+			require.EqualValues(t, tt.expected, tt.olmConfig.PackageServerSyncInterval())
+		})
+	}
+}
 func TestCopiedCSVsAreEnabled(t *testing.T) {
 	tests := []struct {
 		description string

staging/api/pkg/operators/v1/olmconfig_test.go

@@ -1,6 +1,8 @@
 package v1
 
 import (
+	"time"
+
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
@@ -23,6 +25,16 @@ type Features struct {
 	// When reenabled, OLM will recreate the "Copied CSVs" for each
 	// cluster scoped operator.
 	DisableCopiedCSVs *bool `json:"disableCopiedCSVs,omitempty"`
+	// PackageServerSyncInterval is used to define the sync interval for
+	// packagerserver pods. Packageserver pods periodically check the
+	// status of CatalogSources; this specifies the period using duration
+	// format (e.g. "60m"). For this parameter, only hours ("h"), minutes
+	// ("m"), and seconds ("s") may be specified. When not specified, the
+	// period defaults to the value specified within the packageserver.
+	// +optional
+	// +kubebuilder:validation:Type=string
+	// +kubebuilder:validation:Pattern="^([0-9]+(\\.[0-9]+)?(s|m|h))+$"
+	PackageServerSyncInterval *metav1.Duration `json:"packageServerSyncInterval,omitempty"`
 }
 
 // OLMConfigStatus is the status for an OLMConfig resource.
@@ -69,3 +81,10 @@ func (config *OLMConfig) CopiedCSVsAreEnabled() bool {
 
 	return !*config.Spec.Features.DisableCopiedCSVs
 }
+
+func (config *OLMConfig) PackageServerSyncInterval() *time.Duration {
+	if config == nil || config.Spec.Features == nil || config.Spec.Features.PackageServerSyncInterval == nil {
+		return nil
+	}
+	return &config.Spec.Features.PackageServerSyncInterval.Duration
+}