feat(experiments): add ability to set service port mappings

docs/features/experiment.md

@@ -57,6 +57,12 @@ spec:
  service:
  # Name of the Service (optional). If omitted, service: {} would also be acceptable.
  name: service-name
+ # Service ports (optional). This is useful when the target container port is different from the desired service port.
+ # The target port can also match the container port name. Example: targetPort: http
+ # If omitted, the port will be mapped to the container port.
+ ports:
+ - port: 80
+ targetPort: 8080
  selector:
  matchLabels:
  app: canary-demo

docs/features/kustomize/rollout_cr_schema.json

@@ -14791,10 +14791,142 @@
  },
  "service": {
  "properties": {
+ "allocateLoadBalancerNodePorts": {
+ "type": "boolean"
+ },
+ "clusterIP": {
+ "type": "string"
+ },
+ "clusterIPs": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "x-kubernetes-list-type": "atomic"
+ },
+ "externalIPs": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "externalName": {
+ "type": "string"
+ },
+ "externalTrafficPolicy": {
+ "type": "string"
+ },
+ "healthCheckNodePort": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "internalTrafficPolicy": {
+ "type": "string"
+ },
+ "ipFamilies": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "x-kubernetes-list-type": "atomic"
+ },
+ "ipFamilyPolicy": {
+ "type": "string"
+ },
+ "loadBalancerClass": {
+ "type": "string"
+ },
+ "loadBalancerIP": {
+ "type": "string"
+ },
+ "loadBalancerSourceRanges": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
  "name": {
  "type": "string"
+ },
+ "ports": {
+ "items": {
+ "properties": {
+ "appProtocol": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "nodePort": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "port": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "protocol": {
+ "default": "TCP",
+ "type": "string"
+ },
+ "targetPort": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "string"
+ }
+ ],
+ "x-kubernetes-int-or-string": true
+ }
+ },
+ "required": [
+ "port"
+ ],
+ "type": "object"
+ },
+ "type": "array",
+ "x-kubernetes-list-map-keys": [
+ "port",
+ "protocol"
+ ],
+ "x-kubernetes-list-type": "map"
+ },
+ "publishNotReadyAddresses": {
+ "type": "boolean"
+ },
+ "selector": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object",
+ "x-kubernetes-map-type": "atomic"
+ },
+ "sessionAffinity": {
+ "type": "string"
+ },
+ "sessionAffinityConfig": {
+ "properties": {
+ "clientIP": {
+ "properties": {
+ "timeoutSeconds": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "type": {
+ "type": "string"
  }
  },
+ "required": [
+ "name"
+ ],
  "type": "object"
  },
  "template": {

experiments/experiment.go

@@ -22,7 +22,6 @@ import (
  corev1 "k8s.io/api/core/v1"
  k8serrors "k8s.io/apimachinery/pkg/api/errors"
  metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
- "k8s.io/apimachinery/pkg/util/intstr"
  "k8s.io/client-go/kubernetes"
  appslisters "k8s.io/client-go/listers/apps/v1"
  v1 "k8s.io/client-go/listers/core/v1"
@@ -285,33 +284,16 @@ func (ec *experimentContext) scaleTemplateRS(rs *appsv1.ReplicaSet, template v1a
 func (ec *experimentContext) createTemplateService(template *v1alpha1.TemplateSpec, templateStatus *v1alpha1.TemplateStatus, rs *appsv1.ReplicaSet) {
  // Create service with has same name, podTemplateHash, and labels as RS
  podTemplateHash := rs.Labels[v1alpha1.DefaultRolloutUniqueLabelKey]
- svc := ec.templateServices[template.Name]
- var ports []corev1.ServicePort
- for _, ctr := range rs.Spec.Template.Spec.Containers {
- for _, port := range ctr.Ports {
- servicePort := corev1.ServicePort{
- Protocol: port.Protocol,
- Port: port.ContainerPort,
- TargetPort: intstr.FromInt(int(port.ContainerPort)),
- }
- if port.Name != "" {
- servicePort.Name = port.Name
- }
- ports = append(ports, servicePort)
- }
- }
- if (svc == nil || svc.Name != rs.Name) && len(ports) > 0 {
- serviceName := rs.Name
- if template.Service.Name != "" {
- serviceName = template.Service.Name
- }
- newService, err := ec.CreateService(serviceName, *template, rs.Labels, ports)
+ tmplService := ec.templateServices[template.Name]
+
+ if tmplService == nil {
+ service, err := ec.CreateService(*template, rs)
  if err != nil {
  templateStatus.Status = v1alpha1.TemplateStatusError
- templateStatus.Message = fmt.Sprintf("Failed to create Service %s for template '%s': %v", serviceName, template.Name, err)
+ templateStatus.Message = fmt.Sprintf("Failed to create Service %s for template '%s': %v", service.Name, template.Name, err)
  } else {
- ec.templateServices[template.Name] = newService
- templateStatus.ServiceName = newService.Name
+ ec.templateServices[template.Name] = service
+ templateStatus.ServiceName = service.Name
  templateStatus.PodTemplateHash = podTemplateHash
  }
  }

experiments/experiment_test.go

@@ -67,7 +67,6 @@ func newTestContext(ex *v1alpha1.Experiment, objects ...runtime.Object) *experim
 }
 
 func setExperimentService(template *v1alpha1.TemplateSpec) {
- template.Service = &v1alpha1.TemplateService{}
  template.Template.Spec.Containers[0].Ports = []corev1.ContainerPort{
  {
  ContainerPort: 80,

experiments/service.go

@@ -4,6 +4,9 @@ import (
  "context"
  "fmt"
 
+ appsv1 "k8s.io/api/apps/v1"
+ "k8s.io/apimachinery/pkg/util/intstr"
+
  "k8s.io/apimachinery/pkg/api/errors"
 
  "github.com/argoproj/argo-rollouts/pkg/apis/rollouts/v1alpha1"
@@ -58,8 +61,15 @@ func GetServiceForExperiment(experiment *v1alpha1.Experiment, svc *corev1.Servic
  return nil
 }
 
-func (ec *experimentContext) CreateService(serviceName string, template v1alpha1.TemplateSpec, selector map[string]string, ports []corev1.ServicePort) (*corev1.Service, error) {
+func (ec *experimentContext) CreateService(template v1alpha1.TemplateSpec, rs *appsv1.ReplicaSet) (*corev1.Service, error) {
+ // If service name is not provided, default to replica set name
+ serviceName := rs.Name
+ if template.Service != nil && template.Service.Name != "" {
+ serviceName = template.Service.Name
+ }
+
  ctx := context.TODO()
+ ports := getPorts(rs, &template)
  serviceAnnotations := newServiceAnnotations(ec.ex.Name, template.Name)
  newService := &corev1.Service{
  TypeMeta: metav1.TypeMeta{},
@@ -72,8 +82,8 @@ func (ec *experimentContext) CreateService(serviceName string, template v1alpha1
  Annotations: serviceAnnotations,
  },
  Spec: corev1.ServiceSpec{
- Selector: selector,
  Ports: ports,
+ Selector: rs.Labels,
  },
  }
 
@@ -97,6 +107,45 @@ func (ec *experimentContext) CreateService(serviceName string, template v1alpha1
  return service, nil
 }
 
+func getPorts(rs *appsv1.ReplicaSet, template *v1alpha1.TemplateSpec) []corev1.ServicePort {
+ var ports []corev1.ServicePort
+ for _, container := range rs.Spec.Template.Spec.Containers {
+ for _, containerPort := range container.Ports {
+ servicePort := getServicePort(containerPort, template)
+ ports = append(ports, servicePort)
+ }
+ }
+ return ports
+}
+
+func getServicePort(port corev1.ContainerPort, template *v1alpha1.TemplateSpec) corev1.ServicePort {
+ portName := port.Name
+ portNumber := port.ContainerPort
+ targetPort := intstr.FromInt32(port.ContainerPort)
+ if template.Service.Ports != nil {
+ for _, servicePort := range template.Service.Ports {
+ if (port.ContainerPort == servicePort.TargetPort.IntVal) || (port.Name == servicePort.TargetPort.StrVal) {
+ portNumber = servicePort.Port
+ targetPort = servicePort.TargetPort
+
+ // Allow overriding the port name
+ if servicePort.Name != "" {
+ portName = servicePort.Name
+ }
+
+ break
+ }
+ }
+ }
+
+ return corev1.ServicePort{
+ Name: portName,
+ Port: portNumber,
+ TargetPort: targetPort,
+ Protocol: port.Protocol,
+ }
+}
+
 func (ec *experimentContext) deleteService(service corev1.Service) error {
  ctx := context.TODO()
  ec.log.Infof("Trying to cleanup service '%s'", service.Name)

manifests/crds/experiment-crd.yaml

@@ -162,8 +162,96 @@ spec:
  x-kubernetes-map-type: atomic
  service:
  properties:
+ allocateLoadBalancerNodePorts:
+ type: boolean
+ clusterIP:
+ type: string
+ clusterIPs:
+ items:
+ type: string
+ type: array
+ x-kubernetes-list-type: atomic
+ externalIPs:
+ items:
+ type: string
+ type: array
+ externalName:
+ type: string
+ externalTrafficPolicy:
+ type: string
+ healthCheckNodePort:
+ format: int32
+ type: integer
+ internalTrafficPolicy:
+ type: string
+ ipFamilies:
+ items:
+ type: string
+ type: array
+ x-kubernetes-list-type: atomic
+ ipFamilyPolicy:
+ type: string
+ loadBalancerClass:
+ type: string
+ loadBalancerIP:
+ type: string
+ loadBalancerSourceRanges:
+ items:
+ type: string
+ type: array
  name:
  type: string
+ ports:
+ items:
+ properties:
+ appProtocol:
+ type: string
+ name:
+ type: string
+ nodePort:
+ format: int32
+ type: integer
+ port:
+ format: int32
+ type: integer
+ protocol:
+ default: TCP
+ type: string
+ targetPort:
+ anyOf:
+ - type: integer
+ - type: string
+ x-kubernetes-int-or-string: true
+ required:
+ - port
+ type: object
+ type: array
+ x-kubernetes-list-map-keys:
+ - port
+ - protocol
+ x-kubernetes-list-type: map
+ publishNotReadyAddresses:
+ type: boolean
+ selector:
+ additionalProperties:
+ type: string
+ type: object
+ x-kubernetes-map-type: atomic
+ sessionAffinity:
+ type: string
+ sessionAffinityConfig:
+ properties:
+ clientIP:
+ properties:
+ timeoutSeconds:
+ format: int32
+ type: integer
+ type: object
+ type: object
+ type:
+ type: string
+ required:
+ - name
  type: object
  template:
  properties: