Skip to content

Commit

Permalink
Clarify docs on invalid serviceName (#756)
Browse files Browse the repository at this point in the history
* Clarify docs on invalid serviceName

Fixes #638

* update for comments

* Wrap
  • Loading branch information
howardjohn authored Aug 12, 2021
1 parent f573729 commit 70377ed
Show file tree
Hide file tree
Showing 8 changed files with 66 additions and 20 deletions.
8 changes: 5 additions & 3 deletions apis/v1alpha2/httproute_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -237,9 +237,11 @@ type HTTPRouteRule struct {
Filters []HTTPRouteFilter `json:"filters,omitempty"`

// BackendRefs defines the backend(s) where matching requests should be
// sent. If unspecified, the rule performs no forwarding. If unspecified and
// no filters are specified that would result in a response being sent,
// a HTTP 503 status code is returned.
// sent. If unspecified or invalid (refers to a non-existent resource or a Service with no endpoints),
// the rule performs no forwarding; if no filters are specified that would result in a
// response being sent, a HTTP 503 status code is returned. 503 responses must be sent so that the overall
// weight is respected; if an invalid backend is requested to have 80% of requests, then 80% of requests
// must get a 503 instead.
//
// Support: Core for Kubernetes Service
// Support: Custom for any other resource
Expand Down
8 changes: 7 additions & 1 deletion apis/v1alpha2/tcproute_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,13 @@ type TCPRouteRule struct {
Matches []TCPRouteMatch `json:"matches,omitempty"`

// BackendRefs defines the backend(s) where matching requests should be
// sent.
// sent. If unspecified or invalid (refers to a non-existent resource or
// a Service with no endpoints), the rule performs no forwarding; if no
// filters are specified that would result in a response being sent, the
// underlying implementation must actively reject connection attempts to
// this backend. Connection rejections must respect weight; if an invalid
// backend is requested to have 80% of connection, then 80% of connection
// must be rejected instead.
//
// Support: Core for Kubernetes Service
// Support: Custom for any other resource
Expand Down
9 changes: 8 additions & 1 deletion apis/v1alpha2/tlsroute_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,14 @@ type TLSRouteRule struct {
Matches []TLSRouteMatch `json:"matches,omitempty"`

// BackendRefs defines the backend(s) where matching requests should be
// sent.
// sent. If unspecified or invalid (refers to a non-existent resource or
// a Service with no endpoints), the rule performs no forwarding; if no
// filters are specified that would result in a response being sent, the
// underlying implementation must actively reject request attempts to this
// backend, by rejecting the connection or returning a 503 status code.
// Request rejections must respect weight; if an invalid backend is
// requested to have 80% of requests, then 80% of requests must be rejected
// instead.
//
// Support: Core for Kubernetes Service
// Support: Custom for any other resource
Expand Down
8 changes: 7 additions & 1 deletion apis/v1alpha2/udproute_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,13 @@ type UDPRouteRule struct {
Matches []UDPRouteMatch `json:"matches,omitempty"`

// BackendRefs defines the backend(s) where matching requests should be
// sent.
// sent. If unspecified or invalid (refers to a non-existent resource or
// a Service with no endpoints), the rule performs no forwarding; if no
// filters are specified that would result in a response being sent, the
// underlying implementation must actively reject connection attempts to
// this backend. Connection rejections must respect weight; if an invalid
// backend is requested to have 80% of connection, then 80% of connection
// must be rejected instead.
//
// Support: Core for Kubernetes Service
// Support: Custom for any other resource
Expand Down
13 changes: 8 additions & 5 deletions config/crd/bases/gateway.networking.k8s.io_httproutes.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 10 additions & 3 deletions config/crd/bases/gateway.networking.k8s.io_tcproutes.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 11 additions & 3 deletions config/crd/bases/gateway.networking.k8s.io_tlsroutes.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 10 additions & 3 deletions config/crd/bases/gateway.networking.k8s.io_udproutes.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 70377ed

Please sign in to comment.