make repository sync frequency configurable (#4076)

Signed-off-by: himanshuchahar <[email protected]>

Author: himanshu19w

porch/Makefile

@@ -159,7 +159,8 @@ run-local: porch
 	--standalone-debug-mode \
 	--kubeconfig="$(KUBECONFIG)" \
 	--cache-directory="$(CACHEDIR)" \
-	--function-runner 192.168.8.202:9445
+	--function-runner 192.168.8.202:9445 \
+	--repo-sync-frequency=60s
 
 .PHONY: run-jaeger
 run-jaeger:

porch/deployments/porch/3-porch-server.yaml

@@ -73,6 +73,7 @@ spec:
             - --cache-directory=/cache
             - --cert-dir=/tmp/certs
             - --secure-port=4443
+            - --repo-sync-frequency=60s
 
 ---
 apiVersion: v1

porch/pkg/apiserver/apiserver.go

@@ -18,6 +18,7 @@ import (
 	"context"
 	"fmt"
 	"os"
+	"time"
 
 	"github.com/GoogleContainerTools/kpt/internal/fnruntime"
 	"github.com/GoogleContainerTools/kpt/porch/api/porch/install"
@@ -76,6 +77,7 @@ type ExtraConfig struct {
 	CacheDirectory        string
 	FunctionRunnerAddress string
 	DefaultImagePrefix    string
+	RepoSyncFrequency     time.Duration
 }
 
 // Config defines the config for the apiserver
@@ -220,7 +222,7 @@ func (c completedConfig) New() (*PorchServer, error) {
 
 	watcherMgr := engine.NewWatcherManager()
 
-	cache := cache.NewCache(c.ExtraConfig.CacheDirectory, cache.CacheOptions{
+	cache := cache.NewCache(c.ExtraConfig.CacheDirectory, c.ExtraConfig.RepoSyncFrequency, cache.CacheOptions{
 		CredentialResolver: credentialResolver,
 		UserInfoProvider:   userInfoProvider,
 		MetadataStore:      metadataStore,

porch/pkg/cache/cache.go

@@ -20,6 +20,7 @@ import (
 	"fmt"
 	"path/filepath"
 	"sync"
+	"time"
 
 	kptoci "github.com/GoogleContainerTools/kpt/pkg/oci"
 	configapi "github.com/GoogleContainerTools/kpt/porch/api/porchconfig/v1alpha1"
@@ -48,8 +49,8 @@ type Cache struct {
 	credentialResolver repository.CredentialResolver
 	userInfoProvider   repository.UserInfoProvider
 	metadataStore      meta.MetadataStore
-
-	objectNotifier objectNotifier
+	repoSyncFrequency  time.Duration
+	objectNotifier     objectNotifier
 }
 
 type objectNotifier interface {
@@ -63,14 +64,15 @@ type CacheOptions struct {
 	ObjectNotifier     objectNotifier
 }
 
-func NewCache(cacheDir string, opts CacheOptions) *Cache {
+func NewCache(cacheDir string, repoSyncFrequency time.Duration, opts CacheOptions) *Cache {
 	return &Cache{
 		repositories:       make(map[string]*cachedRepository),
 		cacheDir:           cacheDir,
 		credentialResolver: opts.CredentialResolver,
 		userInfoProvider:   opts.UserInfoProvider,
 		metadataStore:      opts.MetadataStore,
 		objectNotifier:     opts.ObjectNotifier,
+		repoSyncFrequency:  repoSyncFrequency,
 	}
 }
 
@@ -101,7 +103,7 @@ func (c *Cache) OpenRepository(ctx context.Context, repositorySpec *configapi.Re
 			if err != nil {
 				return nil, err
 			}
-			cr = newRepository(key, repositorySpec, r, c.objectNotifier, c.metadataStore)
+			cr = newRepository(key, repositorySpec, r, c.objectNotifier, c.metadataStore, c.repoSyncFrequency)
 			c.repositories[key] = cr
 		}
 		return cr, nil
@@ -137,7 +139,7 @@ func (c *Cache) OpenRepository(ctx context.Context, repositorySpec *configapi.Re
 			}); err != nil {
 				return nil, err
 			} else {
-				cr = newRepository(key, repositorySpec, r, c.objectNotifier, c.metadataStore)
+				cr = newRepository(key, repositorySpec, r, c.objectNotifier, c.metadataStore, c.repoSyncFrequency)
 				c.repositories[key] = cr
 			}
 		} else {

porch/pkg/cache/cache_test.go

@@ -20,6 +20,7 @@ import (
 	"os"
 	"path/filepath"
 	"testing"
+	"time"
 
 	api "github.com/GoogleContainerTools/kpt/porch/api/porch/v1alpha1"
 	"github.com/GoogleContainerTools/kpt/porch/api/porchconfig/v1alpha1"
@@ -134,7 +135,7 @@ func openRepositoryFromArchive(t *testing.T, ctx context.Context, testPath, name
 	repo, address := git.ServeGitRepository(t, tarfile, tempdir)
 	metadataStore := createMetadataStoreFromArchive(t, "", "")
 
-	cache := NewCache(t.TempDir(), CacheOptions{
+	cache := NewCache(t.TempDir(), 60*time.Second, CacheOptions{
 		MetadataStore:  metadataStore,
 		ObjectNotifier: &fakecache.ObjectNotifier{},
 	})

porch/pkg/cache/repository.go

@@ -68,7 +68,7 @@ type cachedRepository struct {
 	metadataStore meta.MetadataStore
 }
 
-func newRepository(id string, repoSpec *configapi.Repository, repo repository.Repository, objectNotifier objectNotifier, metadataStore meta.MetadataStore) *cachedRepository {
+func newRepository(id string, repoSpec *configapi.Repository, repo repository.Repository, objectNotifier objectNotifier, metadataStore meta.MetadataStore, repoSyncFrequency time.Duration) *cachedRepository {
 	ctx, cancel := context.WithCancel(context.Background())
 	r := &cachedRepository{
 		id:             id,
@@ -81,7 +81,7 @@ func newRepository(id string, repoSpec *configapi.Repository, repo repository.Re
 
 	// TODO: Should we fetch the packages here?
 
-	go r.pollForever(ctx)
+	go r.pollForever(ctx, repoSyncFrequency)
 
 	return r
 }
@@ -339,7 +339,7 @@ func (r *cachedRepository) Close() error {
 }
 
 // pollForever will continue polling until signal channel is closed or ctx is done.
-func (r *cachedRepository) pollForever(ctx context.Context) {
+func (r *cachedRepository) pollForever(ctx context.Context, repoSyncFrequency time.Duration) {
 	r.pollOnce(ctx)
 	for {
 		select {
@@ -348,7 +348,7 @@ func (r *cachedRepository) pollForever(ctx context.Context) {
 			return
 		default:
 			r.pollOnce(ctx)
-			time.Sleep(60 * time.Second)
+			time.Sleep(repoSyncFrequency)
 		}
 	}
 }

porch/pkg/cmd/server/start.go

@@ -20,6 +20,7 @@ import (
 	"io"
 	"net"
 	"os"
+	"time"
 
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
@@ -51,6 +52,7 @@ type PorchServerOptions struct {
 	CoreAPIKubeconfigPath    string
 	FunctionRunnerAddress    string
 	DefaultImagePrefix       string
+	RepoSyncFrequency        time.Duration
 
 	SharedInformerFactory informers.SharedInformerFactory
 	StdOut                io.Writer
@@ -182,6 +184,7 @@ func (o *PorchServerOptions) Config() (*apiserver.Config, error) {
 		ExtraConfig: apiserver.ExtraConfig{
 			CoreAPIKubeconfigPath: o.CoreAPIKubeconfigPath,
 			CacheDirectory:        o.CacheDirectory,
+			RepoSyncFrequency:     o.RepoSyncFrequency,
 			FunctionRunnerAddress: o.FunctionRunnerAddress,
 			DefaultImagePrefix:    o.DefaultImagePrefix,
 		},
@@ -229,4 +232,5 @@ func (o *PorchServerOptions) AddFlags(fs *pflag.FlagSet) {
 	fs.StringVar(&o.FunctionRunnerAddress, "function-runner", "", "Address of the function runner gRPC service.")
 	fs.StringVar(&o.DefaultImagePrefix, "default-image-prefix", "gcr.io/kpt-fn/", "Default prefix for unqualified function names")
 	fs.StringVar(&o.CacheDirectory, "cache-directory", "", "Directory where Porch server stores repository and package caches.")
+	fs.DurationVar(&o.RepoSyncFrequency, "repo-sync-frequency", 60*time.Second, "Frequency in seconds at which registered repositories will be synced.")
 }

porch/pkg/cmd/server/start_test.go

@@ -0,0 +1,41 @@
+// Copyright 2023 The kpt Authors
+//
+// 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.
+
+package server
+
+import (
+	porchv1alpha1 "github.com/GoogleContainerTools/kpt/porch/api/porch/v1alpha1"
+	"github.com/GoogleContainerTools/kpt/porch/pkg/apiserver"
+	"github.com/spf13/pflag"
+	"k8s.io/apimachinery/pkg/runtime/schema"
+	genericoptions "k8s.io/apiserver/pkg/server/options"
+	"testing"
+	"time"
+)
+
+func TestAddFlags(t *testing.T) {
+	versions := schema.GroupVersions{
+		porchv1alpha1.SchemeGroupVersion,
+	}
+	o := PorchServerOptions{
+		RecommendedOptions: genericoptions.NewRecommendedOptions(
+			defaultEtcdPathPrefix,
+			apiserver.Codecs.LegacyCodec(versions...),
+		),
+	}
+	o.AddFlags(&pflag.FlagSet{})
+	if o.RepoSyncFrequency < 30*time.Second {
+		t.Fatalf("AddFlags(): repo-sync-frequency cannot be less that 30 seconds.")
+	}
+}