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

Add documentation for BackendLBPolicy #3201

Open
gcs278 opened this issue Jul 18, 2024 · 9 comments · May be fixed by #3461
Open

Add documentation for BackendLBPolicy #3201

gcs278 opened this issue Jul 18, 2024 · 9 comments · May be fixed by #3461
Assignees
@amitmaurya07
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Milestone
v1.3.0

Comments

@gcs278
Copy link
Contributor

gcs278 commented Jul 18, 2024 •
edited
Loading

What would you like to be added:

Similar to https://gateway-api.sigs.k8s.io/api-types/backendtlspolicy/, we should have a dedicated documentation page for BackendLBPolicy, which was released as experimental in v1.1.

The documentation should describe the goals of BackendLBPolicy, how to use the policy, and descriptions of the fields.

Why this is needed:

Though the current usage of BackendLBPolicy is documented well in GEP-1619, we should have a user-facing doc to be consistent with BackendTLSPolicy, as we don't expect end-users to dig through GEPs to better understand how a policy works.
@gcs278 gcs278 added the kind/documentation Categorizes issue or PR as related to documentation. label Jul 18, 2024
@gcs278
Copy link
Contributor Author

gcs278 commented Jul 18, 2024

@shaneutt @robscott Do you agree with the documentation need here? I noticed BackendTLSPolicy has a dedicated page, so it made sense to me to dedicate one to BackendLBPolicy. What do you think the priority of this issue is?

@shaneutt
Copy link
Member

shaneutt commented Jul 31, 2024 •
edited
Loading

@gcs278 I agree that since this is out as experimental we should document it similarity as you proposed.

/triage accepted

As for priority it can be hard to say. I'll mark it important-longterm for the moment, but I would recommend you put an agenda item to talk about this our next sync so we can get others to weigh in.

@kubernetes-sigs kubernetes-sigs deleted a comment from k8s-ci-robot Jul 31, 2024
@shaneutt shaneutt added the triage/accepted Indicates an issue or PR is ready to be actively worked on. label Jul 31, 2024
@shaneutt shaneutt added this to the v1.3.0 milestone Jul 31, 2024
@shaneutt shaneutt added the priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. label Jul 31, 2024
@youngnick
Copy link
Contributor

Big +1 from me, I agree this should have a user-facing doc that we can keep up to date and can be the source of truth for how this works.

@shaneutt shaneutt moved this to In Progress in Post-GA Refinement Sep 18, 2024
@shaneutt
Copy link
Member

/help

@k8s-ci-robot
Copy link
Contributor

@shaneutt:
This request has been marked as needing help from a contributor.

Guidelines

Please ensure that the issue body includes answers to the following questions:

  • Why are we solving this issue?
  • To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
  • Does this issue have zero to low barrier of entry?
  • How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

/help

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-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. label Sep 18, 2024
@amitmaurya07
Copy link

Hi, I would like to work on this issue. Could you please assign this issue to me?

@robscott
Copy link
Member

robscott commented Oct 7, 2024

Sure thing, thanks for volunteering @amitmaurya07!

/assign @amitmaurya07

@gcs278
Copy link
Contributor Author

gcs278 commented Oct 7, 2024

@amitmaurya07 Thanks! Feel free to reach out on here, or on the #sig-network-gateway-api slack channel if you have any questions.

@amitmaurya07
Copy link

Sure, Thanks @gcs278 @robscott

@amitmaurya07 amitmaurya07 linked a pull request Nov 20, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@amitmaurya07 amitmaurya07

Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
Post-GA Refinement
Status: Next
Milestone
v1.3.0
Development

Successfully merging a pull request may close this issue.

Add Documentation for BackendLBPolicy (v1.1 Experimental) amitmaurya07/gateway-api
6 participants
@robscott @gcs278 @shaneutt @youngnick @k8s-ci-robot @amitmaurya07