Skip to content

Commit

Permalink
Merge pull request #1234 from keithmattix/0.5.0-release-docs
Browse files Browse the repository at this point in the history
Add experimental warning for resources that are experimental
  • Loading branch information
k8s-ci-robot authored Jun 28, 2022
2 parents c09b615 + d6ac8e8 commit cea484e
Show file tree
Hide file tree
Showing 5 changed files with 39 additions and 0 deletions.
7 changes: 7 additions & 0 deletions site-src/blog/2021/introducing-v1alpha2.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,13 @@ itself to the `prod-web-gw` Gateway.
This is covered in more detail in [GEP 724](https://gateway-api.sigs.k8s.io/geps/gep-709/).

### Safe Cross Namespace References

!!! info "Experimental Channel"

The `ReferenceGrant` resource described below is currently only included in the
"Experimental" channel of Gateway API. For more information on release
channels, refer to the [related documentation](https://gateway-api.sigs.k8s.io/concepts/versioning).

It is quite challenging to cross namespace boundaries in a safe manner. With
Gateway API, we had several key feature requests that required this capability.
Most notably, forwarding traffic to backends in other namespaces and referring
Expand Down
14 changes: 14 additions & 0 deletions site-src/concepts/api-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,12 +92,26 @@ for either routing or modification, for example using HTTP Headers for routing,
modifying them in-flight.

#### TLSRoute

!!! info "Experimental Channel"

The `TLSRoute` resource described below is currently only included in the
"Experimental" channel of Gateway API. For more information on release
channels, refer to the [related documentation](https://gateway-api.sigs.k8s.io/concepts/versioning).

TLSRoute is for multiplexing TLS connections, discriminated via SNI. It's intended
for where you want to use the SNI as the main routing method, and are not interested
in properties of the higher-level protocols like HTTP. The byte stream of the
connection is proxied without any inspection to the backend.

#### TCPRoute and UDPRoute

!!! info "Experimental Channel"

The `TCPRoute` and `UDPRoute` resources described below are currently only included in the
"Experimental" channel of Gateway API. For more information on release
channels, refer to the [related documentation](https://gateway-api.sigs.k8s.io/concepts/versioning).

TCPRoute (and UDPRoute) are intended for use for mapping one or more ports
to a single backend. In this case, there is no discriminator you can
use to choose different backends on the same port, so each TCPRoute really needs a
Expand Down
6 changes: 6 additions & 0 deletions site-src/v1alpha2/api-types/referencegrant.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# ReferenceGrant

!!! info "Experimental Channel"

The `ReferenceGrant` resource described below is currently only included in the
"Experimental" channel of Gateway API. For more information on release
channels, refer to the [related documentation](https://gateway-api.sigs.k8s.io/concepts/versioning).

!!! note
This resource was originally named "ReferencePolicy". It was renamed
to "ReferenceGrant" to avoid any confusion with policy attachment.
Expand Down
6 changes: 6 additions & 0 deletions site-src/v1alpha2/guides/tcp.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
!!! info "Experimental Channel"

The `TCPRoute` resource described below is currently only included in the
"Experimental" channel of Gateway API. For more information on release
channels, refer to the [related documentation](https://gateway-api.sigs.k8s.io/concepts/versioning).

Gateway API is designed to work with multiple protocols and [TCPRoute][tcproute]
is one such route which allows for managing [TCP][tcp] traffic.

Expand Down
6 changes: 6 additions & 0 deletions site-src/v1alpha2/guides/tls.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ Gateway API allow for a variety of ways to configure TLS. This document lays
out various TLS settings and gives general guidelines on how to use them
effectively.

!!! info "Experimental Channel"

The `TLSRoute` resource described below is currently only included in the
"Experimental" channel of Gateway API. For more information on release
channels, refer to the [related documentation](https://gateway-api.sigs.k8s.io/concepts/versioning).

## Client/Server and TLS

![overview](/v1alpha2/images/tls-overview.svg)
Expand Down

0 comments on commit cea484e

Please sign in to comment.