Support for all services kinds (and sticky) in CRD

Co-authored-by: Jean-Baptiste Doumenjou <jb.doumenjou@gmail.com>
Co-authored-by: Julien Salleyron <julien.salleyron@gmail.com>

pkg/provider/kubernetes/crd/traefik/v1alpha1/ingressroute.go

@@ -1,6 +1,9 @@
 package v1alpha1
 
 import (
+	"errors"
+	"fmt"
+
 	"github.com/containous/traefik/v2/pkg/config/dynamic"
 	"github.com/containous/traefik/v2/pkg/types"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -22,13 +25,14 @@ type Route struct {
 	Middlewares []MiddlewareRef `json:"middlewares"`
 }
 
-// TLS contains the TLS certificates configuration of the routes. To enable
-// Let's Encrypt, use an empty TLS struct, e.g. in YAML:
+// TLS contains the TLS certificates configuration of the routes.
+// To enable Let's Encrypt, use an empty TLS struct,
+// e.g. in YAML:
 //
-// tls: {} # inline format
+//	 tls: {} # inline format
 //
-// tls:
-//   secretName: # block format
+//	 tls:
+//	   secretName: # block format
 type TLS struct {
 	// SecretName is the name of the referenced Kubernetes Secret to specify the
 	// certificate details.
@@ -45,16 +49,58 @@ type TLSOptionRef struct {
 	Namespace string `json:"namespace"`
 }
 
-// Service defines an upstream to proxy traffic.
-type Service struct {
-	Name               string                      `json:"name"`
+// LoadBalancerSpec can reference either a Kubernetes Service object (a load-balancer of servers),
+// or a TraefikService object (a traefik load-balancer of services).
+type LoadBalancerSpec struct {
+	// Name is a reference to a Kubernetes Service object (for a load-balancer of servers),
+	// or to a TraefikService object (service load-balancer, mirroring, etc).
+	// The differentiation between the two is specified in the Kind field.
+	Name      string          `json:"name"`
+	Kind      string          `json:"kind"`
+	Namespace string          `json:"namespace"`
+	Sticky    *dynamic.Sticky `json:"sticky,omitempty"`
+
+	// Port and all the fields below are related to a servers load-balancer,
+	// and therefore should only be specified when Name references a Kubernetes Service.
 	Port               int32                       `json:"port"`
 	Scheme             string                      `json:"scheme,omitempty"`
 	HealthCheck        *HealthCheck                `json:"healthCheck,omitempty"`
 	Strategy           string                      `json:"strategy,omitempty"`
 	PassHostHeader     *bool                       `json:"passHostHeader,omitempty"`
 	ResponseForwarding *dynamic.ResponseForwarding `json:"responseForwarding,omitempty"`
-	Weight             *int                        `json:"weight,omitempty"`
+
+	// Weight should only be specified when Name references a TraefikService object
+	// (and to be precise, one that embeds a Weighted Round Robin).
+	Weight *int `json:"weight,omitempty"`
+}
+
+// IsServersLB reports whether lb is a load-balancer of servers
+// (as opposed to a traefik load-balancer of services).
+func (lb LoadBalancerSpec) IsServersLB() (bool, error) {
+	if lb.Name == "" {
+		return false, errors.New("missing Name field in service")
+	}
+	if lb.Kind == "" || lb.Kind == "Service" {
+		return true, nil
+	}
+	if lb.Kind != "TraefikService" {
+		return false, fmt.Errorf("invalid kind value: %v", lb.Kind)
+	}
+	if lb.Port != 0 ||
+		lb.Scheme != "" ||
+		lb.HealthCheck != nil ||
+		lb.Strategy != "" ||
+		lb.PassHostHeader != nil ||
+		lb.ResponseForwarding != nil ||
+		lb.Sticky != nil {
+		return false, fmt.Errorf("service of kind %v is incompatible with Kubernetes Service related fields", lb.Kind)
+	}
+	return false, nil
+}
+
+// Service defines an upstream to proxy traffic.
+type Service struct {
+	LoadBalancerSpec
 }
 
 // MiddlewareRef is a ref to the Middleware resources.

pkg/provider/kubernetes/crd/traefik/v1alpha1/ingressroutetcp.go

@@ -18,13 +18,14 @@ type RouteTCP struct {
 	Services []ServiceTCP `json:"services,omitempty"`
 }
 
-// TLSTCP contains the TLS certificates configuration of the routes. To enable
-// Let's Encrypt, use an empty TLS struct, e.g. in YAML:
+// TLSTCP contains the TLS certificates configuration of the routes.
+// To enable Let's Encrypt, use an empty TLS struct,
+// e.g. in YAML:
 //
-// tls: {} # inline format
+//	 tls: {} # inline format
 //
-// tls:
-//   secretName: # block format
+//	 tls:
+//	   secretName: # block format
 type TLSTCP struct {
 	// SecretName is the name of the referenced Kubernetes Secret to specify the
 	// certificate details.

pkg/provider/kubernetes/crd/traefik/v1alpha1/register.go

@@ -41,6 +41,8 @@ func addKnownTypes(scheme *runtime.Scheme) error {
 		&MiddlewareList{},
 		&TLSOption{},
 		&TLSOptionList{},
+		&TraefikService{},
+		&TraefikServiceList{},
 	)
 	metav1.AddToGroupVersion(scheme, SchemeGroupVersion)
 	return nil

pkg/provider/kubernetes/crd/traefik/v1alpha1/service.go

@@ -0,0 +1,64 @@
+package v1alpha1
+
+import (
+	"github.com/containous/traefik/v2/pkg/config/dynamic"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// +genclient
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
+// TraefikService is the specification for a service (that an IngressRoute refers
+// to) that is usually not a terminal service (i.e. not a pod of servers), as
+// opposed to a Kubernetes Service. That is to say, it usually refers to other
+// (children) services, which themselves can be TraefikServices or Services.
+type TraefikService struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata"`
+
+	Spec ServiceSpec `json:"spec"`
+}
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
+// TraefikServiceList is a list of TraefikService resources.
+type TraefikServiceList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata"`
+
+	Items []TraefikService `json:"items"`
+}
+
+// +k8s:deepcopy-gen=true
+
+// ServiceSpec defines whether a TraefikService is a load-balancer of services or a
+// mirroring service.
+type ServiceSpec struct {
+	Weighted  *WeightedRoundRobin `json:"weighted,omitempty"`
+	Mirroring *Mirroring          `json:"mirroring,omitempty"`
+}
+
+// +k8s:deepcopy-gen=true
+
+// Mirroring defines a mirroring service, which is composed of a main
+// load-balancer, and a list of mirrors.
+type Mirroring struct {
+	LoadBalancerSpec
+	Mirrors []MirrorService `json:"mirrors,omitempty"`
+}
+
+// +k8s:deepcopy-gen=true
+
+// MirrorService defines one of the mirrors of a Mirroring service.
+type MirrorService struct {
+	LoadBalancerSpec
+	Percent int `json:"percent,omitempty"`
+}
+
+// +k8s:deepcopy-gen=true
+
+// WeightedRoundRobin defines a load-balancer of services.
+type WeightedRoundRobin struct {
+	Services []Service       `json:"services,omitempty"`
+	Sticky   *dynamic.Sticky `json:"sticky,omitempty"`
+}

pkg/provider/kubernetes/crd/traefik/v1alpha1/zz_generated.deepcopy.go

@@ -381,6 +381,47 @@ func (in *IngressRouteTCPSpec) DeepCopy() *IngressRouteTCPSpec {
 	return out
 }
 
+// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
+func (in *LoadBalancerSpec) DeepCopyInto(out *LoadBalancerSpec) {
+	*out = *in
+	if in.Sticky != nil {
+		in, out := &in.Sticky, &out.Sticky
+		*out = new(dynamic.Sticky)
+		(*in).DeepCopyInto(*out)
+	}
+	if in.HealthCheck != nil {
+		in, out := &in.HealthCheck, &out.HealthCheck
+		*out = new(HealthCheck)
+		(*in).DeepCopyInto(*out)
+	}
+	if in.PassHostHeader != nil {
+		in, out := &in.PassHostHeader, &out.PassHostHeader
+		*out = new(bool)
+		**out = **in
+	}
+	if in.ResponseForwarding != nil {
+		in, out := &in.ResponseForwarding, &out.ResponseForwarding
+		*out = new(dynamic.ResponseForwarding)
+		**out = **in
+	}
+	if in.Weight != nil {
+		in, out := &in.Weight, &out.Weight
+		*out = new(int)
+		**out = **in
+	}
+	return
+}
+
+// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LoadBalancerSpec.
+func (in *LoadBalancerSpec) DeepCopy() *LoadBalancerSpec {
+	if in == nil {
+		return nil
+	}
+	out := new(LoadBalancerSpec)
+	in.DeepCopyInto(out)
+	return out
+}
+
 // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
 func (in *Middleware) DeepCopyInto(out *Middleware) {
 	*out = *in
@@ -578,6 +619,47 @@ func (in *MiddlewareSpec) DeepCopy() *MiddlewareSpec {
 	return out
 }
 
+// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
+func (in *MirrorService) DeepCopyInto(out *MirrorService) {
+	*out = *in
+	in.LoadBalancerSpec.DeepCopyInto(&out.LoadBalancerSpec)
+	return
+}
+
+// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MirrorService.
+func (in *MirrorService) DeepCopy() *MirrorService {
+	if in == nil {
+		return nil
+	}
+	out := new(MirrorService)
+	in.DeepCopyInto(out)
+	return out
+}
+
+// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
+func (in *Mirroring) DeepCopyInto(out *Mirroring) {
+	*out = *in
+	in.LoadBalancerSpec.DeepCopyInto(&out.LoadBalancerSpec)
+	if in.Mirrors != nil {
+		in, out := &in.Mirrors, &out.Mirrors
+		*out = make([]MirrorService, len(*in))
+		for i := range *in {
+			(*in)[i].DeepCopyInto(&(*out)[i])
+		}
+	}
+	return
+}
+
+// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Mirroring.
+func (in *Mirroring) DeepCopy() *Mirroring {
+	if in == nil {
+		return nil
+	}
+	out := new(Mirroring)
+	in.DeepCopyInto(out)
+	return out
+}
+
 // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
 func (in *Route) DeepCopyInto(out *Route) {
 	*out = *in
@@ -632,26 +714,7 @@ func (in *RouteTCP) DeepCopy() *RouteTCP {
 // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
 func (in *Service) DeepCopyInto(out *Service) {
 	*out = *in
-	if in.HealthCheck != nil {
-		in, out := &in.HealthCheck, &out.HealthCheck
-		*out = new(HealthCheck)
-		(*in).DeepCopyInto(*out)
-	}
-	if in.PassHostHeader != nil {
-		in, out := &in.PassHostHeader, &out.PassHostHeader
-		*out = new(bool)
-		**out = **in
-	}
-	if in.ResponseForwarding != nil {
-		in, out := &in.ResponseForwarding, &out.ResponseForwarding
-		*out = new(dynamic.ResponseForwarding)
-		**out = **in
-	}
-	if in.Weight != nil {
-		in, out := &in.Weight, &out.Weight
-		*out = new(int)
-		**out = **in
-	}
+	in.LoadBalancerSpec.DeepCopyInto(&out.LoadBalancerSpec)
 	return
 }
 
@@ -665,6 +728,32 @@ func (in *Service) DeepCopy() *Service {
 	return out
 }
 
+// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
+func (in *ServiceSpec) DeepCopyInto(out *ServiceSpec) {
+	*out = *in
+	if in.Weighted != nil {
+		in, out := &in.Weighted, &out.Weighted
+		*out = new(WeightedRoundRobin)
+		(*in).DeepCopyInto(*out)
+	}
+	if in.Mirroring != nil {
+		in, out := &in.Mirroring, &out.Mirroring
+		*out = new(Mirroring)
+		(*in).DeepCopyInto(*out)
+	}
+	return
+}
+
+// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceSpec.
+func (in *ServiceSpec) DeepCopy() *ServiceSpec {
+	if in == nil {
+		return nil
+	}
+	out := new(ServiceSpec)
+	in.DeepCopyInto(out)
+	return out
+}
+
 // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
 func (in *ServiceTCP) DeepCopyInto(out *ServiceTCP) {
 	*out = *in
@@ -865,3 +954,91 @@ func (in *TLSTCP) DeepCopy() *TLSTCP {
 	in.DeepCopyInto(out)
 	return out
 }
+
+// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
+func (in *TraefikService) DeepCopyInto(out *TraefikService) {
+	*out = *in
+	out.TypeMeta = in.TypeMeta
+	in.ObjectMeta.DeepCopyInto(&out.ObjectMeta)
+	in.Spec.DeepCopyInto(&out.Spec)
+	return
+}
+
+// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TraefikService.
+func (in *TraefikService) DeepCopy() *TraefikService {
+	if in == nil {
+		return nil
+	}
+	out := new(TraefikService)
+	in.DeepCopyInto(out)
+	return out
+}
+
+// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
+func (in *TraefikService) DeepCopyObject() runtime.Object {
+	if c := in.DeepCopy(); c != nil {
+		return c
+	}
+	return nil
+}
+
+// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
+func (in *TraefikServiceList) DeepCopyInto(out *TraefikServiceList) {
+	*out = *in
+	out.TypeMeta = in.TypeMeta
+	in.ListMeta.DeepCopyInto(&out.ListMeta)
+	if in.Items != nil {
+		in, out := &in.Items, &out.Items
+		*out = make([]TraefikService, len(*in))
+		for i := range *in {
+			(*in)[i].DeepCopyInto(&(*out)[i])
+		}
+	}
+	return
+}
+
+// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TraefikServiceList.
+func (in *TraefikServiceList) DeepCopy() *TraefikServiceList {
+	if in == nil {
+		return nil
+	}
+	out := new(TraefikServiceList)
+	in.DeepCopyInto(out)
+	return out
+}
+
+// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
+func (in *TraefikServiceList) DeepCopyObject() runtime.Object {
+	if c := in.DeepCopy(); c != nil {
+		return c
+	}
+	return nil
+}
+
+// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
+func (in *WeightedRoundRobin) DeepCopyInto(out *WeightedRoundRobin) {
+	*out = *in
+	if in.Services != nil {
+		in, out := &in.Services, &out.Services
+		*out = make([]Service, len(*in))
+		for i := range *in {
+			(*in)[i].DeepCopyInto(&(*out)[i])
+		}
+	}
+	if in.Sticky != nil {
+		in, out := &in.Sticky, &out.Sticky
+		*out = new(dynamic.Sticky)
+		(*in).DeepCopyInto(*out)
+	}
+	return
+}
+
+// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WeightedRoundRobin.
+func (in *WeightedRoundRobin) DeepCopy() *WeightedRoundRobin {
+	if in == nil {
+		return nil
+	}
+	out := new(WeightedRoundRobin)
+	in.DeepCopyInto(out)
+	return out
+}