Skip to content

Add doc content for new Ingress annotation http01-ingress-ingressclassname #1848

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
Open
wants to merge 2 commits into
base: release-next
Choose a base branch
from
Open

Add doc content for new Ingress annotation http01-ingress-ingressclassname #1848

wants to merge 2 commits into from
+34 −10

Conversation

@lunarwhite
Copy link
Member

@lunarwhite lunarwhite commented Nov 19, 2025 •
edited
Loading

@cert-manager-prow cert-manager-prow bot added dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Nov 19, 2025
@netlify
Copy link

netlify bot commented Nov 19, 2025 •
edited
Loading

✅ Deploy Preview for cert-manager ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit c32f9cf
🔍 Latest deploy log https://app.netlify.com/projects/cert-manager/deploys/691da1b777e39e00074784ca
😎 Deploy Preview https://deploy-preview-1848--cert-manager.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@lunarwhite lunarwhite force-pushed the new-anno branch 2 times, most recently from bba2172 to 8d35518 Compare November 19, 2025 08:09
@lunarwhite
Copy link
Member Author

lunarwhite commented Nov 19, 2025

/cc @maelvls

Please feel free to review it once you get the bandwidth. Thank you

@cert-manager-prow cert-manager-prow bot requested a review from maelvls November 19, 2025 08:30
@lunarwhite lunarwhite changed the base branch from master to release-next November 19, 2025 10:38
@cert-manager-prow cert-manager-prow bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Nov 19, 2025
@cert-manager-prow
Copy link
Contributor

cert-manager-prow bot commented Nov 19, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign maelvls for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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

@cert-manager-prow cert-manager-prow bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Nov 19, 2025
SgtCoDFish
SgtCoDFish requested changes Nov 19, 2025
View reviewed changes
Copy link
Member

@SgtCoDFish SgtCoDFish left a comment

Choose a reason for hiding this comment

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

2 minor things with some suggestions. Thank you 🙏

content/docs/reference/annotations.md
Comment on lines +30 to +34
this annotation allows you to configure the `kubernetes.io/ingress.class` that will be
used to solve challenges for this ingress. Customizing this is useful when you are trying
to secure internal services, and need to solve challenges using a different ingress class
to that of the ingress. If not specified and the `acme-http01-edit-in-place` annotation is
not set, this defaults to the `http01.ingress.class` defined in the Issuer resource.
Copy link
Member

@SgtCoDFish SgtCoDFish Nov 19, 2025

Choose a reason for hiding this comment

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

nitpick (minor): I think we should start with a capital letter here, and I don't think we need to say "this annotation" because I think in context it's clear that it's an annotation.

(I can see you adapted this from elsewhere in the docs where it's already present, but I think it's worth writing differently anyway!)

Suggested change
this annotation allows you to configure the `kubernetes.io/ingress.class` that will be
used to solve challenges for this ingress. Customizing this is useful when you are trying
to secure internal services, and need to solve challenges using a different ingress class
to that of the ingress. If not specified and the `acme-http01-edit-in-place` annotation is
not set, this defaults to the `http01.ingress.class` defined in the Issuer resource.
Allows the `kubernetes.io/ingress.class` annotation to be configured.
Customizing this is useful when you are trying
to secure internal services, and need to solve challenges using a different ingress class
to that of the ingress. If not specified and the `acme-http01-edit-in-place` annotation is
not set, this defaults to the `http01.ingress.class` defined in the Issuer resource.

content/docs/reference/annotations.md
Comment on lines +39 to +43
this annotation allows you to configure the `spec.ingressClassName` that will be
used to solve challenges for this ingress. Customizing this is useful when you are trying
to secure internal services, and need to solve challenges using a different ingress class
to that of the ingress. If not specified and the `acme-http01-edit-in-place` annotation is
not set, this defaults to the `http01.ingress.ingressClassName` defined in the Issuer resource.
Copy link
Member

@SgtCoDFish SgtCoDFish Nov 19, 2025

Choose a reason for hiding this comment

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

nitpick (minor): (As above) I think we should start with a capital letter here, and I don't think we need to say "this annotation" because I think in context it's clear that it's an annotation.

(I can see you adapted this from elsewhere in the docs where it's already present, but I think it's worth writing differently anyway!)

Suggested change
this annotation allows you to configure the `spec.ingressClassName` that will be
used to solve challenges for this ingress. Customizing this is useful when you are trying
to secure internal services, and need to solve challenges using a different ingress class
to that of the ingress. If not specified and the `acme-http01-edit-in-place` annotation is
not set, this defaults to the `http01.ingress.ingressClassName` defined in the Issuer resource.
Allows the Ingress's `spec.ingressClassName` to be configured.
Customizing this is useful when you are trying
to secure internal services, and need to solve challenges using a different ingress class
to that of the ingress. If not specified and the `acme-http01-edit-in-place` annotation is
not set, this defaults to the `http01.ingress.ingressClassName` defined in the Issuer resource.

content/docs/usage/ingress.md
Comment on lines 91 to +104
- `acme.cert-manager.io/http01-ingress-class`: this annotation allows you to
configure the ingress class that will be used to solve challenges for this
ingress. Customizing this is useful when you are trying to secure internal
configure the `kubernetes.io/ingress.class` that will be used to solve challenges
for this ingress. Customizing this is useful when you are trying to secure internal
services, and need to solve challenges using a different ingress class to that
of the ingress. If not specified and the `acme-http01-edit-in-place` annotation
is not set, this defaults to the ingress class defined in the Issuer resource.
is not set, this defaults to the `http01.ingress.class` defined in the Issuer resource.

- `acme.cert-manager.io/http01-ingress-ingressclassname`: this annotation allows you to
configure the `spec.ingressClassName` that will be used to solve challenges
for this ingress. Customizing this is useful when you are trying to secure internal
services, and need to solve challenges using a different ingress class to that
of the ingress. If not specified and the `acme-http01-edit-in-place` annotation
is not set, this defaults to the `http01.ingress.ingressClassName` defined in the
Issuer resource.
Copy link
Member

@SgtCoDFish SgtCoDFish Nov 19, 2025

Choose a reason for hiding this comment

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

comment: I'd prefer if this wasn't written "this annotation..." but I totally recognise that's how it already is, and we definitely shouldn't rework this page in this PR. This is really good, thank you 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@SgtCoDFish SgtCoDFish SgtCoDFish requested changes

@maelvls maelvls Awaiting requested review from maelvls

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. 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.

2 participants

@lunarwhite @SgtCoDFish