chore: address copilot feedback

Signed-off-by: Matthew H. Irby <[email protected]>

Author: irby

api/v1alpha1/issuer_types.go

@@ -285,7 +285,7 @@ const (
 )
 
 type HealthCheckConfig struct {
-	// Determines whether to the health check when the issuer is healthy. Default: true
+	// Determines whether to enable the health check when the issuer is healthy. Default: true
 	Enabled bool `json:"enabled"`
 
 	// The interval at which to health check the issuer when healthy. Defaults to 1 minute. Must not be less than "30s".

config/crd/bases/command-issuer.keyfactor.com_clusterissuers.yaml

@@ -108,7 +108,7 @@ spec:
                   a health check to determine issuer's connectivity to Command instance.
                 properties:
                   enabled:
-                    description: 'Determines whether to the health check when the
+                    description: 'Determines whether to enable the health check when the
                       issuer is healthy. Default: true'
                     type: boolean
                   interval:

config/crd/bases/command-issuer.keyfactor.com_issuers.yaml

@@ -108,7 +108,7 @@ spec:
                   a health check to determine issuer's connectivity to Command instance.
                 properties:
                   enabled:
-                    description: 'Determines whether to the health check when the
+                    description: 'Determines whether to enable the health check when the
                       issuer is healthy. Default: true'
                     type: boolean
                   interval:

deploy/charts/command-cert-manager-issuer/templates/crds/clusterissuers.yaml

@@ -85,7 +85,7 @@ spec:
                   a health check to determine issuer's connectivity to Command instance.
                 properties:
                   enabled:
-                    description: 'Determines whether to the health check when the
+                    description: 'Determines whether to enable the health check when the
                       issuer is healthy. Default: true'
                     type: boolean
                   interval:

deploy/charts/command-cert-manager-issuer/templates/crds/issuers.yaml

@@ -85,7 +85,7 @@ spec:
                   a health check to determine issuer's connectivity to Command instance.
                 properties:
                   enabled:
-                    description: 'Determines whether to the health check when the
+                    description: 'Determines whether to enable the health check when the
                       issuer is healthy. Default: true'
                     type: boolean
                   interval:

docsource/content.md

@@ -219,7 +219,7 @@ For example, ClusterIssuer resources can be used to issue certificates for resou
     | ownerRoleName     | The name of the security role assigned as the certificate owner. The security role must be assigned to the identity context of the issuer. If `ownerRoleId` and `ownerRoleName` are both specified, `ownerRoleId` will take precedence. This field is **required** if the enrollment pattern, certificate template, or system-wide setting requires it. |
     | scopes     | (Optional) Required if using ambient credentials with Azure AKS. If using ambient credentials, these scopes will be put on the access token generated by the ambient credentials' token provider, if applicable.   |
      | audience     | (Optional) If using ambient credentials, this audience will be put on the access token generated by the ambient credentials' token provider, if applicable. Google's ambient credential token provider generates an OIDC ID Token. If this value is not provided, it will default to `command`.  |
-     | healthcheck | (Optional) Defines the health check configuration for the issuer. If ommitted, health checks will be enabled and default to 60 seconds. If left disabled, the issuer will not perform a health check when the issuer is healthy and may cause CertificateRequest resources to silently fail. |
+     | healthcheck | (Optional) Defines the health check configuration for the issuer. If omitted, health checks will be enabled and default to 60 seconds. If left disabled, the issuer will not perform a health check when the issuer is healthy and may cause CertificateRequest resources to silently fail. |
      | healthcheck.enabled | (Required if health check block provided) Boolean to enable / disable health checks. By default, health checks are enabled. |
      | healthcheck.interval | (Optional) Defines the interval between health checks. Example values: `30s`, `1m`, `5.5m`. To prevent overloading the Command instance, this interval must not be less than `30s`. Default value: `60s`. |
 

internal/controller/issuer_controller.go

@@ -39,10 +39,10 @@ const (
 )
 
 var (
-	errGetAuthSecret        = errors.New("failed to get Secret containing Issuer credentials")
-	errGetCaSecret          = errors.New("caSecretName specified a name, but failed to get Secret containing CA certificate")
-	errHealthCheckerBuilder = errors.New("failed to build the healthchecker")
-	errHealthCheckerCheck   = errors.New("healthcheck failed")
+	errGetAuthSecret           = errors.New("failed to get Secret containing Issuer credentials")
+	errGetCaSecret             = errors.New("caSecretName specified a name, but failed to get Secret containing CA certificate")
+	errHealthCheckerBuilder    = errors.New("failed to build the healthchecker")
+	errHealthCheckerCheck      = errors.New("healthcheck failed")
 	defaultHealthCheckInterval = time.Minute
 )
 
@@ -102,7 +102,7 @@ func (r *IssuerReconciler) Reconcile(ctx context.Context, req ctrl.Request) (res
 
 	healthCheckInterval, err := getHealthCheckInterval(log, issuer)
 	if err != nil {
-		log.Error(err, "en error occurred while getting the health check interval")
+		log.Error(err, "an error occurred while getting the health check interval")
 		issuer.GetStatus().SetCondition(ctx, commandissuer.IssuerConditionReady, commandissuer.ConditionFalse, issuerReadyConditionReason, err.Error())
 		issuer.GetStatus().SetCondition(ctx, commandissuer.IssuerConditionSupportsMetadata, commandissuer.ConditionUnknown, "", "")
 		return ctrl.Result{}, nil