router: BindOnlyWhenReady -> BindPortsAfterSync

Author: marun

images/router/haproxy/conf/haproxy-config.template

@@ -98,7 +98,7 @@ listen stats :1936
     stats auth {{.StatsUser}}:{{.StatsPassword}}
 {{ end }}
 
-{{ if (and .BindOnlyWhenReady (not .SyncedAtLeastOnce)) }}
+{{ if (and .BindPortsAfterSync (not .SyncedAtLeastOnce)) }}
 # Avoiding binding ports until routing configuration has been synchronized.
 {{ else }}
 frontend public
@@ -530,7 +530,7 @@ backend be_secure_{{$cfgIdx}}
     {{ end }}{{/* end range over serviceUnitNames */}}
   {{ end }}{{/* end tls==reencrypt */}}
 {{ end }}{{/* end loop over routes */}}
-{{ end }}{{/* end bind only when ready */}}
+{{ end }}{{/* end bind ports after sync */}}
 {{ end }}{{/* end haproxy config template */}}
 
 {{/*--------------------------------- END OF HAPROXY CONFIG, BELOW ARE MAPPING FILES ------------------------*/}}

pkg/cmd/infra/router/template.go

@@ -62,7 +62,7 @@ type TemplateRouter struct {
 	DefaultCertificateDir  string
 	ExtendedValidation     bool
 	RouterService          *ktypes.NamespacedName
-	BindOnlyWhenReady      bool
+	BindPortsAfterSync     bool
 }
 
 // reloadInterval returns how often to run the router reloads. The interval
@@ -87,7 +87,7 @@ func (o *TemplateRouter) Bind(flag *pflag.FlagSet) {
 	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.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.BindOnlyWhenReady, "bind-only-when-ready", util.Env("BIND_ONLY_WHEN_READY", "") == "true", "Only bind ports when route state has been synchronized")
