Add renewal policy scenarios and link release notes to docs - #2210
Open
wallrj-cyberark wants to merge 2 commits into
Open
Add renewal policy scenarios and link release notes to docs#2210wallrj-cyberark wants to merge 2 commits into
wallrj-cyberark wants to merge 2 commits into
Conversation
cert-manager-prow
Bot
added
the
dco-signoff: yes
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
cert-manager-prow
Bot
added
the
size/M
✅ Deploy Preview for cert-manager ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
hjoshi123
reviewed
Jul 18, 2026
Add worked, realistic scenarios (change-control windows, coordinating rotation with paired systems, avoiding renewal during a traffic freeze, and disabling renewal for manually-managed root CAs) to the existing renewal policies and renewal windows documentation. Also fix the v1.21 release notes entry for this feature: it referenced a non-existent `renewalPolicies` field (the actual field is `spec.renewal`), and linked to the implementation PR rather than to the user-facing documentation. Signed-off-by: Richard Wall <richard.wall@cyberark.com>
Co-authored-by: Hemant Joshi <mail2hemantjoshi@pm.me> Signed-off-by: Richard Wall <richard.wall@cyberark.com>
wallrj-cyberark
force-pushed
the
docs-renewal-policy-scenarios
branch
from
July 28, 2026 15:37
5e7b251 to
8f82fd2
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Preview: https://deploy-preview-2210--cert-manager.netlify.app/docs/usage/certificate/#renewal-policies-and-windows
Summary
Adds worked, realistic scenarios to the existing "Renewal policies and renewal windows" documentation (added in #2018 for the v1.21 release), and fixes the v1.21 release notes entry for this feature.
renewalPoliciesfield, which doesn't exist — the actual API field isspec.renewal. It also linked to the implementation PR (feat(certificate): renewal policy and windows code cert-manager#8258) rather than to user-facing documentation. Updated it to link to the relevant section ofcertificate.mdinstead, so readers interested in the feature can go straight to the full documentation.Motivation
While triaging cert-manager/cert-manager#9031 (a crash-loop bug specific to
renewal.policy: Disabled, introduced by the same feature), noticed the release notes pointed at the implementation PR rather than the docs, and that the docs' motivation for the feature was a single terse line with no worked examples.Test plan
No
npm/Node toolchain was available in this environment, so./scripts/verifycould not be run locally. Confirmed instead via the Netlify deploy preview (linked above):renewal-policies-and-windowsanchor render correctly.HH:MMoutside of code as an emoji shortcode, but fenced code blocks are unaffected, matching the existing (already-live) pattern used earlier in the same file.pull-cert-manager-website-verifyCI job passed.