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 a description field for GatewayClass #653

Merged
merged 2 commits into from
May 14, 2021
Merged

add a description field for GatewayClass #653

merged 2 commits into from
May 14, 2021

Conversation

hzliangbin
Copy link
Contributor

@hzliangbin hzliangbin commented May 7, 2021 •
edited
Loading

What type of PR is this?

What this PR does / why we need it:
add a field to help describe gatewayclass

Which issue(s) this PR fixes:

Fixes #
#610

Does this PR introduce a user-facing change?:

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

Welcome @hzliangbin!

It looks like this is your first PR to kubernetes-sigs/gateway-api 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/gateway-api has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Contributor

Hi @hzliangbin. 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.

@k8s-ci-robot k8s-ci-robot added 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 May 7, 2021
hbagdi
hbagdi reviewed May 7, 2021
View reviewed changes
apis/v1alpha2/gatewayclass_types.go Outdated
// +kubebuilder:validation:MinLength=1
// +kubebuilder:validation:MaxLength=64
// +optional
Description *string `json:"description,omitempty"`
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this field should be on the spec struct.

@hbagdi
Copy link
Contributor

hbagdi commented May 7, 2021

/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 May 7, 2021
tao12345666333
tao12345666333 reviewed May 8, 2021
View reviewed changes
Copy link
Member

@tao12345666333 tao12345666333 left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 8, 2021
hbagdi
hbagdi reviewed May 12, 2021
View reviewed changes
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.

/cc @robscott @bowei @jpeach

apis/v1alpha2/gatewayclass_types.go
// Description helps describe a GatewayClass with more details.
//
// +kubebuilder:validation:MinLength=1
// +kubebuilder:validation:MaxLength=64
Copy link
Contributor

Choose a reason for hiding this comment

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

Is 64 enough? Should we bump this up to 128? Should we give users at least a tweet to describe their classes?

Copy link
Member

Choose a reason for hiding this comment

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

Although I'd be open to expanding this in the future if needed, I think a primary goal of this was to enable helpful kubectl output, so something that could fit in a single row would be ideal.

Copy link
Contributor

Choose a reason for hiding this comment

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

128 isn't that much more -- we aren't using VT100's anymore...

@k8s-ci-robot k8s-ci-robot requested a review from jpeach May 12, 2021 22:01
robscott
robscott reviewed May 13, 2021
View reviewed changes
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 your work on this @hzliangbin!

apis/v1alpha2/gatewayclass_types.go Outdated
@@ -28,6 +28,7 @@ import (
// +kubebuilder:storageversion
// +kubebuilder:printcolumn:name="Controller",type=string,JSONPath=`.spec.controller`
// +kubebuilder:printcolumn:name="Age",type=date,JSONPath=`.metadata.creationTimestamp`
// +kubebuilder:printcolumn:name="Description",type=string,JSONPath=`.spec.description`
Copy link
Member

Choose a reason for hiding this comment

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

We may want to set a priority field here. That would enable us to only include this in the wide output.

Suggested change
// +kubebuilder:printcolumn:name="Description",type=string,JSONPath=`.spec.description`
// +kubebuilder:printcolumn:name="Description",type=string,JSONPath=`.spec.description`,priority=1

apis/v1alpha2/gatewayclass_types.go Outdated

// Description helps describe a GatewayClass with more details.
//
// +kubebuilder:validation:MinLength=1
Copy link
Member

Choose a reason for hiding this comment

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

It feels a bit confusing to enforce a min length on an optional field.

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

hbagdi commented May 13, 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 May 13, 2021
@hbagdi
Copy link
Contributor

hbagdi commented May 13, 2021

/lgtm cancel
@hzliangbin Can you please re-run ./hack/update-codegen.sh?

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 13, 2021
@bowei
Copy link
Contributor

bowei commented May 14, 2021

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

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: bowei, hzliangbin

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 May 14, 2021
@k8s-ci-robot k8s-ci-robot merged commit 6917fa3 into kubernetes-sigs:master May 14, 2021
@hbagdi hbagdi mentioned this pull request Jul 13, 2021
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@robscott robscott robscott left review comments

@tao12345666333 tao12345666333 tao12345666333 left review comments

@hbagdi hbagdi hbagdi left review comments

@bowei bowei Awaiting requested review from bowei

@jpeach jpeach Awaiting requested review from jpeach

Assignees

@bowei bowei

@tao12345666333 tao12345666333

@hbagdi hbagdi

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. 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.
6 participants
@hzliangbin @k8s-ci-robot @hbagdi @bowei @robscott @tao12345666333