diff --git a/cmd/ctl/pkg/install/helm/applycrd.go b/cmd/ctl/pkg/install/helm/applycrd.go index fb0587d03..4f1c8721a 100644 --- a/cmd/ctl/pkg/install/helm/applycrd.go +++ b/cmd/ctl/pkg/install/helm/applycrd.go @@ -24,8 +24,8 @@ import ( "k8s.io/cli-runtime/pkg/resource" ) -// Create CRDs. Before calling this function, we made sure that the CRDs -// are not yet installed on the cluster. +// CreateCRDs creates cert manager CRDs. Before calling this function, we +// made sure that the CRDs are not yet installed on the cluster. func CreateCRDs(allCRDs []*resource.Info, cfg *action.Configuration) error { log.Printf("Creating the cert-manager CRDs") // Create all CRDs diff --git a/pkg/issuer/acme/dns/cloudflare/cloudflare.go b/pkg/issuer/acme/dns/cloudflare/cloudflare.go index 1f200406f..7a06ff6d0 100644 --- a/pkg/issuer/acme/dns/cloudflare/cloudflare.go +++ b/pkg/issuer/acme/dns/cloudflare/cloudflare.go @@ -28,7 +28,7 @@ import ( // TODO: Unexport? const CloudFlareAPIURL = "https://api.cloudflare.com/client/v4" -// Mockable Interface +// DNSProviderType is the Mockable Interface type DNSProviderType interface { makeRequest(method, uri string, body io.Reader) (json.RawMessage, error) } @@ -91,7 +91,7 @@ func NewDNSProviderCredentials(email, key, token string, dns01Nameservers []stri }, nil } -// This will try to traverse the official Cloudflare API to find the nearest valid Zone. +// FindNearestZoneForFQDN will try to traverse the official Cloudflare API to find the nearest valid Zone. // It's a replacement for /pkg/issuer/acme/dns/util/wait.go#FindZoneByFqdn // example.com. ← Zone-Record found for the SLD (in most cases) // └── foo.example.com. ← Zone-Record could be possibly here, but in this case not. diff --git a/pkg/issuer/factory.go b/pkg/issuer/factory.go index 2cb7c27ef..3e0305680 100644 --- a/pkg/issuer/factory.go +++ b/pkg/issuer/factory.go @@ -25,7 +25,7 @@ import ( "github.com/cert-manager/cert-manager/pkg/controller" ) -// issuerConstructor constructs an issuer given an Issuer resource and a Context. +// IssuerConstructor constructs an issuer given an Issuer resource and a Context. // An error will be returned if the appropriate issuer is not registered. type IssuerConstructor func(*controller.Context, v1.GenericIssuer) (Interface, error) @@ -34,7 +34,7 @@ var ( constructorsLock sync.RWMutex ) -// Register will register an issuer constructor so it can be used within the +// RegisterIssuer will register an issuer constructor so it can be used within the // application. 'name' should be unique, and should be used to identify this // issuer. // TODO: move this method to be on Factory, and invent a way to obtain a