Skip to content

[feat: gw api]Adding docs for L4 routing for gateway api #4232

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.

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

Merged
merged 2 commits into from
Jun 16, 2025

Conversation

shraddhabang
Copy link
Collaborator

@shraddhabang shraddhabang commented Jun 13, 2025

Description

  1. Adding documentation for L4 Gateways implementation. How it works, example walkthrough and limitations
  2. I have refactored the existing customization doc to be it own entity.

Checklist

  • Added tests that cover your change (if possible)
  • Added/modified documentation as required (such as the README.md, or the docs directory)
  • Manually tested
  • Made sure the title of the PR is a good description that can go into the release notes

BONUS POINTS checklist: complete for good vibes and maybe prizes?! 🤯

  • Backfilled missing tests for code in same general area 🎉
  • Refactored something and made the world a better place 🌟

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jun 13, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: shraddhabang

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 approved Indicates a PR has been approved by an approver from all required OWNERS files. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jun 13, 2025
@shraddhabang
Copy link
Collaborator Author

/retest pull-aws-load-balancer-controller-unit-test

@k8s-ci-robot
Copy link
Contributor

@shraddhabang: The /retest command does not accept any targets.
The following commands are available to trigger required jobs:

/test pull-aws-load-balancer-controller-e2e-test
/test pull-aws-load-balancer-controller-lint
/test pull-aws-load-balancer-controller-unit-2
/test pull-aws-load-balancer-controller-unit-3
/test pull-aws-load-balancer-controller-unit-4
/test pull-aws-load-balancer-controller-unit-test

Use /test all to run the following jobs that were automatically triggered:

pull-aws-load-balancer-controller-e2e-test
pull-aws-load-balancer-controller-lint
pull-aws-load-balancer-controller-unit-test

In response to this:

/retest pull-aws-load-balancer-controller-unit-test

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.

@shraddhabang
Copy link
Collaborator Author

/test pull-aws-load-balancer-controller-unit-test

!!! warning
- Only very basic (and not conforming) support of the Gateway API spec currently exists. The team is actively trying to close conformance and support gaps.
- Using the LBC and Gateway API together is not suggested for production workloads (yet!)
!!! warning
Copy link
Collaborator

Choose a reason for hiding this comment

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

is there anyway to make those warning more obvious, like in a red box?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

image This will look this. Its a standard format of displaying the warnings.

* The Kubernetes Gateway API definition is then translated into an equivalent desired state within AWS (e.g., specific NLB, Listeners, Target Groups etc).
* This desired state is meticulously compared against the actual state of AWS resources.
* Necessary AWS API calls are executed to reconcile any identified discrepancies, ensuring the cloud infrastructure matches the Kubernetes declaration.
4. **Status Updates:** Following reconciliation, the LBC updates the `status` field of the Gateway API resources in Kubernetes. This provides real-time feedback on the provisioned AWS resources, such as the NLB's DNS name and ARN or if the gateways are accepted or not.
Copy link
Collaborator

Choose a reason for hiding this comment

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

we support status update for gateway, gatewayClass and routes.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yeah I have mentioned Gateway API resources in Kubernetes which entails these. The DNS name and ARN is just an example. Do not want to go in too much details for each of them right now. What do you think?

@shuqz
Copy link
Collaborator

shuqz commented Jun 13, 2025

have a general question, is there anyway we can preview new pages before they are out? to make sure the layout is good or it will work as expected

@shraddhabang
Copy link
Collaborator Author

have a general question, is there anyway we can preview new pages before they are out? to make sure the layout is good or it will work as expected

Yes. You pull my changes and run make docs-preview. This will serve the docs on localhost and you can check the formatting there.

@shraddhabang shraddhabang merged commit 3ab0add into kubernetes-sigs:main Jun 16, 2025
7 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants