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
Merged
merged 3 commits into from
Nov 21, 2025
Merged

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

merged 3 commits into from
Nov 21, 2025
+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 077192c
🔍 Latest deploy log https://app.netlify.com/projects/cert-manager/deploys/691eea8c19f40b000893ca50
😎 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 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 🙏

@lunarwhite @SgtCoDFish
Incorporate review suggestions
077192c 
Co-authored-by: Ashley Davis <[email protected]>
Signed-off-by: Yuedong Wu <[email protected]>
@maelvls maelvls requested a review from Copilot November 20, 2025 10:42
Copilot finished reviewing on behalf of maelvls November 20, 2025 10:43
Copilot AI reviewed Nov 20, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds documentation for the new acme.cert-manager.io/http01-ingress-ingressclassname annotation, which allows users to configure the spec.ingressClassName field for HTTP01 challenge solving. This complements the existing http01-ingress-class annotation that configures the legacy kubernetes.io/ingress.class annotation.

  • Adds documentation for the new http01-ingress-ingressclassname annotation across multiple documentation pages
  • Adds a redirect for the new annotation to ensure proper URL routing
  • Updates the spelling dictionary to include the new annotation name

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file
File Description
public/_redirects Adds redirect rule for the new annotation documentation URL
content/docs/usage/ingress.md Documents the new annotation in the Ingress usage guide with configuration details
content/docs/reference/annotations.md Adds reference documentation for the new annotation and clarifies the existing http01-ingress-class annotation
content/docs/configuration/acme/http01/README.md Adds notes about overriding both ingressClassName and class on a per-Ingress basis
.spelling Adds the new annotation name to the spelling dictionary

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

SgtCoDFish
SgtCoDFish approved these changes Nov 21, 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.

/lgtm
/approve

Thank you for this!

@cert-manager-prow cert-manager-prow bot added the lgtm Indicates that a PR is ready to be merged. label Nov 21, 2025
@cert-manager-prow
Copy link
Contributor

cert-manager-prow bot commented Nov 21, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: SgtCoDFish

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

@cert-manager-prow cert-manager-prow bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 21, 2025
@cert-manager-prow cert-manager-prow bot merged commit b14023f into cert-manager:release-next Nov 21, 2025
13 checks passed
@lunarwhite lunarwhite deleted the new-anno branch November 21, 2025 16:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@SgtCoDFish SgtCoDFish SgtCoDFish approved these changes

@maelvls maelvls Awaiting requested review from maelvls

Assignees

No one assigned

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. 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/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