feat: support management of multiple Istio VirtualService objects

docs/features/specification.md

@@ -275,10 +275,19 @@ spec:
 
         # Istio traffic routing configuration
         istio:
+          # Either virtualService or virtualServices can be configured.
           virtualService: 
             name: rollout-vsvc  # required
             routes:
             - primary # optional if there is a single route in VirtualService, required otherwise
+          virtualServices:
+          # One or more virtualServices can be configured
+          - name: rollouts-vsvc1  # required
+            routes:
+              - primary # optional if there is a single route in VirtualService, required otherwise
+          - name: rollouts-vsvc2  # required
+            routes:
+              - secondary # optional if there is a single route in VirtualService, required otherwise
 
         # NGINX Ingress Controller routing configuration
         nginx:

docs/getting-started/istio/index.md

@@ -30,38 +30,79 @@ spec:
       stableService: rollouts-demo-stable
       trafficRouting:
         istio:
-          virtualService:
-            # Reference to a VirtualService which the controller updates with canary weights
-            name: rollouts-demo-vsvc
+          virtualServices:
+          # One or more virtualServices can be configured
+          # Reference to a VirtualService which the controller updates with canary weights.
+          - name: rollouts-demo-vsvc1
             routes:
             - primary # optional if there is a single route in VirtualService, required otherwise
+          # Reference to a VirtualService which the controller updates with canary weights
+          - name: rollouts-demo-vsvc2
+            routes:
+            - secondary # optional if there is a single route in VirtualService, required otherwise
 ...
 ```
 
-The VirtualService and route referenced in `trafficRouting.istio.virtualService` is required
-to have a HTTP route which splits between the stable and canary Services, referenced in the rollout.
+The VirtualService and route referenced in either `trafficRouting.istio.virtualService` or
+`trafficRouting.istio.virtualServices`. `trafficRouting.istio.virtualServices` helps in adding
+one or more virtualServices unlike `trafficRouting.istio.virtualService` where only single virtualService can be added.
+This is required to have a HTTP route which splits between the stable and canary Services, referenced in the rollout.
+In this example, primary route splits the http route with port number 15372 between stable and canary services;
+secondary route splits the http route with port number 15373 between stable and canary services.
 In this guide, those Services are named: `rollouts-demo-stable` and `rollouts-demo-canary` 
 respectively. The weight values for these services used should be initially set to 100% stable, 
 and 0% on the canary. During an update, these values will be modified by the controller.
+If there are multiple VirtualService then weight values for stable and canary service of each VirtualService
+will be modified by the controller simultaneously.
 
 ```yaml
 apiVersion: networking.istio.io/v1alpha3
 kind: VirtualService
 metadata:
-  name: rollouts-demo-vsvc
+  name: rollouts-demo-vsvc1
 spec:
   gateways:
   - rollouts-demo-gateway
   hosts:
-  - rollouts-demo.local
+  - rollouts-demo-vsvc1.local
   http:
-  - name: primary  # Should match spec.strategy.canary.trafficRouting.istio.virtualService.routes
+  - name: primary  # Should match rollout.spec.strategy.canary.trafficRouting.istio.virtualServices.routes
     route:
     - destination:
-        host: rollouts-demo-stable  # Should match spec.strategy.canary.stableService
+        host: rollouts-demo-stable  # Should match rollout.spec.strategy.canary.stableService
+        port:
+          number: 15372
       weight: 100
     - destination:
-        host: rollouts-demo-canary  # Should match spec.strategy.canary.canaryService
+        host: rollouts-demo-canary  # Should match rollout.spec.strategy.canary.canaryService
+        port:
+          number: 15372
+      weight: 0
+
+```
+
+```yaml
+apiVersion: networking.istio.io/v1alpha3
+kind: VirtualService
+metadata:
+  name: rollouts-demo-vsvc2
+spec:
+  gateways:
+  - rollouts-demo-gateway
+  hosts:
+  - rollouts-demo-vsvc2.local
+  http:
+  - name: secondary  # Should match rollout.spec.strategy.canary.trafficRouting.istio.virtualServices.routes
+    route:
+    - destination:
+        host: rollouts-demo-stable  # Should match rollout.spec.strategy.canary.stableService
+        port:
+          number: 15373
+      weight: 100
+    - destination:
+        host: rollouts-demo-canary  # Should match rollout.spec.strategy.canary.canaryService
+        port:
+          number: 15373
       weight: 0
 
 ```
@@ -70,13 +111,13 @@ Run the following commands to deploy:
 
 * A Rollout
 * Two Services (stable and canary)
-* An Istio VirtualService
+* One or more Istio VirtualServices
 * An Istio Gateway
 
 ```shell
 kubectl apply -f https://raw.githubusercontent.com/argoproj/argo-rollouts/master/docs/getting-started/istio/rollout.yaml
 kubectl apply -f https://raw.githubusercontent.com/argoproj/argo-rollouts/master/docs/getting-started/istio/services.yaml
