Skip to content

Commit c1a28da

Browse files
committed
improve the ignore function comments
Signed-off-by: Tim Ramlot <[email protected]>
1 parent 6912c7f commit c1a28da

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

controllers/signer/interface.go

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,9 @@ type CertificateRequestObject interface {
5555
// IgnoreIssuer is an optional function that can prevent the issuer controllers from
5656
// reconciling an issuer resource. By default, the controllers will reconcile all
5757
// issuer resources that match the owned types.
58+
// This function will be called by the issuer reconcile loops for each type that matches
59+
// the owned types. If the function returns true, the controller will not reconcile the
60+
// issuer resource.
5861
type IgnoreIssuer func(
5962
ctx context.Context,
6063
issuerObject v1alpha1.Issuer,
@@ -63,6 +66,9 @@ type IgnoreIssuer func(
6366
// IgnoreCertificateRequest is an optional function that can prevent the CertificateRequest
6467
// and Kubernetes CSR controllers from reconciling a CertificateRequest resource. By default,
6568
// the controllers will reconcile all CertificateRequest resources that match the issuerRef type.
69+
// This function will be called by the CertificateRequest reconcile loop and the Kubernetes CSR
70+
// reconcile loop for each type that matches the issuerRef type. If the function returns true,
71+
// the controller will not reconcile the CertificateRequest resource.
6672
type IgnoreCertificateRequest func(
6773
ctx context.Context,
6874
cr CertificateRequestObject,

0 commit comments

Comments
 (0)