github.com/google/cloudprober@v0.11.3/targets/gce/forwarding_rules.go

// Copyright 2017 The Cloudprober 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 gce

import (
	"errors"
	"fmt"
	"net"
	"strings"
	"sync"
	"time"

	"cloud.google.com/go/compute/metadata"
	"github.com/google/cloudprober/logger"
	"github.com/google/cloudprober/targets/endpoint"
	configpb "github.com/google/cloudprober/targets/gce/proto"
	compute "google.golang.org/api/compute/v1"
)

// globalForwardingRules is a singleton instance of the forwardingRules struct.
// It is presented as a singleton because, like instances, forwardingRules provides
// a cache layer that is best shared by all probes.
var (
	globalForwardingRules *forwardingRules
	onceForwardingRules   sync.Once
)

// forwardingRules is a lister which lists GCE forwarding rules (see
// https://cloud.google.com/compute/docs/load-balancing/network/forwarding-rules
// for information on forwarding rules). In addition to being able to list the
// rules, this particular lister implements a cache. On a timer (configured by
// GlobalGCETargetsOptions.re_eval_sec cloudprober/targets/targets.proto) in the
// background the cache will be populated (by the equivalent of running "gcloud
// compute forwarding-rules list"). Listing actually only returns the current
// contents of that cache.
//
// Note that because this uses the GCLOUD API, GCE staging is unable to use this
// target type. See b/26320525 for more on this.
//
// TODO(izzycecil): The cache layer provided by this, instances, lameduck, and resolver
//               are all pretty similar. RTC will need a similar cache. I should
//               abstract out this whole cache layer. It will be more testable that
//               way, and probably more readable, as well.
type forwardingRules struct {
	project     string
	c           *configpb.ForwardingRules
	names       []string
	localRegion string
	cache       map[string]*compute.ForwardingRule
	apiVersion  string
	l           *logger.Logger
}

// List produces a list of all the forwarding rules. The list is similar to
// "gcloud compute forwarding-rules list", but with a cache layer reducing the
// number of actual API calls made.
func (frp *forwardingRules) ListEndpoints() []endpoint.Endpoint {
	return endpoint.EndpointsFromNames(frp.names)
}

// Resolve returns the IP address associated with the forwarding
// rule. Eventually we can expand this to return protocol and port as well.
func (frp *forwardingRules) Resolve(name string, ipVer int) (net.IP, error) {
	f := frp.cache[name]
	if f == nil {
		return nil, fmt.Errorf("gce.forwardingRulesProvider.resolve(%s): forwarding rule not in in-memory GCE forwardingRules database", name)
	}
	return net.ParseIP(f.IPAddress), nil
}

// This function will attempt to refresh the cache of GCE targets.
// This attempt may fail, in which case the function will log and leave the cache untouched,
// since it is assumed that the cache will be refreshed by a subsequent call.
// It runs API calls equivalent to "gcloud compute forwarding-rules list"
func (frp *forwardingRules) expand() {
	frp.l.Infof("gce.forwardingRules.expand: expanding GCE targets")

	cs, err := defaultComputeService(frp.apiVersion)
	if err != nil {
		frp.l.Errorf("gce.forwardingRules.expand: error while creating the compute service: %v", err)
		return
	}

	regions, err := frp.getTargetRegions(cs)
	if err != nil {
		frp.l.Errorf("gce.forwardingRules.expand: error while getting the list of target regions: %v", err)
		return
	}

	var forwardingRulesList []*compute.ForwardingRule

	for _, region := range regions {
		l, err := cs.ForwardingRules.List(frp.project, region).Do()
		if err != nil {
			frp.l.Errorf("gce.forwardingRules.expand(region=%s): error while getting the list of forwarding rules: %v", region, err)
			return
		}
		forwardingRulesList = append(forwardingRulesList, l.Items...)
	}

	var result []string
	for _, ins := range forwardingRulesList {
		frp.cache[ins.Name] = ins
		result = append(result, ins.Name)
	}

	frp.l.Debugf("Expanded target list: %q", result)
	frp.names = result
}

// getTargetRegions returns the list of regions we are interested in based on
// the configuration.
func (frp *forwardingRules) getTargetRegions(cs *compute.Service) ([]string, error) {
	// Select local region if region is not specified.
	if len(frp.c.GetRegion()) == 0 {
		return []string{frp.localRegion}, nil
	}

	// If more than one region is specified or only specified region is not "all"
	if len(frp.c.GetRegion()) > 1 || frp.c.GetRegion()[0] != "all" {
		return frp.c.GetRegion(), nil
	}

	l, err := cs.Regions.List(frp.project).Do()
	if err != nil {
		return nil, err
	}

	regions := make([]string, len(l.Items))
	for i := range l.Items {
		regions[i] = l.Items[i].Name
	}

	return regions, nil
}

// Instance's region is not stored in the metadata, we need to get it from the zone.
func getLocalRegion() (string, error) {
	if !metadata.OnGCE() {
		return "", errors.New("getLocalRegion: not running on GCE")
	}

	zone, err := metadata.Zone()
	if err != nil {
		return "", err
	}

	zoneParts := strings.Split(zone, "-")
	return strings.Join(zoneParts[0:len(zoneParts)-1], "-"), nil
}

// newForwardingrules will (if needed) initialize and return the
// globalForwardingRules singleton.
func newForwardingRules(project string, opts *configpb.GlobalOptions, frpb *configpb.ForwardingRules, l *logger.Logger) (*forwardingRules, error) {
	reEvalInterval := time.Duration(opts.GetReEvalSec()) * time.Second

	var localRegion string
	var err error

	// Initialize forwardingRules provider only once
	onceForwardingRules.Do(func() {

		if len(frpb.GetRegion()) == 0 {
			localRegion, err = getLocalRegion()
			if err != nil {
				err = fmt.Errorf("gce.newForwardingRules: error while getting local region: %v", err)
				return
			}
			l.Infof("gce.newForwardingRules: local region: %s", localRegion)
		}

		globalForwardingRules = &forwardingRules{
			project:     project,
			c:           frpb,
			localRegion: localRegion,
			cache:       make(map[string]*compute.ForwardingRule),
			apiVersion:  opts.GetApiVersion(),
			l:           l,
		}

		go func() {
			globalForwardingRules.expand()
			for range time.Tick(reEvalInterval) {
				globalForwardingRules.expand()
			}
		}()
	})

	if err != nil {
		return nil, err
	}

	return globalForwardingRules, err
}