User guide gRPC #2108

juliens · 2017-09-12T07:53:03Z

A example on how to use gRPC with self-signed certficate

nmengin

@juliens
Many thanks for the user guide.

A few comments.

nmengin · 2017-09-12T08:58:01Z

mkdocs.yml

@@ -93,4 +93,6 @@ pages:
    - 'Marathon': 'user-guide/marathon.md'
    - 'Key-value Store Configuration': 'user-guide/kv-config.md'
    - 'Clustering/HA': 'user-guide/cluster.md'
+    - 'Let''s Encrypt & Docker': 'user-guide/docker-and-lets-encrypt.md'
+    - 'gRPC Example': 'user-guide/grpc.md'


Let's encrypt entry is already described above.

nmengin · 2017-09-12T09:01:07Z

docs/user-guide/grpc.md

@@ -0,0 +1,136 @@
+# gRPC example
+
+This section explains how to use Traefik has reverse proxy for gRPC application with self-signed certificates.


s/Traefik/Træfik/ s/has/as/

nmengin · 2017-09-12T09:20:48Z

docs/user-guide/grpc.md

+
+!!! warning
+    Has gRPC needs HTTP2, we need to have valid HTTPS on both gRPC Server and Traefik.
+


s/has/as ?

we need to have valid HTTPS on

=> we need valid HTTPS certificates on ?

nmengin · 2017-09-12T09:36:08Z

docs/user-guide/grpc.md

+That will prompt for information, the important answer is
+```
+Common Name (e.g. server FQDN or YOUR name) []: backend.local
+```


Maybe show the command line with all information to key (with fake values) and add a note to explain the importance of the CN value?

# Set our CSR variables SUBJ=" C=FR ST=MP O= localityName=Toulouse commonName=$DOMAIN organizationalUnitName=Traefik emailAddress= " openssl req -x509 -nodes -days 365 -newkey rsa:2048 -subj "$(echo -n "$SUBJ" | tr "\n" "/")" -keyout ./backend.key -out ./backend.crt

(command to check)

nmengin · 2017-09-12T09:36:39Z

docs/user-guide/grpc.md

+with
+```
+Common Name (e.g. server FQDN or YOUR name) []: frontend.local
+```


See above for the subject argument

nmengin · 2017-09-12T09:39:40Z

docs/user-guide/grpc.md

+## Traefik configuration
+
+At last, we configure our Traefik to use the both self-signed certificate.
+


s/Traefik/Træfik/

our Traefik to

=> our Træfik instance to ?

nmengin · 2017-09-12T09:47:19Z

docs/user-guide/grpc.md

+## Conclusion
+
+We don't need specific configuration to use gRPC in Traefik, we just need to be careful that all the exchange (between client and Traefik, and between Traefik and backend) are valid HTTPS communication (no InsecureSkipVerify) because gRPC use HTTP2.
+


s/Traefik/Træfik/
s/exchange/exchanges/ ?
s/communication/communications/ ?

no InsecureSkipVerify

=> without the skipInsecureVerify option enabled

nmengin · 2017-09-12T09:49:17Z

docs/user-guide/grpc.md

+
+!!! warning
+    In order to use this gRPC example, we need to modify it in order to use HTTPS
+


we need to modify it in order to use HTTPS

we need to modify it to use HTTPS

(in order to twice in the sentence)

nmengin

LGTM 📖

Even if you don't want my wonderful command line 😉

ldez

LGTM

timoreimann

One comment, one question.

timoreimann · 2017-09-15T15:57:16Z

docs/user-guide/grpc.md

+
+## Træfik configuration
+
+At last, we configure our Træfik instance to use the both self-signed certificate.


Little grammar improvement:

use the both self-signed certificate -> use both self-signed certificates

timoreimann · 2017-09-15T15:59:20Z

docs/user-guide/grpc.md

+    As gRPC needs HTTP2, we need valid HTTPS certificates on both gRPC Server and Træfik.
+
+<p align="center">
+<img src="/img/grpc.svg" alt="gRPC architecture" title="gRPC architecture" />


Doesn't it need to be /docs/img/grpc.svg? 🤔

it's relative to web root e.g. docs/, see https://raw.githubusercontent.com/containous/traefik/master/docs/index.md

https://deploy-preview-2108--traefik-docs.netlify.com/user-guide/grpc/

juliens added area/documentation kind/enhancement a new or improved feature. status/2-needs-review labels Sep 12, 2017

juliens requested review from a team as code owners September 12, 2017 07:53

