Add support for HTTP request header manipulation rules

README.md

@@ -107,10 +107,12 @@ spec:
  rewrite:
  uri: /
  # Envoy timeout and retry policy (optional)
- appendHeaders:
- x-envoy-upstream-rq-timeout-ms: "15000"
- x-envoy-max-retries: "10"
- x-envoy-retry-on: "gateway-error,connect-failure,refused-stream"
+ headers:
+ request:
+ add:
+ x-envoy-upstream-rq-timeout-ms: "15000"
+ x-envoy-max-retries: "10"
+ x-envoy-retry-on: "gateway-error,connect-failure,refused-stream"
  # promote the canary without analysing it (default false)
  skipAnalysis: false
  # define the canary analysis timing and KPIs

artifacts/canaries/canary.yaml

@@ -34,10 +34,12 @@ spec:
  rewrite:
  uri: /
  # Envoy timeout and retry policy (optional)
- appendHeaders:
- x-envoy-upstream-rq-timeout-ms: "15000"
- x-envoy-max-retries: "10"
- x-envoy-retry-on: "gateway-error,connect-failure,refused-stream"
+ headers:
+ request:
+ add:
+ x-envoy-upstream-rq-timeout-ms: "15000"
+ x-envoy-max-retries: "10"
+ x-envoy-retry-on: "gateway-error,connect-failure,refused-stream"
  # promote the canary without analysing it (default false)
  skipAnalysis: false
  canaryAnalysis:

docs/gitbook/how-it-works.md

@@ -39,18 +39,6 @@ spec:
  # Istio virtual service host names (optional)
  hosts:
  - podinfo.example.com
- # HTTP match conditions (optional)
- match:
- - uri:
- prefix: /
- # HTTP rewrite (optional)
- rewrite:
- uri: /
- # Envoy timeout and retry policy (optional)
- appendHeaders:
- x-envoy-upstream-rq-timeout-ms: "15000"
- x-envoy-max-retries: "10"
- x-envoy-retry-on: "gateway-error,connect-failure,refused-stream"
  # promote the canary without analysing it (default false)
  skipAnalysis: false
  # define the canary analysis timing and KPIs
@@ -138,10 +126,12 @@ metadata:
  rewrite:
  uri: /
  # Envoy timeout and retry policy (optional)
- appendHeaders:
- x-envoy-upstream-rq-timeout-ms: "15000"
- x-envoy-max-retries: "10"
- x-envoy-retry-on: "gateway-error,connect-failure,refused-stream"
+ headers:
+ request:
+ add:
+ x-envoy-upstream-rq-timeout-ms: "15000"
+ x-envoy-max-retries: "10"
+ x-envoy-retry-on: "gateway-error,connect-failure,refused-stream"
  # retry policy when a HTTP request fails (optional)
  retries:
  attempts: 3
@@ -171,26 +161,26 @@ spec:
  - frontend.example.com
  - frontend
  http:
-  - match:
-  - uri:
-  prefix: /
- rewrite:
-  uri: /
-  appendHeaders:
- x-envoy-upstream-rq-timeout-ms: "15000"
-  x-envoy-max-retries: "10"
-  x-envoy-retry-on: "gateway-error,connect-failure,refused-stream"
-  route:
-  - destination:
-  host: frontend-primary
-  port:
-  number: 9898
-  weight: 100
-  - destination:
-  host: frontend-canary
-  port:
-  number: 9898
-  weight: 0
+ - appendHeaders:
+ x-envoy-max-retries: "10"
+ x-envoy-retry-on: gateway-error,connect-failure,refused-stream
+ x-envoy-upstream-rq-timeout-ms: "15000"
+ match:
+ - uri:
+ prefix: /
+ rewrite:
+ uri: /
+ route:
+ - destination:
+ host: podinfo-primary
+ port:
+ number: 9898
+ weight: 100
+ - destination:
+ host: podinfo-canary
+ port:
+ number: 9898
+ weight: 0
 ```
 
 Flagger keeps in sync the virtual service with the canary service spec. Any direct modification of the virtual 

pkg/apis/flagger/v1alpha3/types.go

@@ -109,14 +109,14 @@ type CanaryStatus struct {
 // CanaryService is used to create ClusterIP services
 // and Istio Virtual Service
 type CanaryService struct {
- Port  int32 `json:"port"`
- Gateways  []string `json:"gateways"`
- Hosts  []string `json:"hosts"`
- Match  []istiov1alpha3.HTTPMatchRequest `json:"match,omitempty"`
- Rewrite  *istiov1alpha3.HTTPRewrite `json:"rewrite,omitempty"`
- Timeout  string `json:"timeout,omitempty"`
- Retries  *istiov1alpha3.HTTPRetry `json:"retries,omitempty"`
- AppendHeaders map[string]string   `json:"appendHeaders,omitempty"`
+ Port int32 `json:"port"`
+ Gateways []string `json:"gateways"`
+ Hosts []string `json:"hosts"`
+ Match []istiov1alpha3.HTTPMatchRequest `json:"match,omitempty"`
+ Rewrite *istiov1alpha3.HTTPRewrite `json:"rewrite,omitempty"`
+ Timeout string `json:"timeout,omitempty"`
+ Retries *istiov1alpha3.HTTPRetry `json:"retries,omitempty"`
+ Headers *istiov1alpha3.Headers `json:"headers,omitempty"`
 }
 
 // CanaryAnalysis is used to describe how the analysis should be done

pkg/apis/istio/v1alpha3/virtual_service.go

@@ -325,6 +325,9 @@ type HTTPRoute struct {
  // destination.
  Mirror *Destination `json:"mirror,omitempty"`
 
+ // Cross-Origin Resource Sharing policy (CORS). Refer to
+ // https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS
+ // for further details about cross origin resource sharing.
  CorsPolicy *CorsPolicy `json:"CorsPolicy,omitempty"`
 
  // Additional HTTP headers to add before forwarding a request to the
@@ -333,6 +336,33 @@ type HTTPRoute struct {
 
  // Http headers to remove before returning the response to the caller
  RemoveResponseHeaders map[string]string `json:"removeResponseHeaders,omitempty"`
+
+ // Header manipulation rules
+ Headers *Headers `json:"headers,omitempty"`
+}
+
+// Header manipulation rules
+type Headers struct {
+ // Header manipulation rules to apply before forwarding a request
+ // to the destination service
+ Request *HeaderOperations `json:"request,omitempty"`
+
+ // Header manipulation rules to apply before returning a response
+ // to the caller
+ Response *HeaderOperations `json:"response,omitempty"`
+}
+
+// HeaderOperations Describes the header manipulations to apply
+type HeaderOperations struct {
+ // Overwrite the headers specified by key with the given values
+ Set map[string]string `json:"set"`
+
+ // Append the given values to the headers specified by keys
+ // (will create a comma-separated list of values)
+ Add map[string]string `json:"add"`
+
+ // Remove the specified headers
+ Remove []string `json:"remove"`
 }
 
 // HttpMatchRequest specifies a set of criterion to be met in order for the