interface: define traffic manager apis

api/v1alpha1/internalserviceexport_types.go

@@ -6,6 +6,7 @@ Licensed under the MIT license.
 package v1alpha1
 
 import (
+	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
@@ -18,6 +19,14 @@ type InternalServiceExportSpec struct {
 	// The reference to the source Service.
 	// +kubebuilder:validation:Required
 	ServiceReference ExportedObjectReference `json:"serviceReference"`
+	// Type determines how the Service is exposed.
+	Type corev1.ServiceType
+	// LoadBalancer contains the current status of the load-balancer.
+	LoadBalancer corev1.LoadBalancerStatus
+	// Annotations copies the annotations from the exported service, excluding the kubectl.kubernetes.io/last-applied-configuration.
+	// ServiceProvide relies on the label to validate or get the ingress ip information.
+	// +optional
+	Annotations map[string]string `json:"annotations,omitempty"`
 }
 
 // InternalServiceExportStatus contains the current status of an InternalServiceExport.

api/v1alpha1/trafficmanager_types.go

@@ -0,0 +1,264 @@
+package v1alpha1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+type TrafficManagerProfile struct {
+	metav1.TypeMeta `json:",inline"`
+	// +optional
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec TrafficManagerProfileSpec `json:"spec"`
+	// +optional
+	Status TrafficManagerProfileStatus `json:"status,omitempty"`
+}
+
+type TrafficManagerProfileSpec struct {
+	// Type of routing method.
+	// +kubebuilder:validation:Enum=Weighted
+	// +kubebuilder:default=Weighted
+	// +optional
+	RoutingMethod TrafficRoutingMethod
+
+	// The DNS settings of the Traffic Manager profile.
+	// +required
+	DNSConfig *DNSConfig
+
+	// The endpoint monitoring settings of the Traffic Manager profile.
+	MonitorConfig *MonitorConfig
+
+	// The list of endpoints in the Traffic Manager profile.
+	Endpoints []*TrafficManagerEndpointRef
+}
+
+type TrafficManagerEndpointRefType string
+
+const (
+	// TrafficManagerEndpointTypeServiceImport is a group of public ip exposed by the exported service.
+	TrafficManagerEndpointTypeServiceImport TrafficManagerEndpointRefType = "ServiceImport"
+)
+
+type TrafficManagerEndpointRef struct {
+	// Type of endpoint reference. Can be "ServiceImport". Default is ServiceImport.
+	// +kubebuilder:validation:Enum=ServiceImport
+	// +kubebuilder:default=ServiceImport
+	// +optional
+	Type TrafficManagerEndpointRefType
+
+	ServiceImportEndpointConfig *ServiceImportEndpointConfig
+}
+
+type TrafficManagerEndpointType string
+
+const (
+	// EndpointTypeAzureEndpoints are used for services hosted in Azure exposed via PublicIPAddress.
+	// The publicIpAddress must have a DNS name assigned to be used in a Traffic Manager profile.
+	EndpointTypeAzureEndpoints TrafficManagerEndpointType = "AzureEndpoints"
+	// EndpointTypeExternalEndpoints are used for IPv4/IPv6 addresses, FQDNs, or for services hosted outside Azure.
+	// Theses services can either be on-premises or with a different hosting provider.
+	EndpointTypeExternalEndpoints TrafficManagerEndpointType = "ExternalEndpoints"
+)
+
+type ServiceImportEndpointConfig struct {
+	// ServiceImport is the reference to the ServiceImport in the same namespace of Traffic Manager Profile.
+	// +required
+	ServiceImport *ServiceImportRef
+
+	// +required
+	Config *TrafficManagerEndpoint
+}
+
+type TrafficManagerEndpoint struct {
+	// If the type is "AzureEndpoints", it means the public ip is an azure resource and must have a DNS name assigned.
+	// Note: To use Traffic Manager with endpoints from other subscriptions, the controller needs to have read access to
+	// the endpoint.
+	// +kubebuilder:validation:Enum=AzureEndpoints;ExternalEndpoints
+	// +kubebuilder:default=AzureEndpoints
+	// +optional
+	Type TrafficManagerEndpointType
+
+	// If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic
+	// routing method.
+	// +kubebuilder:default=false
+	// +optional
+	AlwaysServe bool
+
+	// The weight of endpoints behind the serviceImport when using the 'Weighted' traffic routing method.
+	// Possible values are from 1 to 1000.
+	// +required
+	// +kubebuilder:default=1
+	// +kubebuilder:validation:Minimum=1
+	// +kubebuilder:validation:Maximum=1000
+	// Defaults to 1.
+	// For example, if there are two clusters exporting the service via public ip, each public ip will be configured
+	// as "Weight".
+	Weight *int64
+
+	// The fully-qualified DNS name or IP address of the endpoint.
+	// When the endpoint reference type is ServiceImport, the controller will configure this value by looking at the
+	// exported Service information.
+	// +optional
+	Target *string
+}
+
+type TrafficManagerEndpointStatus struct {
+	// Name is a unique endpoint name generated by the controller.
+	// +required
+	Name *string
+
+	// ServiceImport is the reference to the ServiceImport in the same namespace of Traffic Manager Profile if the endpoint
+	// reference type is ServiceImport.
+	// +optional
+	ServiceImport *ServiceImportRef
+
+	// Config represents the endpoint configurations.
+	// +required
+	Config *TrafficManagerEndpoint
+
+	// Cluster is where the endpoint is exported from.
+	// +optional
+	Cluster *ClusterStatus
+}
+
+type DNSConfig struct {
+	// +required
+	// +kubebuilder:validation:Minimum=0
+	// +kubebuilder:validation:Maximum=2147483647
+	// Traffic Manager allows you to configure the TTL used in Traffic Manager DNS responses to be as low as 0 seconds
+	// and as high as 2,147,483,647 seconds (the maximum range compliant with RFC-1035), enabling you to choose the value
+	// that best balances the needs of your application.
+	TTL *int64
+}
+
+type MonitorConfig struct {
+	// The monitor interval for endpoints in this profile. This is the interval at which Traffic Manager will check the health
+	// of each endpoint in this profile.
+	IntervalInSeconds *int64
+
+	// The path relative to the endpoint domain name used to probe for endpoint health.
+	Path *string
+
+	// The TCP port used to probe for endpoint health.
+	Port *int64
+
+	// The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health.
+	Protocol *MonitorProtocol
+
+	// The monitor timeout for endpoints in this profile. This is the time that Traffic Manager allows endpoints in this profile
+	// to response to the health check.
+	TimeoutInSeconds *int64
+
+	// The number of consecutive failed health check that Traffic Manager tolerates before declaring an endpoint in this profile
+	// Degraded after the next failed health check.
+	ToleratedNumberOfFailures *int64
+}
+
+type MonitorProtocol string
+
+const (
+	MonitorProtocolHTTP  MonitorProtocol = "HTTP"
+	MonitorProtocolHTTPS MonitorProtocol = "HTTPS"
+	MonitorProtocolTCP   MonitorProtocol = "TCP"
+)
+
+type TrafficRoutingMethod string
+
+const (
+	// TrafficRoutingMethodGeographic  TrafficRoutingMethod = "Geographic"
+	// TrafficRoutingMethodMultiValue  TrafficRoutingMethod = "MultiValue"
+	// TrafficRoutingMethodPerformance TrafficRoutingMethod = "Performance"
+	// TrafficRoutingMethodPriority    TrafficRoutingMethod = "Priority"
+	// TrafficRoutingMethodSubnet      TrafficRoutingMethod = "Subnet"
+
+	// TrafficRoutingMethodWeighted is selected when you want to distribute traffic across a set of endpoints based on
+	// their weight. Set the weight the same to distribute evenly across all endpoints.
+	TrafficRoutingMethodWeighted TrafficRoutingMethod = "Weighted"
+)
+
+type TrafficManagerProfileStatus struct {
+	// DNSName is the fully-qualified domain name (FQDN) of the Traffic Manager profile.
+	// For example, azuresdkfornetautoresttrafficmanager3880.tmpreview.watmtest.azure-test.net
+	// +optional
+	DNSName *string
+
+	// Endpoints contains a list of accepted endpoints which are created or updated under the traffic manager Profile.
+	// +optional
+	Endpoints []TrafficManagerEndpointStatus
+
+	// Current service state
+	// +optional
+	// +patchMergeKey=type
+	// +patchStrategy=merge
+	// +listType=map
+	// +listMapKey=type
+	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`
+}
+
+// TrafficManagerProfileConditionType is a type of condition associated with a
+// Traffic Manager Profile. This type should be used with the TrafficManagerProfileStatus.Conditions
+// field.
+type TrafficManagerProfileConditionType string
+
+// TrafficManagerProfileConditionReason defines the set of reasons that explain why a
+// particular Gateway condition type has been raised.
+type TrafficManagerProfileConditionReason string
+
+const (
+	// ProfileConditionProgrammed condition indicates whether a profile has been generated that is assumed to be ready
+	// soon in the underlying data plane. This does not indicate whether or not the configuration has been propagated
+	// to the data plane.
+	//
+	// It is a positive-polarity summary condition, and so should always be
+	// present on the resource with ObservedGeneration set.
+	//
+	// Possible reasons for this condition to be True are:
+	//
+	// * "Programmed"
+	//
+	// Possible reasons for this condition to be False are:
+	//
+	// * "Invalid"
+	// * "AddressNotUsable"
+	// * "Pending"
+	ProfileConditionProgrammed TrafficManagerProfileConditionType = "Programmed"
+
+	// ProfileReasonProgrammed is used with the "Programmed" condition when the condition is
+	// true.
+	ProfileReasonProgrammed TrafficManagerProfileConditionReason = "Programmed"
+
+	// ProfileReasonInvalid is used with the "Accepted" and "Programmed" when the profile or endpoint is syntactically or
+	// semantically invalid.
+	ProfileReasonInvalid TrafficManagerProfileConditionReason = "Invalid"
+
+	// ProfileReasonAddressNotUsable is used with the "Programmed" condition when the generated DNS name is not usable.
+	ProfileReasonAddressNotUsable TrafficManagerProfileConditionReason = "AddressNotUsable"
+
+	// ProfileReasonPending is used with the "Accepted" and "Programmed" when creating or updating the profile or endpoint
+	// hits an internal error with more detail in the message and the controller will keep retry.
+	ProfileReasonPending TrafficManagerProfileConditionReason = "Pending"
+)
+
+const (
+	// ProfileConditionAccepted condition indicates whether endpoints have been created or updated for the profile.
+	// This does not indicate whether or not the configuration has been propagated to the data plane.
+	//
+	// Possible reasons for this condition to be True are:
+	//
+	// * "Accepted"
+	//
+	// Possible reasons for this condition to be False are:
+	//
+	// * "Invalid"
+	// * "EndpointsRefNotValid"
+	// * "Pending"
+	ProfileConditionAccepted TrafficManagerProfileConditionType = "Accepted"
+
+	// ProfileReasonAccepted is used with the "Accepted" condition when the condition is True.
+	ProfileReasonAccepted TrafficManagerProfileConditionReason = "Accepted"
+
+	// ProfileReasonEndpointsRefNotValid is used with the "Accepted" condition when one or
+	// more endpoint references have an invalid or unsupported configuration
+	// and cannot be configured on the Profile with more detail in the message.
+	ProfileReasonEndpointsRefNotValid TrafficManagerProfileConditionReason = "EndpointsRefNotValid"
+)

pkg/common/serviceprovider/azure/provider.go

@@ -0,0 +1,14 @@
+package azure
+
+import fleetnetv1alpha1 "go.goms.io/fleet-networking/api/v1alpha1"
+
+type ServiceProvider struct {
+}
+
+func (s *ServiceProvider) IsExternalLoadBalancerService(service *fleetnetv1alpha1.InternalServiceExportSpec) bool {
+	return true
+}
+
+func (s *ServiceProvider) ExtractExternalIP(service *fleetnetv1alpha1.InternalServiceExportSpec) string {
+	return ""
+}

pkg/common/serviceprovider/common.go

@@ -0,0 +1,14 @@
+package serviceprovider
+
+import fleetnetv1alpha1 "go.goms.io/fleet-networking/api/v1alpha1"
+
+// ServiceProvider provides the functions how to extract the external ip from the exported services based on the endpoint
+// type.
+type ServiceProvider interface {
+	// IsExternalLoadBalancerService returns whether the service is load balancer type with a public ip.
+	IsExternalLoadBalancerService(service *fleetnetv1alpha1.InternalServiceExportSpec) bool
+
+	// ExtractExternalIP returns an external ip or DNS name of the Service.
+	// If the service is exposed via multiple IPs, it will only return the first one.
+	ExtractExternalIP(service *fleetnetv1alpha1.InternalServiceExportSpec) string
+}