Skip to content

Add secretTemplate to Certificate resources created by ingress-shim#6839

Merged
jetstack-bot merged 3 commits intocert-manager:masterfrom
mangeshhambarde:ingress-annotations-for-secret-template
Mar 14, 2024
Merged

Add secretTemplate to Certificate resources created by ingress-shim#6839
jetstack-bot merged 3 commits intocert-manager:masterfrom
mangeshhambarde:ingress-annotations-for-secret-template

Conversation

@mangeshhambarde
Copy link
Contributor

@mangeshhambarde mangeshhambarde commented Mar 7, 2024 •
edited
Loading

Pull Request Motivation

These are the changes for implementing #6838.

This allows ingress-shim users to set the secretTemplate field on generated Certificate resources. This makes using secret sync tools (e.g. kubernetes-reflector) much simpler for ingress-shim users.

Added a new Ingress annotation cert-manager.io/secret-template whose value is a JSON representation of secretTemplate.

Kind

feature

Release Note

Added a new Ingress annotation for copying specific Ingress annotations to Certificate's secretTemplate

@jetstack-bot jetstack-bot added release-note Denotes a PR that will be considered when it comes time to generate release notes. 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 needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 7, 2024
@jetstack-bot
Copy link
Contributor

jetstack-bot commented Mar 7, 2024

Hi @mangeshhambarde. Thanks for your PR.

I'm waiting for a cert-manager member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

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/test-infra repository.

@jetstack-bot jetstack-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Mar 7, 2024
This was referenced Mar 12, 2024
Closed
Open
jsoref
jsoref reviewed Mar 12, 2024
View reviewed changes
@mangeshhambarde
New Ingress annotation for copying custom annotations to secret template
efe2e06 
Signed-off-by: Mangesh Hambarde <1411192+mangeshhambarde@users.noreply.github.com>
@mangeshhambarde
Add tests
717269e 
Signed-off-by: Mangesh Hambarde <1411192+mangeshhambarde@users.noreply.github.com>
@mangeshhambarde mangeshhambarde force-pushed the ingress-annotations-for-secret-template branch from 1ff6f6e to 44a0e3f Compare March 13, 2024 14:22
@mangeshhambarde
JSON encoded secretTemplate as Ingress annotation
f3bfc93 
Signed-off-by: Mangesh Hambarde <1411192+mangeshhambarde@users.noreply.github.com>
@mangeshhambarde mangeshhambarde force-pushed the ingress-annotations-for-secret-template branch from 44a0e3f to f3bfc93 Compare March 13, 2024 14:40
SgtCoDFish
SgtCoDFish approved these changes Mar 14, 2024
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

Looks great, thank you for this! Feels like we can be confident about this with the tests being there 😁 🚀

@SgtCoDFish
Copy link
Member

SgtCoDFish commented Mar 14, 2024

/ok-to-test

@jetstack-bot jetstack-bot added ok-to-test lgtm Indicates that a PR is ready to be merged. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 14, 2024
@jetstack-bot
Copy link
Contributor

jetstack-bot commented Mar 14, 2024

[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

Details 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

@jetstack-bot jetstack-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 14, 2024
inteon
inteon reviewed Mar 14, 2024
View reviewed changes
pkg/controller/certificate-shim/sync_test.go
Namespace: gen.DefaultTestNamespace,
Annotations: map[string]string{
cmapi.IngressClusterIssuerNameAnnotationKey: "issuer-name",
cmapi.IngressSecretTemplate: `{ "annotations": { "example-annotation" : "dummy-value" }, "labels": { "example-label" : "dummy-value" } }`,
Copy link
Member

@inteon inteon Mar 14, 2024

Choose a reason for hiding this comment

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

I think it will be easier to read and create these annotations if there was a separate annotation for SecretTemplateAnnotations and SecretTemplateLabels.

@SgtCoDFish
Copy link
Member

SgtCoDFish commented Mar 14, 2024

/test pull-cert-manager-master-e2e-v1-28-upgrade

@jetstack-bot jetstack-bot merged commit 5213a53 into cert-manager:master Mar 14, 2024
@mangeshhambarde mangeshhambarde mentioned this pull request May 28, 2024
Closed
@inteon inteon mentioned this pull request Jun 18, 2024
Merged
@uhthomas uhthomas mentioned this pull request Oct 23, 2024
Closed
@morgoved
Copy link

morgoved commented Nov 6, 2024

can you pls help me, i try to add this
cert-manager.io/secret-template: {"annotations": {"reflector.v1.k8s.emberstack.com/reflection-allowed": "true","reflector.v1.k8s.emberstack.com/reflection-allowed-namespaces": "istio-system"}}

in my ingress config but have this error
error converting YAML to JSON: yaml: line 14: found character that cannot start any token

@jsoref
Copy link
Contributor

jsoref commented Nov 6, 2024

you might want to wrap the whole thing in '...'

@wallrj wallrj mentioned this pull request Jun 12, 2025
Open
@wallrj
Copy link
Member

wallrj commented Jun 12, 2025

This new annotation has not been documented:

@maelvls maelvls mentioned this pull request Nov 24, 2025
Open
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@inteon inteon inteon left review comments

@SgtCoDFish SgtCoDFish SgtCoDFish approved these changes

+1 more reviewer

@jsoref jsoref jsoref left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. area/api Indicates a PR directly modifies the 'pkg/apis' directory 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. needs-kind Indicates a PR lacks a `kind/foo` label and requires one. ok-to-test 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

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@mangeshhambarde @jetstack-bot @SgtCoDFish @morgoved @jsoref @wallrj @inteon