Skip to content

Commit 37f64ab

Browse files
committed
Clarify BackendObjectReference Port field godoc
* 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_httproutes.yaml: * config/crd/standard/gateway.networking.k8s.io_httproutes.yaml: Regenerate.
1 parent 854e2bf commit 37f64ab

File tree

3 files changed

+26
-15
lines changed

3 files changed

+26
-15
lines changed

apis/v1beta1/object_reference_types.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,8 @@ type BackendObjectReference struct {
123123
Namespace *Namespace `json:"namespace,omitempty"`
124124

125125
// Port specifies the destination port number to use for this resource.
126-
// Port is required when the referent is a Kubernetes Service.
126+
// Port is required when the referent is a Kubernetes Service. In this
127+
// case, the port number is the service port number, not the target port.
127128
// For other resources, destination port might be derived from the referent
128129
// resource or this field.
129130
//

config/crd/experimental/gateway.networking.k8s.io_httproutes.yaml

Lines changed: 12 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

config/crd/standard/gateway.networking.k8s.io_httproutes.yaml

Lines changed: 12 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)