Skip to content

[release-1.18] [VC-39805] Document the change of PrivateKeyRotationPolicy to Always #1681

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
Closed
wants to merge 1 commit into from
Closed

[release-1.18] [VC-39805] Document the change of PrivateKeyRotationPolicy to Always #1681

wants to merge 1 commit into from

Conversation

wallrj
Copy link
Member

@wallrj wallrj commented Apr 29, 2025 •
edited
Loading

@cert-manager-prow cert-manager-prow bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Apr 29, 2025
@netlify Netlify
Copy link

netlify bot commented Apr 29, 2025 •
edited
Loading

✅ Deploy Preview for cert-manager ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit b624fa2
🔍 Latest deploy log https://app.netlify.com/sites/cert-manager/deploys/68123258c0571f00084ad646
😎 Deploy Preview https://deploy-preview-1681--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 site configuration.

@wallrj wallrj force-pushed the release-note-private-key-rotation-always branch from b43d120 to 2b4244f Compare April 29, 2025 14:00
@cert-manager-prow cert-manager-prow bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Apr 29, 2025
@wallrj wallrj force-pushed the release-note-private-key-rotation-always branch 3 times, most recently from cfb3409 to c7999af Compare April 30, 2025 13:36
@wallrj wallrj requested a review from Copilot April 30, 2025 13:36
Copilot
Copilot AI reviewed Apr 30, 2025
View reviewed changes
Copy link
Contributor

@Copilot 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 updates documentation to reflect the change in cert-manager v1.18 where the default Certificate.Spec.PrivateKey.RotationPolicy is now Always instead of Never. The changes update YAML examples, usage guides, and release notes to document this update.

  • Updated certificate defaults and tutorials to include a note indicating the default change.
  • Revised usage sections for Ingress, Gateway, and Certificate to reflect the new default behavior.
  • Amended release notes and upgrade guides accordingly.

Reviewed Changes

Copilot reviewed 8 out of 9 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
public/docs/tutorials/certificate-defaults/cpol-mutate-certificates-1.yaml Added an informational comment about the cert-manager version-dependent behavior for rotation policy.
public/docs/tutorials/certificate-defaults/cpol-mutate-certificates-0.yaml Similar informational comment update to note that the change is unnecessary with cert-manager >=v1.18.0.
content/docs/usage/ingress.md Updated default rotation policy text from Never to Always.
content/docs/usage/gateway.md Updated default rotation policy text from Never to Always.
content/docs/usage/certificate.md Added a detailed callout explaining the behavior change for different cert-manager versions.
content/docs/tutorials/certificate-defaults/README.md Added an informational comment about the cert-manager default value change.
content/docs/releases/upgrading/upgrading-1.17-1.18.md Added a note in the upgrade guide regarding the change in default rotation policy.
content/docs/releases/release-notes/release-notes-1.18.md Expanded release notes to describe the breaking change in Certificate.Spec.PrivateKey.RotationPolicy.
Files not reviewed (1)
  • .spelling: Language not supported

@wallrj wallrj force-pushed the release-note-private-key-rotation-always branch from c7999af to d36a34e Compare April 30, 2025 13:40
@wallrj
Document the new default Certificate.Spec.PrivateKey.RotationPolicy t…
b624fa2 
…o Always

Signed-off-by: Richard Wall <richard.wall@venafi.com>
@wallrj wallrj force-pushed the release-note-private-key-rotation-always branch from d36a34e to b624fa2 Compare April 30, 2025 14:23
@wallrj wallrj changed the title WIP: [release-1.18] Document the change of PrivateKeyRotationPolicy to Always WIP:[release-1.18] [VC-39805] Document the change of PrivateKeyRotationPolicy to Always May 1, 2025
@wallrj wallrj mentioned this pull request May 6, 2025
Merged
@wallrj wallrj changed the title WIP:[release-1.18] [VC-39805] Document the change of PrivateKeyRotationPolicy to Always [release-1.18] [VC-39805] Document the change of PrivateKeyRotationPolicy to Always May 8, 2025
@cert-manager-prow cert-manager-prow bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 8, 2025
@wallrj wallrj requested a review from inteon May 8, 2025 11:19
@cert-manager-prow
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: inteon

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 May 8, 2025
@wallrj wallrj added the lgtm Indicates that a PR is ready to be merged. label May 8, 2025
@wallrj
Copy link
Member Author

wallrj commented May 8, 2025

This seems to have been merged without closing the PR in e653aaa

@wallrj wallrj closed this May 8, 2025
@inteon
Copy link
Member

inteon commented May 9, 2025

/approve

wallrj pushed a commit to wallrj/website that referenced this pull request May 13, 2025
@cert-manager-prow
Merge pull request cert-manager#1681 from wallrj/release-note-private…
e653aaa 
…-key-rotation-always

[release-1.18] [VC-39805] Document the change of PrivateKeyRotationPolicy to Always
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

@inteon inteon inteon approved these changes

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
@wallrj @inteon