Skip to content

feat: API defaults for IssuerRef #7414

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.

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

Merged
merged 1 commit into from
Aug 2, 2025

Conversation

erikgb
Copy link
Member

@erikgb erikgb commented Nov 9, 2024

Pull Request Motivation

This PR will add the first API defaults to cert-manager APIs. I have personally been motivated to suggest this multiple times, as I think the cert-manager defaults are too "hidden". At least not evident for consumers of cert-manager Go API. PR was triggered by cert-manager/approver-policy#523 (comment).

Since the fields we are adding API defaults belong to a struct with a very "general" name (ObjectReference), I suggest renaming the struct as part of this PR. After discussing this change in our bi-weekly development meeting, I have attempted to make this change non-breaking in the Go API by aliasing the struct type to its current name. I am not sure this will be 100% non-breaking, but I think so. UPDATE: This change will be non-breaking. For now, I have kept the cert-manager use of the deprecated ObjectReference, and it compiles.

Kind

/kind feature

Release Note

Added API defaults to issuer references group (cert-manager.io) and kind (Issuer).

@cert-manager-prow
Copy link
Contributor

@erikgb: The label(s) kind/release, kind/note cannot be applied, because the repository doesn't have them.

In response to this:

Pull Request Motivation

POC/WIP PR will be used as input for a discussion about eventually adding API defaults to cert-manager APIs. I have personally been motivated to suggest this multiple times, as I think the cert-manager defaults are too "hidden". At least not evident for consumers of cert-manager Go API. PR was triggered by cert-manager/approver-policy#523 (comment).

Kind

/kind

Release Note

NONE

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-sigs/prow repository.

@cert-manager-prow cert-manager-prow bot added release-note-none Denotes a PR that doesn't merit a release note. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. labels Nov 9, 2024
@cert-manager-prow
Copy link
Contributor

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@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. area/api Indicates a PR directly modifies the 'pkg/apis' directory area/deploy Indicates a PR modifies deployment configuration needs-kind Indicates a PR lacks a `kind/foo` label and requires one. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Nov 9, 2024
@cert-manager-bot
Copy link
Contributor

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
If this issue is safe to close now please do so with /close.
/lifecycle stale

@cert-manager-prow cert-manager-prow bot added lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Jul 12, 2025
@erikgb erikgb force-pushed the issuer-ref-defaults branch from 9cbc13b to c92b316 Compare July 20, 2025 15:09
@cert-manager-prow cert-manager-prow bot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jul 20, 2025
@erikgb
Copy link
Member Author

erikgb commented Jul 20, 2025

/test all

@erikgb erikgb force-pushed the issuer-ref-defaults branch from c92b316 to d3da561 Compare July 20, 2025 16:00
@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 Jul 20, 2025
@erikgb
Copy link
Member Author

erikgb commented Jul 20, 2025

/test all

@cert-manager-prow
Copy link
Contributor

cert-manager-prow bot commented Jul 20, 2025

@erikgb: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-cert-manager-master-e2e-v1-32-upgrade 49b6cd0 link true /test pull-cert-manager-master-e2e-v1-32-upgrade
pull-cert-manager-master-e2e-v1-32 49b6cd0 link true /test pull-cert-manager-master-e2e-v1-32

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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-sigs/prow repository. I understand the commands that are listed here.

@cert-manager-prow cert-manager-prow bot added area/acme Indicates a PR directly modifies the ACME Issuer code area/acme/dns01 Indicates a PR modifies ACME DNS01 provider code area/monitoring Indicates a PR or issue relates to monitoring area/testing Issues relating to testing size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 20, 2025
@erikgb erikgb force-pushed the issuer-ref-defaults branch from a75d547 to 7c6caff Compare July 20, 2025 16:45
@erikgb erikgb marked this pull request as ready for review July 20, 2025 18:42
@erikgb erikgb force-pushed the issuer-ref-defaults branch from 7c6caff to 4c40de6 Compare July 25, 2025 15:26
@cert-manager-prow cert-manager-prow bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jul 25, 2025
@erikgb erikgb force-pushed the issuer-ref-defaults branch from 4c40de6 to 678dab2 Compare July 29, 2025 14:14
@cert-manager-prow cert-manager-prow bot added release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. release-note-none Denotes a PR that doesn't merit a release note. labels Jul 29, 2025
@erikgb
Copy link
Member Author

erikgb commented Jul 30, 2025

/remove-lifecycle stale
/kind feature

@cert-manager-prow cert-manager-prow bot added kind/feature Categorizes issue or PR as related to a new feature. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. needs-kind Indicates a PR lacks a `kind/foo` label and requires one. labels Jul 30, 2025
@erikgb erikgb changed the title WIP: feat: API defaults for IssuerRef feat: API defaults for IssuerRef Jul 30, 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 Jul 30, 2025
@erikgb erikgb requested review from bashlion, ThatsMrTalbot and wallrj and removed request for bashlion July 30, 2025 19:15
@inteon
Copy link
Member

inteon commented Jul 31, 2025

/approve

@cert-manager-prow
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: bashlion, 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 Jul 31, 2025
Signed-off-by: Erik Godding Boye <egboye@gmail.com>
@erikgb erikgb force-pushed the issuer-ref-defaults branch from 678dab2 to 236523b Compare July 31, 2025 16:36
@inteon
Copy link
Member

inteon commented Aug 2, 2025

/lgtm

@cert-manager-prow cert-manager-prow bot added the lgtm Indicates that a PR is ready to be merged. label Aug 2, 2025
@cert-manager-prow cert-manager-prow bot merged commit cbd6df2 into cert-manager:master Aug 2, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/acme/dns01 Indicates a PR modifies ACME DNS01 provider code area/acme Indicates a PR directly modifies the ACME Issuer code area/api Indicates a PR directly modifies the 'pkg/apis' directory area/deploy Indicates a PR modifies deployment configuration area/monitoring Indicates a PR or issue relates to monitoring area/testing Issues relating to testing dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. kind/feature Categorizes issue or PR as related to a new feature. lgtm Indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants