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

Added docs for --ingress-class-by-name flag in the cli arguments page #7624

Merged
merged 2 commits into from
Dec 23, 2021
Merged

Added docs for --ingress-class-by-name flag in the cli arguments page #7624

merged 2 commits into from
Dec 23, 2021

Conversation

bhumijgupta
Copy link
Member

What this PR does / why we need it:

This PR adds doc for the --ingress-class-by-name flag.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Doc changes

Which issue/s this PR fixes

fixes #7610

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I've read the CONTRIBUTION guide
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@bhumijgupta
Added docs for --ingress-class-by-name flag in the cli arguments page
b7afa8d 
Signed-off-by: bhumijgupta <bhumijgupta@gmail.com>
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Sep 12, 2021
@k8s-ci-robot
Copy link
Contributor

@bhumijgupta: This issue is currently awaiting triage.

If Ingress contributors determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

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-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-priority labels Sep 12, 2021
@k8s-ci-robot
Copy link
Contributor

Hi @bhumijgupta. Thanks for your PR.

I'm waiting for a kubernetes 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 the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Sep 12, 2021
tao12345666333
tao12345666333 reviewed Sep 12, 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.

/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 Sep 12, 2021
@tao12345666333
Copy link
Member

Should it directly match this content?

ingress-nginx/cmd/nginx/flags.go

Lines 71 to 72 in cda59cc

ingressClassByName = flags.Bool("ingress-class-by-name", false,
`Define if Ingress Controller should watch for Ingress Class by Name together with Controller Class`)

@bhumijgupta
Copy link
Member Author

I was not sure that it should directly match or not. But if that's the case, I'll edit the docs to match the flag description in code

Should it directly match this content?

ingress-nginx/cmd/nginx/flags.go

Lines 71 to 72 in cda59cc

ingressClassByName = flags.Bool("ingress-class-by-name", false,
`Define if Ingress Controller should watch for Ingress Class by Name together with Controller Class`)

@bhumijgupta
Updated docs to match the flag description in code
c40e097 
Signed-off-by: bhumijgupta <bhumijgupta@gmail.com>
@rikatz
Copy link
Contributor

rikatz commented Sep 16, 2021

Yes it should :)

/approve
/lgtm
Thanks!

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

rikatz commented Sep 16, 2021

/hold

@k8s-ci-robot k8s-ci-robot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Sep 16, 2021
@rikatz
Copy link
Contributor

rikatz commented Sep 16, 2021

It's a good idea also to add into https://kubernetes.github.io/ingress-nginx/#what-is-an-ingressclass-and-why-is-it-important-for-users-of-ingress-nginx-controller-now some user story of when --ingress-class-by-name should be used (and combining that with --ingress-name arg)

tao12345666333
tao12345666333 reviewed Sep 17, 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

@rikatz
Copy link
Contributor

rikatz commented Sep 19, 2021

@bhumijgupta just waiting until #7624 (comment) gets corrected and we can move forward with this.

For now I will remove approval just so this wont get merged without the comment above being corrected :)

Thanks
/approve cancel

@k8s-ci-robot k8s-ci-robot removed the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 19, 2021
@bhumijgupta
Copy link
Member Author

Update: Due to some unforeseen personal stuff, I couldn't work on #7624 (comment). I am planning to come back to the PR and complete it by this week

@longwuyuan
Copy link
Contributor

@bhumijgupta, gentle request for an update. I am not very clear on that user-story we can write for the --ingress-class-by-name flag. If you can explain on slack, then I can try to write it ina different PR and we can merge this one.

@rikatz I am making above comment assuming we are just waiting for a good story for a end-user to read and understand when and why to use --ingress-class-by-name flag. Any other ideas to not let this one be delayed too much.

@rikatz
Copy link
Contributor

rikatz commented Dec 23, 2021

I'm gonna unhold this, and merge.

We should probably use my comment here as a followup improvement in docs tho

/approve
/lgtm
/hold cancel
Thanks!

@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 Dec 23, 2021
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: bhumijgupta, rikatz, tao12345666333

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 Dec 23, 2021
@k8s-ci-robot k8s-ci-robot merged commit 6d4c51c into kubernetes:main Dec 23, 2021
rchshld pushed a commit to joomcode/ingress-nginx that referenced this pull request May 19, 2023
@bhumijgupta @rchshld
Added docs for --ingress-class-by-name flag in the cli arguments page (…
720065b 
…kubernetes#7624)

* Added docs for --ingress-class-by-name flag in the cli arguments page

Signed-off-by: bhumijgupta <bhumijgupta@gmail.com>

* Updated docs to match the flag description in code

Signed-off-by: bhumijgupta <bhumijgupta@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tao12345666333 tao12345666333 tao12345666333 left review comments

@ElvinEfendi ElvinEfendi Awaiting requested review from ElvinEfendi

Assignees

@tao12345666333 tao12345666333

@rikatz rikatz

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/docs 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. needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-priority needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. 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.

doc is needed for the flag --ingress-class-by-name.
5 participants
@bhumijgupta @k8s-ci-robot @tao12345666333 @rikatz @longwuyuan