Skip to content

Commit

Permalink
Clarify BackendObjectReference Port field godoc
Browse files Browse the repository at this point in the history
* apis/v1alpha2/object_reference_types.go (BackendObjectReference):
* apis/v1beta1/object_reference_types.go (BackendObjectReference): Clarify
that the Port field references the service port number when the backend
is a Kubernetes Service.
* config/crd/experimental/gateway.networking.k8s.io_grpcroutes.yaml:
* config/crd/experimental/gateway.networking.k8s.io_httproutes.yaml:
* config/crd/experimental/gateway.networking.k8s.io_tcproutes.yaml:
* config/crd/experimental/gateway.networking.k8s.io_tlsroutes.yaml:
* config/crd/experimental/gateway.networking.k8s.io_udproutes.yaml:
* config/crd/standard/gateway.networking.k8s.io_httproutes.yaml:
Regenerate.
  • Loading branch information
Miciah authored and robscott committed Sep 19, 2022
1 parent 94bf615 commit f0100ce
Show file tree
Hide file tree
Showing 7 changed files with 64 additions and 39 deletions.
3 changes: 2 additions & 1 deletion apis/v1alpha2/object_reference_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,8 @@ type BackendObjectReference struct {
Namespace *Namespace `json:"namespace,omitempty"`

// Port specifies the destination port number to use for this resource.
// Port is required when the referent is a Kubernetes Service.
// Port is required when the referent is a Kubernetes Service. In this
// case, the port number is the service port number, not the target port.
// For other resources, destination port might be derived from the referent
// resource or this field.
//
Expand Down
3 changes: 2 additions & 1 deletion apis/v1beta1/object_reference_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,8 @@ type BackendObjectReference struct {
Namespace *Namespace `json:"namespace,omitempty"`

// Port specifies the destination port number to use for this resource.
// Port is required when the referent is a Kubernetes Service.
// Port is required when the referent is a Kubernetes Service. In this
// case, the port number is the service port number, not the target port.
// For other resources, destination port might be derived from the referent
// resource or this field.
//
Expand Down
38 changes: 24 additions & 14 deletions config/crd/experimental/gateway.networking.k8s.io_httproutes.yaml

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

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

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

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

38 changes: 24 additions & 14 deletions config/crd/standard/gateway.networking.k8s.io_httproutes.yaml

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

0 comments on commit f0100ce

Please sign in to comment.