traefiker added area/acme area/logs area/provider/boltdb area/provider/consul area/provider/docker area/provider/ecs area/provider/etcd area/provider/eureka area/provider/k8s/ingress area/provider/marathon area/provider/mesos area/provider/rancher size/L labels Sep 12, 2017

juliens changed the base branch from master to v1.4 September 12, 2017 08:00

juliens removed area/acme area/logs area/provider/boltdb area/provider/consul area/provider/docker area/provider/ecs area/provider/etcd area/provider/eureka area/provider/k8s/ingress labels Sep 12, 2017

juliens force-pushed the doc/user-guide-grpc branch 2 times, most recently from 5460042 to a95fa3b Compare September 12, 2017 09:35

nmengin requested changes Sep 12, 2017

View reviewed changes

traefiker added the contributor/waiting-for-corrections label Sep 12, 2017

juliens force-pushed the doc/user-guide-grpc branch from a95fa3b to 997a05d Compare September 12, 2017 13:17

nmengin approved these changes Sep 12, 2017

View reviewed changes

traefiker removed the contributor/waiting-for-corrections label Sep 12, 2017

ldez approved these changes Sep 12, 2017

View reviewed changes

timoreimann suggested changes Sep 15, 2017

View reviewed changes

traefiker added the contributor/waiting-for-corrections label Sep 15, 2017

ldez removed the contributor/waiting-for-corrections label Sep 15, 2017

timoreimann approved these changes Sep 15, 2017

View reviewed changes

timoreimann added status/3-needs-merge and removed status/2-needs-review labels Sep 15, 2017

traefiker added the status/4-merge-in-progress label Sep 15, 2017

traefiker force-pushed the doc/user-guide-grpc branch from 8413f27 to 3a02f13 Compare September 15, 2017 17:24

traefiker added bot/need-human-merge and removed status/4-merge-in-progress labels Sep 15, 2017

ldez removed the bot/need-human-merge label Sep 15, 2017

traefiker added the bot/need-human-merge label Sep 15, 2017

ldez removed the bot/need-human-merge label Sep 15, 2017

traefiker added the bot/need-human-merge label Sep 15, 2017

juliens and others added 3 commits September 16, 2017 01:33

Add GRPC user-guide

3087072

doc: render.

c40b23d

doc: grammar.

d256ab0

ldez force-pushed the doc/user-guide-grpc branch from 3a02f13 to d256ab0 Compare September 15, 2017 23:33

ldez removed the bot/need-human-merge label Sep 16, 2017

traefiker merged commit 3942f33 into traefik:v1.4 Sep 16, 2017

traefiker removed the status/3-needs-merge label Sep 16, 2017

juliens deleted the doc/user-guide-grpc branch January 25, 2018 20:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

User guide gRPC #2108

User guide gRPC #2108

juliens commented Sep 12, 2017

nmengin left a comment

nmengin Sep 12, 2017

nmengin Sep 12, 2017

nmengin Sep 12, 2017

nmengin Sep 12, 2017

nmengin Sep 12, 2017 •

edited

Loading

nmengin Sep 12, 2017

nmengin Sep 12, 2017

nmengin Sep 12, 2017

nmengin left a comment

ldez left a comment

timoreimann left a comment

timoreimann Sep 15, 2017

timoreimann Sep 15, 2017

ldez Sep 15, 2017

ldez Sep 15, 2017

timoreimann Sep 15, 2017

		@@ -0,0 +1,136 @@
		# gRPC example

		This section explains how to use Traefik has reverse proxy for gRPC application with self-signed certificates.


		!!! warning
		Has gRPC needs HTTP2, we need to have valid HTTPS on both gRPC Server and Traefik.

		## Traefik configuration

		At last, we configure our Traefik to use the both self-signed certificate.

		## Conclusion

		We don't need specific configuration to use gRPC in Traefik, we just need to be careful that all the exchange (between client and Traefik, and between Traefik and backend) are valid HTTPS communication (no InsecureSkipVerify) because gRPC use HTTP2.


		!!! warning
		In order to use this gRPC example, we need to modify it in order to use HTTPS


		## Træfik configuration

		At last, we configure our Træfik instance to use the both self-signed certificate.

User guide gRPC #2108

User guide gRPC #2108

Conversation

juliens commented Sep 12, 2017

nmengin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nmengin Sep 12, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nmengin left a comment

Choose a reason for hiding this comment

ldez left a comment

Choose a reason for hiding this comment

timoreimann left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nmengin Sep 12, 2017 •

edited

Loading