Add --envoy-ingress-name, and --envoy-ingress-namespace flags. (#4952)

Signed-off-by: kahirokunn <[email protected]>

Author: kahirokunn

apis/projectcontour/v1alpha1/contourconfig.go

@@ -239,6 +239,12 @@ type EnvoyConfig struct {
 	// +optional
 	Service *NamespacedName `json:"service,omitempty"`
 
+	// Ingress holds Envoy service parameters for setting Ingress status.
+	//
+	// Contour's default is { namespace: "projectcontour", name: "envoy" }.
+	// +optional
+	Ingress *NamespacedName `json:"ingress,omitempty"`
+
 	// Defines the HTTP Listener for Envoy.
 	//
 	// Contour's default is { address: "0.0.0.0", port: 8080, accessLog: "/dev/stdout" }.

cmd/contour/serve.go

@@ -146,6 +146,8 @@ func registerServe(app *kingpin.Application) (*kingpin.CmdClause, *serveContext)
 	serve.Flag("envoy-service-https-port", "Kubernetes Service port for HTTPS requests.").PlaceHolder("<port>").IntVar(&ctx.httpsPort)
 	serve.Flag("envoy-service-name", "Name of the Envoy service to inspect for Ingress status details.").PlaceHolder("<name>").StringVar(&ctx.Config.EnvoyServiceName)
 	serve.Flag("envoy-service-namespace", "Envoy Service Namespace.").PlaceHolder("<namespace>").StringVar(&ctx.Config.EnvoyServiceNamespace)
+	serve.Flag("envoy-ingress-name", "Name of the Envoy ingress to inspect for Ingress status details.").PlaceHolder("<name>").StringVar(&ctx.Config.EnvoyIngressName)
+	serve.Flag("envoy-ingress-namespace", "Envoy Ingress Namespace.").PlaceHolder("<namespace>").StringVar(&ctx.Config.EnvoyIngressNamespace)
 
 	serve.Flag("health-address", "Address the health HTTP endpoint will bind to.").PlaceHolder("<ipaddr>").StringVar(&ctx.healthAddr)
 	serve.Flag("health-port", "Port the health HTTP endpoint will bind to.").PlaceHolder("<port>").IntVar(&ctx.healthPort)
@@ -688,6 +690,50 @@ func (s *Server) doServe() error {
 		return err
 	}
 
+	// Register an informer to watch envoy's service if we haven't been given static details.
+	if lbAddress := contourConfiguration.Ingress.StatusAddress; len(lbAddress) > 0 {
+		s.log.WithField("loadbalancer-address", lbAddress).Info("Using supplied information for Ingress status")
+		lbsw.lbStatus <- parseStatusFlag(lbAddress)
+	} else {
+		serviceHandler := &k8s.ServiceStatusLoadBalancerWatcher{
+			ServiceName: contourConfiguration.Envoy.Service.Name,
+			LBStatus:    lbsw.lbStatus,
+			Log:         s.log.WithField("context", "serviceStatusLoadBalancerWatcher"),
+		}
+
+		var handler cache.ResourceEventHandler = serviceHandler
+		if contourConfiguration.Envoy.Service.Namespace != "" {
+			handler = k8s.NewNamespaceFilter([]string{contourConfiguration.Envoy.Service.Namespace}, handler)
+		}
+
+		if err := s.informOnResource(&corev1.Service{}, handler); err != nil {
+			s.log.WithError(err).WithField("resource", "services").Fatal("failed to create informer")
+		}
+
+		ingressHandler := &k8s.IngressStatusLoadBalancerWatcher{
+			ServiceName: contourConfiguration.Envoy.Service.Name,
+			LBStatus:    lbsw.lbStatus,
+			Log:         s.log.WithField("context", "ingressStatusLoadBalancerWatcher"),
+		}
+
+		var ingressEventHandler cache.ResourceEventHandler = ingressHandler
+		if contourConfiguration.Envoy.Ingress.Namespace != "" {
+			handler = k8s.NewNamespaceFilter([]string{contourConfiguration.Envoy.Ingress.Namespace}, handler)
+		}
+
+		if err := informOnResource(&networking_v1.Ingress{}, ingressEventHandler, s.mgr.GetCache()); err != nil {
+			s.log.WithError(err).WithField("resource", "ingresses").Fatal("failed to create ingresses informer")
+		}
+
+		s.log.WithField("envoy-service-name", contourConfiguration.Envoy.Service.Name).
+			WithField("envoy-service-namespace", contourConfiguration.Envoy.Service.Namespace).
+			Info("Watching Service for Ingress status")
+
+		s.log.WithField("envoy-ingress-name", contourConfiguration.Envoy.Ingress.Name).
+			WithField("envoy-ingress-namespace", contourConfiguration.Envoy.Ingress.Namespace).
+			Info("Watching Ingress for Ingress status")
+	}
+
 	xdsServer := &xdsServer{
 		log:             s.log,
 		registry:        s.registry,

cmd/contour/servecontext.go

@@ -571,6 +571,10 @@ func (ctx *serveContext) convertToContourConfigurationSpec() contour_v1alpha1.Co
 				Name:      ctx.Config.EnvoyServiceName,
 				Namespace: ctx.Config.EnvoyServiceNamespace,
 			},
+			Ingress: &contour_v1alpha1.NamespacedName{
+				Name:      ctx.Config.EnvoyIngressName,
+				Namespace: ctx.Config.EnvoyIngressNamespace,
+			},
 			HTTPListener: &contour_v1alpha1.EnvoyListener{
 				Address:   ctx.httpAddr,
 				Port:      ctx.httpPort,

internal/k8s/statusaddress.go

@@ -280,3 +280,63 @@ func lbStatusToGatewayAddresses(lbs core_v1.LoadBalancerStatus) []gatewayapi_v1.
 
 	return addrs
 }
+
+// IngressStatusLoadBalancerWatcher implements ResourceEventHandler and
+// watches for changes to the status.loadbalancer field
+// Note that we specifically *don't* inspect inside the struct, as sending empty values
+// is desirable to clear the status.
+type IngressStatusLoadBalancerWatcher struct {
+	IngressName string
+	LBStatus    chan networking_v1.IngressLoadBalancerStatus
+	Log         logrus.FieldLogger
+}
+
+func (s *IngressStatusLoadBalancerWatcher) OnAdd(obj interface{}) {
+	ingress, ok := obj.(*networking_v1.Ingress)
+	if !ok {
+		// not a service
+		return
+	}
+	if ingress.Name != s.IngressName {
+		return
+	}
+	s.Log.WithField("name", ingress.Name).
+		WithField("namespace", ingress.Namespace).
+		Debug("received new service address")
+
+	s.notify(ingress.Status.LoadBalancer)
+}
+
+func (s *IngressStatusLoadBalancerWatcher) OnUpdate(oldObj, newObj interface{}) {
+	ingress, ok := newObj.(*networking_v1.Ingress)
+	if !ok {
+		// not a service
+		return
+	}
+	if ingress.Name != s.IngressName {
+		return
+	}
+	s.Log.WithField("name", ingress.Name).
+		WithField("namespace", ingress.Namespace).
+		Debug("received new service address")
+
+	s.notify(ingress.Status.LoadBalancer)
+}
+
+func (s *IngressStatusLoadBalancerWatcher) OnDelete(obj interface{}) {
+	ingress, ok := obj.(*networking_v1.Ingress)
+	if !ok {
+		// not a service
+		return
+	}
+	if ingress.Name != s.IngressName {
+		return
+	}
+	s.notify(networking_v1.IngressLoadBalancerStatus{
+		Ingress: nil,
+	})
+}
+
+func (s *IngressStatusLoadBalancerWatcher) notify(lbstatus networking_v1.IngressLoadBalancerStatus) {
+	s.LBStatus <- lbstatus
+}

internal/provisioner/model/names.go

@@ -32,6 +32,11 @@ func (c *Contour) EnvoyServiceName() string {
 	return "envoy-" + c.Name
 }
 
+// EnvoyIngressName returns the name of the Envoy Ingress resource.
+func (c *Contour) EnvoyIngressName() string {
+	return "envoy-" + c.Name
+}
+
 // ContourDeploymentName returns the name of the Contour Deployment resource.
 func (c *Contour) ContourDeploymentName() string {
 	return "contour-" + c.Name

internal/provisioner/objects/contourconfig/contourconfig.go

@@ -73,6 +73,10 @@ func setGatewayConfig(config *contour_v1alpha1.ContourConfiguration, contour *mo
 		Namespace: contour.Namespace,
 		Name:      contour.EnvoyServiceName(),
 	}
+	config.Spec.Envoy.Ingress = &contour_api_v1alpha1.NamespacedName{
+		Namespace: contour.Namespace,
+		Name:      contour.EnvoyIngressName(),
+	}
 }
 
 // EnsureContourConfigDeleted deletes a ContourConfig for the provided contour, if the configured owner labels exist.

internal/provisioner/objects/deployment/deployment.go

@@ -95,6 +95,7 @@ func DesiredDeployment(contour *model.Contour, image string) *apps_v1.Deployment
 		fmt.Sprintf("--contour-config-name=%s", contour.ContourConfigurationName()),
 		fmt.Sprintf("--leader-election-resource-name=%s", contour.LeaderElectionLeaseName()),
 		fmt.Sprintf("--envoy-service-name=%s", contour.EnvoyServiceName()),
+		fmt.Sprintf("--envoy-ingress-name=%s", contour.EnvoyIngressName()),
 		fmt.Sprintf("--kubernetes-debug=%d", contour.Spec.KubernetesLogLevel),
 	}
 

pkg/config/parameters.go

@@ -667,6 +667,12 @@ type Parameters struct {
 	// Name of the envoy service to inspect for Ingress status details.
 	EnvoyServiceName string `yaml:"envoy-service-name,omitempty"`
 
+	// Namespace of the envoy ingress to inspect for Ingress status details.
+	EnvoyIngressNamespace string `yaml:"envoy-ingress-namespace,omitempty"`
+
+	// Name of the envoy ingress to inspect for Ingress status details.
+	EnvoyIngressName string `yaml:"envoy-ingress-name,omitempty"`
+
 	// DefaultHTTPVersions defines the default set of HTTPS
 	// versions the proxy should accept. HTTP versions are
 	// strings of the form "HTTP/xx". Supported versions are
@@ -1093,6 +1099,8 @@ func Defaults() Parameters {
 		},
 		EnvoyServiceName:      "envoy",
 		EnvoyServiceNamespace: contourNamespace,
+		EnvoyIngressName:      "envoy",
+		EnvoyIngressNamespace: contourNamespace,
 		DefaultHTTPVersions:   []HTTPVersionType{},
 		Cluster: ClusterParameters{
 			DNSLookupFamily: AutoClusterDNSFamily,