-kubectl apply -f https://raw.githubusercontent.com/argoproj/argo-rollouts/master/docs/getting-started/istio/virtualsvc.yaml
+kubectl apply -f https://raw.githubusercontent.com/argoproj/argo-rollouts/master/docs/getting-started/istio/multipleVirtualsvc.yaml
 kubectl apply -f https://raw.githubusercontent.com/argoproj/argo-rollouts/master/docs/getting-started/istio/gateway.yaml
 ```
 
@@ -94,8 +135,9 @@ rollouts-demo-canary   ClusterIP   10.103.146.137   <none>        80/TCP    37s
 rollouts-demo-stable   ClusterIP   10.101.158.227   <none>        80/TCP    37s
 
 $ kubectl get virtualservice
-NAME                 GATEWAYS                  HOSTS                   AGE
-rollouts-demo-vsvc   [rollouts-demo-gateway]   [rollouts-demo.local]   54s
+NAME                 GATEWAYS                  HOSTS                        AGE
+rollouts-demo-vsvc1  [rollouts-demo-gateway]   [rollouts-demo-vsvc1.local]  54s
+rollouts-demo-vsvc2  [rollouts-demo-gateway]   [rollouts-demo-vsvc2.local]  54s
 
 $ kubectl get gateway
 NAME                    AGE
@@ -122,28 +164,58 @@ kubectl argo rollouts get rollout rollouts-demo
 
 At this point, both the canary and stable version of the Rollout are running, with 5% of the
 traffic directed to the canary. To understand how this works, inspect the VirtualService which
-the Rollout was referencing. When looking at the VirtualService, we see that the route destination
+the Rollout was referencing. When looking at both the VirtualService, we see that the route destination
 weights have been modified by the controller to reflect the current weight of the canary.
 
 ```yaml
 apiVersion: networking.istio.io/v1beta1
 kind: VirtualService
 metadata:
-  name: rollouts-demo-vsvc
+  name: rollouts-demo-vsvc1
   namespace: default
 spec:
   gateways:
   - rollouts-demo-gateway
   hosts:
-  - rollouts-demo.local
+  - rollouts-demo-vsvc1.local
   http:
   - name: primary
     route:
     - destination:
         host: rollouts-demo-stable
+        port:
+          number: 15372
+      weight: 95
+    - destination:
+        host: rollouts-demo-canary
+        port:
+          number: 15372
+      weight: 5
+```
+
+```yaml
+apiVersion: networking.istio.io/v1beta1
+kind: VirtualService
+metadata:
+  name: rollouts-demo-vsvc2
+  namespace: default
+spec:
+  gateways:
+  - rollouts-demo-gateway
+  hosts:
+  - rollouts-demo-vsvc2.local
+  http:
+  - name: secondary
+    route:
+    - destination:
+        host: rollouts-demo-stable
+        port:
+          number: 15373
       weight: 95
     - destination:
         host: rollouts-demo-canary