+	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")
 }
 
 type RouterStats struct {
@@ -190,7 +190,7 @@ func (o *TemplateRouterOptions) Run() error {
 		StatsUsername:          o.StatsUsername,
 		StatsPassword:          o.StatsPassword,
 		PeerService:            o.RouterService,
-		BindOnlyWhenReady:      o.BindOnlyWhenReady,
+		BindPortsAfterSync:     o.BindPortsAfterSync,
 		IncludeUDP:             o.RouterSelection.IncludeUDP,
 		AllowWildcardRoutes:    o.RouterSelection.AllowWildcardRoutes,
 	}

pkg/router/template/plugin.go

@@ -50,7 +50,7 @@ type TemplatePluginConfig struct {
 	IncludeUDP             bool
 	AllowWildcardRoutes    bool
 	PeerService            *ktypes.NamespacedName
-	BindOnlyWhenReady      bool
+	BindPortsAfterSync     bool
 }
 
 // routerInterface controls the interaction of the plugin with the underlying router implementation
@@ -147,7 +147,7 @@ func NewTemplatePlugin(cfg TemplatePluginConfig, lookupSvc ServiceLookup) (*Temp
 		statsPort:              cfg.StatsPort,
 		allowWildcardRoutes:    cfg.AllowWildcardRoutes,
 		peerEndpointsKey:       peerKey,
-		bindOnlyWhenReady:      cfg.BindOnlyWhenReady,
+		bindPortsAfterSync:     cfg.BindPortsAfterSync,
 	}
 	router, err := newTemplateRouter(templateRouterCfg)
 	return newDefaultTemplatePlugin(router, cfg.IncludeUDP, lookupSvc), err

pkg/router/template/router.go

@@ -87,7 +87,7 @@ type templateRouter struct {
 	// the router should only reload when the value is false
 	skipCommit bool
 	// If true, haproxy should only bind ports when it has route and endpoint state
-	bindOnlyWhenReady bool
+	bindPortsAfterSync bool
 	// whether the router state has been read from the api at least once
 	syncedAtLeastOnce bool
 }
@@ -107,7 +107,7 @@ type templateRouterCfg struct {
 	allowWildcardRoutes    bool
 	peerEndpointsKey       string
 	includeUDP             bool
-	bindOnlyWhenReady      bool
+	bindPortsAfterSync     bool
 }
 
 // templateConfig is a subset of the templateRouter information that should be passed to the template for generating
@@ -130,7 +130,7 @@ type templateData struct {
 	//port to expose stats with (if the template supports it)
 	StatsPort int
 	// whether the router should bind the default ports only when ready
-	BindOnlyWhenReady bool
+	BindPortsAfterSync bool
 	// whether the router state has been read from the api at least once
 	SyncedAtLeastOnce bool
 }
@@ -171,7 +171,7 @@ func newTemplateRouter(cfg templateRouterCfg) (*templateRouter, error) {
 		allowWildcardRoutes:    cfg.allowWildcardRoutes,
 		peerEndpointsKey:       cfg.peerEndpointsKey,
 		peerEndpoints:          []Endpoint{},
-		bindOnlyWhenReady:      cfg.bindOnlyWhenReady,
+		bindPortsAfterSync:     cfg.bindPortsAfterSync,
 
 		rateLimitedCommitFunction:    nil,
 		rateLimitedCommitStopChannel: make(chan struct{}),
@@ -404,7 +404,7 @@ func (r *templateRouter) writeConfig() error {
 			StatsUser:          r.statsUser,
 			StatsPassword:      r.statsPassword,
 			StatsPort:          r.statsPort,
-			BindOnlyWhenReady:  r.bindOnlyWhenReady,
+			BindPortsAfterSync: r.bindPortsAfterSync,
 			SyncedAtLeastOnce:  r.syncedAtLeastOnce,
 		}
 		if err := template.Execute(file, data); err != nil {

test/integration/router_test.go

@@ -1256,10 +1256,10 @@ u3YLAbyW/lHhOCiZu2iAI8AbmXem9lW6Tr7p/97s0w==
 // createAndStartRouterContainer is responsible for deploying the router image in docker.  It assumes that all router images
 // will use a command line flag that can take --master which points to the master url
 func createAndStartRouterContainer(dockerCli *dockerClient.Client, masterIp string, routerStatsPort int, reloadInterval int) (containerId string, err error) {
-	return createAndStartRouterContainerBindWhenReady(dockerCli, masterIp, routerStatsPort, reloadInterval, false)
+	return createAndStartRouterContainerBindAfterSync(dockerCli, masterIp, routerStatsPort, reloadInterval, false)
 }
 
-func createAndStartRouterContainerBindWhenReady(dockerCli *dockerClient.Client, masterIp string, routerStatsPort int, reloadInterval int, bindOnlyWhenReady bool) (containerId string, err error) {
+func createAndStartRouterContainerBindAfterSync(dockerCli *dockerClient.Client, masterIp string, routerStatsPort int, reloadInterval int, bindPortsAfterSync bool) (containerId string, err error) {
 	ports := []string{"80", "443"}
 	if routerStatsPort > 0 {
 		ports = append(ports, fmt.Sprintf("%d", routerStatsPort))
@@ -1295,7 +1295,7 @@ func createAndStartRouterContainerBindWhenReady(dockerCli *dockerClient.Client,
 		fmt.Sprintf("STATS_USERNAME=%s", statsUser),
 		fmt.Sprintf("STATS_PASSWORD=%s", statsPassword),
 		fmt.Sprintf("DEFAULT_CERTIFICATE=%s", defaultCert),
-		fmt.Sprintf("BIND_ONLY_WHEN_READY=%s", strconv.FormatBool(bindOnlyWhenReady)),
+		fmt.Sprintf("ROUTER_BIND_PORTS_AFTER_SYNC=%s", strconv.FormatBool(bindPortsAfterSync)),
 	}
 
 	reloadIntVar := fmt.Sprintf("RELOAD_INTERVAL=%ds", reloadInterval)
@@ -1624,9 +1624,9 @@ func makeRouterRequest(t *testing.T, scheme string) (*http.Response, error) {
 	return httpClient.Do(req)
 }
 
-// Ensure that when configured with BIND_ONLY_WHEN_READY=true, haproxy
-// binds ports only when it has routes and endpoints to expose.
-func TestRouterBindsPortsOnlyWhenReady(t *testing.T) {
+// Ensure that when configured with ROUTER_BIND_PORTS_AFTER_SYNC=true,
+// haproxy binds ports only when an initial sync has been performed.
+func TestRouterBindsPortsAfterSync(t *testing.T) {
 	// Create a new master but do not start it yet to simulate a router without api access.
 	fakeMasterAndPod := tr.NewTestHttpService()
 
@@ -1635,8 +1635,8 @@ func TestRouterBindsPortsOnlyWhenReady(t *testing.T) {
 		t.Fatalf("Unable to get docker client: %v", err)
 	}
 
-	bindOnlyWhenReady := true
-	routerId, err := createAndStartRouterContainerBindWhenReady(dockerCli, fakeMasterAndPod.MasterHttpAddr, statsPort, 1, bindOnlyWhenReady)
+	bindPortsAfterSync := true
+	routerId, err := createAndStartRouterContainerBindAfterSync(dockerCli, fakeMasterAndPod.MasterHttpAddr, statsPort, 1, bindPortsAfterSync)
 	if err != nil {
 		t.Fatalf("Error starting container %s : %v", getRouterImage(), err)
 	}