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 notes on Ingress Class compatibility for 1.5-1.7 #812

Merged
merged 2 commits into from
Jan 26, 2022
Merged

Add notes on Ingress Class compatibility for 1.5-1.7 #812

merged 2 commits into from
Jan 26, 2022

Conversation

jakexks
Copy link
Member

@jakexks jakexks commented Jan 26, 2022 •
edited
Loading

Hopefully this addresses concerns found during testing of the Ingress Annotation fallout

@jetstack-bot
Copy link
Contributor

@jakexks: This PR is not for the master branch but does not have the cherry-pick-approved label. Adding the do-not-merge/cherry-pick-not-approved label.

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.

@jetstack-bot jetstack-bot added do-not-merge/cherry-pick-not-approved Indicates that a PR is not yet approved to merge into a release branch. dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. approved Indicates a PR has been approved by an approver from all required OWNERS files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jan 26, 2022
@netlify
Copy link

netlify bot commented Jan 26, 2022 •
edited
Loading

✔️ Deploy Preview for cert-manager-website ready!

🔨 Explore the source changes: 3b9222d

🔍 Inspect the deploy log: https://app.netlify.com/sites/cert-manager-website/deploys/61f154c70fa51d0008e0e98c

😎 Browse the preview: https://deploy-preview-812--cert-manager-website.netlify.app/docs/installation/upgrading/ingress-class-compatibility

wallrj
wallrj previously requested changes Jan 26, 2022
View reviewed changes
Copy link
Member

@wallrj wallrj left a comment

Choose a reason for hiding this comment

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

Could you also add a note to https://cert-manager.io/next-docs/installation/upgrading/upgrading-1.6-1.7/ with a link to this information.

@jakexks
Copy link
Member Author

jakexks commented Jan 26, 2022

I think there should be upgrade notes for 1.5, 1.6 and 1.7, I shall add them now

@jakexks jakexks mentioned this pull request Jan 26, 2022
Merged
@jakexks jakexks requested a review from wallrj January 26, 2022 13:07
@jakexks @maelvls
Add notes on Ingress Class compatibility for 1.5-1.7
ca3d18a 
Add upgrade notes to 1.5-1.7

Co-authored-by: Maël Valais <mael@vls.dev>
Signed-off-by: Jake Sanders <i@am.so-aweso.me>
@jakexks jakexks dismissed wallrj’s stale review January 26, 2022 13:22

Added upgrade notes

@jakexks jakexks added cherry-pick-approved Indicates a cherry-pick PR into a release branch has been approved by the release branch manager and removed do-not-merge/cherry-pick-not-approved Indicates that a PR is not yet approved to merge into a release branch. labels Jan 26, 2022
maelvls
maelvls reviewed Jan 26, 2022
View reviewed changes
content/en/docs/installation/upgrading/ingress-class-compatibility.md

[Kubernetes enhancement proposal]: https://github.com/kubernetes/enhancements/tree/44dd2975dc6cdad96ca73e7b0ba1794f1196f604/keps/sig-network/1453-ingress-api#interoperability-with-previous-annotation

# Notes For Specific Ingress Controllers
Copy link
Member

Choose a reason for hiding this comment

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

People reading this page in a "standalone" way (without reading the 1.7 release notes first) won't know whether they should read the rest of the document or not. I think we should explain if they are affected or not by adding which cert-manager versions are affected.

Copy link
Member Author

Choose a reason for hiding this comment

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

https://github.com/cert-manager/website/pull/812/files#diff-0253be5163bbb956f00cbf9d08ea6281c91d9b75ea5cd83ff331ff0c256d6923R8

It is at the top of the page, but it may not be good enough. Do you have a suggestion?

Copy link
Member

@maelvls maelvls Jan 26, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

I'll try to share a suggestion.

Copy link
Member

@maelvls maelvls Jan 26, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Suggested change
# Notes For Specific Ingress Controllers
# Notes For Specific Ingress Controllers
When upgrading from one of the affected versions of cert-manager (1.5.0, 1.5.1, 1.5.2, 1.5.3, 1.5.4, 1.6.0, 1.6.1, 1.6.2, and 1.6.3) to 1.5.5, 1.6.4 or 1.7.0 and above, and that the ingress controllers you are using match the following:
- You are using Gloo, Contour, Skipper, or kube-ingress-aws-controller,
- You are using Traefik, Istio, Ambassador, or ingress-nginx with their default "class" (e.g., `istio` for Istio),
then you don't need to worry and the upgrade will have no impact. You can skip the rest of this document.
If you are using an ingress controller that doesn't belong to the above, upgrading from a version that contains the regression to 1.5.5, 1.6.4 or 1.7.0 and above may have an impact. The rest of this document details the measures you will need to take.

Copy link
Member

Choose a reason for hiding this comment

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

I am OK for moving this suggestion to a new PR.

wallrj
wallrj approved these changes Jan 26, 2022
View reviewed changes
Copy link
Member

@wallrj wallrj left a comment

Choose a reason for hiding this comment

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

Nice clear description of the regression and the upgrade steps.

I spotted a couple of typos (I think) but ignore those if you prefer to get this merged.

content/en/docs/installation/upgrading/ingress-class-compatibility.md Outdated Show resolved Hide resolved
content/en/docs/installation/upgrading/ingress-class-compatibility.md Outdated Show resolved Hide resolved
content/en/docs/installation/upgrading/ingress-class-compatibility.md Outdated Show resolved Hide resolved
@jetstack-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jakexks, wallrj

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

@wallrj
Copy link
Member

wallrj commented Jan 26, 2022

/lgtm
/hold

@jetstack-bot jetstack-bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 26, 2022
@jetstack-bot jetstack-bot added the lgtm Indicates that a PR is ready to be merged. label Jan 26, 2022
@jakexks @maelvls @wallrj
Apply suggestions from code review
3b9222d 
Signed-off-by: Jake Sanders <i@am.so-aweso.me>

Co-authored-by: Maël Valais <mael@vls.dev>
Co-authored-by: Richard Wall <wallrj@users.noreply.github.com>
@jetstack-bot jetstack-bot removed the lgtm Indicates that a PR is ready to be merged. label Jan 26, 2022
@jakexks
Copy link
Member Author

jakexks commented Jan 26, 2022

/hold cancel

@jetstack-bot jetstack-bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 26, 2022
@maelvls
Copy link
Member

maelvls commented Jan 26, 2022

/lgtm

@jetstack-bot jetstack-bot added the lgtm Indicates that a PR is ready to be merged. label Jan 26, 2022
@jetstack-bot jetstack-bot merged commit 1d5cf7c into cert-manager:release-next Jan 26, 2022
@jetstack-bot jetstack-bot mentioned this pull request Jan 26, 2022
Merged
@jakexks jakexks deleted the ingress-notes branch January 26, 2022 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@maelvls maelvls maelvls left review comments

@wallrj wallrj wallrj approved these changes

Assignees

@wallrj wallrj

@maelvls maelvls

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cherry-pick-approved Indicates a cherry-pick PR into a release branch has been approved by the release branch manager dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. lgtm 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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@jakexks @jetstack-bot @wallrj @maelvls