+        port:
+          number: 15373
       weight: 5
 ```
 

docs/getting-started/istio/multipleVirtualsvc.yaml

@@ -0,0 +1,46 @@
+apiVersion: networking.istio.io/v1alpha3
+kind: VirtualService
+metadata:
+  name: rollouts-demo-vsvc1
+spec:
+  gateways:
+  - rollouts-demo-gateway
+  hosts:
+  - rollouts-demo-vsvc1.local
+  http:
+  - name: primary
+    route:
+    - destination:
+        host: rollouts-demo-stable
+        port:
+          number: 15372
+      weight: 100
+    - destination:
+        host: rollouts-demo-canary
+        port:
+          number: 15372
+      weight: 0
+
+---
+apiVersion: networking.istio.io/v1alpha3
+kind: VirtualService
+metadata:
+  name: rollouts-demo-vsvc2
+spec:
+  gateways:
+  - rollouts-demo-gateway
+  hosts:
+  - rollouts-demo-vsvc2.local
+  http:
+  - name: secondary
+    route:
+    - destination:
+        host: rollouts-demo-stable
+        port:
+          number: 15373
+      weight: 100
+    - destination:
+        host: rollouts-demo-canary
+        port:
+          number: 15373
+      weight: 0

docs/getting-started/istio/rollout.yaml

@@ -10,10 +10,13 @@ spec:
       stableService: rollouts-demo-stable
       trafficRouting:
         istio:
-          virtualService:
-            name: rollouts-demo-vsvc
+          virtualServices:
+          - name: rollouts-demo-vsvc1 # At least one virtualService is required
             routes:
             - primary # At least one route is required
+          - name: rollouts-demo-vsvc2
+            routes:
+            - secondary # At least one route is required
       steps:
       - setWeight: 5
       - pause: {}

manifests/crds/rollout-crd.yaml

@@ -532,8 +532,19 @@ spec:
                                 required:
                                 - name
                                 type: object
-                            required:
-                            - virtualService
+                              virtualServices:
+                                items:
+                                  properties:
+                                    name:
+                                      type: string
+                                    routes:
+                                      items:
+                                        type: string
+                                      type: array
+                                  required:
+                                  - name
+                                  type: object
+                                type: array
                             type: object
                           nginx:
                             properties:

manifests/install.yaml

@@ -10230,8 +10230,19 @@ spec:
                                 required:
                                 - name
                                 type: object
-                            required:
-                            - virtualService
+                              virtualServices:
+                                items:
+                                  properties:
+                                    name:
+                                      type: string
+                                    routes:
+                                      items:
+                                        type: string
+                                      type: array
+                                  required:
+                                  - name
+                                  type: object
+                                type: array
                             type: object
                           nginx:
                             properties:

manifests/namespace-install.yaml

@@ -10230,8 +10230,19 @@ spec:
                                 required:
                                 - name
                                 type: object
-                            required:
-                            - virtualService
+                              virtualServices:
+                                items:
+                                  properties:
+                                    name:
+                                      type: string
+                                    routes:
+                                      items:
+                                        type: string
+                                      type: array
+                                  required:
+                                  - name
+                                  type: object
+                                type: array
                             type: object
                           nginx:
                             properties:

pkg/apiclient/rollout/rollout.swagger.json

@@ -817,6 +817,13 @@
         "destinationRule": {
           "$ref": "#/definitions/github.jparrowsec.cn.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.IstioDestinationRule",
           "title": "DestinationRule references an Istio DestinationRule to modify to shape traffic"
+        },
+        "virtualServices": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/github.jparrowsec.cn.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.IstioVirtualService"
+          },
+          "title": "VirtualServices references a list of Istio VirtualService to modify to shape traffic"
         }
       },
       "title": "IstioTrafficRouting configuration for Istio service mesh to enable fine grain configuration"

pkg/apis/api-rules/violation_exceptions.list

@@ -11,6 +11,7 @@ API rule violation: list_type_missing,github.com/argoproj/argo-rollouts/pkg/apis
 API rule violation: list_type_missing,github.com/argoproj/argo-rollouts/pkg/apis/rollouts/v1alpha1,ExperimentStatus,AnalysisRuns
 API rule violation: list_type_missing,github.com/argoproj/argo-rollouts/pkg/apis/rollouts/v1alpha1,ExperimentStatus,Conditions
 API rule violation: list_type_missing,github.com/argoproj/argo-rollouts/pkg/apis/rollouts/v1alpha1,ExperimentStatus,TemplateStatuses
+API rule violation: list_type_missing,github.com/argoproj/argo-rollouts/pkg/apis/rollouts/v1alpha1,IstioTrafficRouting,VirtualServices
 API rule violation: list_type_missing,github.com/argoproj/argo-rollouts/pkg/apis/rollouts/v1alpha1,IstioVirtualService,Routes
 API rule violation: list_type_missing,github.com/argoproj/argo-rollouts/pkg/apis/rollouts/v1alpha1,KayentaMetric,Scopes
 API rule violation: list_type_missing,github.com/argoproj/argo-rollouts/pkg/apis/rollouts/v1alpha1,MetricResult,Measurements

pkg/apis/rollouts/v1alpha1/types.go

@@ -354,9 +354,11 @@ type NginxTrafficRouting struct {
 // IstioTrafficRouting configuration for Istio service mesh to enable fine grain configuration
 type IstioTrafficRouting struct {
 	// VirtualService references an Istio VirtualService to modify to shape traffic
-	VirtualService IstioVirtualService `json:"virtualService" protobuf:"bytes,1,opt,name=virtualService"`
+	VirtualService IstioVirtualService `json:"virtualService,omitempty" protobuf:"bytes,1,opt,name=virtualService"`
 	// DestinationRule references an Istio DestinationRule to modify to shape traffic
 	DestinationRule *IstioDestinationRule `json:"destinationRule,omitempty" protobuf:"bytes,2,opt,name=destinationRule"`
+	// VirtualServices references a list of Istio VirtualService to modify to shape traffic
+	VirtualServices []IstioVirtualService `json:"virtualServices,omitempty" protobuf:"bytes,3,opt,name=virtualServices"`
 }
 
 // IstioVirtualService holds information on the virtual service the rollout needs to modify