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

Fixup docs for the ingress-class flag. #5796

Merged
merged 1 commit into from
Jun 27, 2020
Merged

Fixup docs for the ingress-class flag. #5796

merged 1 commit into from
Jun 27, 2020

Conversation

mqsoh
Copy link

@mqsoh mqsoh commented Jun 26, 2020

According to this issue, there is no way to handle all ingress classes. This will make the documentation consistent.

#3101

What this PR does / why we need it:

The documentation is misleading.

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)

Which issue/s this PR fixes

None. It was something that confused me.

How Has This Been Tested?

I'm moving from Traefik so all our existing Ingresses had "traefik" as the ingress class (annotation). I removed the --ingress-class from my deployment of Ingress Nginx expecting it to handle all those ingresses, but it doesn't! This change makes the docs consistent.

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.

According to this issue, there is no way to handle all ingress classes.

#3101
@k8s-ci-robot
Copy link
Contributor

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.


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. I understand the commands that are listed here.

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jun 26, 2020
@k8s-ci-robot
Copy link
Contributor

Welcome @mqsoh!

It looks like this is your first PR to kubernetes/ingress-nginx 🎉. 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/ingress-nginx 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 @mqsoh. 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 Jun 26, 2020
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jun 26, 2020
@aledbf
Copy link
Member

aledbf commented Jun 26, 2020

/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 Jun 26, 2020
@aledbf
Copy link
Member

aledbf commented Jun 26, 2020

/lgtm
/approve

@aledbf
Copy link
Member

aledbf commented Jun 26, 2020

@mqsoh thanks!

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 26, 2020
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: aledbf, mqsoh

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 Jun 26, 2020
@aledbf
Copy link
Member

aledbf commented Jun 26, 2020

/retest

1 similar comment
@aledbf
Copy link
Member

aledbf commented Jun 26, 2020

/retest

@mqsoh
Copy link
Author

mqsoh commented Jun 26, 2020

Is this normal or did my change actually break something?

@aledbf
Copy link
Member

aledbf commented Jun 26, 2020

Is this normal or did my change actually break something?

No, your change is fine. I broke the e2e test 🙃 . I am fixing the issue.

@aledbf
Copy link
Member

aledbf commented Jun 27, 2020

/retest

3 similar comments
@aledbf
Copy link
Member

aledbf commented Jun 27, 2020

/retest

@aledbf
Copy link
Member

aledbf commented Jun 27, 2020

/retest

@aledbf
Copy link
Member

aledbf commented Jun 27, 2020

/retest

@k8s-ci-robot k8s-ci-robot merged commit 47b5e20 into kubernetes:master Jun 27, 2020
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. 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
Development

Successfully merging this pull request may close these issues.

3 participants