Merge pull request kubernetes#89146 from SataQiu/fix-kube-proxy-20200316

k8s-ci-robot · web-flow · commit 1b3c94b0343a · 2020-03-18T22:25:05.000-07:00
comment cleanup for kube-proxy
diff --git a/pkg/proxy/config/config.go b/pkg/proxy/config/config.go
@@ -20,7 +20,7 @@ import (
 	"fmt"
 	"time"
 
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 	discovery "k8s.io/api/discovery/v1beta1"
 	utilruntime "k8s.io/apimachinery/pkg/util/runtime"
 	coreinformers "k8s.io/client-go/informers/core/v1"
@@ -381,7 +381,7 @@ type NodeHandler interface {
 	// OnNodeUpdate is called whenever modification of an existing
 	// node object is observed.
 	OnNodeUpdate(oldNode, node *v1.Node)
-	// OnNodeDelete is called whever deletion of an existing node
+	// OnNodeDelete is called whenever deletion of an existing node
 	// object is observed.
 	OnNodeDelete(node *v1.Node)
 	// OnNodeSynced is called once all the initial event handlers were
diff --git a/pkg/proxy/iptables/proxier.go b/pkg/proxy/iptables/proxier.go
@@ -541,7 +541,7 @@ func (proxier *Proxier) OnServiceDelete(service *v1.Service) {
 
 }
 
-// OnServiceSynced is called once all the initial even handlers were
+// OnServiceSynced is called once all the initial event handlers were
 // called and the state is fully propagated to local cache.
 func (proxier *Proxier) OnServiceSynced() {
 	proxier.mu.Lock()
@@ -663,7 +663,7 @@ func (proxier *Proxier) OnNodeUpdate(oldNode, node *v1.Node) {
 	proxier.syncProxyRules()
 }
 
-// OnNodeDelete is called whever deletion of an existing node
+// OnNodeDelete is called whenever deletion of an existing node
 // object is observed.
 func (proxier *Proxier) OnNodeDelete(node *v1.Node) {
 	if node.Name != proxier.hostname {
diff --git a/pkg/proxy/ipvs/proxier.go b/pkg/proxy/ipvs/proxier.go
@@ -980,7 +980,7 @@ func (proxier *Proxier) OnNodeUpdate(oldNode, node *v1.Node) {
 	proxier.syncProxyRules()
 }
 
-// OnNodeDelete is called whever deletion of an existing node
+// OnNodeDelete is called whenever deletion of an existing node
 // object is observed.
 func (proxier *Proxier) OnNodeDelete(node *v1.Node) {
 	if node.Name != proxier.hostname {
diff --git a/pkg/proxy/userspace/proxier.go b/pkg/proxy/userspace/proxier.go
@@ -621,18 +621,26 @@ func (proxier *Proxier) serviceChange(previous, current *v1.Service, detail stri
 	}
 }
 
+// OnServiceAdd is called whenever creation of new service object
+// is observed.
 func (proxier *Proxier) OnServiceAdd(service *v1.Service) {
 	proxier.serviceChange(nil, service, "OnServiceAdd")
 }
 
+// OnServiceUpdate is called whenever modification of an existing
+// service object is observed.
 func (proxier *Proxier) OnServiceUpdate(oldService, service *v1.Service) {
 	proxier.serviceChange(oldService, service, "OnServiceUpdate")
 }
 
+// OnServiceDelete is called whenever deletion of an existing service
+// object is observed.
 func (proxier *Proxier) OnServiceDelete(service *v1.Service) {
 	proxier.serviceChange(service, nil, "OnServiceDelete")
 }
 
+// OnServiceSynced is called once all the initial event handlers were
+// called and the state is fully propagated to local cache.
 func (proxier *Proxier) OnServiceSynced() {
 	klog.V(2).Infof("userspace OnServiceSynced")
 
@@ -649,18 +657,26 @@ func (proxier *Proxier) OnServiceSynced() {
 	go proxier.syncProxyRules()
 }
 
+// OnEndpointsAdd is called whenever creation of new endpoints object
+// is observed.
 func (proxier *Proxier) OnEndpointsAdd(endpoints *v1.Endpoints) {
 	proxier.loadBalancer.OnEndpointsAdd(endpoints)
 }
 
+// OnEndpointsUpdate is called whenever modification of an existing
+// endpoints object is observed.
 func (proxier *Proxier) OnEndpointsUpdate(oldEndpoints, endpoints *v1.Endpoints) {
 	proxier.loadBalancer.OnEndpointsUpdate(oldEndpoints, endpoints)
 }
 
+// OnEndpointsDelete is called whenever deletion of an existing endpoints
+// object is observed.
 func (proxier *Proxier) OnEndpointsDelete(endpoints *v1.Endpoints) {
 	proxier.loadBalancer.OnEndpointsDelete(endpoints)
 }
 
+// OnEndpointsSynced is called once all the initial event handlers were
+// called and the state is fully propagated to local cache.
 func (proxier *Proxier) OnEndpointsSynced() {
 	klog.V(2).Infof("userspace OnEndpointsSynced")
 	proxier.loadBalancer.OnEndpointsSynced()
diff --git a/pkg/proxy/winkernel/proxier.go b/pkg/proxy/winkernel/proxier.go
@@ -761,27 +761,35 @@ func (proxier *Proxier) isInitialized() bool {
 	return atomic.LoadInt32(&proxier.initialized) > 0
 }
 
+// OnServiceAdd is called whenever creation of new service object
+// is observed.
 func (proxier *Proxier) OnServiceAdd(service *v1.Service) {
 	namespacedName := types.NamespacedName{Namespace: service.Namespace, Name: service.Name}
 	if proxier.serviceChanges.update(&namespacedName, nil, service, proxier.hns) && proxier.isInitialized() {
 		proxier.Sync()
 	}
 }
 
+// OnServiceUpdate is called whenever modification of an existing
+// service object is observed.
 func (proxier *Proxier) OnServiceUpdate(oldService, service *v1.Service) {
 	namespacedName := types.NamespacedName{Namespace: service.Namespace, Name: service.Name}
 	if proxier.serviceChanges.update(&namespacedName, oldService, service, proxier.hns) && proxier.isInitialized() {
 		proxier.Sync()
 	}
 }
 
+// OnServiceDelete is called whenever deletion of an existing service
+// object is observed.
 func (proxier *Proxier) OnServiceDelete(service *v1.Service) {
 	namespacedName := types.NamespacedName{Namespace: service.Namespace, Name: service.Name}
 	if proxier.serviceChanges.update(&namespacedName, service, nil, proxier.hns) && proxier.isInitialized() {
 		proxier.Sync()
 	}
 }
 
+// OnServiceSynced is called once all the initial event handlers were
+// called and the state is fully propagated to local cache.
 func (proxier *Proxier) OnServiceSynced() {
 	proxier.mu.Lock()
 	proxier.servicesSynced = true
@@ -836,27 +844,35 @@ func (proxier *Proxier) updateServiceMap() (result updateServiceMapResult) {
 	return result
 }
 
+// OnEndpointsAdd is called whenever creation of new endpoints object
+// is observed.
 func (proxier *Proxier) OnEndpointsAdd(endpoints *v1.Endpoints) {
 	namespacedName := types.NamespacedName{Namespace: endpoints.Namespace, Name: endpoints.Name}
 	if proxier.endpointsChanges.update(&namespacedName, nil, endpoints, proxier.hns) && proxier.isInitialized() {
 		proxier.Sync()
 	}
 }
 
+// OnEndpointsUpdate is called whenever modification of an existing
+// endpoints object is observed.
 func (proxier *Proxier) OnEndpointsUpdate(oldEndpoints, endpoints *v1.Endpoints) {
 	namespacedName := types.NamespacedName{Namespace: endpoints.Namespace, Name: endpoints.Name}
 	if proxier.endpointsChanges.update(&namespacedName, oldEndpoints, endpoints, proxier.hns) && proxier.isInitialized() {
 		proxier.Sync()
 	}
 }
 
+// OnEndpointsDelete is called whenever deletion of an existing endpoints
+// object is observed.
 func (proxier *Proxier) OnEndpointsDelete(endpoints *v1.Endpoints) {
 	namespacedName := types.NamespacedName{Namespace: endpoints.Namespace, Name: endpoints.Name}
 	if proxier.endpointsChanges.update(&namespacedName, endpoints, nil, proxier.hns) && proxier.isInitialized() {
 		proxier.Sync()
 	}
 }
 
+// OnEndpointsSynced is called once all the initial event handlers were
+// called and the state is fully propagated to local cache.
 func (proxier *Proxier) OnEndpointsSynced() {
 	proxier.mu.Lock()
 	proxier.endpointsSynced = true
diff --git a/pkg/proxy/winuserspace/proxier.go b/pkg/proxy/winuserspace/proxier.go
@@ -411,34 +411,50 @@ func (proxier *Proxier) unmergeService(service *v1.Service, existingPortPortals
 	}
 }
 
+// OnServiceAdd is called whenever creation of new service object
+// is observed.
 func (proxier *Proxier) OnServiceAdd(service *v1.Service) {
 	_ = proxier.mergeService(service)
 }
 
+// OnServiceUpdate is called whenever modification of an existing
+// service object is observed.
 func (proxier *Proxier) OnServiceUpdate(oldService, service *v1.Service) {
 	existingPortPortals := proxier.mergeService(service)
 	proxier.unmergeService(oldService, existingPortPortals)
 }
 
+// OnServiceDelete is called whenever deletion of an existing service
+// object is observed.
 func (proxier *Proxier) OnServiceDelete(service *v1.Service) {
 	proxier.unmergeService(service, map[ServicePortPortalName]bool{})
 }
 
+// OnServiceSynced is called once all the initial event handlers were
+// called and the state is fully propagated to local cache.
 func (proxier *Proxier) OnServiceSynced() {
 }
 
+// OnEndpointsAdd is called whenever creation of new endpoints object
+// is observed.
 func (proxier *Proxier) OnEndpointsAdd(endpoints *v1.Endpoints) {
 	proxier.loadBalancer.OnEndpointsAdd(endpoints)
 }
 
+// OnEndpointsUpdate is called whenever modification of an existing
+// endpoints object is observed.
 func (proxier *Proxier) OnEndpointsUpdate(oldEndpoints, endpoints *v1.Endpoints) {
 	proxier.loadBalancer.OnEndpointsUpdate(oldEndpoints, endpoints)
 }
 
+// OnEndpointsDelete is called whenever deletion of an existing endpoints
+// object is observed.
 func (proxier *Proxier) OnEndpointsDelete(endpoints *v1.Endpoints) {
 	proxier.loadBalancer.OnEndpointsDelete(endpoints)
 }
 
+// OnEndpointsSynced is called once all the initial event handlers were
+// called and the state is fully propagated to local cache.
 func (proxier *Proxier) OnEndpointsSynced() {
 	proxier.loadBalancer.OnEndpointsSynced()
 }

Original file line number	Diff line number	Diff line change
`@@ -541,7 +541,7 @@ func (proxier Proxier) OnServiceDelete(service v1.Service) {`
`541`	`541`
`542`	`542`	`}`
`543`	`543`
`544`		`-// OnServiceSynced is called once all the initial even handlers were`
	`544`	`+// OnServiceSynced is called once all the initial event handlers were`
`545`	`545`	`// called and the state is fully propagated to local cache.`
`546`	`546`	`func (proxier *Proxier) OnServiceSynced() {`
`547`	`547`	`proxier.mu.Lock()`
`@@ -663,7 +663,7 @@ func (proxier Proxier) OnNodeUpdate(oldNode, node v1.Node) {`
`663`	`663`	`proxier.syncProxyRules()`
`664`	`664`	`}`
`665`	`665`
`666`		`-// OnNodeDelete is called whever deletion of an existing node`
	`666`	`+// OnNodeDelete is called whenever deletion of an existing node`
`667`	`667`	`// object is observed.`
`668`	`668`	`func (proxier Proxier) OnNodeDelete(node v1.Node) {`
`669`	`669`	`if node.Name != proxier.hostname {`
Original file line number	Diff line number	Diff line change
`@@ -980,7 +980,7 @@ func (proxier Proxier) OnNodeUpdate(oldNode, node v1.Node) {`
`980`	`980`	`proxier.syncProxyRules()`
`981`	`981`	`}`
`982`	`982`
`983`		`-// OnNodeDelete is called whever deletion of an existing node`
	`983`	`+// OnNodeDelete is called whenever deletion of an existing node`
`984`	`984`	`// object is observed.`
`985`	`985`	`func (proxier Proxier) OnNodeDelete(node v1.Node) {`
`986`	`986`	`if node.Name != proxier.hostname {`
Original file line number	Diff line number	Diff line change
`@@ -621,18 +621,26 @@ func (proxier Proxier) serviceChange(previous, current v1.Service, detail stri`
`621`	`621`	`}`
`622`	`622`	`}`
`623`	`623`
	`624`	`+// OnServiceAdd is called whenever creation of new service object`
	`625`	`+// is observed.`
`624`	`626`	`func (proxier Proxier) OnServiceAdd(service v1.Service) {`
`625`	`627`	`proxier.serviceChange(nil, service, "OnServiceAdd")`
`626`	`628`	`}`
`627`	`629`
	`630`	`+// OnServiceUpdate is called whenever modification of an existing`
	`631`	`+// service object is observed.`
`628`	`632`	`func (proxier Proxier) OnServiceUpdate(oldService, service v1.Service) {`
`629`	`633`	`proxier.serviceChange(oldService, service, "OnServiceUpdate")`
`630`	`634`	`}`
`631`	`635`
	`636`	`+// OnServiceDelete is called whenever deletion of an existing service`
	`637`	`+// object is observed.`
`632`	`638`	`func (proxier Proxier) OnServiceDelete(service v1.Service) {`
`633`	`639`	`proxier.serviceChange(service, nil, "OnServiceDelete")`
`634`	`640`	`}`
`635`	`641`
	`642`	`+// OnServiceSynced is called once all the initial event handlers were`
	`643`	`+// called and the state is fully propagated to local cache.`
`636`	`644`	`func (proxier *Proxier) OnServiceSynced() {`
`637`	`645`	`klog.V(2).Infof("userspace OnServiceSynced")`
`638`	`646`
`@@ -649,18 +657,26 @@ func (proxier *Proxier) OnServiceSynced() {`
`649`	`657`	`go proxier.syncProxyRules()`
`650`	`658`	`}`
`651`	`659`
	`660`	`+// OnEndpointsAdd is called whenever creation of new endpoints object`
	`661`	`+// is observed.`
`652`	`662`	`func (proxier Proxier) OnEndpointsAdd(endpoints v1.Endpoints) {`
`653`	`663`	`proxier.loadBalancer.OnEndpointsAdd(endpoints)`
`654`	`664`	`}`
`655`	`665`
	`666`	`+// OnEndpointsUpdate is called whenever modification of an existing`
	`667`	`+// endpoints object is observed.`
`656`	`668`	`func (proxier Proxier) OnEndpointsUpdate(oldEndpoints, endpoints v1.Endpoints) {`
`657`	`669`	`proxier.loadBalancer.OnEndpointsUpdate(oldEndpoints, endpoints)`
`658`	`670`	`}`
`659`	`671`
	`672`	`+// OnEndpointsDelete is called whenever deletion of an existing endpoints`
	`673`	`+// object is observed.`
`660`	`674`	`func (proxier Proxier) OnEndpointsDelete(endpoints v1.Endpoints) {`
`661`	`675`	`proxier.loadBalancer.OnEndpointsDelete(endpoints)`
`662`	`676`	`}`
`663`	`677`
	`678`	`+// OnEndpointsSynced is called once all the initial event handlers were`
	`679`	`+// called and the state is fully propagated to local cache.`
`664`	`680`	`func (proxier *Proxier) OnEndpointsSynced() {`
`665`	`681`	`klog.V(2).Infof("userspace OnEndpointsSynced")`
`666`	`682`	`proxier.loadBalancer.OnEndpointsSynced()`
Original file line number	Diff line number	Diff line change
`@@ -761,27 +761,35 @@ func (proxier *Proxier) isInitialized() bool {`
`761`	`761`	`return atomic.LoadInt32(&proxier.initialized) > 0`
`762`	`762`	`}`
`763`	`763`
	`764`	`+// OnServiceAdd is called whenever creation of new service object`
	`765`	`+// is observed.`
`764`	`766`	`func (proxier Proxier) OnServiceAdd(service v1.Service) {`
`765`	`767`	`namespacedName := types.NamespacedName{Namespace: service.Namespace, Name: service.Name}`
`766`	`768`	`if proxier.serviceChanges.update(&namespacedName, nil, service, proxier.hns) && proxier.isInitialized() {`
`767`	`769`	`proxier.Sync()`
`768`	`770`	`}`
`769`	`771`	`}`
`770`	`772`
	`773`	`+// OnServiceUpdate is called whenever modification of an existing`
	`774`	`+// service object is observed.`
`771`	`775`	`func (proxier Proxier) OnServiceUpdate(oldService, service v1.Service) {`
`772`	`776`	`namespacedName := types.NamespacedName{Namespace: service.Namespace, Name: service.Name}`
`773`	`777`	`if proxier.serviceChanges.update(&namespacedName, oldService, service, proxier.hns) && proxier.isInitialized() {`
`774`	`778`	`proxier.Sync()`
`775`	`779`	`}`
`776`	`780`	`}`
`777`	`781`
	`782`	`+// OnServiceDelete is called whenever deletion of an existing service`
	`783`	`+// object is observed.`
`778`	`784`	`func (proxier Proxier) OnServiceDelete(service v1.Service) {`
`779`	`785`	`namespacedName := types.NamespacedName{Namespace: service.Namespace, Name: service.Name}`
`780`	`786`	`if proxier.serviceChanges.update(&namespacedName, service, nil, proxier.hns) && proxier.isInitialized() {`
`781`	`787`	`proxier.Sync()`
`782`	`788`	`}`
`783`	`789`	`}`
`784`	`790`
	`791`	`+// OnServiceSynced is called once all the initial event handlers were`
	`792`	`+// called and the state is fully propagated to local cache.`
`785`	`793`	`func (proxier *Proxier) OnServiceSynced() {`
`786`	`794`	`proxier.mu.Lock()`
`787`	`795`	`proxier.servicesSynced = true`
`@@ -836,27 +844,35 @@ func (proxier *Proxier) updateServiceMap() (result updateServiceMapResult) {`
`836`	`844`	`return result`
`837`	`845`	`}`
`838`	`846`
	`847`	`+// OnEndpointsAdd is called whenever creation of new endpoints object`
	`848`	`+// is observed.`
`839`	`849`	`func (proxier Proxier) OnEndpointsAdd(endpoints v1.Endpoints) {`
`840`	`850`	`namespacedName := types.NamespacedName{Namespace: endpoints.Namespace, Name: endpoints.Name}`
`841`	`851`	`if proxier.endpointsChanges.update(&namespacedName, nil, endpoints, proxier.hns) && proxier.isInitialized() {`
`842`	`852`	`proxier.Sync()`
`843`	`853`	`}`
`844`	`854`	`}`
`845`	`855`
	`856`	`+// OnEndpointsUpdate is called whenever modification of an existing`
	`857`	`+// endpoints object is observed.`
`846`	`858`	`func (proxier Proxier) OnEndpointsUpdate(oldEndpoints, endpoints v1.Endpoints) {`
`847`	`859`	`namespacedName := types.NamespacedName{Namespace: endpoints.Namespace, Name: endpoints.Name}`
`848`	`860`	`if proxier.endpointsChanges.update(&namespacedName, oldEndpoints, endpoints, proxier.hns) && proxier.isInitialized() {`
`849`	`861`	`proxier.Sync()`
`850`	`862`	`}`
`851`	`863`	`}`
`852`	`864`
	`865`	`+// OnEndpointsDelete is called whenever deletion of an existing endpoints`
	`866`	`+// object is observed.`
`853`	`867`	`func (proxier Proxier) OnEndpointsDelete(endpoints v1.Endpoints) {`
`854`	`868`	`namespacedName := types.NamespacedName{Namespace: endpoints.Namespace, Name: endpoints.Name}`
`855`	`869`	`if proxier.endpointsChanges.update(&namespacedName, endpoints, nil, proxier.hns) && proxier.isInitialized() {`
`856`	`870`	`proxier.Sync()`
`857`	`871`	`}`
`858`	`872`	`}`
`859`	`873`
	`874`	`+// OnEndpointsSynced is called once all the initial event handlers were`
	`875`	`+// called and the state is fully propagated to local cache.`
`860`	`876`	`func (proxier *Proxier) OnEndpointsSynced() {`
`861`	`877`	`proxier.mu.Lock()`
`862`	`878`	`proxier.endpointsSynced = true`
Original file line number	Diff line number	Diff line change
`@@ -411,34 +411,50 @@ func (proxier Proxier) unmergeService(service v1.Service, existingPortPortals`
`411`	`411`	`}`
`412`	`412`	`}`
`413`	`413`
	`414`	`+// OnServiceAdd is called whenever creation of new service object`
	`415`	`+// is observed.`
`414`	`416`	`func (proxier Proxier) OnServiceAdd(service v1.Service) {`
`415`	`417`	`_ = proxier.mergeService(service)`
`416`	`418`	`}`
`417`	`419`
	`420`	`+// OnServiceUpdate is called whenever modification of an existing`
	`421`	`+// service object is observed.`
`418`	`422`	`func (proxier Proxier) OnServiceUpdate(oldService, service v1.Service) {`
`419`	`423`	`existingPortPortals := proxier.mergeService(service)`
`420`	`424`	`proxier.unmergeService(oldService, existingPortPortals)`
`421`	`425`	`}`
`422`	`426`
	`427`	`+// OnServiceDelete is called whenever deletion of an existing service`
	`428`	`+// object is observed.`
`423`	`429`	`func (proxier Proxier) OnServiceDelete(service v1.Service) {`
`424`	`430`	`proxier.unmergeService(service, map[ServicePortPortalName]bool{})`
`425`	`431`	`}`
`426`	`432`
	`433`	`+// OnServiceSynced is called once all the initial event handlers were`
	`434`	`+// called and the state is fully propagated to local cache.`
`427`	`435`	`func (proxier *Proxier) OnServiceSynced() {`
`428`	`436`	`}`
`429`	`437`
	`438`	`+// OnEndpointsAdd is called whenever creation of new endpoints object`
	`439`	`+// is observed.`
`430`	`440`	`func (proxier Proxier) OnEndpointsAdd(endpoints v1.Endpoints) {`
`431`	`441`	`proxier.loadBalancer.OnEndpointsAdd(endpoints)`
`432`	`442`	`}`
`433`	`443`
	`444`	`+// OnEndpointsUpdate is called whenever modification of an existing`
	`445`	`+// endpoints object is observed.`
`434`	`446`	`func (proxier Proxier) OnEndpointsUpdate(oldEndpoints, endpoints v1.Endpoints) {`
`435`	`447`	`proxier.loadBalancer.OnEndpointsUpdate(oldEndpoints, endpoints)`
`436`	`448`	`}`
`437`	`449`
	`450`	`+// OnEndpointsDelete is called whenever deletion of an existing endpoints`
	`451`	`+// object is observed.`
`438`	`452`	`func (proxier Proxier) OnEndpointsDelete(endpoints v1.Endpoints) {`
`439`	`453`	`proxier.loadBalancer.OnEndpointsDelete(endpoints)`
`440`	`454`	`}`
`441`	`455`
	`456`	`+// OnEndpointsSynced is called once all the initial event handlers were`
	`457`	`+// called and the state is fully propagated to local cache.`
`442`	`458`	`func (proxier *Proxier) OnEndpointsSynced() {`
`443`	`459`	`proxier.loadBalancer.OnEndpointsSynced()`
`444`	`460`	`}`