docs: add ssl passthrough note in FAQ #844

shaneutt · 2021-08-31T19:41:10Z

What type of PR is this?
/kind documentation

What this PR does / why we need it:
The HTTPRoute API (specifically) doesn't support SSL Passthrough. An implementer recently reported this wasn't clear. There is documentation on this, but in order to help make this more clear/prominent this patch adds a note about it in the FAQ with links to the relevant docs and guides.

Which issue(s) this PR fixes:
Fixes #840

Does this PR introduce a user-facing change?:

NONE

site-src/faq.md

bowei · 2021-08-31T22:04:45Z

LGTM (giving other people a chance to look)

jpeach · 2021-09-01T00:31:39Z

Should we make a corresponding spec change?

youngnick · 2021-09-01T05:54:44Z

Should we make a corresponding spec change?

I think something in the godoc would be a good idea, agreed. Maybe a note in the Listener docstring, or in the HTTPRoute one?

Wording of the change LGTM though.

shaneutt · 2021-09-01T14:55:10Z

0ededfc was added to add a similar note to the HTTPRoute spec 👍

robscott · 2021-09-01T22:29:46Z

apis/v1alpha2/httproute_types.go

+	// Note that SSL passthrough is not supported for these backend refs, and
+	// if you're looking to implement that kind of functionality use TLSRoute.
+	//


I think instead of adding this here, it might be better to add this to the Passthrough godocs here: https://github.com/kubernetes-sigs/gateway-api/blob/master/apis/v1alpha2/gateway_types.go#L337-L340

Moved as suggested in 34d584e 👍, lmkwyt

hbagdi · 2021-09-01T22:48:12Z

site-src/faq.md

+  terminating it) is not currently a supported routing option when using the
+  [HTTPRoute][routes] API. If you need this functionality it is supported by
+  the [TLSRoute][tlsroute] API. Also see the [TLS Guide][tlsguide] for more
+  details about passthrough and other TLS configurations.


I'd recommend framing it rather as "Yes, it is supported using TLSRoute. It is not supported in HTTPRoute because it is not possible to route based on HTTP metadata without terminating TLS."
This educates our users. The current wording makes me feel "something is possible but is not supported in the API".

Sounds good, 3dc2ed4 changes the language lmkwyt

robscott

Thanks for the work on this!

site-src/faq.md

apis/v1alpha2/gateway_types.go

Co-authored-by: Rob Scott <rob.scott87@gmail.com>

site-src/faq.md

robscott · 2021-09-02T18:30:04Z

Thanks!

/lgtm
/approve

robscott · 2021-09-02T18:40:32Z

Weird, I didn't know that would remove lgtm and approved labels... Trying again.

/lgtm
/approve

k8s-ci-robot · 2021-09-02T18:40:45Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: robscott, shaneutt

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:

~~OWNERS~~ [robscott]

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

k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Aug 31, 2021

k8s-ci-robot requested review from bowei and hbagdi August 31, 2021 19:41

bowei reviewed Aug 31, 2021

View reviewed changes

site-src/faq.md Outdated Show resolved Hide resolved

shaneutt force-pushed the shaneutt/docs/ssl-passthrough branch from 5838b30 to 174161e Compare August 31, 2021 20:16

k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Aug 31, 2021

shaneutt marked this pull request as draft August 31, 2021 20:18

k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 31, 2021

shaneutt force-pushed the shaneutt/docs/ssl-passthrough branch from 174161e to 283c7d7 Compare August 31, 2021 20:23

k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Aug 31, 2021

shaneutt force-pushed the shaneutt/docs/ssl-passthrough branch from 283c7d7 to 22d06c3 Compare August 31, 2021 20:26

k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Aug 31, 2021

shaneutt marked this pull request as ready for review August 31, 2021 20:26

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 31, 2021

shaneutt requested a review from bowei August 31, 2021 20:26

shaneutt force-pushed the shaneutt/docs/ssl-passthrough branch from 22d06c3 to 0ededfc Compare September 1, 2021 14:54

robscott reviewed Sep 1, 2021

View reviewed changes

hbagdi reviewed Sep 1, 2021

View reviewed changes

shaneutt added 2 commits September 2, 2021 09:33

docs: note about SSL passthrough in gateway godoc

34d584e

docs: add FAQ entry about SSL passthrough

3dc2ed4

shaneutt force-pushed the shaneutt/docs/ssl-passthrough branch from 38f3d39 to f3ac23d Compare September 2, 2021 13:34

shaneutt force-pushed the shaneutt/docs/ssl-passthrough branch from f3ac23d to 3dc2ed4 Compare September 2, 2021 13:36

shaneutt requested review from robscott and hbagdi September 2, 2021 13:36

robscott reviewed Sep 2, 2021

View reviewed changes

site-src/faq.md Outdated Show resolved Hide resolved

site-src/faq.md Outdated Show resolved Hide resolved

apis/v1alpha2/gateway_types.go Outdated Show resolved Hide resolved

Apply suggestions from code review

c1cd76a

Co-authored-by: Rob Scott <rob.scott87@gmail.com>

shaneutt requested a review from robscott September 2, 2021 17:32

robscott reviewed Sep 2, 2021

View reviewed changes

site-src/faq.md Outdated Show resolved Hide resolved

Update site-src/faq.md

d68c175

shaneutt requested a review from robscott September 2, 2021 18:29

k8s-ci-robot assigned robscott Sep 2, 2021

k8s-ci-robot added lgtm "Looks good to me", indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Sep 2, 2021

robscott added tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. and removed approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm "Looks good to me", indicates that a PR is ready to be merged. labels Sep 2, 2021

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 2, 2021

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 2, 2021

k8s-ci-robot merged commit 817f1b6 into kubernetes-sigs:master Sep 2, 2021

shaneutt deleted the shaneutt/docs/ssl-passthrough branch September 2, 2021 18:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add ssl passthrough note in FAQ #844

docs: add ssl passthrough note in FAQ #844

shaneutt commented Aug 31, 2021 •

edited

Loading

bowei commented Aug 31, 2021

jpeach commented Sep 1, 2021

youngnick commented Sep 1, 2021

shaneutt commented Sep 1, 2021

robscott Sep 1, 2021

shaneutt Sep 2, 2021 •

edited

Loading

hbagdi Sep 1, 2021

shaneutt Sep 2, 2021

robscott left a comment

robscott commented Sep 2, 2021

robscott commented Sep 2, 2021

k8s-ci-robot commented Sep 2, 2021

docs: add ssl passthrough note in FAQ #844

docs: add ssl passthrough note in FAQ #844

Conversation

shaneutt commented Aug 31, 2021 • edited Loading

bowei commented Aug 31, 2021

jpeach commented Sep 1, 2021

youngnick commented Sep 1, 2021

shaneutt commented Sep 1, 2021

robscott Sep 1, 2021

Choose a reason for hiding this comment

shaneutt Sep 2, 2021 • edited Loading

Choose a reason for hiding this comment

hbagdi Sep 1, 2021

Choose a reason for hiding this comment

shaneutt Sep 2, 2021

Choose a reason for hiding this comment

robscott left a comment

Choose a reason for hiding this comment

robscott commented Sep 2, 2021

robscott commented Sep 2, 2021

k8s-ci-robot commented Sep 2, 2021

shaneutt commented Aug 31, 2021 •

edited

Loading

shaneutt Sep 2, 2021 •

edited

Loading