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.

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

docs: update tcp guide for v1alpha2 #808

Conversation

shaneutt
Copy link
Member

What type of PR is this?

/kind documentation

What this PR does / why we need it:

This updates the TCP guide for v1alpha2.

Which issue(s) this PR fixes:

This resolves the 5th task of #783

Does this PR introduce a user-facing change?:

NONE

@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. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 23, 2021
@shaneutt shaneutt force-pushed the shaneutt/update-tcp-guide-v1alpha2 branch from 57a188c to d7f1073 Compare August 23, 2021 14:58
spec:
parentRefs:
- name: my-tcp-gateway
sectionName: foo
Copy link
Contributor

Choose a reason for hiding this comment

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

This section name feels off. Or maybe it is a new thing so it feels that way. Just a comment and no action required.

@@ -26,5 +22,5 @@ Please note the following:
be resolved as per the [conflict resolution](/v1alpha2/concepts/guidelines#conflicts) guidelines.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we please explain how a route is tied to a specific listener via the sectionName based matching? That may not be obvious and it deserves special attention here because most users won't do the sectionName based attachment for HTTP.

Copy link
Member Author

Choose a reason for hiding this comment

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

I've done a bit of a rewrite geared towards getting this explained:

e5635c8

lmkwyt

Copy link
Member

@robscott robscott left a comment

Choose a reason for hiding this comment

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

Thanks for the work on this @shaneutt! This mostly LGTM, just a few nits. The line wrapping feels a bit inconsistent in this file, so if you want to update it to be consistently 80 as part of this PR that would be welcome (though not necessary).

examples/v1alpha2/basic-tcp.yaml Outdated Show resolved Hide resolved
site-src/v1alpha2/guides/tcp.md Outdated Show resolved Hide resolved
@shaneutt shaneutt force-pushed the shaneutt/update-tcp-guide-v1alpha2 branch from 94fe465 to e5635c8 Compare August 23, 2021 17:16
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 23, 2021
@shaneutt shaneutt requested review from robscott and hbagdi August 23, 2021 17:19
@shaneutt shaneutt requested a review from hbagdi August 23, 2021 19:09
Copy link
Contributor

@hbagdi hbagdi left a comment

Choose a reason for hiding this comment

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

was about to approve but some more nits
lgtm otherwise

site-src/v1alpha2/guides/tcp.md Show resolved Hide resolved
site-src/v1alpha2/guides/tcp.md Show resolved Hide resolved
site-src/v1alpha2/guides/tcp.md Show resolved Hide resolved
site-src/v1alpha2/guides/tcp.md Show resolved Hide resolved
@shaneutt shaneutt force-pushed the shaneutt/update-tcp-guide-v1alpha2 branch from 013627a to c20ba93 Compare August 23, 2021 20:03
@shaneutt shaneutt requested a review from hbagdi August 23, 2021 20:03
@youngnick
Copy link
Contributor

/lgtm

nice work @shaneutt.

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

hbagdi commented Aug 24, 2021

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hbagdi, shaneutt

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 24, 2021
@k8s-ci-robot k8s-ci-robot merged commit 26ef98d into kubernetes-sigs:master Aug 24, 2021
@shaneutt shaneutt deleted the shaneutt/update-tcp-guide-v1alpha2 branch August 24, 2021 15:32
markmc added a commit to markmc/gateway-api that referenced this pull request Feb 28, 2022
In commit c7bb1d6 (kubernetes-sigs#808), we documented how the tcp route match
extension point can be used for metadata based tcp matching.

Soon after, in commit e3450f7 (kubernetes-sigs#829), this extension point was
removed, but the docs remained.

Remove this section to reflect the current state of the API.
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. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants