From 937cde666e533e4f70087207910d6135c672340a Mon Sep 17 00:00:00 2001 From: nikhiljindal Date: Mon, 11 Sep 2017 20:29:49 -0700 Subject: [PATCH] Remove multiple calls to CreateInstanceGroups by reusing results from a single call --- controllers/gce/backends/backends.go | 20 +++++++---- controllers/gce/backends/backends_test.go | 28 +++++++-------- controllers/gce/backends/interfaces.go | 4 +-- controllers/gce/controller/cluster_manager.go | 35 ++++++++----------- controllers/gce/controller/controller.go | 35 ++++++------------- controllers/gce/controller/utils.go | 8 ++--- controllers/gce/instances/instances.go | 3 +- controllers/gce/instances/utils.go | 2 +- .../gce/loadbalancers/loadbalancers.go | 2 +- controllers/gce/utils/utils.go | 6 ++++ 10 files changed, 68 insertions(+), 75 deletions(-) diff --git a/controllers/gce/backends/backends.go b/controllers/gce/backends/backends.go index 8e8dd3706..49b632efe 100644 --- a/controllers/gce/backends/backends.go +++ b/controllers/gce/backends/backends.go @@ -211,15 +211,22 @@ func (b *Backends) create(namedPort *compute.NamedPort, hcLink string, sp Servic } // Add will get or create a Backend for the given port. -func (b *Backends) Add(p ServicePort) error { +// Uses the given instance groups if non-nil, else creates instance groups. +func (b *Backends) Add(p ServicePort, igs []*compute.InstanceGroup) error { // We must track the port even if creating the backend failed, because // we might've created a health-check for it. be := &compute.BackendService{} defer func() { b.snapshotter.Add(portKey(p.Port), be) }() - igs, namedPort, err := instances.CreateInstanceGroups(b.nodePool, b.namer, p.Port) - if err != nil { - return err + var err error + // Ideally callers should pass the instance groups to prevent recomputing them here. + // Igs can be nil in scenarios where we do not have instance groups such as + // while syncing default backend service. + if igs == nil { + igs, _, err = instances.EnsureInstanceGroupsAndPorts(b.nodePool, b.namer, p.Port) + if err != nil { + return err + } } // Ensure health check for backend service exists @@ -232,6 +239,7 @@ func (b *Backends) Add(p ServicePort) error { pName := b.namer.BeName(p.Port) be, _ = b.Get(p.Port) if be == nil { + namedPort := utils.GetNamedPort(p.Port) glog.V(2).Infof("Creating backend service for port %v named port %v", p.Port, namedPort) be, err = b.create(namedPort, hcLink, p, pName) if err != nil { @@ -381,12 +389,12 @@ func (b *Backends) edgeHop(be *compute.BackendService, igs []*compute.InstanceGr } // Sync syncs backend services corresponding to ports in the given list. -func (b *Backends) Sync(svcNodePorts []ServicePort) error { +func (b *Backends) Sync(svcNodePorts []ServicePort, igs []*compute.InstanceGroup) error { glog.V(3).Infof("Sync: backends %v", svcNodePorts) // create backends for new ports, perform an edge hop for existing ports for _, port := range svcNodePorts { - if err := b.Add(port); err != nil { + if err := b.Add(port, igs); err != nil { return err } } diff --git a/controllers/gce/backends/backends_test.go b/controllers/gce/backends/backends_test.go index ba1331558..8d116ac6e 100644 --- a/controllers/gce/backends/backends_test.go +++ b/controllers/gce/backends/backends_test.go @@ -80,7 +80,7 @@ func TestBackendPoolAdd(t *testing.T) { // Add a backend for a port, then re-add the same port and // make sure it corrects a broken link from the backend to // the instance group. - err := pool.Add(nodePort) + err := pool.Add(nodePort, nil) if err != nil { t.Fatalf("Did not find expect error when adding a nodeport: %v, err: %v", nodePort, err) } @@ -143,7 +143,7 @@ func TestHealthCheckMigration(t *testing.T) { hcp.CreateHttpHealthCheck(legacyHC) // Add the service port to the backend pool - pool.Add(p) + pool.Add(p, nil) // Assert the proper health check was created hc, _ := pool.healthChecker.Get(p.Port) @@ -168,7 +168,7 @@ func TestBackendPoolUpdate(t *testing.T) { namer := utils.Namer{} p := ServicePort{Port: 3000, Protocol: utils.ProtocolHTTP} - pool.Add(p) + pool.Add(p, nil) beName := namer.BeName(p.Port) be, err := f.GetGlobalBackendService(beName) @@ -188,7 +188,7 @@ func TestBackendPoolUpdate(t *testing.T) { // Update service port to encrypted p.Protocol = utils.ProtocolHTTPS - pool.Sync([]ServicePort{p}) + pool.Sync([]ServicePort{p}, nil) be, err = f.GetGlobalBackendService(beName) if err != nil { @@ -214,7 +214,7 @@ func TestBackendPoolChaosMonkey(t *testing.T) { namer := utils.Namer{} nodePort := ServicePort{Port: 8080, Protocol: utils.ProtocolHTTP} - pool.Add(nodePort) + pool.Add(nodePort, nil) beName := namer.BeName(nodePort.Port) be, _ := f.GetGlobalBackendService(beName) @@ -227,7 +227,7 @@ func TestBackendPoolChaosMonkey(t *testing.T) { f.calls = []int{} f.UpdateGlobalBackendService(be) - pool.Add(nodePort) + pool.Add(nodePort, nil) for _, call := range f.calls { if call == utils.Create { t.Fatalf("Unexpected create for existing backend service") @@ -260,9 +260,9 @@ func TestBackendPoolSync(t *testing.T) { f := NewFakeBackendServices(noOpErrFunc) fakeIGs := instances.NewFakeInstanceGroups(sets.NewString()) pool, _ := newTestJig(f, fakeIGs, true) - pool.Add(ServicePort{Port: 81}) - pool.Add(ServicePort{Port: 90}) - if err := pool.Sync(svcNodePorts); err != nil { + pool.Add(ServicePort{Port: 81}, nil) + pool.Add(ServicePort{Port: 90}, nil) + if err := pool.Sync(svcNodePorts, nil); err != nil { t.Errorf("Expected backend pool to sync, err: %v", err) } if err := pool.GC(svcNodePorts); err != nil { @@ -361,7 +361,7 @@ func TestBackendPoolDeleteLegacyHealthChecks(t *testing.T) { }) // Have pool sync the above backend service - bp.Add(ServicePort{Port: 80, Protocol: utils.ProtocolHTTPS}) + bp.Add(ServicePort{Port: 80, Protocol: utils.ProtocolHTTPS}, nil) // Verify the legacy health check has been deleted _, err = hcp.GetHttpHealthCheck(beName) @@ -388,7 +388,7 @@ func TestBackendPoolShutdown(t *testing.T) { namer := utils.Namer{} // Add a backend-service and verify that it doesn't exist after Shutdown() - pool.Add(ServicePort{Port: 80}) + pool.Add(ServicePort{Port: 80}, nil) pool.Shutdown() if _, err := f.GetGlobalBackendService(namer.BeName(80)); err == nil { t.Fatalf("%v", err) @@ -402,7 +402,7 @@ func TestBackendInstanceGroupClobbering(t *testing.T) { namer := utils.Namer{} // This will add the instance group k8s-ig to the instance pool - pool.Add(ServicePort{Port: 80}) + pool.Add(ServicePort{Port: 80}, nil) be, err := f.GetGlobalBackendService(namer.BeName(80)) if err != nil { @@ -420,7 +420,7 @@ func TestBackendInstanceGroupClobbering(t *testing.T) { } // Make sure repeated adds don't clobber the inserted instance group - pool.Add(ServicePort{Port: 80}) + pool.Add(ServicePort{Port: 80}, nil) be, err = f.GetGlobalBackendService(namer.BeName(80)) if err != nil { t.Fatalf("%v", err) @@ -462,7 +462,7 @@ func TestBackendCreateBalancingMode(t *testing.T) { return nil } - pool.Add(nodePort) + pool.Add(nodePort, nil) be, err := f.GetGlobalBackendService(namer.BeName(nodePort.Port)) if err != nil { t.Fatalf("%v", err) diff --git a/controllers/gce/backends/interfaces.go b/controllers/gce/backends/interfaces.go index 2153f3505..586ceb17c 100644 --- a/controllers/gce/backends/interfaces.go +++ b/controllers/gce/backends/interfaces.go @@ -30,10 +30,10 @@ type probeProvider interface { // as gce backendServices, and sync them through the BackendServices interface. type BackendPool interface { Init(p probeProvider) - Add(port ServicePort) error + Add(port ServicePort, igs []*compute.InstanceGroup) error Get(port int64) (*compute.BackendService, error) Delete(port int64) error - Sync(ports []ServicePort) error + Sync(ports []ServicePort, igs []*compute.InstanceGroup) error GC(ports []ServicePort) error Shutdown() error Status(name string) string diff --git a/controllers/gce/controller/cluster_manager.go b/controllers/gce/controller/cluster_manager.go index 902c32354..e987711b9 100644 --- a/controllers/gce/controller/cluster_manager.go +++ b/controllers/gce/controller/cluster_manager.go @@ -116,9 +116,10 @@ func (c *ClusterManager) shutdown() error { // instance groups. // - backendServicePorts are the ports for which we require BackendServices. // - namedPorts are the ports which must be opened on instance groups. +// Returns the list of all instance groups corresponding to the given loadbalancers. // If in performing the checkpoint the cluster manager runs out of quota, a // googleapi 403 is returned. -func (c *ClusterManager) Checkpoint(lbs []*loadbalancers.L7RuntimeInfo, nodeNames []string, backendServicePorts []backends.ServicePort, namedPorts []backends.ServicePort) error { +func (c *ClusterManager) Checkpoint(lbs []*loadbalancers.L7RuntimeInfo, nodeNames []string, backendServicePorts []backends.ServicePort, namedPorts []backends.ServicePort) ([]*compute.InstanceGroup, error) { if len(namedPorts) != 0 { // Add the default backend node port to the list of named ports for instance groups. namedPorts = append(namedPorts, c.defaultBackendNodePort) @@ -129,19 +130,18 @@ func (c *ClusterManager) Checkpoint(lbs []*loadbalancers.L7RuntimeInfo, nodeName namedPorts = uniq(namedPorts) backendServicePorts = uniq(backendServicePorts) // Create Instance Groups. - _, err := c.CreateInstanceGroups(namedPorts) + igs, err := c.EnsureInstanceGroupsAndPorts(namedPorts) if err != nil { - return err + return igs, err } - if err := c.backendPool.Sync(backendServicePorts); err != nil { - return err + if err := c.backendPool.Sync(backendServicePorts, igs); err != nil { + return igs, err } - - if err := c.SyncNodesInInstanceGroups(nodeNames); err != nil { - return err + if err := c.instancePool.Sync(nodeNames); err != nil { + return igs, err } if err := c.l7Pool.Sync(lbs); err != nil { - return err + return igs, err } // TODO: Manage default backend and its firewall rule in a centralized way. @@ -160,22 +160,22 @@ func (c *ClusterManager) Checkpoint(lbs []*loadbalancers.L7RuntimeInfo, nodeName np = append(np, p.Port) } if err := c.firewallPool.Sync(np, nodeNames); err != nil { - return err + return igs, err } - return nil + return igs, nil } -func (c *ClusterManager) CreateInstanceGroups(servicePorts []backends.ServicePort) ([]*compute.InstanceGroup, error) { +func (c *ClusterManager) EnsureInstanceGroupsAndPorts(servicePorts []backends.ServicePort) ([]*compute.InstanceGroup, error) { var igs []*compute.InstanceGroup var err error for _, p := range servicePorts { - // CreateInstanceGroups always returns all the instance groups, so we can return + // EnsureInstanceGroupsAndPorts always returns all the instance groups, so we can return // the output of any call, no need to append the return from all calls. // TODO: Ideally, we want to call CreateInstaceGroups only the first time and // then call AddNamedPort multiple times. Need to update the interface to // achieve this. - igs, _, err = instances.CreateInstanceGroups(c.instancePool, c.ClusterNamer, p.Port) + igs, _, err = instances.EnsureInstanceGroupsAndPorts(c.instancePool, c.ClusterNamer, p.Port) if err != nil { return nil, err } @@ -183,13 +183,6 @@ func (c *ClusterManager) CreateInstanceGroups(servicePorts []backends.ServicePor return igs, nil } -func (c *ClusterManager) SyncNodesInInstanceGroups(nodeNames []string) error { - if err := c.instancePool.Sync(nodeNames); err != nil { - return err - } - return nil -} - // GC garbage collects unused resources. // - lbNames are the names of L7 loadbalancers we wish to exist. Those not in // this list are removed from the cloud. diff --git a/controllers/gce/controller/controller.go b/controllers/gce/controller/controller.go index 0bf1a69b5..e0a8de1fa 100644 --- a/controllers/gce/controller/controller.go +++ b/controllers/gce/controller/controller.go @@ -36,7 +36,6 @@ import ( "k8s.io/client-go/tools/cache" "k8s.io/client-go/tools/record" - "k8s.io/ingress/controllers/gce/backends" "k8s.io/ingress/controllers/gce/loadbalancers" ) @@ -288,7 +287,7 @@ func (lbc *LoadBalancerController) sync(key string) (err error) { allNodePorts := lbc.tr.toNodePorts(&allIngresses) gceNodePorts := lbc.tr.toNodePorts(&gceIngresses) lbNames := lbc.ingLister.Store.ListKeys() - lbs, err := lbc.ListGCERuntimeInfo() + lbs, err := lbc.toRuntimeInfo(gceIngresses) if err != nil { return err } @@ -319,10 +318,10 @@ func (lbc *LoadBalancerController) sync(key string) (err error) { } glog.V(3).Infof("Finished syncing %v", key) }() - // Record any errors during sync and throw a single error at the end. This // allows us to free up associated cloud resources ASAP. - if err := lbc.CloudClusterManager.Checkpoint(lbs, nodeNames, gceNodePorts, allNodePorts); err != nil { + igs, err := lbc.CloudClusterManager.Checkpoint(lbs, nodeNames, gceNodePorts, allNodePorts) + if err != nil { // TODO: Implement proper backoff for the queue. eventMsg := "GCE" if ingExists { @@ -336,19 +335,12 @@ func (lbc *LoadBalancerController) sync(key string) (err error) { if !ingExists { return syncError } - ing := obj.(*extensions.Ingress) - if isGCEMultiClusterIngress(ing) { + ing := *obj.(*extensions.Ingress) + if isGCEMultiClusterIngress(&ing) { // Add instance group names as annotation on the ingress. if ing.Annotations == nil { ing.Annotations = map[string]string{} } - // Since we just created instance groups in Checkpoint, calling create - // instance groups again should just return names of the existing - // instance groups. It does not matter which nodePort we pass as argument. - igs, err := lbc.CloudClusterManager.CreateInstanceGroups([]backends.ServicePort{allNodePorts[0]}) - if err != nil { - return fmt.Errorf("error in creating instance groups: %v", err) - } err = setInstanceGroupsAnnotation(ing.Annotations, igs) if err != nil { return err @@ -366,13 +358,13 @@ func (lbc *LoadBalancerController) sync(key string) (err error) { return syncError } - if urlMap, err := lbc.tr.toURLMap(ing); err != nil { + if urlMap, err := lbc.tr.toURLMap(&ing); err != nil { syncError = fmt.Errorf("%v, convert to url map error %v", syncError, err) } else if err := l7.UpdateUrlMap(urlMap); err != nil { - lbc.recorder.Eventf(ing, apiv1.EventTypeWarning, "UrlMap", err.Error()) + lbc.recorder.Eventf(&ing, apiv1.EventTypeWarning, "UrlMap", err.Error()) syncError = fmt.Errorf("%v, update url map error: %v", syncError, err) - } else if err := lbc.updateIngressStatus(l7, *ing); err != nil { - lbc.recorder.Eventf(ing, apiv1.EventTypeWarning, "Status", err.Error()) + } else if err := lbc.updateIngressStatus(l7, ing); err != nil { + lbc.recorder.Eventf(&ing, apiv1.EventTypeWarning, "Status", err.Error()) syncError = fmt.Errorf("%v, update ingress error: %v", syncError, err) } return syncError @@ -432,13 +424,8 @@ func (lbc *LoadBalancerController) updateAnnotations(name, namespace string, ann return nil } -// ListGCERuntimeInfo lists L7RuntimeInfo as understood by the loadbalancer module. -// It returns runtime info only for gce ingresses and not for multi cluster ingresses. -func (lbc *LoadBalancerController) ListGCERuntimeInfo() (lbs []*loadbalancers.L7RuntimeInfo, err error) { - ingList, err := lbc.ingLister.ListGCEIngresses() - if err != nil { - return lbs, err - } +// toRuntimeInfo returns L7RuntimeInfo for the given ingresses. +func (lbc *LoadBalancerController) toRuntimeInfo(ingList extensions.IngressList) (lbs []*loadbalancers.L7RuntimeInfo, err error) { for _, ing := range ingList.Items { k, err := keyFunc(&ing) if err != nil { diff --git a/controllers/gce/controller/utils.go b/controllers/gce/controller/utils.go index 075865776..d313097f5 100644 --- a/controllers/gce/controller/utils.go +++ b/controllers/gce/controller/utils.go @@ -521,13 +521,13 @@ func (t *GCETranslator) ingressToNodePorts(ing *extensions.Ingress) []backends.S for _, rule := range ing.Spec.Rules { if rule.HTTP == nil { glog.Errorf("ignoring non http Ingress rule") - return knownPorts + continue } for _, path := range rule.HTTP.Paths { port, err := t.getServiceNodePort(path.Backend, ing.Namespace) if err != nil { glog.Infof("%v", err) - return knownPorts + continue } knownPorts = append(knownPorts, port) } @@ -680,7 +680,7 @@ func setInstanceGroupsAnnotation(existing map[string]string, igs []*compute.Inst Name string Zone string } - instanceGroups := []Value{} + var instanceGroups []Value for _, ig := range igs { instanceGroups = append(instanceGroups, Value{Name: ig.Name, Zone: ig.Zone}) } @@ -698,7 +698,7 @@ func uniq(nodePorts []backends.ServicePort) []backends.ServicePort { for _, p := range nodePorts { portMap[p.Port] = p } - nodePorts = []backends.ServicePort{} + nodePorts = make([]backends.ServicePort, 0, len(portMap)) for _, sp := range portMap { nodePorts = append(nodePorts, sp) } diff --git a/controllers/gce/instances/instances.go b/controllers/gce/instances/instances.go index 94664b065..fd54de034 100644 --- a/controllers/gce/instances/instances.go +++ b/controllers/gce/instances/instances.go @@ -63,8 +63,7 @@ func (i *Instances) Init(zl zoneLister) { // all of which have the exact same named port. func (i *Instances) AddInstanceGroup(name string, port int64) ([]*compute.InstanceGroup, *compute.NamedPort, error) { igs := []*compute.InstanceGroup{} - // TODO: move port naming to namer - namedPort := &compute.NamedPort{Name: fmt.Sprintf("port%v", port), Port: port} + namedPort := utils.GetNamedPort(port) zones, err := i.ListZones() if err != nil { diff --git a/controllers/gce/instances/utils.go b/controllers/gce/instances/utils.go index 4bd011081..934311c66 100644 --- a/controllers/gce/instances/utils.go +++ b/controllers/gce/instances/utils.go @@ -8,6 +8,6 @@ import ( // Helper method to create instance groups. // This method exists to ensure that we are using the same logic at all places. -func CreateInstanceGroups(nodePool NodePool, namer *utils.Namer, port int64) ([]*compute.InstanceGroup, *compute.NamedPort, error) { +func EnsureInstanceGroupsAndPorts(nodePool NodePool, namer *utils.Namer, port int64) ([]*compute.InstanceGroup, *compute.NamedPort, error) { return nodePool.AddInstanceGroup(namer.IGName(), port) } diff --git a/controllers/gce/loadbalancers/loadbalancers.go b/controllers/gce/loadbalancers/loadbalancers.go index e8ce54228..15ded2562 100644 --- a/controllers/gce/loadbalancers/loadbalancers.go +++ b/controllers/gce/loadbalancers/loadbalancers.go @@ -169,7 +169,7 @@ func (l *L7s) Sync(lbs []*L7RuntimeInfo) error { // Lazily create a default backend so we don't tax users who don't care // about Ingress by consuming 1 of their 3 GCE BackendServices. This // BackendService is GC'd when there are no more Ingresses. - if err := l.defaultBackendPool.Add(l.defaultBackendNodePort); err != nil { + if err := l.defaultBackendPool.Add(l.defaultBackendNodePort, nil); err != nil { return err } defaultBackend, err := l.defaultBackendPool.Get(l.defaultBackendNodePort.Port) diff --git a/controllers/gce/utils/utils.go b/controllers/gce/utils/utils.go index 237943a3a..c0486f557 100644 --- a/controllers/gce/utils/utils.go +++ b/controllers/gce/utils/utils.go @@ -353,3 +353,9 @@ func CompareLinks(l1, l2 string) bool { // FakeIngressRuleValueMap is a convenience type used by multiple submodules // that share the same testing methods. type FakeIngressRuleValueMap map[string]string + +// GetNamedPort creates the NamedPort API object for the given port. +func GetNamedPort(port int64) *compute.NamedPort { + // TODO: move port naming to namer + return &compute.NamedPort{Name: fmt.Sprintf("port%v", port), Port: port} +}