Skip to content

TLS support docs inconsistencies #1474

Open
@mlavacca

Description

@mlavacca

What happened:

In the api-overview docs section (https://gateway-api.sigs.k8s.io/concepts/api-overview/#route-summary-table), a compatibility matrix about the TLS support lists the TLS types supported by each Route; apparently, all the routes but the UDPRoute support TLS (either in terminated or in passthrough mode, or in both modes).

In the TLS guide docs section (https://gateway-api.sigs.k8s.io/guides/tls/#clientserver-and-tls), another TLS support matrix contains data that are inconsistent with the above table. Specifically:

  • TLSRoute seems to support only Passthrough, instead of both modes
  • TCPRoute seems to support only Terminate, instead of both modes
  • GRPCRoute is not listed

What you expected to happen:

The two tables should be consistent. Furthermore, adding this kind of information in the godoc section of the listener would be useful, as it is quite important for those who are implementing the API.

How to reproduce it (as minimally and precisely as possible):

Anything else we need to know?:

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationkind/bugCategorizes issue or PR as related to a bug.needs-triageIndicates an issue or PR lacks a `triage/foo` label and requires one.

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions