Skip to content

tlsroute: make TLSRoute structure consistent with HTTPRoute #682

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
Merged
merged 1 commit into from
Jun 22, 2021
Merged

tlsroute: make TLSRoute structure consistent with HTTPRoute #682

merged 1 commit into from
Jun 22, 2021

Conversation

hbagdi
Copy link
Contributor

@hbagdi hbagdi commented May 25, 2021 •
edited
Loading

What type of PR is this?

/kind cleanup
/kind api-change

What this PR does / why we need it:

This PR makes the structure of TLSRoute similar to HTTPRoute:

  • SNIs field has been renamed to Hostnames
  • The same field has been pulled up to the Spec struct instead of a match

Which issue(s) this PR fixes:

Fixes #566

Does this PR introduce a user-facing change?:

- Breaking change: the structure of TLSRoute is now consistent with HTTPRoute.

Putting a hold here as there is still work to do. I'd like to get consensus on moving this forward before putting more time in here.
/hold

/cc @howardjohn @bowei @jpeach @robscott

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label May 25, 2021
@k8s-ci-robot k8s-ci-robot requested a review from jpeach May 25, 2021 18:26
@k8s-ci-robot k8s-ci-robot added kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/api-change Categorizes issue or PR as related to adding, removing, or otherwise changing an API labels May 25, 2021
@k8s-ci-robot k8s-ci-robot requested a review from robscott May 25, 2021 18:26
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label May 25, 2021
@k8s-ci-robot
Copy link
Contributor

@hbagdi: GitHub didn't allow me to request PR reviews from the following users: howardjohn.

Note that only kubernetes-sigs members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

What type of PR is this?

/kind cleanup
/kind api-change

What this PR does / why we need it:

This PR makes the structure of TLSRoute similar to HTTPRoute:

  • SNIs field has been renamed to Hostnames
  • The same field has been pulled up to the Spec struct instead of a match

Which issue(s) this PR fixes:

Fixes #566

Does this PR introduce a user-facing change?:

TODO

TODO for the PR:

  • Update release notes
  • Re-organize godoc comments to make sense

Putting a hold here as there is still work to do. I'd like to get consensus on moving this forward before putting more time in here.
/hold

/cc @howardjohn @bowei @jpeach @robscott

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.

@k8s-ci-robot k8s-ci-robot requested a review from bowei May 25, 2021 18:26
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels May 25, 2021
jpeach
jpeach reviewed May 27, 2021
View reviewed changes
apis/v1alpha2/tlsroute_types.go Outdated
//
// +optional
// +kubebuilder:validation:MaxItems=16
Hostnames []Hostname `json:"snis,omitempty"`
Copy link
Contributor

Choose a reason for hiding this comment

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

Would you mind reverting the Go field name to match the JSON/YAML field name? Divergence on the names for fields has led me astray many times in the past :)

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 the other way around since the discussion has to be around renaming this field to hostnames as well.

@hbagdi hbagdi force-pushed the feat/tlsroute-consistency branch from 4c86a99 to 6beb478 Compare May 27, 2021 16:15
@jpeach
Copy link
Contributor

jpeach commented Jun 2, 2021

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 2, 2021
howardjohn
howardjohn approved these changes Jun 2, 2021
View reviewed changes
apis/v1alpha2/tlsroute_types.go
// a domain name prefixed with a single wildcard label (e.g. `*.example.com`).
// The wildcard character `*` must appear by itself as the first DNS label
// and matches only a single label. You cannot have a wildcard label by
// itself (e.g. Host == `*`).
Copy link
Contributor

Choose a reason for hiding this comment

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

Why not? I think right now in the spec the answer would be "Because you should just use TCPRoute instead in that case", but in the future could we not allow routing on other attributes of the TLS handshake?

I don't feel strongly about this at all - our implementation only supports routing by SNI today - just curious.

Copy link
Contributor

Choose a reason for hiding this comment

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

I see this is also copy+pasted so definitely not blocking this PR at all

@jpeach
Copy link
Contributor

jpeach commented Jun 6, 2021

/approve

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 7, 2021
@robscott
Copy link
Member

robscott commented Jun 8, 2021

@hbagdi Looks like this needs a rebase. I'm not quite sure how I feel about the sni -> hostname rename here, @danehans or @bowei do you have any strong opinions on this?

@robscott
Copy link
Member

@hbagdi I've thought about this more and agree that this change makes sense. We discussed this briefly at community meeting today and it didn't sound like there was any opposition to this change, so I'm happy to LGTM once it's rebased.

@hbagdi hbagdi force-pushed the feat/tlsroute-consistency branch from 6beb478 to 237d154 Compare June 22, 2021 17:49
@k8s-ci-robot k8s-ci-robot removed lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Jun 22, 2021
@hbagdi
Copy link
Contributor Author

hbagdi commented Jun 22, 2021

/hold cancel

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 22, 2021
@hbagdi
Copy link
Contributor Author

hbagdi commented Jun 22, 2021

@jpeach @robscott I've rebased and updated the release notes. PTAL.

@hbagdi hbagdi force-pushed the feat/tlsroute-consistency branch from 237d154 to 21caf2b Compare June 22, 2021 17:56
@robscott
Copy link
Member

Thanks!

/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 Jun 22, 2021
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hbagdi, howardjohn, jpeach, 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:
  • OWNERS [hbagdi,jpeach,robscott]

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 merged commit 369cb4a into kubernetes-sigs:master Jun 22, 2021
@rostislavbobo rostislavbobo mentioned this pull request Sep 4, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@robscott robscott Awaiting requested review from robscott

@bowei bowei Awaiting requested review from bowei

2 more reviewers

@jpeach jpeach jpeach left review comments

@howardjohn howardjohn howardjohn approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees

@jpeach jpeach

@robscott robscott

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. breaking-change cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/api-change Categorizes issue or PR as related to adding, removing, or otherwise changing an API kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

TLSRoute SNI match inconsistency
5 participants
@hbagdi @k8s-ci-robot @jpeach @robscott @howardjohn