Change the router reload supression, and add some more controls

contrib/completions/bash/openshift

@@ -24282,6 +24282,10 @@ _openshift_infra_router()
     local_nonpersistent_flags+=("--project-labels=")
     flags+=("--reload=")
     local_nonpersistent_flags+=("--reload=")
+    flags+=("--reload-event-wait=")
+    local_nonpersistent_flags+=("--reload-event-wait=")
+    flags+=("--reload-gap=")
+    local_nonpersistent_flags+=("--reload-gap=")
     flags+=("--request-timeout=")
     local_nonpersistent_flags+=("--request-timeout=")
     flags+=("--resync-interval=")

contrib/completions/zsh/openshift

@@ -24431,6 +24431,10 @@ _openshift_infra_router()
     local_nonpersistent_flags+=("--project-labels=")
     flags+=("--reload=")
     local_nonpersistent_flags+=("--reload=")
+    flags+=("--reload-event-wait=")
+    local_nonpersistent_flags+=("--reload-event-wait=")
+    flags+=("--reload-gap=")
+    local_nonpersistent_flags+=("--reload-gap=")
     flags+=("--request-timeout=")
     local_nonpersistent_flags+=("--request-timeout=")
     flags+=("--resync-interval=")

pkg/cmd/infra/router/template.go

@@ -34,9 +34,6 @@ import (
 	"github.com/openshift/origin/pkg/version"
 )
 
-// defaultReloadInterval is how often to do reloads in seconds.
-const defaultReloadInterval = 5
-
 var routerLong = templates.LongDesc(`
 	Start a router
 
@@ -68,6 +65,8 @@ type TemplateRouter struct {
 	TemplateFile             string
 	ReloadScript             string
 	ReloadInterval           time.Duration
+	ReloadGap                time.Duration
+	ReloadEventWait          time.Duration
 	DefaultCertificate       string
 	DefaultCertificatePath   string
 	DefaultCertificateDir    string
@@ -81,14 +80,15 @@ type TemplateRouter struct {
 	MetricsType              string
 }
 
-// reloadInterval returns how often to run the router reloads. The interval
-// value is based on an environment variable or the default.
-func reloadInterval() time.Duration {
-	interval := util.Env("RELOAD_INTERVAL", fmt.Sprintf("%vs", defaultReloadInterval))
-	value, err := time.ParseDuration(interval)
+// getDurationEnv() gets retrieves the value of the named environment
+// variable and checks that is a valid duration.  If it is not, or it
+// is not set, it returns the given default.
+func getDurationEnv(envName string, defaultDuration time.Duration) time.Duration {
+	valueString := util.Env(envName, defaultDuration.String())
+	value, err := time.ParseDuration(valueString)
 	if err != nil {
-		glog.Warningf("Invalid RELOAD_INTERVAL %q, using default value %v ...", interval, defaultReloadInterval)
-		value = time.Duration(defaultReloadInterval * time.Second)
+		glog.Warningf("Invalid %s %q, using default value %s ...", envName, valueString, defaultDuration.String())
+		value = defaultDuration
 	}
 	return value
 }
@@ -103,7 +103,9 @@ func (o *TemplateRouter) Bind(flag *pflag.FlagSet) {
 	flag.StringVar(&o.DefaultDestinationCAPath, "default-destination-ca-path", util.Env("DEFAULT_DESTINATION_CA_PATH", "/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt"), "A path to a PEM file containing the default CA bundle to use with re-encrypt routes. This CA should sign for certificates in the Kubernetes DNS space (service.namespace.svc).")
 	flag.StringVar(&o.TemplateFile, "template", util.Env("TEMPLATE_FILE", ""), "The path to the template file to use")
 	flag.StringVar(&o.ReloadScript, "reload", util.Env("RELOAD_SCRIPT", ""), "The path to the reload script to use")
-	flag.DurationVar(&o.ReloadInterval, "interval", reloadInterval(), "Controls how often router reloads are invoked. Mutiple router reload requests are coalesced for the duration of this interval since the last reload time.")
+	flag.DurationVar(&o.ReloadInterval, "interval", getDurationEnv("RELOAD_INTERVAL", 5*time.Second), "Controls how often router reloads are invoked. Mutiple router reload requests are coalesced for the duration of this interval since the time the last reload started.")
+	flag.DurationVar(&o.ReloadGap, "reload-gap", getDurationEnv("RELOAD_GAP", 100*time.Millisecond), "Controls how often router reloads are invoked. Mutiple router reload requests are coalesced for the duration of this interval since the time the last reload ended.")
+	flag.DurationVar(&o.ReloadEventWait, "reload-event-wait", getDurationEnv("RELOAD_EVENT_WAIT", 10*time.Millisecond), "Controls how often router reloads are invoked. Mutiple router reload events are gathered for the given duration before a reload is triggered.")
 	flag.BoolVar(&o.ExtendedValidation, "extended-validation", util.Env("EXTENDED_VALIDATION", "true") == "true", "If set, then an additional extended validation step is performed on all routes admitted in by this router. Defaults to true and enables the extended validation checks.")
 	flag.BoolVar(&o.BindPortsAfterSync, "bind-ports-after-sync", util.Env("ROUTER_BIND_PORTS_AFTER_SYNC", "") == "true", "Bind ports only after route state has been synchronized")
 	flag.StringVar(&o.MaxConnections, "max-connections", util.Env("ROUTER_MAX_CONNECTIONS", ""), "Specifies the maximum number of concurrent connections.")
@@ -205,6 +207,14 @@ func (o *TemplateRouterOptions) Complete() error {
 		return fmt.Errorf("invalid reload interval: %v - must be a positive duration", nsecs)
 	}
 
+	if o.ReloadGap < 0 {
+		return fmt.Errorf("invalid reload gap: %s - must not be negative", o.ReloadGap.String())
+	}
+
+	if o.ReloadEventWait < 0 {
+		return fmt.Errorf("invalid reload event wait: %s - must not be negative", o.ReloadEventWait.String())
+	}
+
 	if len(routerCanonicalHostname) > 0 {
 		if errs := validation.IsDNS1123Subdomain(routerCanonicalHostname); len(errs) != 0 {
 			return fmt.Errorf("invalid canonical hostname: %s", routerCanonicalHostname)
@@ -324,6 +334,8 @@ func (o *TemplateRouterOptions) Run() error {
 		TemplatePath:             o.TemplateFile,
 		ReloadScriptPath:         o.ReloadScript,
 		ReloadInterval:           o.ReloadInterval,
+		ReloadGap:                o.ReloadGap,
+		ReloadEventWait:          o.ReloadEventWait,
 		DefaultCertificate:       o.DefaultCertificate,
 		DefaultCertificatePath:   o.DefaultCertificatePath,
 		DefaultCertificateDir:    o.DefaultCertificateDir,

pkg/router/template/fake.go

@@ -1,25 +1,27 @@
 package templaterouter
 
+import "time"
+
 // NewFakeTemplateRouter provides an empty template router with a simple certificate manager
 // backed by a fake cert writer for testing
 func NewFakeTemplateRouter() *templateRouter {
 	fakeCertManager, _ := newSimpleCertificateManager(newFakeCertificateManagerConfig(), &fakeCertWriter{})
 	return &templateRouter{
-		state:                        map[string]ServiceAliasConfig{},
-		serviceUnits:                 make(map[string]ServiceUnit),
-		certManager:                  fakeCertManager,
-		rateLimitedCommitFunction:    nil,
-		rateLimitedCommitStopChannel: make(chan struct{}),
+		state:        map[string]ServiceAliasConfig{},
+		serviceUnits: make(map[string]ServiceUnit),
+		certManager:  fakeCertManager,
 	}
 }
 
 // FakeReloadHandler implements the minimal changes needed to make the locking behavior work
-// This MUST match the behavior with the stateChanged of commitAndReload
+// This MUST match the behavior with the object updates of commitAndReload() in router.go
 func (r *templateRouter) FakeReloadHandler() {
 	r.lock.Lock()
 	defer r.lock.Unlock()
 
 	r.stateChanged = false
+	r.lastReloadStart = time.Now()
+	r.lastReloadEnd = time.Now()
 
 	return
 }

pkg/router/template/plugin.go

@@ -46,6 +46,8 @@ type TemplatePluginConfig struct {
 	TemplatePath             string
 	ReloadScriptPath         string
 	ReloadInterval           time.Duration
+	ReloadGap                time.Duration
+	ReloadEventWait          time.Duration
 	ReloadCallbacks          []func()
 	DefaultCertificate       string
 	DefaultCertificatePath   string
@@ -123,6 +125,8 @@ func NewTemplatePlugin(cfg TemplatePluginConfig, lookupSvc ServiceLookup) (*Temp
 		templates:                templates,
 		reloadScriptPath:         cfg.ReloadScriptPath,
 		reloadInterval:           cfg.ReloadInterval,
+		reloadGap:                cfg.ReloadGap,
+		reloadEventWait:          cfg.ReloadEventWait,
 		reloadCallbacks:          cfg.ReloadCallbacks,
 		defaultCertificate:       cfg.DefaultCertificate,
 		defaultCertificatePath:   cfg.DefaultCertificatePath,