Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify BackendObjectReference Port field godoc #1332

Merged
merged 1 commit into from
Aug 18, 2022
Merged

Clarify BackendObjectReference Port field godoc #1332

merged 1 commit into from
Aug 18, 2022

Conversation

Miciah
Copy link
Contributor

@Miciah Miciah commented Aug 16, 2022 •
edited

  • 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.

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Clarify that BackendObjectReference's Port field specifies a service port, not a target port, when the backend is a Kubernetes Service.

Which issue(s) this PR fixes:

Fixes #1331.

Does this PR introduce a user-facing change?:

Clarify that BackendObjectReference's Port field specifies a service port, not a target port, for Kubernetes Service backends.

@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Aug 16, 2022
@k8s-ci-robot
Copy link
Contributor

Hi @Miciah. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

shaneutt
shaneutt reviewed Aug 16, 2022
View reviewed changes
apis/v1beta1/object_reference_types.go Outdated
@@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// Port is required when the referent is a Kubernetes Service. In this
// Port is required when the referent is a Kubernetes Service. In this

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated (though it pains me to use single sentence spacing; 💔).

@robscott
Copy link
Member

Thanks @Miciah! This change LGTM, do you mind mirroring this to the v1alpha2 types file as well?

@robscott
Copy link
Member

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Aug 16, 2022
@Miciah
Clarify BackendObjectReference Port field godoc
82ebeaf 
* 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.
@Miciah Miciah force-pushed the GH1331-clarify-BackendObjectReference-Port-field-godoc branch from 37f64ab to 82ebeaf Compare August 17, 2022 22:51
@Miciah
Copy link
Contributor Author

Miciah commented Aug 17, 2022

Thanks @Miciah! This change LGTM, do you mind mirroring this to the v1alpha2 types file as well?

Done.

@robscott
Copy link
Member

Thanks @Miciah!

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 18, 2022
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Miciah, robscott

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 18, 2022
@k8s-ci-robot k8s-ci-robot merged commit 96414f1 into kubernetes-sigs:main Aug 18, 2022
@robscott robscott mentioned this pull request Sep 19, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shaneutt shaneutt shaneutt left review comments

@howardjohn howardjohn Awaiting requested review from howardjohn

@youngnick youngnick Awaiting requested review from youngnick

Assignees

@robscott robscott

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

BackendObjectReference's Port field is underspecified
4 participants
@Miciah @k8s-ci-robot @robscott @shaneutt