pilot: add support for grpc-web prefixed ports #10064

venilnoronha · 2018-11-20T01:59:30Z

Description

This adds support for grpc-web prefixed port names. Whenever Istio notices a Service port prefixed with grpc-web, an additional envoy.grpc_web filter will be added to the http filters list in the HTTP connection manager for inbound sidecars.

Fixes #1368

Usage

To enable the envoy.grpc_web filter, users will now just need to use a service config similar to below. The grpc-web prefix in name: grpc-web-port will let Pilot know that the envoy.grpc_web filter should be enabled.

apiVersion: v1
kind: Service
metadata:
  name: some-service
  labels:
    app: some-service
spec:
  ports:
  - name: grpc-web-port
    port: 9000
  selector:
    app: some-service

One additional thing to do after deploying the service is to enable CORS on the VirtualService i.e. if the gRPC-Web based service is accessed externally. The following configuration should do the job.

apiVersion: networking.istio.io/v1alpha3
kind: VirtualService
metadata:
  name: virtual-service
spec:
  hosts:
  - "*"
  gateways:
  - gateway
  http:
  - match:
    - port: 80
    route:
    - destination:
        host: some-service
        port:
          number: 9000
    corsPolicy:
      allowOrigin:
        - "*"
      allowMethods:
        - POST
        - GET
        - OPTIONS
        - PUT
        - DELETE
      allowHeaders:
        - grpc-timeout
        - content-type
        - keep-alive
        - user-agent
        - cache-control
        - content-type
        - content-transfer-encoding
        - custom-header-1
        - x-accept-content-transfer-encoding
        - x-accept-response-streaming
        - x-user-agent
        - x-grpc-web
      maxAge: 1728s
      exposeHeaders:
        - custom-header-1
        - grpc-status
        - grpc-message
      allowCredentials: true

See https://github.com/grpc/grpc-web/tree/master/net/grpc/gateway/examples/helloworld#configure-the-proxy for more information.

pilot/pkg/networking/core/v1alpha3/listener.go

pilot/pkg/serviceregistry/kube/conversion.go

rshriram

..

codecov · 2018-11-20T22:41:53Z

Codecov Report

Merging #10064 into release-1.1 will increase coverage by 1%.
The diff coverage is 64%.

@@              Coverage Diff              @@
##           release-1.1   #10064    +/-   ##
=============================================
+ Coverage           70%      71%    +1%     
=============================================
  Files              442      442            
  Lines            41187    41147    -40     
=============================================
+ Hits             28640    28820   +180     
+ Misses           11141    10921   -220     
  Partials          1406     1406

Impacted Files	Coverage Δ
pilot/pkg/networking/plugin/plugin.go	`75% <100%> (ø)`	⬆️
pilot/pkg/serviceregistry/kube/conversion.go	`92% <100%> (+4%)`	⬆️
pilot/pkg/model/service.go	`86% <100%> (ø)`	⬇️
pilot/pkg/networking/core/v1alpha3/listener.go	`78% <42%> (ø)`	⬇️
mixer/adapter/signalfx/cumulative.go	`67% <0%> (-4%)`	⬇️
mixer/adapter/signalfx/tracing.go	`80% <0%> (-3%)`	⬇️
galley/pkg/kube/converter/proto.go	`86% <0%> (-2%)`	⬇️
mixer/adapter/fluentd/fluentd.go	`74% <0%> (-1%)`	⬇️
galley/pkg/crd/validation/config.go	`66% <0%> (-1%)`	⬇️
...ter/kubernetesenv/template/template_handler.gen.go	`96% <0%> (-1%)`	⬇️
... and 31 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 60e6e9b...eb7c6f1. Read the comment docs.

googlebot · 2018-11-21T02:20:42Z

So there's good news and bad news.

👍 The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there.

😕 The bad news is that it appears that one or more commits were authored or co-authored by someone other than the pull request submitter. We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that here in the pull request.

Note to project maintainer: This is a terminal state, meaning the cla/google commit status will not change from this state. It's up to you to confirm consent of all the commit author(s), set the cla label to yes (if enabled on your project), and then merge this pull request when appropriate.

rshriram

/lgtm

istio-testing · 2018-11-21T02:22:25Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: rshriram, venilnoronha

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~pilot/OWNERS~~ [rshriram]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

googlebot · 2018-11-21T02:22:27Z

CLAs look good, thanks!

venilnoronha · 2018-11-21T03:12:37Z